aws-cdk-lib.aws_quicksight.CfnAnalysis.ParameterControlProperty

ParameterControlProperty Struct

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.

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_quicksight as quicksight } from 'aws-cdk-lib';
const parameterControlProperty: quicksight.CfnAnalysis.ParameterControlProperty = {
  dateTimePicker: {
    parameterControlId: 'parameterControlId',
    sourceParameterName: 'sourceParameterName',
    title: 'title',

    // the properties below are optional
    displayOptions: {
      dateIconVisibility: 'dateIconVisibility',
      dateTimeFormat: 'dateTimeFormat',
      helperTextVisibility: 'helperTextVisibility',
      infoIconLabelOptions: {
        infoIconText: 'infoIconText',
        visibility: 'visibility',
      },
      titleOptions: {
        customLabel: 'customLabel',
        fontConfiguration: {
          fontColor: 'fontColor',
          fontDecoration: 'fontDecoration',
          fontFamily: 'fontFamily',
          fontSize: {
            absolute: 'absolute',
            relative: 'relative',
          },
          fontStyle: 'fontStyle',
          fontWeight: {
            name: 'name',
          },
        },
        visibility: 'visibility',
      },
    },
  },
  dropdown: {
    parameterControlId: 'parameterControlId',
    sourceParameterName: 'sourceParameterName',
    title: 'title',

    // the properties below are optional
    cascadingControlConfiguration: {
      sourceControls: [{
        columnToMatch: {
          columnName: 'columnName',

          // the properties below are optional
          dataSetIdentifier: 'dataSetIdentifier',
          topicIdentifier: 'topicIdentifier',
        },
        sourceSheetControlId: 'sourceSheetControlId',
      }],
    },
    commitMode: 'commitMode',
    displayOptions: {
      infoIconLabelOptions: {
        infoIconText: 'infoIconText',
        visibility: 'visibility',
      },
      selectAllOptions: {
        visibility: 'visibility',
      },
      titleOptions: {
        customLabel: 'customLabel',
        fontConfiguration: {
          fontColor: 'fontColor',
          fontDecoration: 'fontDecoration',
          fontFamily: 'fontFamily',
          fontSize: {
            absolute: 'absolute',
            relative: 'relative',
          },
          fontStyle: 'fontStyle',
          fontWeight: {
            name: 'name',
          },
        },
        visibility: 'visibility',
      },
    },
    selectableValues: {
      linkToDataSetColumn: {
        columnName: 'columnName',

        // the properties below are optional
        dataSetIdentifier: 'dataSetIdentifier',
        topicIdentifier: 'topicIdentifier',
      },
      values: ['values'],
    },
    type: 'type',
  },
  list: {
    parameterControlId: 'parameterControlId',
    sourceParameterName: 'sourceParameterName',
    title: 'title',

    // the properties below are optional
    cascadingControlConfiguration: {
      sourceControls: [{
        columnToMatch: {
          columnName: 'columnName',

          // the properties below are optional
          dataSetIdentifier: 'dataSetIdentifier',
          topicIdentifier: 'topicIdentifier',
        },
        sourceSheetControlId: 'sourceSheetControlId',
      }],
    },
    displayOptions: {
      infoIconLabelOptions: {
        infoIconText: 'infoIconText',
        visibility: 'visibility',
      },
      searchOptions: {
        visibility: 'visibility',
      },
      selectAllOptions: {
        visibility: 'visibility',
      },
      titleOptions: {
        customLabel: 'customLabel',
        fontConfiguration: {
          fontColor: 'fontColor',
          fontDecoration: 'fontDecoration',
          fontFamily: 'fontFamily',
          fontSize: {
            absolute: 'absolute',
            relative: 'relative',
          },
          fontStyle: 'fontStyle',
          fontWeight: {
            name: 'name',
          },
        },
        visibility: 'visibility',
      },
    },
    selectableValues: {
      linkToDataSetColumn: {
        columnName: 'columnName',

        // the properties below are optional
        dataSetIdentifier: 'dataSetIdentifier',
        topicIdentifier: 'topicIdentifier',
      },
      values: ['values'],
    },
    type: 'type',
  },
  slider: {
    maximumValue: 123,
    minimumValue: 123,
    parameterControlId: 'parameterControlId',
    sourceParameterName: 'sourceParameterName',
    stepSize: 123,
    title: 'title',

    // the properties below are optional
    displayOptions: {
      infoIconLabelOptions: {
        infoIconText: 'infoIconText',
        visibility: 'visibility',
      },
      titleOptions: {
        customLabel: 'customLabel',
        fontConfiguration: {
          fontColor: 'fontColor',
          fontDecoration: 'fontDecoration',
          fontFamily: 'fontFamily',
          fontSize: {
            absolute: 'absolute',
            relative: 'relative',
          },
          fontStyle: 'fontStyle',
          fontWeight: {
            name: 'name',
          },
        },
        visibility: 'visibility',
      },
    },
  },
  textArea: {
    parameterControlId: 'parameterControlId',
    sourceParameterName: 'sourceParameterName',
    title: 'title',

    // the properties below are optional
    delimiter: 'delimiter',
    displayOptions: {
      infoIconLabelOptions: {
        infoIconText: 'infoIconText',
        visibility: 'visibility',
      },
      placeholderOptions: {
        visibility: 'visibility',
      },
      titleOptions: {
        customLabel: 'customLabel',
        fontConfiguration: {
          fontColor: 'fontColor',
          fontDecoration: 'fontDecoration',
          fontFamily: 'fontFamily',
          fontSize: {
            absolute: 'absolute',
            relative: 'relative',
          },
          fontStyle: 'fontStyle',
          fontWeight: {
            name: 'name',
          },
        },
        visibility: 'visibility',
      },
    },
  },
  textField: {
    parameterControlId: 'parameterControlId',
    sourceParameterName: 'sourceParameterName',
    title: 'title',

    // the properties below are optional
    displayOptions: {
      infoIconLabelOptions: {
        infoIconText: 'infoIconText',
        visibility: 'visibility',
      },
      placeholderOptions: {
        visibility: 'visibility',
      },
      titleOptions: {
        customLabel: 'customLabel',
        fontConfiguration: {
          fontColor: 'fontColor',
          fontDecoration: 'fontDecoration',
          fontFamily: 'fontFamily',
          fontSize: {
            absolute: 'absolute',
            relative: 'relative',
          },
          fontStyle: 'fontStyle',
          fontWeight: {
            name: 'name',
          },
        },
        visibility: 'visibility',
      },
    },
  },
};

Properties

dateTimePickerIResolvable | CfnAnalysis.ParameterDateTimePickerControlPropertydate_time_pickertyping.Union[IResolvable, ParameterDateTimePickerControlProperty]dateTimePickerIResolvableDateTimePickerIResolvableDateTimePickerinterface{}#

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

dropdownIResolvable | CfnAnalysis.ParameterDropDownControlPropertydropdowntyping.Union[IResolvable, ParameterDropDownControlProperty]dropdownIResolvableDropdownIResolvableDropdowninterface{}#

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

listIResolvable | CfnAnalysis.ParameterListControlPropertylisttyping.Union[IResolvable, ParameterListControlProperty]listIResolvableListIResolvableListinterface{}#

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

sliderIResolvable | CfnAnalysis.ParameterSliderControlPropertyslidertyping.Union[IResolvable, ParameterSliderControlProperty]sliderIResolvableSliderIResolvableSliderinterface{}#

A control to display a horizontal toggle bar.

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

textAreaIResolvable | CfnAnalysis.ParameterTextAreaControlPropertytext_areatyping.Union[IResolvable, ParameterTextAreaControlProperty]textAreaIResolvableTextAreaIResolvableTextAreainterface{}#

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

textFieldIResolvable | CfnAnalysis.ParameterTextFieldControlPropertytext_fieldtyping.Union[IResolvable, ParameterTextFieldControlProperty]textFieldIResolvableTextFieldIResolvableTextFieldinterface{}#

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