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

A custom filter that filters based on a single value. This filter can be partially matched.

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

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

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

```
{
  "[CategoryValue](#cfn-quicksight-analysis-customfilterconfiguration-categoryvalue)" : String,
  "[MatchOperator](#cfn-quicksight-analysis-customfilterconfiguration-matchoperator)" : String,
  "[NullOption](#cfn-quicksight-analysis-customfilterconfiguration-nulloption)" : String,
  "[ParameterName](#cfn-quicksight-analysis-customfilterconfiguration-parametername)" : String,
  "[SelectAllOptions](#cfn-quicksight-analysis-customfilterconfiguration-selectalloptions)" : String
}
```

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

```
  [CategoryValue](#cfn-quicksight-analysis-customfilterconfiguration-categoryvalue): String
  [MatchOperator](#cfn-quicksight-analysis-customfilterconfiguration-matchoperator): String
  [NullOption](#cfn-quicksight-analysis-customfilterconfiguration-nulloption): String
  [ParameterName](#cfn-quicksight-analysis-customfilterconfiguration-parametername): String
  [SelectAllOptions](#cfn-quicksight-analysis-customfilterconfiguration-selectalloptions): String
```

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

`CategoryValue`  <a name="cfn-quicksight-analysis-customfilterconfiguration-categoryvalue"></a>
The category value for the filter.  
This field is mutually exclusive to `ParameterName`.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `512`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MatchOperator`  <a name="cfn-quicksight-analysis-customfilterconfiguration-matchoperator"></a>
The match operator that is used to determine if a filter should be applied.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `EQUALS | DOES_NOT_EQUAL | CONTAINS | DOES_NOT_CONTAIN | STARTS_WITH | ENDS_WITH`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`NullOption`  <a name="cfn-quicksight-analysis-customfilterconfiguration-nulloption"></a>
This option determines how null values should be treated when filtering data.  
+ `ALL_VALUES`: Include null values in filtered results.
+ `NULLS_ONLY`: Only include null values in filtered results.
+ `NON_NULLS_ONLY`: Exclude null values from filtered results.
*Required*: Yes  
*Type*: String  
*Allowed values*: `ALL_VALUES | NULLS_ONLY | NON_NULLS_ONLY`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ParameterName`  <a name="cfn-quicksight-analysis-customfilterconfiguration-parametername"></a>
The parameter whose value should be used for the filter value.  
This field is mutually exclusive to `CategoryValue`.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9]+$`  
*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)

`SelectAllOptions`  <a name="cfn-quicksight-analysis-customfilterconfiguration-selectalloptions"></a>
Select all of the values. Null is not the assigned value of select all.  
+  `FILTER_ALL_VALUES` 
*Required*: No  
*Type*: String  
*Allowed values*: `FILTER_ALL_VALUES`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)