interface DateTimeParameterDeclarationProperty

Language	Type name
.NET	`Amazon.CDK.Mixins.Preview.AWS.QuickSight.Mixins.CfnDashboardPropsMixin.DateTimeParameterDeclarationProperty`
Go	`github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsquicksight/mixins#CfnDashboardPropsMixin_DateTimeParameterDeclarationProperty`
Java	`software.amazon.awscdk.mixins.preview.services.quicksight.mixins.CfnDashboardPropsMixin.DateTimeParameterDeclarationProperty`
Python	`aws_cdk.mixins_preview.aws_quicksight.mixins.CfnDashboardPropsMixin.DateTimeParameterDeclarationProperty`
TypeScript	`@aws-cdk/mixins-preview` » `aws_quicksight` » `mixins` » `CfnDashboardPropsMixin` » `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 { mixins as quicksight_mixins } from '@aws-cdk/mixins-preview/aws-quicksight';
const dateTimeParameterDeclarationProperty: quicksight_mixins.CfnDashboardPropsMixin.DateTimeParameterDeclarationProperty = {
  defaultValues: {
    dynamicValue: {
      defaultValueColumn: {
        columnName: 'columnName',
        dataSetIdentifier: 'dataSetIdentifier',
      },
      groupNameColumn: {
        columnName: 'columnName',
        dataSetIdentifier: 'dataSetIdentifier',
      },
      userNameColumn: {
        columnName: 'columnName',
        dataSetIdentifier: 'dataSetIdentifier',
      },
    },
    rollingDate: {
      dataSetIdentifier: 'dataSetIdentifier',
      expression: 'expression',
    },
    staticValues: ['staticValues'],
  },
  mappedDataSetParameters: [{
    dataSetIdentifier: 'dataSetIdentifier',
    dataSetParameterName: 'dataSetParameterName',
  }],
  name: 'name',
  timeGranularity: 'timeGranularity',
  valueWhenUnset: {
    customValue: 'customValue',
    valueWhenUnsetOption: 'valueWhenUnsetOption',
  },
};

Properties

Name	Type	Description
defaultValues?	`IResolvable` `\|` `DateTimeDefaultValuesProperty`	The default values of a parameter.
mappedDataSetParameters?	`IResolvable` `\| (IResolvable` `\|` `MappedDataSetParameterProperty)[]`
name?	`string`	The name of the parameter that is being declared.
timeGranularity?	`string`	The level of time precision that is used to aggregate `DateTime` values.
valueWhenUnset?	`IResolvable` `\|` `DateTimeValueWhenUnsetConfigurationProperty`	The configuration that defines the default value of a `DateTime` parameter when a value has not been set.

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)

name?

Type: string (optional)

The name of the parameter that is being declared.

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.

AWS CDK

2.232.1