Package software.amazon.awscdk.services.chatbot

Interface CfnCustomActionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCustomActionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-17T14:40:46.720Z")
@Stability(Stable)
public interface CfnCustomActionProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnCustomAction.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.chatbot.*;
 CfnCustomActionProps cfnCustomActionProps = CfnCustomActionProps.builder()
         .actionName("actionName")
         .definition(CustomActionDefinitionProperty.builder()
                 .commandText("commandText")
                 .build())
         // the properties below are optional
         .aliasName("aliasName")
         .attachments(List.of(CustomActionAttachmentProperty.builder()
                 .buttonText("buttonText")
                 .criteria(List.of(CustomActionAttachmentCriteriaProperty.builder()
                         .operator("operator")
                         .variableName("variableName")
                         // the properties below are optional
                         .value("value")
                         .build()))
                 .notificationType("notificationType")
                 .variables(Map.of(
                         "variablesKey", "variables"))
                 .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	CfnCustomActionProps.Builder	A builder for CfnCustomActionProps
static final class	CfnCustomActionProps.Jsii$Proxy	An implementation for CfnCustomActionProps

Method Summary

Modifier and Type	Method	Description
static CfnCustomActionProps.Builder	builder()
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.
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)
@NotNull
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

getDefinition

@Stability(Stable)
@NotNull
Object getDefinition()

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

Returns union: either IResolvable or CfnCustomAction.CustomActionDefinitionProperty

See Also:

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

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 CfnCustomAction.CustomActionAttachmentProperty>

See Also:

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

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 CfnCustomActionProps.Builder builder()

Returns:

a CfnCustomActionProps.Builder of CfnCustomActionProps