CfnCustomActionProps

class aws_cdk.aws_chatbot.CfnCustomActionProps(*, action_name, definition, alias_name=None, attachments=None, tags=None)

Bases: object

Properties for defining a CfnCustomAction.

Parameters:

action_name (str) – The name of the custom action. This name is included in the Amazon Resource Name (ARN).
definition (Union[IResolvable, CustomActionDefinitionProperty, Dict[str, Any]]) – The definition of the command to run when invoked as an alias or as an action button.
alias_name (Optional[str]) – The name used to invoke this action in a chat channel. For example, @aws run my-alias .
attachments (Union[IResolvable, Sequence[Union[IResolvable, CustomActionAttachmentProperty, Dict[str, Any]]], None]) – Defines when this custom action button should be attached to a notification.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags to add to the configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-customaction.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_chatbot as chatbot

cfn_custom_action_props = chatbot.CfnCustomActionProps(
    action_name="actionName",
    definition=chatbot.CfnCustomAction.CustomActionDefinitionProperty(
        command_text="commandText"
    ),

    # the properties below are optional
    alias_name="aliasName",
    attachments=[chatbot.CfnCustomAction.CustomActionAttachmentProperty(
        button_text="buttonText",
        criteria=[chatbot.CfnCustomAction.CustomActionAttachmentCriteriaProperty(
            operator="operator",
            variable_name="variableName",

            # the properties below are optional
            value="value"
        )],
        notification_type="notificationType",
        variables={
            "variables_key": "variables"
        }
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)