AWS::QuickSight::Template VisualCustomAction
A custom action defined on a visual.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "ActionOperations" :
[ VisualCustomActionOperation, ... ]
, "CustomActionId" :String
, "Name" :String
, "Status" :String
, "Trigger" :String
}
YAML
ActionOperations:
- VisualCustomActionOperation
CustomActionId:String
Name:String
Status:String
Trigger:String
Properties
ActionOperations
-
A list of
VisualCustomActionOperations
.This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
Required: Yes
Type: Array of VisualCustomActionOperation
Minimum:
1
Maximum:
2
Update requires: No interruption
CustomActionId
-
The ID of the
VisualCustomAction
.Required: Yes
Type: String
Pattern:
^[\w\-]+$
Minimum:
1
Maximum:
512
Update requires: No interruption
Name
-
The name of the
VisualCustomAction
.Required: Yes
Type: String
Minimum:
1
Maximum:
256
Update requires: No interruption
Status
-
The status of the
VisualCustomAction
.Required: No
Type: String
Allowed values:
ENABLED | DISABLED
Update requires: No interruption
Trigger
-
The trigger of the
VisualCustomAction
.Valid values are defined as follows:
-
DATA_POINT_CLICK
: Initiates a custom action by a left pointer click on a data point. -
DATA_POINT_MENU
: Initiates a custom action by right pointer click from the menu.
Required: Yes
Type: String
Allowed values:
DATA_POINT_CLICK | DATA_POINT_MENU
Update requires: No interruption
-