CfnCustomActionPropsMixin

class aws_cdk.mixins_preview.aws_chatbot.mixins.CfnCustomActionPropsMixin(props, *, strategy=None)

Bases: Mixin

AWS Chatbot is now .

Learn more .. epigraph:

``Type`` attribute values remain unchanged.
see:

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

cloudformationResource:

AWS::Chatbot::CustomAction

mixin:

true

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

cfn_custom_action_props_mixin = chatbot_mixins.CfnCustomActionPropsMixin(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"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Chatbot::CustomAction.

Parameters:

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['actionName', 'aliasName', 'attachments', 'definition', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Mixin.

Stability:

experimental

CustomActionAttachmentCriteriaProperty

class CfnCustomActionPropsMixin.CustomActionAttachmentCriteriaProperty(*, operator=None, value=None, variable_name=None)

Bases: object

AWS Chatbot is now . Learn more > > Type attribute values remain unchanged.

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

Attributes

operator

The operation to perform on the named variable.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-chatbot-customaction-customactionattachmentcriteria.html#cfn-chatbot-customaction-customactionattachmentcriteria-operator

value

A value that is compared with the actual value of the variable based on the behavior of the operator.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-chatbot-customaction-customactionattachmentcriteria.html#cfn-chatbot-customaction-customactionattachmentcriteria-value

variable_name

The name of the variable to operate on.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-chatbot-customaction-customactionattachmentcriteria.html#cfn-chatbot-customaction-customactionattachmentcriteria-variablename

CustomActionAttachmentProperty

class CfnCustomActionPropsMixin.CustomActionAttachmentProperty(*, button_text=None, criteria=None, notification_type=None, variables=None)

Bases: object

AWS Chatbot is now . Learn more > > Type attribute values remain unchanged.

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

Attributes

button_text

The text of the button that appears on the notification.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-chatbot-customaction-customactionattachment.html#cfn-chatbot-customaction-customactionattachment-buttontext

criteria

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-chatbot-customaction-customactionattachment.html#cfn-chatbot-customaction-customactionattachment-criteria

notification_type

The type of notification that the custom action should be attached to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-chatbot-customaction-customactionattachment.html#cfn-chatbot-customaction-customactionattachment-notificationtype

variables

The variables to extract from the notification.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-chatbot-customaction-customactionattachment.html#cfn-chatbot-customaction-customactionattachment-variables

CustomActionDefinitionProperty

class CfnCustomActionPropsMixin.CustomActionDefinitionProperty(*, command_text=None)

Bases: object

AWS Chatbot is now . Learn more > > Type attribute values remain unchanged.

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

Attributes

command_text

The command string to run which may include variables by prefixing with a dollar sign ($).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-chatbot-customaction-customactiondefinition.html#cfn-chatbot-customaction-customactiondefinition-commandtext