AWS::QuickSight::Dashboard FilterSliderControl

A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.

Syntax

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

JSON

{
  "DisplayOptions" : SliderControlDisplayOptions,
  "FilterControlId" : String,
  "MaximumValue" : Number,
  "MinimumValue" : Number,
  "SourceFilterId" : String,
  "StepSize" : Number,
  "Title" : String,
  "Type" : String
}

YAML

  DisplayOptions: 
    SliderControlDisplayOptions
  FilterControlId: String
  MaximumValue: Number
  MinimumValue: Number
  SourceFilterId: String
  StepSize: Number
  Title: String
  Type: String

Properties

DisplayOptions

The display options of a control.

Required: No

Type: SliderControlDisplayOptions

Update requires: No interruption

FilterControlId

The ID of the FilterSliderControl.

Required: Yes

Type: String

Pattern: ^[\w\-]+$

Minimum: 1

Maximum: 512

Update requires: No interruption

MaximumValue

The larger value that is displayed at the right of the slider.

Required: Yes

Type: Number

Update requires: No interruption

MinimumValue

The smaller value that is displayed at the left of the slider.

Required: Yes

Type: Number

Update requires: No interruption

SourceFilterId

The source filter ID of the FilterSliderControl.

Required: Yes

Type: String

Pattern: ^[\w\-]+$

Minimum: 1

Maximum: 512

Update requires: No interruption

StepSize

The number of increments that the slider bar is divided into.

Required: Yes

Type: Number

Update requires: No interruption

Title

The title of the FilterSliderControl.

Required: Yes

Type: String

Minimum: 1

Maximum: 2048

Update requires: No interruption

Type

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

• SINGLE_POINT: Filter against(equals) a single data point.

• RANGE: Filter data that is in a specified range.

Required: No

Type: String

Allowed values: SINGLE_POINT | RANGE

Update requires: No interruption