aws-cdk-lib.aws_quicksight.CfnAnalysis.ParameterDeclarationProperty

ParameterDeclarationProperty Struct

The declaration definition of a parameter.

For more information, see Parameters in Amazon Quick Sight in the Amazon Quick Suite User Guide .

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

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

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',

          // 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',
        },
      },
      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',

          // 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',
    },
  },
  integerParameterDeclaration: {
    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',
    },
  },
  stringParameterDeclaration: {
    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: ['staticValues'],
    },
    mappedDataSetParameters: [{
      dataSetIdentifier: 'dataSetIdentifier',
      dataSetParameterName: 'dataSetParameterName',
    }],
    valueWhenUnset: {
      customValue: 'customValue',
      valueWhenUnsetOption: 'valueWhenUnsetOption',
    },
  },
};

Properties

dateTimeParameterDeclarationIResolvable | CfnAnalysis.DateTimeParameterDeclarationPropertydate_time_parameter_declarationtyping.Union[IResolvable, DateTimeParameterDeclarationProperty]dateTimeParameterDeclarationIResolvableDateTimeParameterDeclarationIResolvableDateTimeParameterDeclarationinterface{}#

A parameter declaration for the `DateTime` data type.

decimalParameterDeclarationIResolvable | CfnAnalysis.DecimalParameterDeclarationPropertydecimal_parameter_declarationtyping.Union[IResolvable, DecimalParameterDeclarationProperty]decimalParameterDeclarationIResolvableDecimalParameterDeclarationIResolvableDecimalParameterDeclarationinterface{}#

A parameter declaration for the `Decimal` data type.

integerParameterDeclarationIResolvable | CfnAnalysis.IntegerParameterDeclarationPropertyinteger_parameter_declarationtyping.Union[IResolvable, IntegerParameterDeclarationProperty]integerParameterDeclarationIResolvableIntegerParameterDeclarationIResolvableIntegerParameterDeclarationinterface{}#

A parameter declaration for the `Integer` data type.

stringParameterDeclarationIResolvable | CfnAnalysis.StringParameterDeclarationPropertystring_parameter_declarationtyping.Union[IResolvable, StringParameterDeclarationProperty]stringParameterDeclarationIResolvableStringParameterDeclarationIResolvableStringParameterDeclarationinterface{}#

A parameter declaration for the `String` data type.