Package software.amazon.awscdk.services.chatbot

Class CfnCustomAction

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.chatbot.CfnCustomAction
All Implemented Interfaces:
IInspectable, ICustomActionRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-13T16:10:00.210Z") @Stability(Stable) public class CfnCustomAction extends CfnResource implements IInspectable, ICustomActionRef, ITaggableV2

AWS Chatbot is now .

Learn more

Type attribute values remain unchanged.

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.*;
 CfnCustomAction cfnCustomAction = CfnCustomAction.Builder.create(this, "MyCfnCustomAction")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnCustomAction

      protected CfnCustomAction(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnCustomAction

      protected CfnCustomAction(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnCustomAction

      @Stability(Stable) public CfnCustomAction(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnCustomActionProps props)
      Create a new AWS::Chatbot::CustomAction.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrCustomActionArn

      @Stability(Stable) @NotNull public String getAttrCustomActionArn()
      The fully defined ARN of the custom action.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCustomActionRef

      @Stability(Stable) @NotNull public CustomActionReference getCustomActionRef()
      A reference to a CustomAction resource.
      Specified by:
      getCustomActionRef in interface ICustomActionRef

    • getActionName

      @Stability(Stable) @NotNull public String getActionName()
      The name of the custom action.

    • setActionName

      @Stability(Stable) public void setActionName(@NotNull String value)
      The name of the custom action.

    • getDefinition

      @Stability(Stable) @NotNull public 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

    • setDefinition

      @Stability(Stable) public void setDefinition(@NotNull IResolvable value)
      The definition of the command to run when invoked as an alias or as an action button.

    • setDefinition

      @Stability(Stable) public void setDefinition(@NotNull CfnCustomAction.CustomActionDefinitionProperty value)
      The definition of the command to run when invoked as an alias or as an action button.

    • getAliasName

      @Stability(Stable) @Nullable public String getAliasName()
      The name used to invoke this action in a chat channel.

    • setAliasName

      @Stability(Stable) public void setAliasName(@Nullable String value)
      The name used to invoke this action in a chat channel.

    • getAttachments

      @Stability(Stable) @Nullable public 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>

    • setAttachments

      @Stability(Stable) public void setAttachments(@Nullable IResolvable value)
      Defines when this custom action button should be attached to a notification.

    • setAttachments

      @Stability(Stable) public void setAttachments(@Nullable List<Object> value)
      Defines when this custom action button should be attached to a notification.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The tags to add to the configuration.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The tags to add to the configuration.