Interface AuthConfig.Builder

All Superinterfaces:

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

Enclosing class:

AuthConfig

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

Method Summary

Modifier and Type	Method	Description
AuthConfig.Builder	audienceOverride(String audienceOverride)	The value that Connect Customer uses as the audience (aud) claim of the JSON Web Token (JWT) that it issues.
AuthConfig.Builder	authType(String authType)	The type of authentication that Connect Customer uses to call the external application endpoint.
AuthConfig.Builder	authType(AuthType authType)	The type of authentication that Connect Customer uses to call the external application endpoint.
AuthConfig.Builder	credentialProviderIdentifier(String credentialProviderIdentifier)	The ARN of the Secrets Manager secret that stores the 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

authType

AuthConfig.Builder authType(String authType)

The type of authentication that Connect Customer uses to call the external application endpoint. You must specify an authentication type for A2A_SERVER applications. Valid values:

• API_KEY: Connect Customer sends an API key that is stored in the Secrets Manager secret that you specify in CredentialProviderIdentifier.

• CONNECT_JWT: Connect Customer issues a short-lived, signed JSON Web Token (JWT). This authentication type doesn't require a stored credential.

Parameters:

authType - The type of authentication that Connect Customer uses to call the external application endpoint. You must specify an authentication type for A2A_SERVER applications. Valid values:

• API_KEY: Connect Customer sends an API key that is stored in the Secrets Manager secret that you specify in CredentialProviderIdentifier.

• CONNECT_JWT: Connect Customer issues a short-lived, signed JSON Web Token (JWT). This authentication type doesn't require a stored credential.

Returns:

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

See Also:

• AuthType
• AuthType

authType

AuthConfig.Builder authType(AuthType authType)

The type of authentication that Connect Customer uses to call the external application endpoint. You must specify an authentication type for A2A_SERVER applications. Valid values:

• API_KEY: Connect Customer sends an API key that is stored in the Secrets Manager secret that you specify in CredentialProviderIdentifier.

• CONNECT_JWT: Connect Customer issues a short-lived, signed JSON Web Token (JWT). This authentication type doesn't require a stored credential.

Parameters:

authType - The type of authentication that Connect Customer uses to call the external application endpoint. You must specify an authentication type for A2A_SERVER applications. Valid values:

• API_KEY: Connect Customer sends an API key that is stored in the Secrets Manager secret that you specify in CredentialProviderIdentifier.

• CONNECT_JWT: Connect Customer issues a short-lived, signed JSON Web Token (JWT). This authentication type doesn't require a stored credential.

Returns:

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

See Also:

• AuthType
• AuthType

credentialProviderIdentifier

AuthConfig.Builder credentialProviderIdentifier(String credentialProviderIdentifier)

The ARN of the Secrets Manager secret that stores the credentials. The secret must be accessible to Connect Customer.

You must specify this ARN when AuthType is API_KEY. Don't specify it when AuthType is CONNECT_JWT.

Parameters:

credentialProviderIdentifier - The ARN of the Secrets Manager secret that stores the credentials. The secret must be accessible to Connect Customer.

You must specify this ARN when AuthType is API_KEY. Don't specify it when AuthType is CONNECT_JWT.

Returns:

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

audienceOverride

AuthConfig.Builder audienceOverride(String audienceOverride)

The value that Connect Customer uses as the audience (aud) claim of the JSON Web Token (JWT) that it issues. You can specify this parameter only when AuthType is CONNECT_JWT. If you don't specify it, the audience is the AccessUrl of the application. The value can't contain connect.amazonaws.com.

Parameters:

audienceOverride - The value that Connect Customer uses as the audience (aud) claim of the JSON Web Token (JWT) that it issues. You can specify this parameter only when AuthType is CONNECT_JWT. If you don't specify it, the audience is the AccessUrl of the application. The value can't contain connect.amazonaws.com.

Returns:

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