Package software.amazon.awscdk.services.qbusiness

Class CfnPlugin.OAuth2ClientCredentialConfigurationProperty.Builder

java.lang.Object

software.amazon.awscdk.services.qbusiness.CfnPlugin.OAuth2ClientCredentialConfigurationProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnPlugin.OAuth2ClientCredentialConfigurationProperty>

Enclosing interface:

CfnPlugin.OAuth2ClientCredentialConfigurationProperty

@Stability(Stable)
public static final class CfnPlugin.OAuth2ClientCredentialConfigurationProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnPlugin.OAuth2ClientCredentialConfigurationProperty>

A builder for CfnPlugin.OAuth2ClientCredentialConfigurationProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnPlugin.OAuth2ClientCredentialConfigurationProperty.Builder	authorizationUrl(String authorizationUrl)	Sets the value of CfnPlugin.OAuth2ClientCredentialConfigurationProperty.getAuthorizationUrl()
CfnPlugin.OAuth2ClientCredentialConfigurationProperty	build()	Builds the configured instance.
CfnPlugin.OAuth2ClientCredentialConfigurationProperty.Builder	roleArn(String roleArn)	Sets the value of CfnPlugin.OAuth2ClientCredentialConfigurationProperty.getRoleArn()
CfnPlugin.OAuth2ClientCredentialConfigurationProperty.Builder	secretArn(String secretArn)	Sets the value of CfnPlugin.OAuth2ClientCredentialConfigurationProperty.getSecretArn()
CfnPlugin.OAuth2ClientCredentialConfigurationProperty.Builder	tokenUrl(String tokenUrl)	Sets the value of CfnPlugin.OAuth2ClientCredentialConfigurationProperty.getTokenUrl()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

roleArn

@Stability(Stable)
public CfnPlugin.OAuth2ClientCredentialConfigurationProperty.Builder roleArn(String roleArn)

Sets the value of CfnPlugin.OAuth2ClientCredentialConfigurationProperty.getRoleArn()

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. This parameter is required.

Returns:

this

secretArn

@Stability(Stable)
public CfnPlugin.OAuth2ClientCredentialConfigurationProperty.Builder secretArn(String secretArn)

Sets the value of CfnPlugin.OAuth2ClientCredentialConfigurationProperty.getSecretArn()

Parameters:

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

Returns:

this

authorizationUrl

@Stability(Stable)
public CfnPlugin.OAuth2ClientCredentialConfigurationProperty.Builder authorizationUrl(String authorizationUrl)

Sets the value of CfnPlugin.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

tokenUrl

@Stability(Stable)
public CfnPlugin.OAuth2ClientCredentialConfigurationProperty.Builder tokenUrl(String tokenUrl)

Sets the value of CfnPlugin.OAuth2ClientCredentialConfigurationProperty.getTokenUrl()

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

@Stability(Stable)
public CfnPlugin.OAuth2ClientCredentialConfigurationProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnPlugin.OAuth2ClientCredentialConfigurationProperty>

Returns:

a new instance of CfnPlugin.OAuth2ClientCredentialConfigurationProperty

Throws:

NullPointerException - if any required attribute was not provided