Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. chatbot
  5. CustomAction

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.chatbot.CustomAction

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

Definition of AWS::Chatbot::CustomAction Resource Type

Create CustomAction Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new CustomAction(name: string, args: CustomActionArgs, opts?: CustomResourceOptions);
@overload
def CustomAction(resource_name: str,
                 args: CustomActionArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def CustomAction(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 definition: Optional[CustomActionDefinitionArgs] = None,
                 action_name: Optional[str] = None,
                 alias_name: Optional[str] = None,
                 attachments: Optional[Sequence[CustomActionAttachmentArgs]] = None,
                 tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
func NewCustomAction(ctx *Context, name string, args CustomActionArgs, opts ...ResourceOption) (*CustomAction, error)
public CustomAction(string name, CustomActionArgs args, CustomResourceOptions? opts = null)
public CustomAction(String name, CustomActionArgs args)
public CustomAction(String name, CustomActionArgs args, CustomResourceOptions options)

type: aws-native:chatbot:CustomAction
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. CustomActionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. CustomActionArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. CustomActionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. CustomActionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. CustomActionArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

CustomAction Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The CustomAction resource accepts the following input properties:

Definition This property is required. Pulumi.AwsNative.Chatbot.Inputs.CustomActionDefinition
The definition of the command to run when invoked as an alias or as an action button.
ActionName string
The name of the custom action. This name is included in the Amazon Resource Name (ARN).
AliasName string
The name used to invoke this action in a chat channel. For example, @Amazon Q run my-alias .
Attachments List<Pulumi.AwsNative.Chatbot.Inputs.CustomActionAttachment>
Defines when this custom action button should be attached to a notification.
Tags List<Pulumi.AwsNative.Inputs.Tag>
The tags to add to the configuration.
Definition This property is required. CustomActionDefinitionArgs
The definition of the command to run when invoked as an alias or as an action button.
ActionName string
The name of the custom action. This name is included in the Amazon Resource Name (ARN).
AliasName string
The name used to invoke this action in a chat channel. For example, @Amazon Q run my-alias .
Attachments []CustomActionAttachmentArgs
Defines when this custom action button should be attached to a notification.
Tags TagArgs
The tags to add to the configuration.
definition This property is required. CustomActionDefinition
The definition of the command to run when invoked as an alias or as an action button.
actionName String
The name of the custom action. This name is included in the Amazon Resource Name (ARN).
aliasName String
The name used to invoke this action in a chat channel. For example, @Amazon Q run my-alias .
attachments List<CustomActionAttachment>
Defines when this custom action button should be attached to a notification.
tags List<Tag>
The tags to add to the configuration.
definition This property is required. CustomActionDefinition
The definition of the command to run when invoked as an alias or as an action button.
actionName string
The name of the custom action. This name is included in the Amazon Resource Name (ARN).
aliasName string
The name used to invoke this action in a chat channel. For example, @Amazon Q run my-alias .
attachments CustomActionAttachment[]
Defines when this custom action button should be attached to a notification.
tags Tag[]
The tags to add to the configuration.
definition This property is required. CustomActionDefinitionArgs
The definition of the command to run when invoked as an alias or as an action button.
action_name str
The name of the custom action. This name is included in the Amazon Resource Name (ARN).
alias_name str
The name used to invoke this action in a chat channel. For example, @Amazon Q run my-alias .
attachments Sequence[CustomActionAttachmentArgs]
Defines when this custom action button should be attached to a notification.
tags Sequence[TagArgs]
The tags to add to the configuration.
definition This property is required. Property Map
The definition of the command to run when invoked as an alias or as an action button.
actionName String
The name of the custom action. This name is included in the Amazon Resource Name (ARN).
aliasName String
The name used to invoke this action in a chat channel. For example, @Amazon Q run my-alias .
attachments List<Property Map>
Defines when this custom action button should be attached to a notification.
tags List<Property Map>
The tags to add to the configuration.

Outputs

All input properties are implicitly available as output properties. Additionally, the CustomAction resource produces the following output properties:

CustomActionArn string
The fully defined ARN of the custom action.
Id string
The provider-assigned unique ID for this managed resource.
CustomActionArn string
The fully defined ARN of the custom action.
Id string
The provider-assigned unique ID for this managed resource.
customActionArn String
The fully defined ARN of the custom action.
id String
The provider-assigned unique ID for this managed resource.
customActionArn string
The fully defined ARN of the custom action.
id string
The provider-assigned unique ID for this managed resource.
custom_action_arn str
The fully defined ARN of the custom action.
id str
The provider-assigned unique ID for this managed resource.
customActionArn String
The fully defined ARN of the custom action.
id String
The provider-assigned unique ID for this managed resource.

Supporting Types

CustomActionAttachment
, CustomActionAttachmentArgs

ButtonText string
The text of the button that appears on the notification.
Criteria List<Pulumi.AwsNative.Chatbot.Inputs.CustomActionAttachmentCriteria>
The criteria for when a button should be shown based on values in the notification.
NotificationType string
The type of notification that the custom action should be attached to.
Variables Dictionary<string, string>
The variables to extract from the notification.
ButtonText string
The text of the button that appears on the notification.
Criteria []CustomActionAttachmentCriteria
The criteria for when a button should be shown based on values in the notification.
NotificationType string
The type of notification that the custom action should be attached to.
Variables map[string]string
The variables to extract from the notification.
buttonText String
The text of the button that appears on the notification.
criteria List<CustomActionAttachmentCriteria>
The criteria for when a button should be shown based on values in the notification.
notificationType String
The type of notification that the custom action should be attached to.
variables Map<String,String>
The variables to extract from the notification.
buttonText string
The text of the button that appears on the notification.
criteria CustomActionAttachmentCriteria[]
The criteria for when a button should be shown based on values in the notification.
notificationType string
The type of notification that the custom action should be attached to.
variables {[key: string]: string}
The variables to extract from the notification.
button_text str
The text of the button that appears on the notification.
criteria Sequence[CustomActionAttachmentCriteria]
The criteria for when a button should be shown based on values in the notification.
notification_type str
The type of notification that the custom action should be attached to.
variables Mapping[str, str]
The variables to extract from the notification.
buttonText String
The text of the button that appears on the notification.
criteria List<Property Map>
The criteria for when a button should be shown based on values in the notification.
notificationType String
The type of notification that the custom action should be attached to.
variables Map<String>
The variables to extract from the notification.

CustomActionAttachmentCriteria
, CustomActionAttachmentCriteriaArgs

Operator This property is required. Pulumi.AwsNative.Chatbot.CustomActionAttachmentCriteriaOperator
The operation to perform on the named variable.
VariableName This property is required. string
The name of the variable to operate on.
Value string
A value that is compared with the actual value of the variable based on the behavior of the operator.
Operator This property is required. CustomActionAttachmentCriteriaOperator
The operation to perform on the named variable.
VariableName This property is required. string
The name of the variable to operate on.
Value string
A value that is compared with the actual value of the variable based on the behavior of the operator.
operator This property is required. CustomActionAttachmentCriteriaOperator
The operation to perform on the named variable.
variableName This property is required. String
The name of the variable to operate on.
value String
A value that is compared with the actual value of the variable based on the behavior of the operator.
operator This property is required. CustomActionAttachmentCriteriaOperator
The operation to perform on the named variable.
variableName This property is required. string
The name of the variable to operate on.
value string
A value that is compared with the actual value of the variable based on the behavior of the operator.
operator This property is required. CustomActionAttachmentCriteriaOperator
The operation to perform on the named variable.
variable_name This property is required. str
The name of the variable to operate on.
value str
A value that is compared with the actual value of the variable based on the behavior of the operator.
operator This property is required. "HAS_VALUE" | "EQUALS"
The operation to perform on the named variable.
variableName This property is required. String
The name of the variable to operate on.
value String
A value that is compared with the actual value of the variable based on the behavior of the operator.

CustomActionAttachmentCriteriaOperator
, CustomActionAttachmentCriteriaOperatorArgs

HasValue
HAS_VALUE
EqualsValue
EQUALS
CustomActionAttachmentCriteriaOperatorHasValue
HAS_VALUE
CustomActionAttachmentCriteriaOperatorEquals
EQUALS
HasValue
HAS_VALUE
Equals
EQUALS
HasValue
HAS_VALUE
Equals
EQUALS
HAS_VALUE
HAS_VALUE
EQUALS
EQUALS
"HAS_VALUE"
HAS_VALUE
"EQUALS"
EQUALS

CustomActionDefinition
, CustomActionDefinitionArgs

CommandText This property is required. string
The command string to run which may include variables by prefixing with a dollar sign ($).
CommandText This property is required. string
The command string to run which may include variables by prefixing with a dollar sign ($).
commandText This property is required. String
The command string to run which may include variables by prefixing with a dollar sign ($).
commandText This property is required. string
The command string to run which may include variables by prefixing with a dollar sign ($).
command_text This property is required. str
The command string to run which may include variables by prefixing with a dollar sign ($).
commandText This property is required. String
The command string to run which may include variables by prefixing with a dollar sign ($).

Tag
, TagArgs

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native