Interface AuthenticationConfiguration.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<AuthenticationConfiguration.Builder,
,AuthenticationConfiguration> SdkBuilder<AuthenticationConfiguration.Builder,
,AuthenticationConfiguration> SdkPojo
- Enclosing class:
AuthenticationConfiguration
@Mutable
@NotThreadSafe
public static interface AuthenticationConfiguration.Builder
extends SdkPojo, CopyableBuilder<AuthenticationConfiguration.Builder,AuthenticationConfiguration>
-
Method Summary
Modifier and TypeMethodDescriptionauthenticationType
(String authenticationType) A structure containing the authentication configuration.authenticationType
(AuthenticationType authenticationType) A structure containing the authentication configuration.The Amazon Resource Name (ARN) of the KMS key used to encrypt sensitive authentication information.oAuth2Properties
(Consumer<OAuth2Properties.Builder> oAuth2Properties) The properties for OAuth2 authentication.oAuth2Properties
(OAuth2Properties oAuth2Properties) The properties for OAuth2 authentication.The secret manager ARN to store credentials.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
authenticationType
A structure containing the authentication configuration.
- Parameters:
authenticationType
- A structure containing the authentication configuration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
authenticationType
A structure containing the authentication configuration.
- Parameters:
authenticationType
- A structure containing the authentication configuration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
secretArn
The secret manager ARN to store credentials.
- Parameters:
secretArn
- The secret manager ARN to store credentials.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
kmsKeyArn
The Amazon Resource Name (ARN) of the KMS key used to encrypt sensitive authentication information. This key is used to protect credentials and other sensitive data stored within the authentication configuration.
- Parameters:
kmsKeyArn
- The Amazon Resource Name (ARN) of the KMS key used to encrypt sensitive authentication information. This key is used to protect credentials and other sensitive data stored within the authentication configuration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
oAuth2Properties
The properties for OAuth2 authentication.
- Parameters:
oAuth2Properties
- The properties for OAuth2 authentication.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
oAuth2Properties
default AuthenticationConfiguration.Builder oAuth2Properties(Consumer<OAuth2Properties.Builder> oAuth2Properties) The properties for OAuth2 authentication.
This is a convenience method that creates an instance of theOAuth2Properties.Builder
avoiding the need to create one manually viaOAuth2Properties.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tooAuth2Properties(OAuth2Properties)
.- Parameters:
oAuth2Properties
- a consumer that will call methods onOAuth2Properties.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-