Package software.amazon.awscdk.cfnpropertymixins.services.qbusiness

Interface CfnPluginPropsMixin.BasicAuthConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPluginPropsMixin.BasicAuthConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnPluginPropsMixin

@Stability(Stable)
public static interface CfnPluginPropsMixin.BasicAuthConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Information about the basic authentication credentials 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.cfnpropertymixins.services.qbusiness.*;
 BasicAuthConfigurationProperty basicAuthConfigurationProperty = BasicAuthConfigurationProperty.builder()
         .roleArn("roleArn")
         .secretArn("secretArn")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnPluginPropsMixin.BasicAuthConfigurationProperty.Builder	builder()
default String	getRoleArn()	The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
default String	getSecretArn()	The ARN of the Secrets Manager secret that stores the basic authentication credentials used for plugin configuration..

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRoleArn

@Stability(Stable)
@Nullable
default String getRoleArn()

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

See Also:

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

getSecretArn

@Stability(Stable)
@Nullable
default String getSecretArn()

The ARN of the Secrets Manager secret that stores the basic authentication credentials used for plugin configuration..

See Also:

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

builder

@Stability(Stable)
static CfnPluginPropsMixin.BasicAuthConfigurationProperty.Builder builder()

Returns:

a CfnPluginPropsMixin.BasicAuthConfigurationProperty.Builder of CfnPluginPropsMixin.BasicAuthConfigurationProperty