AWS::QuickSight::Analysis FilterListControl

A control to display a list of buttons or boxes. This is used to select either a single value or multiple values.

Syntax

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

JSON

{
  "CascadingControlConfiguration" : CascadingControlConfiguration,
  "DisplayOptions" : ListControlDisplayOptions,
  "FilterControlId" : String,
  "SelectableValues" : FilterSelectableValues,
  "SourceFilterId" : String,
  "Title" : String,
  "Type" : String
}

YAML

  CascadingControlConfiguration: 
    CascadingControlConfiguration
  DisplayOptions: 
    ListControlDisplayOptions
  FilterControlId: String
  SelectableValues: 
    FilterSelectableValues
  SourceFilterId: String
  Title: String
  Type: String

Properties

CascadingControlConfiguration

The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.

Required: No

Type: CascadingControlConfiguration

Update requires: No interruption

DisplayOptions

The display options of a control.

Required: No

Type: ListControlDisplayOptions

Update requires: No interruption

FilterControlId

The ID of the FilterListControl.

Required: Yes

Type: String

Pattern: ^[\w\-]+$

Minimum: 1

Maximum: 512

Update requires: No interruption

SelectableValues

A list of selectable values that are used in a control.

Required: No

Type: FilterSelectableValues

Update requires: No interruption

SourceFilterId

The source filter ID of the FilterListControl.

Required: Yes

Type: String

Pattern: ^[\w\-]+$

Minimum: 1

Maximum: 512

Update requires: No interruption

Title

The title of the FilterListControl.

Required: Yes

Type: String

Minimum: 1

Maximum: 2048

Update requires: No interruption

Type

The type of the FilterListControl. Choose one of the following options:

• MULTI_SELECT: The user can select multiple entries from the list.

• SINGLE_SELECT: The user can select a single entry from the list.

Required: No

Type: String

Allowed values: MULTI_SELECT | SINGLE_SELECT

Update requires: No interruption