AWS CDK Reference

Appearance

v2.274.0

ParameterDropDownControlProperty Struct ​

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

Source
Generated code
Type last changed
v2.161.0 · 4 Oct 2024

Example ​

ts
// 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 parameterDropDownControlProperty: quicksight.CfnAnalysis.ParameterDropDownControlProperty = {
  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',
};

Properties ​

cascadingControlConfigurationIResolvable | CfnAnalysis.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.
commitModestringcommit_modestrcommitModeStringCommitModestringCommitMode*string#
The visibility configuration of the Apply button on a `ParameterDropDownControl` .
displayOptionsIResolvable | CfnAnalysis.DropDownControlDisplayOptionsPropertydisplay_optionstyping.Union[IResolvable, DropDownControlDisplayOptionsProperty]displayOptionsIResolvableDisplayOptionsIResolvableDisplayOptionsinterface{}#
The display options of a control.
parameterControlIdstringparameter_control_idstrparameterControlIdStringParameterControlIdstringParameterControlId*stringrequired#
The ID of the `ParameterDropDownControl` .
selectableValuesIResolvable | CfnAnalysis.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 `ParameterDropDownControl` .
titlestringtitlestrtitleStringTitlestringTitle*stringrequired#
The title of the `ParameterDropDownControl` .
typestringtypestrtypeStringTypestringType*string#
The type parameter name of the `ParameterDropDownControl` .