Skip to content
v2.274.0

DecimalParameterDeclarationProperty Struct ​

A parameter declaration for the Decimal data type.

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 decimalParameterDeclarationProperty: quicksight.CfnAnalysis.DecimalParameterDeclarationProperty = {
  name: 'name',
  parameterValueType: 'parameterValueType',

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

        // the properties below are optional
        dataSetIdentifier: 'dataSetIdentifier',
        topicIdentifier: 'topicIdentifier',
      },

      // the properties below are optional
      groupNameColumn: {
        columnName: 'columnName',

        // the properties below are optional
        dataSetIdentifier: 'dataSetIdentifier',
        topicIdentifier: 'topicIdentifier',
      },
      userNameColumn: {
        columnName: 'columnName',

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

Properties ​

defaultValuesoptionalIResolvable | CfnAnalysis.DecimalDefaultValuesPropertydefault_valuesoptionaltyping.Union[IResolvable, DecimalDefaultValuesProperty]defaultValuesoptionalIResolvableDefaultValuesoptionalIResolvableDefaultValuesoptionalinterface{}#
The default values of a parameter.

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

mappedDataSetParametersoptionalIResolvable | IResolvable | CfnAnalysis.MappedDataSetParameterProperty[]mapped_data_set_parametersoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, MappedDataSetParameterProperty]]]mappedDataSetParametersoptionalIResolvableMappedDataSetParametersoptionalIResolvableMappedDataSetParametersoptionalinterface{}#
namestringnamestrnameStringNamestringName*stringrequired#
The name of the parameter that is being declared.
parameterValueTypestringparameter_value_typestrparameterValueTypeStringParameterValueTypestringParameterValueType*stringrequired#
The value type determines whether the parameter is a single-value or multi-value parameter.
valueWhenUnsetoptionalIResolvable | CfnAnalysis.DecimalValueWhenUnsetConfigurationPropertyvalue_when_unsetoptionaltyping.Union[IResolvable, DecimalValueWhenUnsetConfigurationProperty]valueWhenUnsetoptionalIResolvableValueWhenUnsetoptionalIResolvableValueWhenUnsetoptionalinterface{}#
The configuration that defines the default value of a `Decimal` parameter when a value has not been set.