Interface AuthenticationConfigurationInput.Builder

All Superinterfaces:

Buildable, CopyableBuilder<AuthenticationConfigurationInput.Builder,AuthenticationConfigurationInput>, SdkBuilder<AuthenticationConfigurationInput.Builder,AuthenticationConfigurationInput>, SdkPojo

Enclosing class:

AuthenticationConfigurationInput

@Mutable
@NotThreadSafe
public static interface AuthenticationConfigurationInput.Builder
extends SdkPojo, CopyableBuilder<AuthenticationConfigurationInput.Builder,AuthenticationConfigurationInput>

Method Summary

Modifier and Type	Method	Description
AuthenticationConfigurationInput.Builder	authenticationType(String authenticationType)	A structure containing the authentication configuration in the CreateConnection request.
AuthenticationConfigurationInput.Builder	authenticationType(AuthenticationType authenticationType)	A structure containing the authentication configuration in the CreateConnection request.
default AuthenticationConfigurationInput.Builder	basicAuthenticationCredentials(Consumer<BasicAuthenticationCredentials.Builder> basicAuthenticationCredentials)	The credentials used when the authentication type is basic authentication.
AuthenticationConfigurationInput.Builder	basicAuthenticationCredentials(BasicAuthenticationCredentials basicAuthenticationCredentials)	The credentials used when the authentication type is basic authentication.
AuthenticationConfigurationInput.Builder	customAuthenticationCredentials(Map<String,String> customAuthenticationCredentials)	The credentials used when the authentication type is custom authentication.
AuthenticationConfigurationInput.Builder	kmsKeyArn(String kmsKeyArn)	The ARN of the KMS key used to encrypt the connection.
default AuthenticationConfigurationInput.Builder	oAuth2Properties(Consumer<OAuth2PropertiesInput.Builder> oAuth2Properties)	The properties for OAuth2 authentication in the CreateConnection request.
AuthenticationConfigurationInput.Builder	oAuth2Properties(OAuth2PropertiesInput oAuth2Properties)	The properties for OAuth2 authentication in the CreateConnection request.
AuthenticationConfigurationInput.Builder	secretArn(String secretArn)	The secret manager ARN to store credentials in the CreateConnection request.

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

AuthenticationConfigurationInput.Builder authenticationType(String authenticationType)

A structure containing the authentication configuration in the CreateConnection request.

Parameters:

authenticationType - A structure containing the authentication configuration in the CreateConnection request.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• AuthenticationType
• AuthenticationType

authenticationType

AuthenticationConfigurationInput.Builder authenticationType(AuthenticationType authenticationType)

A structure containing the authentication configuration in the CreateConnection request.

Parameters:

authenticationType - A structure containing the authentication configuration in the CreateConnection request.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• AuthenticationType
• AuthenticationType

oAuth2Properties

AuthenticationConfigurationInput.Builder oAuth2Properties(OAuth2PropertiesInput oAuth2Properties)

The properties for OAuth2 authentication in the CreateConnection request.

Parameters:

oAuth2Properties - The properties for OAuth2 authentication in the CreateConnection request.

Returns:

Returns a reference to this object so that method calls can be chained together.

oAuth2Properties

default AuthenticationConfigurationInput.Builder oAuth2Properties(Consumer<OAuth2PropertiesInput.Builder> oAuth2Properties)

The properties for OAuth2 authentication in the CreateConnection request.

This is a convenience method that creates an instance of the OAuth2PropertiesInput.Builder avoiding the need to create one manually via OAuth2PropertiesInput.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to oAuth2Properties(OAuth2PropertiesInput).

Parameters:

oAuth2Properties - a consumer that will call methods on OAuth2PropertiesInput.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• oAuth2Properties(OAuth2PropertiesInput)

secretArn

AuthenticationConfigurationInput.Builder secretArn(String secretArn)

The secret manager ARN to store credentials in the CreateConnection request.

Parameters:

secretArn - The secret manager ARN to store credentials in the CreateConnection request.

Returns:

Returns a reference to this object so that method calls can be chained together.

kmsKeyArn

AuthenticationConfigurationInput.Builder kmsKeyArn(String kmsKeyArn)

The ARN of the KMS key used to encrypt the connection. Only taken an as input in the request and stored in the Secret Manager.

Parameters:

kmsKeyArn - The ARN of the KMS key used to encrypt the connection. Only taken an as input in the request and stored in the Secret Manager.

Returns:

Returns a reference to this object so that method calls can be chained together.

basicAuthenticationCredentials

AuthenticationConfigurationInput.Builder basicAuthenticationCredentials(BasicAuthenticationCredentials basicAuthenticationCredentials)

The credentials used when the authentication type is basic authentication.

Parameters:

basicAuthenticationCredentials - The credentials used when the authentication type is basic authentication.

Returns:

Returns a reference to this object so that method calls can be chained together.

basicAuthenticationCredentials

default AuthenticationConfigurationInput.Builder basicAuthenticationCredentials(Consumer<BasicAuthenticationCredentials.Builder> basicAuthenticationCredentials)

The credentials used when the authentication type is basic authentication.

This is a convenience method that creates an instance of the BasicAuthenticationCredentials.Builder avoiding the need to create one manually via BasicAuthenticationCredentials.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to basicAuthenticationCredentials(BasicAuthenticationCredentials).

Parameters:

basicAuthenticationCredentials - a consumer that will call methods on BasicAuthenticationCredentials.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• basicAuthenticationCredentials(BasicAuthenticationCredentials)

customAuthenticationCredentials

AuthenticationConfigurationInput.Builder customAuthenticationCredentials(Map<String,String> customAuthenticationCredentials)

The credentials used when the authentication type is custom authentication.

Parameters:

customAuthenticationCredentials - The credentials used when the authentication type is custom authentication.

Returns:

Returns a reference to this object so that method calls can be chained together.