interface ParameterDeclarationProperty

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

The declaration definition of a parameter.

For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide .

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

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 parameterDeclarationProperty: quicksight.CfnAnalysis.ParameterDeclarationProperty = {
  dateTimeParameterDeclaration: {
    name: 'name',

    // 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',
        },
      },
      rollingDate: {
        expression: 'expression',

        // the properties below are optional
        dataSetIdentifier: 'dataSetIdentifier',
      },
      staticValues: ['staticValues'],
    },
    mappedDataSetParameters: [{
      dataSetIdentifier: 'dataSetIdentifier',
      dataSetParameterName: 'dataSetParameterName',
    }],
    timeGranularity: 'timeGranularity',
    valueWhenUnset: {
      customValue: 'customValue',
      valueWhenUnsetOption: 'valueWhenUnsetOption',
    },
  },
  decimalParameterDeclaration: {
    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',
    },
  },
  integerParameterDeclaration: {
    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',
    },
  },
  stringParameterDeclaration: {
    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
dateTimeParameterDeclaration?	`IResolvable` `\|` `DateTimeParameterDeclarationProperty`	A parameter declaration for the `DateTime` data type.
decimalParameterDeclaration?	`IResolvable` `\|` `DecimalParameterDeclarationProperty`	A parameter declaration for the `Decimal` data type.
integerParameterDeclaration?	`IResolvable` `\|` `IntegerParameterDeclarationProperty`	A parameter declaration for the `Integer` data type.
stringParameterDeclaration?	`IResolvable` `\|` `StringParameterDeclarationProperty`	A parameter declaration for the `String` data type.

dateTimeParameterDeclaration?

Type: IResolvable | DateTimeParameterDeclarationProperty (optional)

A parameter declaration for the DateTime data type.

decimalParameterDeclaration?

Type: IResolvable | DecimalParameterDeclarationProperty (optional)

A parameter declaration for the Decimal data type.

integerParameterDeclaration?

Type: IResolvable | IntegerParameterDeclarationProperty (optional)

A parameter declaration for the Integer data type.

stringParameterDeclaration?

Type: IResolvable | StringParameterDeclarationProperty (optional)

A parameter declaration for the String data type.