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

Interface CfnPluginMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPluginMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-04-02T21:55:30.910Z")
@Stability(Stable)
public interface CfnPluginMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnPluginPropsMixin.

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.*;
 Object noAuthConfiguration;
 CfnPluginMixinProps cfnPluginMixinProps = CfnPluginMixinProps.builder()
         .applicationId("applicationId")
         .authConfiguration(PluginAuthConfigurationProperty.builder()
                 .basicAuthConfiguration(BasicAuthConfigurationProperty.builder()
                         .roleArn("roleArn")
                         .secretArn("secretArn")
                         .build())
                 .noAuthConfiguration(noAuthConfiguration)
                 .oAuth2ClientCredentialConfiguration(OAuth2ClientCredentialConfigurationProperty.builder()
                         .authorizationUrl("authorizationUrl")
                         .roleArn("roleArn")
                         .secretArn("secretArn")
                         .tokenUrl("tokenUrl")
                         .build())
                 .build())
         .customPluginConfiguration(CustomPluginConfigurationProperty.builder()
                 .apiSchema(APISchemaProperty.builder()
                         .payload("payload")
                         .s3(S3Property.builder()
                                 .bucket("bucket")
                                 .key("key")
                                 .build())
                         .build())
                 .apiSchemaType("apiSchemaType")
                 .description("description")
                 .build())
         .displayName("displayName")
         .serverUrl("serverUrl")
         .state("state")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .type("type")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnPluginMixinProps.Builder	builder()
default String	getApplicationId()	The identifier of the application that will contain the plugin.
default Object	getAuthConfiguration()	Authentication configuration information for an Amazon Q Business plugin.
default Object	getCustomPluginConfiguration()	Configuration information required to create a custom plugin.
default String	getDisplayName()	The name of the plugin.
default String	getServerUrl()	The plugin server URL used for configuration.
default String	getState()	The current status of the plugin.
default List<CfnTag>	getTags()	A list of key-value pairs that identify or categorize the data source connector.
default String	getType()	The type of the plugin.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApplicationId

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

The identifier of the application that will contain the plugin.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-plugin.html#cfn-qbusiness-plugin-applicationid

getAuthConfiguration

@Stability(Stable)
@Nullable
default Object getAuthConfiguration()

Authentication configuration information for an Amazon Q Business plugin.

Returns union: either IResolvable or CfnPluginPropsMixin.PluginAuthConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-plugin.html#cfn-qbusiness-plugin-authconfiguration

getCustomPluginConfiguration

@Stability(Stable)
@Nullable
default Object getCustomPluginConfiguration()

Configuration information required to create a custom plugin.

Returns union: either IResolvable or CfnPluginPropsMixin.CustomPluginConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-plugin.html#cfn-qbusiness-plugin-custompluginconfiguration

getDisplayName

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

The name of the plugin.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-plugin.html#cfn-qbusiness-plugin-displayname

getServerUrl

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

The plugin server URL used for configuration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-plugin.html#cfn-qbusiness-plugin-serverurl

getState

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

The current status of the plugin.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-plugin.html#cfn-qbusiness-plugin-state

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

A list of key-value pairs that identify or categorize the data source connector.

You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + -

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-plugin.html#cfn-qbusiness-plugin-tags

getType

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

The type of the plugin.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-plugin.html#cfn-qbusiness-plugin-type

builder

@Stability(Stable)
static CfnPluginMixinProps.Builder builder()

Returns:

a CfnPluginMixinProps.Builder of CfnPluginMixinProps