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::Template CategoryFilter
<a name="aws-properties-quicksight-template-categoryfilter"></a>

A `CategoryFilter` filters text values.

For more information, see [Adding text filters](https://docs.aws.amazon.com/quicksight/latest/user/add-a-text-filter-data-prep.html) in the *Amazon Quick Suite User Guide*.

## Syntax
<a name="aws-properties-quicksight-template-categoryfilter-syntax"></a>

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

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

```
{
  "[Column](#cfn-quicksight-template-categoryfilter-column)" : ColumnIdentifier,
  "[Configuration](#cfn-quicksight-template-categoryfilter-configuration)" : CategoryFilterConfiguration,
  "[DefaultFilterControlConfiguration](#cfn-quicksight-template-categoryfilter-defaultfiltercontrolconfiguration)" : DefaultFilterControlConfiguration,
  "[FilterId](#cfn-quicksight-template-categoryfilter-filterid)" : String
}
```

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

```
  [Column](#cfn-quicksight-template-categoryfilter-column): 
    ColumnIdentifier
  [Configuration](#cfn-quicksight-template-categoryfilter-configuration): 
    CategoryFilterConfiguration
  [DefaultFilterControlConfiguration](#cfn-quicksight-template-categoryfilter-defaultfiltercontrolconfiguration): 
    DefaultFilterControlConfiguration
  [FilterId](#cfn-quicksight-template-categoryfilter-filterid): String
```

## Properties
<a name="aws-properties-quicksight-template-categoryfilter-properties"></a>

`Column`  <a name="cfn-quicksight-template-categoryfilter-column"></a>
The column that the filter is applied to.  
*Required*: Yes  
*Type*: [ColumnIdentifier](aws-properties-quicksight-template-columnidentifier.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Configuration`  <a name="cfn-quicksight-template-categoryfilter-configuration"></a>
The configuration for a `CategoryFilter`.  
*Required*: Yes  
*Type*: [CategoryFilterConfiguration](aws-properties-quicksight-template-categoryfilterconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DefaultFilterControlConfiguration`  <a name="cfn-quicksight-template-categoryfilter-defaultfiltercontrolconfiguration"></a>
The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.  
*Required*: No  
*Type*: [DefaultFilterControlConfiguration](aws-properties-quicksight-template-defaultfiltercontrolconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`FilterId`  <a name="cfn-quicksight-template-categoryfilter-filterid"></a>
An identifier that uniquely identifies a filter within a dashboard, analysis, or template.  
*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)