CfnCustomActionMixinProps

class aws_cdk.mixins_preview.aws_chatbot.mixins.CfnCustomActionMixinProps(*, action_name=None, alias_name=None, attachments=None, definition=None, tags=None)

Bases: object

Properties for CfnCustomActionPropsMixin.

Parameters:
  • action_name (Optional[str]) – The name of the custom action. This name is included in the Amazon Resource Name (ARN).

  • alias_name (Optional[str]) – The name used to invoke this action in a chat channel. For example, @Amazon Q 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.

  • definition (Union[IResolvable, CustomActionDefinitionProperty, Dict[str, Any], None]) – The definition of the command to run when invoked as an alias or as an action button.

  • 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.mixins_preview.aws_chatbot import mixins as chatbot_mixins

cfn_custom_action_mixin_props = chatbot_mixins.CfnCustomActionMixinProps(
    action_name="actionName",
    alias_name="aliasName",
    attachments=[chatbot_mixins.CfnCustomActionPropsMixin.CustomActionAttachmentProperty(
        button_text="buttonText",
        criteria=[chatbot_mixins.CfnCustomActionPropsMixin.CustomActionAttachmentCriteriaProperty(
            operator="operator",
            value="value",
            variable_name="variableName"
        )],
        notification_type="notificationType",
        variables={
            "variables_key": "variables"
        }
    )],
    definition=chatbot_mixins.CfnCustomActionPropsMixin.CustomActionDefinitionProperty(
        command_text="commandText"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

action_name

The name of the custom action.

This name is included in the Amazon Resource Name (ARN).

See:

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

alias_name

The name used to invoke this action in a chat channel.

For example, @Amazon Q run my-alias .

See:

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

attachments

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

See:

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

definition

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

See:

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

tags

The tags to add to the configuration.

See:

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