interface CustomPluginConfigurationProperty
| Language | Type name |
|---|---|
.NET | Amazon.CDK.Mixins.Preview.AWS.QBusiness.Mixins.CfnPluginPropsMixin.CustomPluginConfigurationProperty |
Go | github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsqbusiness/mixins#CfnPluginPropsMixin_CustomPluginConfigurationProperty |
Java | software.amazon.awscdk.mixins.preview.services.qbusiness.mixins.CfnPluginPropsMixin.CustomPluginConfigurationProperty |
Python | aws_cdk.mixins_preview.aws_qbusiness.mixins.CfnPluginPropsMixin.CustomPluginConfigurationProperty |
TypeScript | @aws-cdk/mixins-preview » aws_qbusiness » mixins » CfnPluginPropsMixin » CustomPluginConfigurationProperty |
Configuration information required to create a custom plugin.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as qbusiness_mixins } from '@aws-cdk/mixins-preview/aws-qbusiness';
const customPluginConfigurationProperty: qbusiness_mixins.CfnPluginPropsMixin.CustomPluginConfigurationProperty = {
apiSchema: {
payload: 'payload',
s3: {
bucket: 'bucket',
key: 'key',
},
},
apiSchemaType: 'apiSchemaType',
description: 'description',
};
Properties
| Name | Type | Description |
|---|---|---|
| api | IResolvable | APISchema | Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. |
| api | string | The type of OpenAPI schema to use. |
| description? | string | A description for your custom plugin configuration. |
apiSchema?
Type:
IResolvable | APISchema
(optional)
Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema.
apiSchemaType?
Type:
string
(optional)
The type of OpenAPI schema to use.
description?
Type:
string
(optional)
A description for your custom plugin configuration.

.NET
Go
Java
Python
TypeScript