AWS::QuickSight::Template CustomFilterConfiguration - AWS CloudFormation
SyntaxProperties

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::QuickSight::Template CustomFilterConfiguration

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

Syntax

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

JSON

{
  "CategoryValue" : String,
  "MatchOperator" : String,
  "NullOption" : String,
  "ParameterName" : String,
  "SelectAllOptions" : String
}

YAML

  CategoryValue: String
  MatchOperator: String
  NullOption: String
  ParameterName: String
  SelectAllOptions: String

Properties

CategoryValue

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

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

ParameterName

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

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