We recommend new projects start with resources from the AWS provider.
aws-native.chatbot.CustomAction
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
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 string
- The unique name of the resource.
- args CustomActionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args 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 string
- The unique name of the resource.
- args CustomActionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CustomActionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args 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
Pulumi.
Aws Native. Chatbot. Inputs. Custom Action Definition - The definition of the command to run when invoked as an alias or as an action button.
- Action
Name string - The name of the custom action. This name is included in the Amazon Resource Name (ARN).
- Alias
Name string - The name used to invoke this action in a chat channel. For example,
@aws run my-alias
. - Attachments
List<Pulumi.
Aws Native. Chatbot. Inputs. Custom Action Attachment> - Defines when this custom action button should be attached to a notification.
- List<Pulumi.
Aws Native. Inputs. Tag> - The tags to add to the configuration.
- Definition
Custom
Action Definition Args - The definition of the command to run when invoked as an alias or as an action button.
- Action
Name string - The name of the custom action. This name is included in the Amazon Resource Name (ARN).
- Alias
Name string - The name used to invoke this action in a chat channel. For example,
@aws run my-alias
. - Attachments
[]Custom
Action Attachment Args - Defines when this custom action button should be attached to a notification.
- Tag
Args - The tags to add to the configuration.
- definition
Custom
Action Definition - The definition of the command to run when invoked as an alias or as an action button.
- action
Name String - The name of the custom action. This name is included in the Amazon Resource Name (ARN).
- alias
Name String - The name used to invoke this action in a chat channel. For example,
@aws run my-alias
. - attachments
List<Custom
Action Attachment> - Defines when this custom action button should be attached to a notification.
- List<Tag>
- The tags to add to the configuration.
- definition
Custom
Action Definition - The definition of the command to run when invoked as an alias or as an action button.
- action
Name string - The name of the custom action. This name is included in the Amazon Resource Name (ARN).
- alias
Name string - The name used to invoke this action in a chat channel. For example,
@aws run my-alias
. - attachments
Custom
Action Attachment[] - Defines when this custom action button should be attached to a notification.
- Tag[]
- The tags to add to the configuration.
- definition
Custom
Action Definition Args - 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,
@aws run my-alias
. - attachments
Sequence[Custom
Action Attachment Args] - Defines when this custom action button should be attached to a notification.
- Sequence[Tag
Args] - The tags to add to the configuration.
- definition Property Map
- The definition of the command to run when invoked as an alias or as an action button.
- action
Name String - The name of the custom action. This name is included in the Amazon Resource Name (ARN).
- alias
Name String - The name used to invoke this action in a chat channel. For example,
@aws run my-alias
. - attachments List<Property Map>
- Defines when this custom action button should be attached to a notification.
- 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:
- Custom
Action stringArn - The fully defined ARN of the custom action.
- Id string
- The provider-assigned unique ID for this managed resource.
- Custom
Action stringArn - The fully defined ARN of the custom action.
- Id string
- The provider-assigned unique ID for this managed resource.
- custom
Action StringArn - The fully defined ARN of the custom action.
- id String
- The provider-assigned unique ID for this managed resource.
- custom
Action stringArn - The fully defined ARN of the custom action.
- id string
- The provider-assigned unique ID for this managed resource.
- custom_
action_ strarn - The fully defined ARN of the custom action.
- id str
- The provider-assigned unique ID for this managed resource.
- custom
Action StringArn - The fully defined ARN of the custom action.
- id String
- The provider-assigned unique ID for this managed resource.
Supporting Types
CustomActionAttachment, CustomActionAttachmentArgs
- string
- The text of the button that appears on the notification.
- Criteria
List<Pulumi.
Aws Native. Chatbot. Inputs. Custom Action Attachment Criteria> - The criteria for when a button should be shown based on values in the notification.
- Notification
Type string - The type of notification that the custom action should be attached to.
- Variables Dictionary<string, string>
- The variables to extract from the notification.
- string
- The text of the button that appears on the notification.
- Criteria
[]Custom
Action Attachment Criteria - The criteria for when a button should be shown based on values in the notification.
- Notification
Type string - The type of notification that the custom action should be attached to.
- Variables map[string]string
- The variables to extract from the notification.
- String
- The text of the button that appears on the notification.
- criteria
List<Custom
Action Attachment Criteria> - The criteria for when a button should be shown based on values in the notification.
- notification
Type String - The type of notification that the custom action should be attached to.
- variables Map<String,String>
- The variables to extract from the notification.
- string
- The text of the button that appears on the notification.
- criteria
Custom
Action Attachment Criteria[] - The criteria for when a button should be shown based on values in the notification.
- notification
Type string - The type of notification that the custom action should be attached to.
- variables {[key: string]: string}
- The variables to extract from the notification.
- str
- The text of the button that appears on the notification.
- criteria
Sequence[Custom
Action Attachment Criteria] - 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.
- 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.
- notification
Type 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
Pulumi.
Aws Native. Chatbot. Custom Action Attachment Criteria Operator - The operation to perform on the named variable.
- Variable
Name 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
Custom
Action Attachment Criteria Operator - The operation to perform on the named variable.
- Variable
Name 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
Custom
Action Attachment Criteria Operator - The operation to perform on the named variable.
- variable
Name 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
Custom
Action Attachment Criteria Operator - The operation to perform on the named variable.
- variable
Name 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
Custom
Action Attachment Criteria Operator - The operation to perform on the named variable.
- variable_
name 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 "HAS_VALUE" | "EQUALS"
- The operation to perform on the named variable.
- variable
Name 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
- Has
Value - HAS_VALUE
- Equals
Value - EQUALS
- Custom
Action Attachment Criteria Operator Has Value - HAS_VALUE
- Custom
Action Attachment Criteria Operator Equals - EQUALS
- Has
Value - HAS_VALUE
- Equals
- EQUALS
- Has
Value - HAS_VALUE
- Equals
- EQUALS
- HAS_VALUE
- HAS_VALUE
- EQUALS
- EQUALS
- "HAS_VALUE"
- HAS_VALUE
- "EQUALS"
- EQUALS
CustomActionDefinition, CustomActionDefinitionArgs
- Command
Text string - The command string to run which may include variables by prefixing with a dollar sign ($).
- Command
Text string - The command string to run which may include variables by prefixing with a dollar sign ($).
- command
Text String - The command string to run which may include variables by prefixing with a dollar sign ($).
- command
Text string - The command string to run which may include variables by prefixing with a dollar sign ($).
- command_
text str - The command string to run which may include variables by prefixing with a dollar sign ($).
- command
Text String - The command string to run which may include variables by prefixing with a dollar sign ($).
Tag, TagArgs
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.