AWS::QuickSight::Template ParameterListControl

Filter View

All

A control to display a list with buttons or boxes that are 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,
  "ParameterControlId" : String,
  "SelectableValues" : ParameterSelectableValues,
  "SourceParameterName" : String,
  "Title" : String,
  "Type" : String
}

YAML

  CascadingControlConfiguration: 
    CascadingControlConfiguration
  DisplayOptions: 
    ListControlDisplayOptions
  ParameterControlId: String
  SelectableValues: 
    ParameterSelectableValues
  SourceParameterName: 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

ParameterControlId

The ID of the ParameterListControl.

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: ParameterSelectableValues

Update requires: No interruption

SourceParameterName

The source parameter name of the ParameterListControl.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9]+$

Minimum: 1

Maximum: 2048

Update requires: No interruption

Title

The title of the ParameterListControl.

Required: Yes

Type: String

Minimum: 1

Maximum: 2048

Update requires: No interruption

Type

The type of ParameterListControl.

Required: No

Type: String

Allowed values: MULTI_SELECT | SINGLE_SELECT

Update requires: No interruption