CfnCustomActionPropsMixin
- class aws_cdk.mixins_preview.aws_chatbot.mixins.CfnCustomActionPropsMixin(props, *, strategy=None)
Bases:
MixinAWS 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:
props (
Union[CfnCustomActionMixinProps,Dict[str,Any]]) – L1 properties to apply.strategy (
Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE
Methods
- apply_to(construct)
Apply the mixin properties to the construct.
- Parameters:
construct (
IConstruct)- Return type:
- 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
xis a Mixin.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsMixin.- Stability:
experimental
CustomActionAttachmentCriteriaProperty
- class CfnCustomActionPropsMixin.CustomActionAttachmentCriteriaProperty(*, operator=None, value=None, variable_name=None)
Bases:
objectAWS Chatbot is now . Learn more > >
Typeattribute 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.
- value
A value that is compared with the actual value of the variable based on the behavior of the operator.
- variable_name
The name of the variable to operate on.
CustomActionAttachmentProperty
- class CfnCustomActionPropsMixin.CustomActionAttachmentProperty(*, button_text=None, criteria=None, notification_type=None, variables=None)
Bases:
objectAWS Chatbot is now . Learn more > >
Typeattribute 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.
- criteria
The criteria for when a button should be shown based on values in the notification.
- notification_type
The type of notification that the custom action should be attached to.
- variables
The variables to extract from the notification.
CustomActionDefinitionProperty
- class CfnCustomActionPropsMixin.CustomActionDefinitionProperty(*, command_text=None)
Bases:
objectAWS Chatbot is now . Learn more > >
Typeattribute 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 ($).