Package software.amazon.awscdk.services.qbusiness

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")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-oauth2clientcredentialconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPlugin.OAuth2ClientCredentialConfigurationProperty.Builder	A builder for CfnPlugin.OAuth2ClientCredentialConfigurationProperty
static final class	CfnPlugin.OAuth2ClientCredentialConfigurationProperty.Jsii$Proxy	An implementation for CfnPlugin.OAuth2ClientCredentialConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnPlugin.OAuth2ClientCredentialConfigurationProperty.Builder	builder()
String	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.
String	getSecretArn()	The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRoleArn

@Stability(Stable)
@NotNull
String 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-oauth2clientcredentialconfiguration.html#cfn-qbusiness-plugin-oauth2clientcredentialconfiguration-rolearn

getSecretArn

@Stability(Stable)
@NotNull
String getSecretArn()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-oauth2clientcredentialconfiguration.html#cfn-qbusiness-plugin-oauth2clientcredentialconfiguration-secretarn

builder

@Stability(Stable)
static CfnPlugin.OAuth2ClientCredentialConfigurationProperty.Builder builder()

Returns:

a CfnPlugin.OAuth2ClientCredentialConfigurationProperty.Builder of CfnPlugin.OAuth2ClientCredentialConfigurationProperty