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::Chatbot::CustomAction
<a name="aws-resource-chatbot-customaction"></a>

**Note**  
AWS Chatbot is now Amazon Q Developer. [Learn more](https://docs.aws.amazon.com//chatbot/latest/adminguide/service-rename.html)  
`Type` attribute values remain unchanged.

## Syntax
<a name="aws-resource-chatbot-customaction-syntax"></a>

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

### JSON
<a name="aws-resource-chatbot-customaction-syntax.json"></a>

```
{
  "Type" : "AWS::Chatbot::CustomAction",
  "Properties" : {
      "[ActionName](#cfn-chatbot-customaction-actionname)" : String,
      "[AliasName](#cfn-chatbot-customaction-aliasname)" : String,
      "[Attachments](#cfn-chatbot-customaction-attachments)" : [ CustomActionAttachment, ... ],
      "[Definition](#cfn-chatbot-customaction-definition)" : CustomActionDefinition,
      "[Tags](#cfn-chatbot-customaction-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-chatbot-customaction-syntax.yaml"></a>

```
Type: AWS::Chatbot::CustomAction
Properties:
  [ActionName](#cfn-chatbot-customaction-actionname): String
  [AliasName](#cfn-chatbot-customaction-aliasname): String
  [Attachments](#cfn-chatbot-customaction-attachments): 
    - CustomActionAttachment
  [Definition](#cfn-chatbot-customaction-definition): 
    CustomActionDefinition
  [Tags](#cfn-chatbot-customaction-tags): 
    - Tag
```

## Properties
<a name="aws-resource-chatbot-customaction-properties"></a>

`ActionName`  <a name="cfn-chatbot-customaction-actionname"></a>
The name of the custom action. This name is included in the Amazon Resource Name (ARN).  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9_-]{1,64}$`  
*Minimum*: `1`  
*Maximum*: `64`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`AliasName`  <a name="cfn-chatbot-customaction-aliasname"></a>
The name used to invoke this action in a chat channel. For example, `@Amazon Q run my-alias`.  
*Required*: No  
*Type*: String  
*Pattern*: `^[A-Za-z0-9-_]+$`  
*Minimum*: `1`  
*Maximum*: `30`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Attachments`  <a name="cfn-chatbot-customaction-attachments"></a>
Defines when this custom action button should be attached to a notification.  
*Required*: No  
*Type*: Array of [CustomActionAttachment](aws-properties-chatbot-customaction-customactionattachment.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Definition`  <a name="cfn-chatbot-customaction-definition"></a>
The definition of the command to run when invoked as an alias or as an action button.  
*Required*: Yes  
*Type*: [CustomActionDefinition](aws-properties-chatbot-customaction-customactiondefinition.md)  
*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-chatbot-customaction-tags"></a>
The tags to add to the configuration.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-chatbot-customaction-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)

## Return values
<a name="aws-resource-chatbot-customaction-return-values"></a>

### Ref
<a name="aws-resource-chatbot-customaction-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the configuration created.

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

#### 
<a name="aws-resource-chatbot-customaction-return-values-fn--getatt-fn--getatt"></a>

`CustomActionArn`  <a name="CustomActionArn-fn::getatt"></a>
The fully defined ARN of the custom action.

# AWS::Chatbot::CustomAction CustomActionAttachment
<a name="aws-properties-chatbot-customaction-customactionattachment"></a>

**Note**  
AWS Chatbot is now Amazon Q Developer. [Learn more](https://docs.aws.amazon.com//chatbot/latest/adminguide/service-rename.html)  
`Type` attribute values remain unchanged.

Defines when a custom action button should be attached to a notification.

## Syntax
<a name="aws-properties-chatbot-customaction-customactionattachment-syntax"></a>

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

### JSON
<a name="aws-properties-chatbot-customaction-customactionattachment-syntax.json"></a>

```
{
  "[ButtonText](#cfn-chatbot-customaction-customactionattachment-buttontext)" : String,
  "[Criteria](#cfn-chatbot-customaction-customactionattachment-criteria)" : [ CustomActionAttachmentCriteria, ... ],
  "[NotificationType](#cfn-chatbot-customaction-customactionattachment-notificationtype)" : String,
  "[Variables](#cfn-chatbot-customaction-customactionattachment-variables)" : {Key: Value, ...}
}
```

### YAML
<a name="aws-properties-chatbot-customaction-customactionattachment-syntax.yaml"></a>

```
  [ButtonText](#cfn-chatbot-customaction-customactionattachment-buttontext): String
  [Criteria](#cfn-chatbot-customaction-customactionattachment-criteria): 
    - CustomActionAttachmentCriteria
  [NotificationType](#cfn-chatbot-customaction-customactionattachment-notificationtype): String
  [Variables](#cfn-chatbot-customaction-customactionattachment-variables): 
    Key: Value
```

## Properties
<a name="aws-properties-chatbot-customaction-customactionattachment-properties"></a>

`ButtonText`  <a name="cfn-chatbot-customaction-customactionattachment-buttontext"></a>
The text of the button that appears on the notification.  
*Required*: No  
*Type*: String  
*Pattern*: `^[\S\s]+$`  
*Minimum*: `1`  
*Maximum*: `50`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Criteria`  <a name="cfn-chatbot-customaction-customactionattachment-criteria"></a>
The criteria for when a button should be shown based on values in the notification.  
*Required*: No  
*Type*: Array of [CustomActionAttachmentCriteria](aws-properties-chatbot-customaction-customactionattachmentcriteria.md)  
*Minimum*: `1`  
*Maximum*: `5`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`NotificationType`  <a name="cfn-chatbot-customaction-customactionattachment-notificationtype"></a>
The type of notification that the custom action should be attached to.  
*Required*: No  
*Type*: String  
*Pattern*: `^[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)

`Variables`  <a name="cfn-chatbot-customaction-customactionattachment-variables"></a>
The variables to extract from the notification.  
*Required*: No  
*Type*: Object of String  
*Pattern*: `.+`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Chatbot::CustomAction CustomActionAttachmentCriteria
<a name="aws-properties-chatbot-customaction-customactionattachmentcriteria"></a>

**Note**  
AWS Chatbot is now Amazon Q Developer. [Learn more](https://docs.aws.amazon.com//chatbot/latest/adminguide/service-rename.html)  
`Type` attribute values remain unchanged.

A criteria for when a button should be shown based on values in the notification.

## Syntax
<a name="aws-properties-chatbot-customaction-customactionattachmentcriteria-syntax"></a>

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

### JSON
<a name="aws-properties-chatbot-customaction-customactionattachmentcriteria-syntax.json"></a>

```
{
  "[Operator](#cfn-chatbot-customaction-customactionattachmentcriteria-operator)" : String,
  "[Value](#cfn-chatbot-customaction-customactionattachmentcriteria-value)" : String,
  "[VariableName](#cfn-chatbot-customaction-customactionattachmentcriteria-variablename)" : String
}
```

### YAML
<a name="aws-properties-chatbot-customaction-customactionattachmentcriteria-syntax.yaml"></a>

```
  [Operator](#cfn-chatbot-customaction-customactionattachmentcriteria-operator): String
  [Value](#cfn-chatbot-customaction-customactionattachmentcriteria-value): String
  [VariableName](#cfn-chatbot-customaction-customactionattachmentcriteria-variablename): String
```

## Properties
<a name="aws-properties-chatbot-customaction-customactionattachmentcriteria-properties"></a>

`Operator`  <a name="cfn-chatbot-customaction-customactionattachmentcriteria-operator"></a>
The operation to perform on the named variable.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `HAS_VALUE | EQUALS`  
*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-chatbot-customaction-customactionattachmentcriteria-value"></a>
A value that is compared with the actual value of the variable based on the behavior of the operator.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`VariableName`  <a name="cfn-chatbot-customaction-customactionattachmentcriteria-variablename"></a>
The name of the variable to operate on.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Chatbot::CustomAction CustomActionDefinition
<a name="aws-properties-chatbot-customaction-customactiondefinition"></a>

**Note**  
AWS Chatbot is now Amazon Q Developer. [Learn more](https://docs.aws.amazon.com//chatbot/latest/adminguide/service-rename.html)  
`Type` attribute values remain unchanged.

The definition of the command to run when invoked as an alias or as an action button.

## Syntax
<a name="aws-properties-chatbot-customaction-customactiondefinition-syntax"></a>

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

### JSON
<a name="aws-properties-chatbot-customaction-customactiondefinition-syntax.json"></a>

```
{
  "[CommandText](#cfn-chatbot-customaction-customactiondefinition-commandtext)" : String
}
```

### YAML
<a name="aws-properties-chatbot-customaction-customactiondefinition-syntax.yaml"></a>

```
  [CommandText](#cfn-chatbot-customaction-customactiondefinition-commandtext): String
```

## Properties
<a name="aws-properties-chatbot-customaction-customactiondefinition-properties"></a>

`CommandText`  <a name="cfn-chatbot-customaction-customactiondefinition-commandtext"></a>
The command string to run which may include variables by prefixing with a dollar sign (\$1).  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `5000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Chatbot::CustomAction Tag
<a name="aws-properties-chatbot-customaction-tag"></a>

**Note**  
AWS Chatbot is now Amazon Q Developer. [Learn more](https://docs.aws.amazon.com//chatbot/latest/adminguide/service-rename.html)  
`Type` attribute values remain unchanged.

A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

## Syntax
<a name="aws-properties-chatbot-customaction-tag-syntax"></a>

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

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

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

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

```
  [Key](#cfn-chatbot-customaction-tag-key): String
  [Value](#cfn-chatbot-customaction-tag-value): String
```

## Properties
<a name="aws-properties-chatbot-customaction-tag-properties"></a>

`Key`  <a name="cfn-chatbot-customaction-tag-key"></a>
 A string used to identify this tag. You can specify a maximum of 128 characters for a tag key. Tags owned by Amazon Web Services (AWS) have the reserved prefix: `aws:`.  
*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-chatbot-customaction-tag-value"></a>
A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.  
*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)