Interface OAuth2ClientCredentialConfiguration.Builder

All Superinterfaces:

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

Enclosing class:

OAuth2ClientCredentialConfiguration

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

Method Summary

Modifier and Type	Method	Description
OAuth2ClientCredentialConfiguration.Builder	authorizationUrl(String authorizationUrl)	The redirect URL required by the OAuth 2.0 protocol for Amazon Q Business to authenticate a plugin user through a third party authentication server.
OAuth2ClientCredentialConfiguration.Builder	roleArn(String roleArn)	The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0 authentication credentials stored in a Secrets Manager secret.
OAuth2ClientCredentialConfiguration.Builder	secretArn(String secretArn)	The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration.
OAuth2ClientCredentialConfiguration.Builder	tokenUrl(String tokenUrl)	The URL required by the OAuth 2.0 protocol to exchange an end user authorization code for an access token.

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

secretArn

OAuth2ClientCredentialConfiguration.Builder secretArn(String secretArn)

The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration.

Parameters:

secretArn - The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration.

Returns:

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

roleArn

OAuth2ClientCredentialConfiguration.Builder roleArn(String roleArn)

The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0 authentication credentials stored in a Secrets Manager secret.

Parameters:

roleArn - The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0 authentication credentials stored in a Secrets Manager secret.

Returns:

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

authorizationUrl

OAuth2ClientCredentialConfiguration.Builder authorizationUrl(String authorizationUrl)

The redirect URL required by the OAuth 2.0 protocol for Amazon Q Business to authenticate a plugin user through a third party authentication server.

Parameters:

authorizationUrl - The redirect URL required by the OAuth 2.0 protocol for Amazon Q Business to authenticate a plugin user through a third party authentication server.

Returns:

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

tokenUrl

OAuth2ClientCredentialConfiguration.Builder tokenUrl(String tokenUrl)

The URL required by the OAuth 2.0 protocol to exchange an end user authorization code for an access token.

Parameters:

tokenUrl - The URL required by the OAuth 2.0 protocol to exchange an end user authorization code for an access token.

Returns:

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