Package software.amazon.awscdk.cfnpropertymixins.services.chatbot

Interface CfnCustomActionMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCustomActionMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:56.852Z")
@Stability(Stable)
public interface CfnCustomActionMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnCustomActionPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.chatbot.*;
 CfnCustomActionMixinProps cfnCustomActionMixinProps = CfnCustomActionMixinProps.builder()
         .actionName("actionName")
         .aliasName("aliasName")
         .attachments(List.of(CustomActionAttachmentProperty.builder()
                 .buttonText("buttonText")
                 .criteria(List.of(CustomActionAttachmentCriteriaProperty.builder()
                         .operator("operator")
                         .value("value")
                         .variableName("variableName")
                         .build()))
                 .notificationType("notificationType")
                 .variables(Map.of(
                         "variablesKey", "variables"))
                 .build()))
         .definition(CustomActionDefinitionProperty.builder()
                 .commandText("commandText")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnCustomActionMixinProps.Builder	A builder for CfnCustomActionMixinProps
static final class	CfnCustomActionMixinProps.Jsii$Proxy	An implementation for CfnCustomActionMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnCustomActionMixinProps.Builder	builder()
default String	getActionName()	The name of the custom action.
default String	getAliasName()	The name used to invoke this action in a chat channel.
default Object	getAttachments()	Defines when this custom action button should be attached to a notification.
default Object	getDefinition()	The definition of the command to run when invoked as an alias or as an action button.
default List<CfnTag>	getTags()	The tags to add to the configuration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getActionName

@Stability(Stable)
@Nullable
default String getActionName()

The name of the custom action.

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

See Also:

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

getAliasName

@Stability(Stable)
@Nullable
default String getAliasName()

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

For example, @Amazon Q run my-alias .

See Also:

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

getAttachments

@Stability(Stable)
@Nullable
default Object getAttachments()

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

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnCustomActionPropsMixin.CustomActionAttachmentProperty>

See Also:

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

getDefinition

@Stability(Stable)
@Nullable
default Object getDefinition()

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

Returns union: either IResolvable or CfnCustomActionPropsMixin.CustomActionDefinitionProperty

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The tags to add to the configuration.

See Also:

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

builder

@Stability(Stable)
static CfnCustomActionMixinProps.Builder builder()

Returns:

a CfnCustomActionMixinProps.Builder of CfnCustomActionMixinProps