interface StringParameterDeclarationProperty

Language	Type name
.NET	Amazon.CDK.AWS.QuickSight.CfnDashboard.StringParameterDeclarationProperty
Java	software.amazon.awscdk.services.quicksight.CfnDashboard.StringParameterDeclarationProperty
Python	aws_cdk.aws_quicksight.CfnDashboard.StringParameterDeclarationProperty
TypeScript	@aws-cdk/aws-quicksight » CfnDashboard » StringParameterDeclarationProperty

A parameter declaration for the String data type.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as quicksight from '@aws-cdk/aws-quicksight';
const stringParameterDeclarationProperty: quicksight.CfnDashboard.StringParameterDeclarationProperty = {
  name: 'name',
  parameterValueType: 'parameterValueType',

  // the properties below are optional
  defaultValues: {
    dynamicValue: {
      defaultValueColumn: {
        columnName: 'columnName',
        dataSetIdentifier: 'dataSetIdentifier',
      },

      // the properties below are optional
      groupNameColumn: {
        columnName: 'columnName',
        dataSetIdentifier: 'dataSetIdentifier',
      },
      userNameColumn: {
        columnName: 'columnName',
        dataSetIdentifier: 'dataSetIdentifier',
      },
    },
    staticValues: ['staticValues'],
  },
  mappedDataSetParameters: [{
    dataSetIdentifier: 'dataSetIdentifier',
    dataSetParameterName: 'dataSetParameterName',
  }],
  valueWhenUnset: {
    customValue: 'customValue',
    valueWhenUnsetOption: 'valueWhenUnsetOption',
  },
};

Properties

Name	Type	Description
name	string	The name of the parameter that is being declared.
parameterValueType	string	The value type determines whether the parameter is a single-value or multi-value parameter.
defaultValues?	IResolvable | StringDefaultValuesProperty	The default values of a parameter.
mappedDataSetParameters?	IResolvable | IResolvable | MappedDataSetParameterProperty[]	CfnDashboard.StringParameterDeclarationProperty.MappedDataSetParameters.
valueWhenUnset?	IResolvable | StringValueWhenUnsetConfigurationProperty	The configuration that defines the default value of a String parameter when a value has not been set.

---

name

Type: string

The name of the parameter that is being declared.

---

parameterValueType

Type: string

The value type determines whether the parameter is a single-value or multi-value parameter.

---

defaultValues?

Type: IResolvable | StringDefaultValuesProperty (optional)

The default values of a parameter.

If the parameter is a single-value parameter, a maximum of one default value can be provided.

---

mappedDataSetParameters?

Type: IResolvable | IResolvable | MappedDataSetParameterProperty[] (optional)

CfnDashboard.StringParameterDeclarationProperty.MappedDataSetParameters.

---

valueWhenUnset?

Type: IResolvable | StringValueWhenUnsetConfigurationProperty (optional)

The configuration that defines the default value of a String parameter when a value has not been set.