2.234.1

interface DateDimensionFieldProperty

LanguageType name
.NETAmazon.CDK.Mixins.Preview.AWS.QuickSight.Mixins.CfnDashboardPropsMixin.DateDimensionFieldProperty
Gogithub.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsquicksight/mixins#CfnDashboardPropsMixin_DateDimensionFieldProperty
Javasoftware.amazon.awscdk.mixins.preview.services.quicksight.mixins.CfnDashboardPropsMixin.DateDimensionFieldProperty
Pythonaws_cdk.mixins_preview.aws_quicksight.mixins.CfnDashboardPropsMixin.DateDimensionFieldProperty
TypeScript @aws-cdk/mixins-preview » aws_quicksight » mixins » CfnDashboardPropsMixin » DateDimensionFieldProperty

The dimension type field with date type columns.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datedimensionfield.html

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 dateDimensionFieldProperty: quicksight_mixins.CfnDashboardPropsMixin.DateDimensionFieldProperty = {
  column: {
    columnName: 'columnName',
    dataSetIdentifier: 'dataSetIdentifier',
  },
  dateGranularity: 'dateGranularity',
  fieldId: 'fieldId',
  formatConfiguration: {
    dateTimeFormat: 'dateTimeFormat',
    nullValueFormatConfiguration: {
      nullString: 'nullString',
    },
    numericFormatConfiguration: {
      currencyDisplayFormatConfiguration: {
        decimalPlacesConfiguration: {
          decimalPlaces: 123,
        },
        negativeValueConfiguration: {
          displayMode: 'displayMode',
        },
        nullValueFormatConfiguration: {
          nullString: 'nullString',
        },
        numberScale: 'numberScale',
        prefix: 'prefix',
        separatorConfiguration: {
          decimalSeparator: 'decimalSeparator',
          thousandsSeparator: {
            groupingStyle: 'groupingStyle',
            symbol: 'symbol',
            visibility: 'visibility',
          },
        },
        suffix: 'suffix',
        symbol: 'symbol',
      },
      numberDisplayFormatConfiguration: {
        decimalPlacesConfiguration: {
          decimalPlaces: 123,
        },
        negativeValueConfiguration: {
          displayMode: 'displayMode',
        },
        nullValueFormatConfiguration: {
          nullString: 'nullString',
        },
        numberScale: 'numberScale',
        prefix: 'prefix',
        separatorConfiguration: {
          decimalSeparator: 'decimalSeparator',
          thousandsSeparator: {
            groupingStyle: 'groupingStyle',
            symbol: 'symbol',
            visibility: 'visibility',
          },
        },
        suffix: 'suffix',
      },
      percentageDisplayFormatConfiguration: {
        decimalPlacesConfiguration: {
          decimalPlaces: 123,
        },
        negativeValueConfiguration: {
          displayMode: 'displayMode',
        },
        nullValueFormatConfiguration: {
          nullString: 'nullString',
        },
        prefix: 'prefix',
        separatorConfiguration: {
          decimalSeparator: 'decimalSeparator',
          thousandsSeparator: {
            groupingStyle: 'groupingStyle',
            symbol: 'symbol',
            visibility: 'visibility',
          },
        },
        suffix: 'suffix',
      },
    },
  },
  hierarchyId: 'hierarchyId',
};

Properties

NameTypeDescription
column?IResolvable | ColumnIdentifierPropertyThe column that is used in the DateDimensionField .
dateGranularity?stringThe date granularity of the DateDimensionField . Choose one of the following options:.
fieldId?stringThe custom field ID.
formatConfiguration?IResolvable | DateTimeFormatConfigurationPropertyThe format configuration of the field.
hierarchyId?stringThe custom hierarchy ID.

column?

Type: IResolvable | ColumnIdentifierProperty (optional)

The column that is used in the DateDimensionField .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datedimensionfield.html#cfn-quicksight-dashboard-datedimensionfield-column

dateGranularity?

Type: string (optional)

The date granularity of the DateDimensionField . Choose one of the following options:.

  • YEAR
  • QUARTER
  • MONTH
  • WEEK
  • DAY
  • HOUR
  • MINUTE
  • SECOND
  • MILLISECOND

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datedimensionfield.html#cfn-quicksight-dashboard-datedimensionfield-dategranularity

fieldId?

Type: string (optional)

The custom field ID.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datedimensionfield.html#cfn-quicksight-dashboard-datedimensionfield-fieldid

formatConfiguration?

Type: IResolvable | DateTimeFormatConfigurationProperty (optional)

The format configuration of the field.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datedimensionfield.html#cfn-quicksight-dashboard-datedimensionfield-formatconfiguration

hierarchyId?

Type: string (optional)

The custom hierarchy ID.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datedimensionfield.html#cfn-quicksight-dashboard-datedimensionfield-hierarchyid

← PreviousNext →