AWS::QBusiness::Plugin APISchema - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::QBusiness::Plugin APISchema

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.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Payload" : String,
  "S3" : S3
}

YAML

  Payload: String
  S3: 
    S3

Properties

Payload

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

Required: No

Type: String

Update requires: No interruption

S3

Contains details about the S3 object containing the OpenAPI schema for a custom plugin. The schema could be in either JSON or YAML format.

Required: No

Type: S3

Update requires: No interruption