Package software.amazon.awscdk.services.quicksight

Interface CfnDashboard.ParameterControlProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDashboard.ParameterControlProperty.Jsii$Proxy

Enclosing class:

CfnDashboard

@Stability(Stable)
public static interface CfnDashboard.ParameterControlProperty
extends software.amazon.jsii.JsiiSerializable

The control of a parameter that users can interact with in a dashboard or an analysis.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.quicksight.*;
 ParameterControlProperty parameterControlProperty = ParameterControlProperty.builder()
         .dateTimePicker(ParameterDateTimePickerControlProperty.builder()
                 .parameterControlId("parameterControlId")
                 .sourceParameterName("sourceParameterName")
                 .title("title")
                 // the properties below are optional
                 .displayOptions(DateTimePickerControlDisplayOptionsProperty.builder()
                         .dateIconVisibility("dateIconVisibility")
                         .dateTimeFormat("dateTimeFormat")
                         .helperTextVisibility("helperTextVisibility")
                         .infoIconLabelOptions(SheetControlInfoIconLabelOptionsProperty.builder()
                                 .infoIconText("infoIconText")
                                 .visibility("visibility")
                                 .build())
                         .titleOptions(LabelOptionsProperty.builder()
                                 .customLabel("customLabel")
                                 .fontConfiguration(FontConfigurationProperty.builder()
                                         .fontColor("fontColor")
                                         .fontDecoration("fontDecoration")
                                         .fontFamily("fontFamily")
                                         .fontSize(FontSizeProperty.builder()
                                                 .absolute("absolute")
                                                 .relative("relative")
                                                 .build())
                                         .fontStyle("fontStyle")
                                         .fontWeight(FontWeightProperty.builder()
                                                 .name("name")
                                                 .build())
                                         .build())
                                 .visibility("visibility")
                                 .build())
                         .build())
                 .build())
         .dropdown(ParameterDropDownControlProperty.builder()
                 .parameterControlId("parameterControlId")
                 .sourceParameterName("sourceParameterName")
                 .title("title")
                 // the properties below are optional
                 .cascadingControlConfiguration(CascadingControlConfigurationProperty.builder()
                         .sourceControls(List.of(CascadingControlSourceProperty.builder()
                                 .columnToMatch(ColumnIdentifierProperty.builder()
                                         .columnName("columnName")
                                         .dataSetIdentifier("dataSetIdentifier")
                                         .build())
                                 .sourceSheetControlId("sourceSheetControlId")
                                 .build()))
                         .build())
                 .commitMode("commitMode")
                 .displayOptions(DropDownControlDisplayOptionsProperty.builder()
                         .infoIconLabelOptions(SheetControlInfoIconLabelOptionsProperty.builder()
                                 .infoIconText("infoIconText")
                                 .visibility("visibility")
                                 .build())
                         .selectAllOptions(ListControlSelectAllOptionsProperty.builder()
                                 .visibility("visibility")
                                 .build())
                         .titleOptions(LabelOptionsProperty.builder()
                                 .customLabel("customLabel")
                                 .fontConfiguration(FontConfigurationProperty.builder()
                                         .fontColor("fontColor")
                                         .fontDecoration("fontDecoration")
                                         .fontFamily("fontFamily")
                                         .fontSize(FontSizeProperty.builder()
                                                 .absolute("absolute")
                                                 .relative("relative")
                                                 .build())
                                         .fontStyle("fontStyle")
                                         .fontWeight(FontWeightProperty.builder()
                                                 .name("name")
                                                 .build())
                                         .build())
                                 .visibility("visibility")
                                 .build())
                         .build())
                 .selectableValues(ParameterSelectableValuesProperty.builder()
                         .linkToDataSetColumn(ColumnIdentifierProperty.builder()
                                 .columnName("columnName")
                                 .dataSetIdentifier("dataSetIdentifier")
                                 .build())
                         .values(List.of("values"))
                         .build())
                 .type("type")
                 .build())
         .list(ParameterListControlProperty.builder()
                 .parameterControlId("parameterControlId")
                 .sourceParameterName("sourceParameterName")
                 .title("title")
                 // the properties below are optional
                 .cascadingControlConfiguration(CascadingControlConfigurationProperty.builder()
                         .sourceControls(List.of(CascadingControlSourceProperty.builder()
                                 .columnToMatch(ColumnIdentifierProperty.builder()
                                         .columnName("columnName")
                                         .dataSetIdentifier("dataSetIdentifier")
                                         .build())
                                 .sourceSheetControlId("sourceSheetControlId")
                                 .build()))
                         .build())
                 .displayOptions(ListControlDisplayOptionsProperty.builder()
                         .infoIconLabelOptions(SheetControlInfoIconLabelOptionsProperty.builder()
                                 .infoIconText("infoIconText")
                                 .visibility("visibility")
                                 .build())
                         .searchOptions(ListControlSearchOptionsProperty.builder()
                                 .visibility("visibility")
                                 .build())
                         .selectAllOptions(ListControlSelectAllOptionsProperty.builder()
                                 .visibility("visibility")
                                 .build())
                         .titleOptions(LabelOptionsProperty.builder()
                                 .customLabel("customLabel")
                                 .fontConfiguration(FontConfigurationProperty.builder()
                                         .fontColor("fontColor")
                                         .fontDecoration("fontDecoration")
                                         .fontFamily("fontFamily")
                                         .fontSize(FontSizeProperty.builder()
                                                 .absolute("absolute")
                                                 .relative("relative")
                                                 .build())
                                         .fontStyle("fontStyle")
                                         .fontWeight(FontWeightProperty.builder()
                                                 .name("name")
                                                 .build())
                                         .build())
                                 .visibility("visibility")
                                 .build())
                         .build())
                 .selectableValues(ParameterSelectableValuesProperty.builder()
                         .linkToDataSetColumn(ColumnIdentifierProperty.builder()
                                 .columnName("columnName")
                                 .dataSetIdentifier("dataSetIdentifier")
                                 .build())
                         .values(List.of("values"))
                         .build())
                 .type("type")
                 .build())
         .slider(ParameterSliderControlProperty.builder()
                 .maximumValue(123)
                 .minimumValue(123)
                 .parameterControlId("parameterControlId")
                 .sourceParameterName("sourceParameterName")
                 .stepSize(123)
                 .title("title")
                 // the properties below are optional
                 .displayOptions(SliderControlDisplayOptionsProperty.builder()
                         .infoIconLabelOptions(SheetControlInfoIconLabelOptionsProperty.builder()
                                 .infoIconText("infoIconText")
                                 .visibility("visibility")
                                 .build())
                         .titleOptions(LabelOptionsProperty.builder()
                                 .customLabel("customLabel")
                                 .fontConfiguration(FontConfigurationProperty.builder()
                                         .fontColor("fontColor")
                                         .fontDecoration("fontDecoration")
                                         .fontFamily("fontFamily")
                                         .fontSize(FontSizeProperty.builder()
                                                 .absolute("absolute")
                                                 .relative("relative")
                                                 .build())
                                         .fontStyle("fontStyle")
                                         .fontWeight(FontWeightProperty.builder()
                                                 .name("name")
                                                 .build())
                                         .build())
                                 .visibility("visibility")
                                 .build())
                         .build())
                 .build())
         .textArea(ParameterTextAreaControlProperty.builder()
                 .parameterControlId("parameterControlId")
                 .sourceParameterName("sourceParameterName")
                 .title("title")
                 // the properties below are optional
                 .delimiter("delimiter")
                 .displayOptions(TextAreaControlDisplayOptionsProperty.builder()
                         .infoIconLabelOptions(SheetControlInfoIconLabelOptionsProperty.builder()
                                 .infoIconText("infoIconText")
                                 .visibility("visibility")
                                 .build())
                         .placeholderOptions(TextControlPlaceholderOptionsProperty.builder()
                                 .visibility("visibility")
                                 .build())
                         .titleOptions(LabelOptionsProperty.builder()
                                 .customLabel("customLabel")
                                 .fontConfiguration(FontConfigurationProperty.builder()
                                         .fontColor("fontColor")
                                         .fontDecoration("fontDecoration")
                                         .fontFamily("fontFamily")
                                         .fontSize(FontSizeProperty.builder()
                                                 .absolute("absolute")
                                                 .relative("relative")
                                                 .build())
                                         .fontStyle("fontStyle")
                                         .fontWeight(FontWeightProperty.builder()
                                                 .name("name")
                                                 .build())
                                         .build())
                                 .visibility("visibility")
                                 .build())
                         .build())
                 .build())
         .textField(ParameterTextFieldControlProperty.builder()
                 .parameterControlId("parameterControlId")
                 .sourceParameterName("sourceParameterName")
                 .title("title")
                 // the properties below are optional
                 .displayOptions(TextFieldControlDisplayOptionsProperty.builder()
                         .infoIconLabelOptions(SheetControlInfoIconLabelOptionsProperty.builder()
                                 .infoIconText("infoIconText")
                                 .visibility("visibility")
                                 .build())
                         .placeholderOptions(TextControlPlaceholderOptionsProperty.builder()
                                 .visibility("visibility")
                                 .build())
                         .titleOptions(LabelOptionsProperty.builder()
                                 .customLabel("customLabel")
                                 .fontConfiguration(FontConfigurationProperty.builder()
                                         .fontColor("fontColor")
                                         .fontDecoration("fontDecoration")
                                         .fontFamily("fontFamily")
                                         .fontSize(FontSizeProperty.builder()
                                                 .absolute("absolute")
                                                 .relative("relative")
                                                 .build())
                                         .fontStyle("fontStyle")
                                         .fontWeight(FontWeightProperty.builder()
                                                 .name("name")
                                                 .build())
                                         .build())
                                 .visibility("visibility")
                                 .build())
                         .build())
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parametercontrol.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDashboard.ParameterControlProperty.Builder	A builder for CfnDashboard.ParameterControlProperty
static final class	CfnDashboard.ParameterControlProperty.Jsii$Proxy	An implementation for CfnDashboard.ParameterControlProperty

Method Summary

Modifier and Type	Method	Description
static CfnDashboard.ParameterControlProperty.Builder	builder()
default Object	getDateTimePicker()	A control from a date parameter that specifies date and time.
default Object	getDropdown()	A control to display a dropdown list with buttons that are used to select a single value.
default Object	getList()	A control to display a list with buttons or boxes that are used to select either a single value or multiple values.
default Object	getSlider()	A control to display a horizontal toggle bar.
default Object	getTextArea()	A control to display a text box that is used to enter multiple entries.
default Object	getTextField()	A control to display a text box that is used to enter a single entry.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDateTimePicker

@Stability(Stable)
@Nullable
default Object getDateTimePicker()

A control from a date parameter that specifies date and time.

Returns union: either IResolvable or CfnDashboard.ParameterDateTimePickerControlProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parametercontrol.html#cfn-quicksight-dashboard-parametercontrol-datetimepicker

getDropdown

@Stability(Stable)
@Nullable
default Object getDropdown()

A control to display a dropdown list with buttons that are used to select a single value.

Returns union: either IResolvable or CfnDashboard.ParameterDropDownControlProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parametercontrol.html#cfn-quicksight-dashboard-parametercontrol-dropdown

getList

@Stability(Stable)
@Nullable
default Object getList()

A control to display a list with buttons or boxes that are used to select either a single value or multiple values.

Returns union: either IResolvable or CfnDashboard.ParameterListControlProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parametercontrol.html#cfn-quicksight-dashboard-parametercontrol-list

getSlider

@Stability(Stable)
@Nullable
default Object getSlider()

A control to display a horizontal toggle bar.

This is used to change a value by sliding the toggle.

Returns union: either IResolvable or CfnDashboard.ParameterSliderControlProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parametercontrol.html#cfn-quicksight-dashboard-parametercontrol-slider

getTextArea

@Stability(Stable)
@Nullable
default Object getTextArea()

A control to display a text box that is used to enter multiple entries.

Returns union: either IResolvable or CfnDashboard.ParameterTextAreaControlProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parametercontrol.html#cfn-quicksight-dashboard-parametercontrol-textarea

getTextField

@Stability(Stable)
@Nullable
default Object getTextField()

A control to display a text box that is used to enter a single entry.

Returns union: either IResolvable or CfnDashboard.ParameterTextFieldControlProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parametercontrol.html#cfn-quicksight-dashboard-parametercontrol-textfield

builder

@Stability(Stable)
static CfnDashboard.ParameterControlProperty.Builder builder()

Returns:

a CfnDashboard.ParameterControlProperty.Builder of CfnDashboard.ParameterControlProperty