

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 PivotTableFieldOption
<a name="aws-properties-quicksight-analysis-pivottablefieldoption"></a>

The selected field options for the pivot table field options.

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

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

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

```
{
  "[CustomLabel](#cfn-quicksight-analysis-pivottablefieldoption-customlabel)" : {{String}},
  "[FieldId](#cfn-quicksight-analysis-pivottablefieldoption-fieldid)" : {{String}},
  "[Visibility](#cfn-quicksight-analysis-pivottablefieldoption-visibility)" : {{String}}
}
```

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

```
  [CustomLabel](#cfn-quicksight-analysis-pivottablefieldoption-customlabel): {{String}}
  [FieldId](#cfn-quicksight-analysis-pivottablefieldoption-fieldid): {{String}}
  [Visibility](#cfn-quicksight-analysis-pivottablefieldoption-visibility): {{String}}
```

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

`CustomLabel`  <a name="cfn-quicksight-analysis-pivottablefieldoption-customlabel"></a>
The custom label of the pivot table field.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`FieldId`  <a name="cfn-quicksight-analysis-pivottablefieldoption-fieldid"></a>
The field ID of the pivot table field.  
*Required*: Yes  
*Type*: String  
*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)

`Visibility`  <a name="cfn-quicksight-analysis-pivottablefieldoption-visibility"></a>
The visibility of the pivot table field.  
*Required*: No  
*Type*: String  
*Allowed values*: `HIDDEN | VISIBLE`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)