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

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

Information about an Amazon Q Business plugin and its configuration.

## Syntax
<a name="aws-resource-qbusiness-plugin-syntax"></a>

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

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

```
{
  "Type" : "AWS::QBusiness::Plugin",
  "Properties" : {
      "[ApplicationId](#cfn-qbusiness-plugin-applicationid)" : String,
      "[AuthConfiguration](#cfn-qbusiness-plugin-authconfiguration)" : PluginAuthConfiguration,
      "[CustomPluginConfiguration](#cfn-qbusiness-plugin-custompluginconfiguration)" : CustomPluginConfiguration,
      "[DisplayName](#cfn-qbusiness-plugin-displayname)" : String,
      "[ServerUrl](#cfn-qbusiness-plugin-serverurl)" : String,
      "[State](#cfn-qbusiness-plugin-state)" : String,
      "[Tags](#cfn-qbusiness-plugin-tags)" : [ Tag, ... ],
      "[Type](#cfn-qbusiness-plugin-type)" : String
    }
}
```

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

```
Type: AWS::QBusiness::Plugin
Properties:
  [ApplicationId](#cfn-qbusiness-plugin-applicationid): String
  [AuthConfiguration](#cfn-qbusiness-plugin-authconfiguration): 
    PluginAuthConfiguration
  [CustomPluginConfiguration](#cfn-qbusiness-plugin-custompluginconfiguration): 
    CustomPluginConfiguration
  [DisplayName](#cfn-qbusiness-plugin-displayname): String
  [ServerUrl](#cfn-qbusiness-plugin-serverurl): String
  [State](#cfn-qbusiness-plugin-state): String
  [Tags](#cfn-qbusiness-plugin-tags): 
    - Tag
  [Type](#cfn-qbusiness-plugin-type): String
```

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

`ApplicationId`  <a name="cfn-qbusiness-plugin-applicationid"></a>
The identifier of the application that will contain the plugin.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9][a-zA-Z0-9-]{35}$`  
*Minimum*: `36`  
*Maximum*: `36`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`AuthConfiguration`  <a name="cfn-qbusiness-plugin-authconfiguration"></a>
Authentication configuration information for an Amazon Q Business plugin.  
*Required*: Yes  
*Type*: [PluginAuthConfiguration](aws-properties-qbusiness-plugin-pluginauthconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CustomPluginConfiguration`  <a name="cfn-qbusiness-plugin-custompluginconfiguration"></a>
 Configuration information required to create a custom plugin.  
*Required*: No  
*Type*: [CustomPluginConfiguration](aws-properties-qbusiness-plugin-custompluginconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DisplayName`  <a name="cfn-qbusiness-plugin-displayname"></a>
The name of the plugin.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9][a-zA-Z0-9_-]*$`  
*Minimum*: `1`  
*Maximum*: `100`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ServerUrl`  <a name="cfn-qbusiness-plugin-serverurl"></a>
The plugin server URL used for configuration.  
*Required*: No  
*Type*: String  
*Pattern*: `^(https?|ftp|file)://([^\s]*)$`  
*Minimum*: `1`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`State`  <a name="cfn-qbusiness-plugin-state"></a>
The current status of the plugin.  
*Required*: No  
*Type*: String  
*Allowed values*: `ENABLED | DISABLED`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-qbusiness-plugin-tags"></a>
A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: \$1 . : / = \$1 - @.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-qbusiness-plugin-tag.md)  
*Minimum*: `0`  
*Maximum*: `200`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Type`  <a name="cfn-qbusiness-plugin-type"></a>
The type of the plugin.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `SERVICE_NOW | SALESFORCE | JIRA | ZENDESK | CUSTOM | QUICKSIGHT | SERVICENOW_NOW_PLATFORM | JIRA_CLOUD | SALESFORCE_CRM | ZENDESK_SUITE | ATLASSIAN_CONFLUENCE | GOOGLE_CALENDAR | MICROSOFT_TEAMS | MICROSOFT_EXCHANGE | PAGERDUTY_ADVANCE | SMARTSHEET | ASANA`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

## Return values
<a name="aws-resource-qbusiness-plugin-return-values"></a>

### Ref
<a name="aws-resource-qbusiness-plugin-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the application ID and plugin ID. For example:

 `{"Ref": "ApplicationId|PluginId"}` 

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-qbusiness-plugin-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-qbusiness-plugin-return-values-fn--getatt-fn--getatt"></a>

`BuildStatus`  <a name="BuildStatus-fn::getatt"></a>
The current status of a plugin. A plugin is modified asynchronously.

`CreatedAt`  <a name="CreatedAt-fn::getatt"></a>
The timestamp for when the plugin was created.

`PluginArn`  <a name="PluginArn-fn::getatt"></a>
The Amazon Resource Name (ARN) of a plugin.

`PluginId`  <a name="PluginId-fn::getatt"></a>
The identifier of the plugin.

`UpdatedAt`  <a name="UpdatedAt-fn::getatt"></a>
The timestamp for when the plugin was last updated.

# 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.aws.amazon.com/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 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.aws.amazon.com/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.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

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

Information about the basic authentication credentials used to configure a plugin.

## Syntax
<a name="aws-properties-qbusiness-plugin-basicauthconfiguration-syntax"></a>

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

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

```
{
  "[RoleArn](#cfn-qbusiness-plugin-basicauthconfiguration-rolearn)" : String,
  "[SecretArn](#cfn-qbusiness-plugin-basicauthconfiguration-secretarn)" : String
}
```

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

```
  [RoleArn](#cfn-qbusiness-plugin-basicauthconfiguration-rolearn): String
  [SecretArn](#cfn-qbusiness-plugin-basicauthconfiguration-secretarn): String
```

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

`RoleArn`  <a name="cfn-qbusiness-plugin-basicauthconfiguration-rolearn"></a>
The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$`  
*Minimum*: `0`  
*Maximum*: `1284`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SecretArn`  <a name="cfn-qbusiness-plugin-basicauthconfiguration-secretarn"></a>
The ARN of the Secrets Manager secret that stores the basic authentication credentials used for plugin configuration..  
*Required*: Yes  
*Type*: String  
*Pattern*: `^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$`  
*Minimum*: `0`  
*Maximum*: `1284`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

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

 Configuration information required to create a custom plugin.

## Syntax
<a name="aws-properties-qbusiness-plugin-custompluginconfiguration-syntax"></a>

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

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

```
{
  "[ApiSchema](#cfn-qbusiness-plugin-custompluginconfiguration-apischema)" : APISchema,
  "[ApiSchemaType](#cfn-qbusiness-plugin-custompluginconfiguration-apischematype)" : String,
  "[Description](#cfn-qbusiness-plugin-custompluginconfiguration-description)" : String
}
```

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

```
  [ApiSchema](#cfn-qbusiness-plugin-custompluginconfiguration-apischema): 
    APISchema
  [ApiSchemaType](#cfn-qbusiness-plugin-custompluginconfiguration-apischematype): String
  [Description](#cfn-qbusiness-plugin-custompluginconfiguration-description): String
```

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

`ApiSchema`  <a name="cfn-qbusiness-plugin-custompluginconfiguration-apischema"></a>
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.  
*Required*: Yes  
*Type*: [APISchema](aws-properties-qbusiness-plugin-apischema.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ApiSchemaType`  <a name="cfn-qbusiness-plugin-custompluginconfiguration-apischematype"></a>
The type of OpenAPI schema to use.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `OPEN_API_V3`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Description`  <a name="cfn-qbusiness-plugin-custompluginconfiguration-description"></a>
A description for your custom plugin configuration.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `200`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

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

Information about the OAuth 2.0 authentication credential/token used to configure a plugin.

## Syntax
<a name="aws-properties-qbusiness-plugin-oauth2clientcredentialconfiguration-syntax"></a>

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

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

```
{
  "[AuthorizationUrl](#cfn-qbusiness-plugin-oauth2clientcredentialconfiguration-authorizationurl)" : String,
  "[RoleArn](#cfn-qbusiness-plugin-oauth2clientcredentialconfiguration-rolearn)" : String,
  "[SecretArn](#cfn-qbusiness-plugin-oauth2clientcredentialconfiguration-secretarn)" : String,
  "[TokenUrl](#cfn-qbusiness-plugin-oauth2clientcredentialconfiguration-tokenurl)" : String
}
```

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

```
  [AuthorizationUrl](#cfn-qbusiness-plugin-oauth2clientcredentialconfiguration-authorizationurl): String
  [RoleArn](#cfn-qbusiness-plugin-oauth2clientcredentialconfiguration-rolearn): String
  [SecretArn](#cfn-qbusiness-plugin-oauth2clientcredentialconfiguration-secretarn): String
  [TokenUrl](#cfn-qbusiness-plugin-oauth2clientcredentialconfiguration-tokenurl): String
```

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

`AuthorizationUrl`  <a name="cfn-qbusiness-plugin-oauth2clientcredentialconfiguration-authorizationurl"></a>
The redirect URL required by the OAuth 2.0 protocol for Amazon Q Business to authenticate a plugin user through a third party authentication server.  
*Required*: No  
*Type*: String  
*Pattern*: `^(https?|ftp|file)://([^\s]*)$`  
*Minimum*: `1`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RoleArn`  <a name="cfn-qbusiness-plugin-oauth2clientcredentialconfiguration-rolearn"></a>
The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0 authentication credentials stored in a Secrets Manager secret.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$`  
*Minimum*: `0`  
*Maximum*: `1284`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SecretArn`  <a name="cfn-qbusiness-plugin-oauth2clientcredentialconfiguration-secretarn"></a>
The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$`  
*Minimum*: `0`  
*Maximum*: `1284`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TokenUrl`  <a name="cfn-qbusiness-plugin-oauth2clientcredentialconfiguration-tokenurl"></a>
The URL required by the OAuth 2.0 protocol to exchange an end user authorization code for an access token.  
*Required*: No  
*Type*: String  
*Pattern*: `^(https?|ftp|file)://([^\s]*)$`  
*Minimum*: `1`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

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

Authentication configuration information for an Amazon Q Business plugin.

## Syntax
<a name="aws-properties-qbusiness-plugin-pluginauthconfiguration-syntax"></a>

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

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

```
{
  "[BasicAuthConfiguration](#cfn-qbusiness-plugin-pluginauthconfiguration-basicauthconfiguration)" : BasicAuthConfiguration,
  "[NoAuthConfiguration](#cfn-qbusiness-plugin-pluginauthconfiguration-noauthconfiguration)" : Json,
  "[OAuth2ClientCredentialConfiguration](#cfn-qbusiness-plugin-pluginauthconfiguration-oauth2clientcredentialconfiguration)" : OAuth2ClientCredentialConfiguration
}
```

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

```
  [BasicAuthConfiguration](#cfn-qbusiness-plugin-pluginauthconfiguration-basicauthconfiguration): 
    BasicAuthConfiguration
  [NoAuthConfiguration](#cfn-qbusiness-plugin-pluginauthconfiguration-noauthconfiguration): Json
  [OAuth2ClientCredentialConfiguration](#cfn-qbusiness-plugin-pluginauthconfiguration-oauth2clientcredentialconfiguration): 
    OAuth2ClientCredentialConfiguration
```

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

`BasicAuthConfiguration`  <a name="cfn-qbusiness-plugin-pluginauthconfiguration-basicauthconfiguration"></a>
Information about the basic authentication credentials used to configure a plugin.  
*Required*: No  
*Type*: [BasicAuthConfiguration](aws-properties-qbusiness-plugin-basicauthconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`NoAuthConfiguration`  <a name="cfn-qbusiness-plugin-pluginauthconfiguration-noauthconfiguration"></a>
Information about invoking a custom plugin without any authentication.  
*Required*: No  
*Type*: Json  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OAuth2ClientCredentialConfiguration`  <a name="cfn-qbusiness-plugin-pluginauthconfiguration-oauth2clientcredentialconfiguration"></a>
Information about the OAuth 2.0 authentication credential/token used to configure a plugin.  
*Required*: No  
*Type*: [OAuth2ClientCredentialConfiguration](aws-properties-qbusiness-plugin-oauth2clientcredentialconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

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

Information required for Amazon Q Business to find a specific file in an Amazon S3 bucket.

## Syntax
<a name="aws-properties-qbusiness-plugin-s3-syntax"></a>

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

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

```
{
  "[Bucket](#cfn-qbusiness-plugin-s3-bucket)" : String,
  "[Key](#cfn-qbusiness-plugin-s3-key)" : String
}
```

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

```
  [Bucket](#cfn-qbusiness-plugin-s3-bucket): String
  [Key](#cfn-qbusiness-plugin-s3-key): String
```

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

`Bucket`  <a name="cfn-qbusiness-plugin-s3-bucket"></a>
The name of the S3 bucket that contains the file.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]$`  
*Minimum*: `1`  
*Maximum*: `63`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Key`  <a name="cfn-qbusiness-plugin-s3-key"></a>
The name of the file.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

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

A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: \$1 . : / = \$1 - @.

## Syntax
<a name="aws-properties-qbusiness-plugin-tag-syntax"></a>

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

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

```
{
  "[Key](#cfn-qbusiness-plugin-tag-key)" : String,
  "[Value](#cfn-qbusiness-plugin-tag-value)" : String
}
```

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

```
  [Key](#cfn-qbusiness-plugin-tag-key): String
  [Value](#cfn-qbusiness-plugin-tag-value): String
```

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

`Key`  <a name="cfn-qbusiness-plugin-tag-key"></a>
 The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-qbusiness-plugin-tag-value"></a>
The value associated with the tag. The value may be an empty string but it can't be null.  
*Required*: Yes  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)