Interface CfnPlugin.OAuth2ClientCredentialConfigurationProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnPlugin.OAuth2ClientCredentialConfigurationProperty.Jsii$Proxy
- Enclosing class:
CfnPlugin
@Stability(Stable)
public static interface CfnPlugin.OAuth2ClientCredentialConfigurationProperty
extends software.amazon.jsii.JsiiSerializable
Information about the OAuth 2.0 authentication credential/token used to configure a plugin.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.qbusiness.*; OAuth2ClientCredentialConfigurationProperty oAuth2ClientCredentialConfigurationProperty = OAuth2ClientCredentialConfigurationProperty.builder() .roleArn("roleArn") .secretArn("secretArn") // the properties below are optional .authorizationUrl("authorizationUrl") .tokenUrl("tokenUrl") .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnPlugin.OAuth2ClientCredentialConfigurationProperty
static final class
An implementation forCfnPlugin.OAuth2ClientCredentialConfigurationProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default String
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.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.The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration.default String
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.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getRoleArn
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.- See Also:
-
getSecretArn
The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration.- See Also:
-
getAuthorizationUrl
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.- See Also:
-
getTokenUrl
The URL required by the OAuth 2.0 protocol to exchange an end user authorization code for an access token.- See Also:
-
builder
-