This is the new *Amazon CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [Amazon CloudFormation User Guide](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::QBusiness::Plugin APISchema
<a name="aws-properties-qbusiness-plugin-apischema"></a>

Contains details about the OpenAPI schema for a custom plugin. For more information, see [custom plugin OpenAPI schemas](https://docs.amazonaws.cn/amazonq/latest/qbusiness-ug/custom-plugin.html#plugins-api-schema). 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
<a name="aws-properties-qbusiness-plugin-apischema-syntax"></a>

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

### JSON
<a name="aws-properties-qbusiness-plugin-apischema-syntax.json"></a>

```
{
  "[Payload](#cfn-qbusiness-plugin-apischema-payload)" : {{String}},
  "[S3](#cfn-qbusiness-plugin-apischema-s3)" : {{S3}}
}
```

### YAML
<a name="aws-properties-qbusiness-plugin-apischema-syntax.yaml"></a>

```
  [Payload](#cfn-qbusiness-plugin-apischema-payload): {{String}}
  [S3](#cfn-qbusiness-plugin-apischema-s3): {{
    S3}}
```

## Properties
<a name="aws-properties-qbusiness-plugin-apischema-properties"></a>

`Payload`  <a name="cfn-qbusiness-plugin-apischema-payload"></a>
The JSON or YAML-formatted payload defining the OpenAPI schema for a custom plugin.   
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`S3`  <a name="cfn-qbusiness-plugin-apischema-s3"></a>
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](aws-properties-qbusiness-plugin-s3.md)  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)