interface CustomPluginConfigurationProperty

Language	Type name
.NET	Amazon.CDK.aws_qbusiness.CfnPlugin.CustomPluginConfigurationProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsqbusiness#CfnPlugin_CustomPluginConfigurationProperty
Java	software.amazon.awscdk.services.qbusiness.CfnPlugin.CustomPluginConfigurationProperty
Python	aws_cdk.aws_qbusiness.CfnPlugin.CustomPluginConfigurationProperty
TypeScript	aws-cdk-lib » aws_qbusiness » CfnPlugin » CustomPluginConfigurationProperty

Configuration information required to create a custom plugin.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-custompluginconfiguration.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_qbusiness as qbusiness } from 'aws-cdk-lib';
const customPluginConfigurationProperty: qbusiness.CfnPlugin.CustomPluginConfigurationProperty = {
  apiSchema: {
    payload: 'payload',
    s3: {
      bucket: 'bucket',
      key: 'key',
    },
  },
  apiSchemaType: 'apiSchemaType',
  description: 'description',
};

Properties

Name	Type	Description
apiSchema	IResolvable | APISchemaProperty	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	string	The type of OpenAPI schema to use.
description	string	A description for your custom plugin configuration.

---

apiSchema

Type: IResolvable | APISchemaProperty

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-custompluginconfiguration.html#cfn-qbusiness-plugin-custompluginconfiguration-apischema

---

apiSchemaType

Type: string

The type of OpenAPI schema to use.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-custompluginconfiguration.html#cfn-qbusiness-plugin-custompluginconfiguration-apischematype

---

description

Type: string

A description for your custom plugin configuration.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-custompluginconfiguration.html#cfn-qbusiness-plugin-custompluginconfiguration-description