aws-cdk-lib.aws_quicksight.CfnDashboard.ParameterListControlProperty

ParameterListControlProperty Struct

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

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 parameterListControlProperty: quicksight.CfnDashboard.ParameterListControlProperty = {
  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',
};

Properties

cascadingControlConfigurationIResolvable | CfnDashboard.CascadingControlConfigurationPropertycascading_control_configurationtyping.Union[IResolvable, CascadingControlConfigurationProperty]cascadingControlConfigurationIResolvableCascadingControlConfigurationIResolvableCascadingControlConfigurationinterface{}#

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.

displayOptionsIResolvable | CfnDashboard.ListControlDisplayOptionsPropertydisplay_optionstyping.Union[IResolvable, ListControlDisplayOptionsProperty]displayOptionsIResolvableDisplayOptionsIResolvableDisplayOptionsinterface{}#

The display options of a control.

parameterControlIdstringparameter_control_idstrparameterControlIdStringParameterControlIdstringParameterControlId*stringrequired#

The ID of the `ParameterListControl` .

selectableValuesIResolvable | CfnDashboard.ParameterSelectableValuesPropertyselectable_valuestyping.Union[IResolvable, ParameterSelectableValuesProperty]selectableValuesIResolvableSelectableValuesIResolvableSelectableValuesinterface{}#

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

sourceParameterNamestringsource_parameter_namestrsourceParameterNameStringSourceParameterNamestringSourceParameterName*stringrequired#

The source parameter name of the `ParameterListControl` .

titlestringtitlestrtitleStringTitlestringTitle*stringrequired#

The title of the `ParameterListControl` .

typestringtypestrtypeStringTypestringType*string#

The type of `ParameterListControl` .