interface IntegerParameterDeclarationProperty

Language	Type name
.NET	`Amazon.CDK.AWS.QuickSight.CfnDashboard.IntegerParameterDeclarationProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnDashboard_IntegerParameterDeclarationProperty`
Java	`software.amazon.awscdk.services.quicksight.CfnDashboard.IntegerParameterDeclarationProperty`
Python	`aws_cdk.aws_quicksight.CfnDashboard.IntegerParameterDeclarationProperty`
TypeScript	`aws-cdk-lib` » `aws_quicksight` » `CfnDashboard` » `IntegerParameterDeclarationProperty`

A parameter declaration for the Integer data type.

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 integerParameterDeclarationProperty: quicksight.CfnDashboard.IntegerParameterDeclarationProperty = {
  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: [123],
  },
  mappedDataSetParameters: [{
    dataSetIdentifier: 'dataSetIdentifier',
    dataSetParameterName: 'dataSetParameterName',
  }],
  valueWhenUnset: {
    customValue: 123,
    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` `\|` `IntegerDefaultValuesProperty`	The default values of a parameter.
mappedDataSetParameters?	`IResolvable` `\| (IResolvable` `\|` `MappedDataSetParameterProperty)[]`
valueWhenUnset?	`IResolvable` `\|` `IntegerValueWhenUnsetConfigurationProperty`	A parameter declaration for the `Integer` data type.

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 | IntegerDefaultValuesProperty (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)

valueWhenUnset?

Type: IResolvable | IntegerValueWhenUnsetConfigurationProperty (optional)

A parameter declaration for the Integer data type.