aws-cdk-lib.aws_quicksight.CfnDashboard.DateTimeParameterDeclarationProperty

interface DateTimeParameterDeclarationProperty

LanguageType name
.NETAmazon.CDK.AWS.QuickSight.CfnDashboard.DateTimeParameterDeclarationProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnDashboard_DateTimeParameterDeclarationProperty
Javasoftware.amazon.awscdk.services.quicksight.CfnDashboard.DateTimeParameterDeclarationProperty
Pythonaws_cdk.aws_quicksight.CfnDashboard.DateTimeParameterDeclarationProperty
TypeScript aws-cdk-lib » aws_quicksight » CfnDashboard » DateTimeParameterDeclarationProperty

A parameter declaration for the DateTime 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 dateTimeParameterDeclarationProperty: quicksight.CfnDashboard.DateTimeParameterDeclarationProperty = {
  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',
  },
};

Properties

NameTypeDescription
namestringThe name of the parameter that is being declared.
defaultValues?IResolvable | DateTimeDefaultValuesPropertyThe default values of a parameter.
mappedDataSetParameters?IResolvable | IResolvable | MappedDataSetParameterProperty[]CfnDashboard.DateTimeParameterDeclarationProperty.MappedDataSetParameters.
timeGranularity?stringThe level of time precision that is used to aggregate DateTime values.
valueWhenUnset?IResolvable | DateTimeValueWhenUnsetConfigurationPropertyThe configuration that defines the default value of a DateTime parameter when a value has not been set.

name

Type: string

The name of the parameter that is being declared.


defaultValues?

Type: IResolvable | DateTimeDefaultValuesProperty (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.DateTimeParameterDeclarationProperty.MappedDataSetParameters.


timeGranularity?

Type: string (optional)

The level of time precision that is used to aggregate DateTime values.


valueWhenUnset?

Type: IResolvable | DateTimeValueWhenUnsetConfigurationProperty (optional)

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