AWS::Chatbot::CustomAction - AWS CloudFormation
SyntaxPropertiesReturn values

AWS::Chatbot::CustomAction

The AWS::Chatbot::CustomAction resource creates a custom action that can be invoked as an alias or as a button on a notification.

Syntax

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

JSON

{
  "Type" : "AWS::Chatbot::CustomAction",
  "Properties" : {
      "ActionName" : String,
      "AliasName" : String,
      "Attachments" : [ CustomActionAttachment, ... ],
      "Definition" : CustomActionDefinition,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Chatbot::CustomAction
Properties:
  ActionName: String
  AliasName: String
  Attachments: 
    - CustomActionAttachment
  Definition: 
    CustomActionDefinition
  Tags: 
    - Tag

Properties

ActionName

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

AliasName

The name used to invoke this action in a chat channel. For example, @aws run my-alias.

Required: No

Type: String

Pattern: ^[A-Za-z0-9-_]+$

Minimum: 1

Maximum: 30

Update requires: No interruption

Attachments

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

Required: No

Type: Array of CustomActionAttachment

Update requires: No interruption

Definition

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

Required: Yes

Type: CustomActionDefinition

Update requires: No interruption

Tags

The tags to add to the configuration.

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 200

Update requires: No interruption

Return values

Ref

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

Fn::GetAtt

CustomActionArn

The fully defined ARN of the custom action.