This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::QuickSight::Analysis VisualCustomAction
<a name="aws-properties-quicksight-analysis-visualcustomaction"></a>

A custom action defined on a visual.

## Syntax
<a name="aws-properties-quicksight-analysis-visualcustomaction-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-quicksight-analysis-visualcustomaction-syntax.json"></a>

```
{
  "[ActionOperations](#cfn-quicksight-analysis-visualcustomaction-actionoperations)" : [ VisualCustomActionOperation, ... ],
  "[CustomActionId](#cfn-quicksight-analysis-visualcustomaction-customactionid)" : String,
  "[Name](#cfn-quicksight-analysis-visualcustomaction-name)" : String,
  "[Status](#cfn-quicksight-analysis-visualcustomaction-status)" : String,
  "[Trigger](#cfn-quicksight-analysis-visualcustomaction-trigger)" : String
}
```

### YAML
<a name="aws-properties-quicksight-analysis-visualcustomaction-syntax.yaml"></a>

```
  [ActionOperations](#cfn-quicksight-analysis-visualcustomaction-actionoperations): 
    - VisualCustomActionOperation
  [CustomActionId](#cfn-quicksight-analysis-visualcustomaction-customactionid): String
  [Name](#cfn-quicksight-analysis-visualcustomaction-name): String
  [Status](#cfn-quicksight-analysis-visualcustomaction-status): String
  [Trigger](#cfn-quicksight-analysis-visualcustomaction-trigger): String
```

## Properties
<a name="aws-properties-quicksight-analysis-visualcustomaction-properties"></a>

`ActionOperations`  <a name="cfn-quicksight-analysis-visualcustomaction-actionoperations"></a>
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](aws-properties-quicksight-analysis-visualcustomactionoperation.md)  
*Minimum*: `1`  
*Maximum*: `2`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CustomActionId`  <a name="cfn-quicksight-analysis-visualcustomaction-customactionid"></a>
The ID of the `VisualCustomAction`.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[\w\-]+$`  
*Minimum*: `1`  
*Maximum*: `512`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-quicksight-analysis-visualcustomaction-name"></a>
The name of the `VisualCustomAction`.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Status`  <a name="cfn-quicksight-analysis-visualcustomaction-status"></a>
The status of the `VisualCustomAction`.  
*Required*: No  
*Type*: String  
*Allowed values*: `ENABLED | DISABLED`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Trigger`  <a name="cfn-quicksight-analysis-visualcustomaction-trigger"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)