Class CfnPluginPropsMixin.OAuth2ClientCredentialConfigurationProperty.Builder
java.lang.Object
software.amazon.awscdk.cfnpropertymixins.services.qbusiness.CfnPluginPropsMixin.OAuth2ClientCredentialConfigurationProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnPluginPropsMixin.OAuth2ClientCredentialConfigurationProperty>
- Enclosing interface:
CfnPluginPropsMixin.OAuth2ClientCredentialConfigurationProperty
@Stability(Stable)
public static final class CfnPluginPropsMixin.OAuth2ClientCredentialConfigurationProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnPluginPropsMixin.OAuth2ClientCredentialConfigurationProperty>
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionauthorizationUrl(String authorizationUrl) build()Builds the configured instance.
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
authorizationUrl
@Stability(Stable) public CfnPluginPropsMixin.OAuth2ClientCredentialConfigurationProperty.Builder authorizationUrl(String authorizationUrl) Sets the value ofCfnPluginPropsMixin.OAuth2ClientCredentialConfigurationProperty.getAuthorizationUrl()- 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:
this
-
roleArn
@Stability(Stable) public CfnPluginPropsMixin.OAuth2ClientCredentialConfigurationProperty.Builder roleArn(String roleArn) - 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:
this
-
secretArn
@Stability(Stable) public CfnPluginPropsMixin.OAuth2ClientCredentialConfigurationProperty.Builder secretArn(String secretArn) - Parameters:
secretArn- The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration.- Returns:
this
-
tokenUrl
@Stability(Stable) public CfnPluginPropsMixin.OAuth2ClientCredentialConfigurationProperty.Builder tokenUrl(String tokenUrl) - Parameters:
tokenUrl- The URL required by the OAuth 2.0 protocol to exchange an end user authorization code for an access token.- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnPluginPropsMixin.OAuth2ClientCredentialConfigurationProperty>- Returns:
- a new instance of
CfnPluginPropsMixin.OAuth2ClientCredentialConfigurationProperty - Throws:
NullPointerException- if any required attribute was not provided
-