AWS::QuickSight::Dashboard CustomFilterListConfiguration - AWS CloudFormation
SyntaxProperties
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

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.

AWS::QuickSight::Dashboard CustomFilterListConfiguration

A list of custom filter values.

Syntax

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

JSON

{
  "CategoryValues" : [ String, ... ],
  "MatchOperator" : String,
  "NullOption" : String,
  "SelectAllOptions" : String
}

YAML

  CategoryValues: 
    - String
  MatchOperator: String
  NullOption: String
  SelectAllOptions: String

Properties

CategoryValues

The list of category values for the filter.

Required: No

Type: Array of String

Minimum: 0 | 0

Maximum: 512 | 100000

Update requires: No interruption

MatchOperator

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

NullOption

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

SelectAllOptions

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