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

Class CfnPluginPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.qbusiness.CfnPluginPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-27T13:12:17.918Z")
@Stability(Stable)
public class CfnPluginPropsMixin
extends Mixin
implements software.constructs.IMixin

Information about an Amazon Q Business plugin and its configuration.

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.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 Object noAuthConfiguration;
 CfnPluginPropsMixin cfnPluginPropsMixin = CfnPluginPropsMixin.Builder.create(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())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnPluginPropsMixin.APISchemaProperty	Contains details about the OpenAPI schema for a custom plugin.
static interface	CfnPluginPropsMixin.BasicAuthConfigurationProperty	Information about the basic authentication credentials used to configure a plugin.
static final class	CfnPluginPropsMixin.Builder	A fluent builder for CfnPluginPropsMixin.
static interface	CfnPluginPropsMixin.CustomPluginConfigurationProperty	Configuration information required to create a custom plugin.
static interface	CfnPluginPropsMixin.OAuth2ClientCredentialConfigurationProperty	Information about the OAuth 2.0 authentication credential/token used to configure a plugin.
static interface	CfnPluginPropsMixin.PluginAuthConfigurationProperty	Authentication configuration information for an Amazon Q Business plugin.
static interface	CfnPluginPropsMixin.S3Property	Information required for Amazon Q Business to find a specific file in an Amazon S3 bucket.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnPluginPropsMixin(CfnPluginMixinProps props)	Create a mixin to apply properties to AWS::QBusiness::Plugin.
	CfnPluginPropsMixin(CfnPluginMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::QBusiness::Plugin.
protected	CfnPluginPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnPluginPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnPluginMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnPluginPropsMixin

protected CfnPluginPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnPluginPropsMixin

protected CfnPluginPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnPluginPropsMixin

@Stability(Stable)
public CfnPluginPropsMixin(@NotNull
 CfnPluginMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::QBusiness::Plugin.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnPluginPropsMixin

@Stability(Stable)
public CfnPluginPropsMixin(@NotNull
 CfnPluginMixinProps props)

Create a mixin to apply properties to AWS::QBusiness::Plugin.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnPluginMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()