interface APISchemaProperty

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

Contains details about the OpenAPI schema for a custom plugin.

For more information, see custom plugin OpenAPI schemas . You can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3 field.

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 aPISchemaProperty: qbusiness.CfnPlugin.APISchemaProperty = {
  payload: 'payload',
  s3: {
    bucket: 'bucket',
    key: 'key',
  },
};

Properties

Name	Type	Description
payload?	`string`	The JSON or YAML-formatted payload defining the OpenAPI schema for a custom plugin.
s3?	`IResolvable` `\|` `S3Property`	Contains details about the S3 object containing the OpenAPI schema for a custom plugin.

payload?

Type: string (optional)

The JSON or YAML-formatted payload defining the OpenAPI schema for a custom plugin.

s3?

Type: IResolvable | S3Property (optional)

Contains details about the S3 object containing the OpenAPI schema for a custom plugin.

The schema could be in either JSON or YAML format.