aws-cdk-lib.aws_quicksight.CfnDashboard.RelativeDatesFilterProperty

interface RelativeDatesFilterProperty

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

A RelativeDatesFilter filters relative dates values.

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 relativeDatesFilterProperty: quicksight.CfnDashboard.RelativeDatesFilterProperty = {
  anchorDateConfiguration: {
    anchorOption: 'anchorOption',
    parameterName: 'parameterName',
  },
  column: {
    columnName: 'columnName',
    dataSetIdentifier: 'dataSetIdentifier',
  },
  filterId: 'filterId',
  nullOption: 'nullOption',
  relativeDateType: 'relativeDateType',
  timeGranularity: 'timeGranularity',

  // the properties below are optional
  excludePeriodConfiguration: {
    amount: 123,
    granularity: 'granularity',

    // the properties below are optional
    status: 'status',
  },
  minimumGranularity: 'minimumGranularity',
  parameterName: 'parameterName',
  relativeDateValue: 123,
};

Properties

NameTypeDescription
anchorDateConfigurationIResolvable | AnchorDateConfigurationPropertyThe date configuration of the filter.
columnIResolvable | ColumnIdentifierPropertyThe column that the filter is applied to.
filterIdstringAn identifier that uniquely identifies a filter within a dashboard, analysis, or template.
nullOptionstringThis option determines how null values should be treated when filtering data.
relativeDateTypestringThe range date type of the filter. Choose one of the options below:.
timeGranularitystringThe level of time precision that is used to aggregate DateTime values.
excludePeriodConfiguration?IResolvable | ExcludePeriodConfigurationPropertyThe configuration for the exclude period of the filter.
minimumGranularity?stringThe minimum granularity (period granularity) of the relative dates filter.
parameterName?stringThe parameter whose value should be used for the filter value.
relativeDateValue?numberThe date value of the filter.

anchorDateConfiguration

Type: IResolvable | AnchorDateConfigurationProperty

The date configuration of the filter.


column

Type: IResolvable | ColumnIdentifierProperty

The column that the filter is applied to.


filterId

Type: string

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.


nullOption

Type: string

This option determines how null values should be treated when filtering data.

  • ALL_VALUES : Include null values in filtered results.
  • NULLS_ONLY : Only include null values in filtered results.
  • NON_NULLS_ONLY : Exclude null values from filtered results.

relativeDateType

Type: string

The range date type of the filter. Choose one of the options below:.

  • PREVIOUS
  • THIS
  • LAST
  • NOW
  • NEXT

timeGranularity

Type: string

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


excludePeriodConfiguration?

Type: IResolvable | ExcludePeriodConfigurationProperty (optional)

The configuration for the exclude period of the filter.


minimumGranularity?

Type: string (optional)

The minimum granularity (period granularity) of the relative dates filter.


parameterName?

Type: string (optional)

The parameter whose value should be used for the filter value.


relativeDateValue?

Type: number (optional)

The date value of the filter.