Interface UpdateWorkspaceAuthenticationRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<UpdateWorkspaceAuthenticationRequest.Builder,
,UpdateWorkspaceAuthenticationRequest> GrafanaRequest.Builder
,SdkBuilder<UpdateWorkspaceAuthenticationRequest.Builder,
,UpdateWorkspaceAuthenticationRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
UpdateWorkspaceAuthenticationRequest
-
Method Summary
Modifier and TypeMethodDescriptionauthenticationProviders
(Collection<AuthenticationProviderTypes> authenticationProviders) Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace.authenticationProviders
(AuthenticationProviderTypes... authenticationProviders) Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace.authenticationProvidersWithStrings
(String... authenticationProviders) Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace.authenticationProvidersWithStrings
(Collection<String> authenticationProviders) Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.samlConfiguration
(Consumer<SamlConfiguration.Builder> samlConfiguration) If the workspace uses SAML, use this structure to map SAML assertion attributes to workspace user information and define which groups in the assertion attribute are to have theAdmin
andEditor
roles in the workspace.samlConfiguration
(SamlConfiguration samlConfiguration) If the workspace uses SAML, use this structure to map SAML assertion attributes to workspace user information and define which groups in the assertion attribute are to have theAdmin
andEditor
roles in the workspace.workspaceId
(String workspaceId) The ID of the workspace to update the authentication for.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.grafana.model.GrafanaRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
authenticationProvidersWithStrings
UpdateWorkspaceAuthenticationRequest.Builder authenticationProvidersWithStrings(Collection<String> authenticationProviders) Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana.
- Parameters:
authenticationProviders
- Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
authenticationProvidersWithStrings
UpdateWorkspaceAuthenticationRequest.Builder authenticationProvidersWithStrings(String... authenticationProviders) Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana.
- Parameters:
authenticationProviders
- Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
authenticationProviders
UpdateWorkspaceAuthenticationRequest.Builder authenticationProviders(Collection<AuthenticationProviderTypes> authenticationProviders) Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana.
- Parameters:
authenticationProviders
- Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
authenticationProviders
UpdateWorkspaceAuthenticationRequest.Builder authenticationProviders(AuthenticationProviderTypes... authenticationProviders) Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana.
- Parameters:
authenticationProviders
- Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
samlConfiguration
If the workspace uses SAML, use this structure to map SAML assertion attributes to workspace user information and define which groups in the assertion attribute are to have the
Admin
andEditor
roles in the workspace.- Parameters:
samlConfiguration
- If the workspace uses SAML, use this structure to map SAML assertion attributes to workspace user information and define which groups in the assertion attribute are to have theAdmin
andEditor
roles in the workspace.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
samlConfiguration
default UpdateWorkspaceAuthenticationRequest.Builder samlConfiguration(Consumer<SamlConfiguration.Builder> samlConfiguration) If the workspace uses SAML, use this structure to map SAML assertion attributes to workspace user information and define which groups in the assertion attribute are to have the
This is a convenience method that creates an instance of theAdmin
andEditor
roles in the workspace.SamlConfiguration.Builder
avoiding the need to create one manually viaSamlConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosamlConfiguration(SamlConfiguration)
.- Parameters:
samlConfiguration
- a consumer that will call methods onSamlConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
workspaceId
The ID of the workspace to update the authentication for.
- Parameters:
workspaceId
- The ID of the workspace to update the authentication for.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
UpdateWorkspaceAuthenticationRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
UpdateWorkspaceAuthenticationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-