aws-cdk-lib.aws_quicksight.CfnTemplate.TimeRangeFilterProperty

interface TimeRangeFilterProperty

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

A TimeRangeFilter filters values that are between two specified 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 timeRangeFilterProperty: quicksight.CfnTemplate.TimeRangeFilterProperty = {
  column: {
    columnName: 'columnName',
    dataSetIdentifier: 'dataSetIdentifier',
  },
  filterId: 'filterId',
  nullOption: 'nullOption',

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

    // the properties below are optional
    status: 'status',
  },
  includeMaximum: false,
  includeMinimum: false,
  rangeMaximumValue: {
    parameter: 'parameter',
    rollingDate: {
      expression: 'expression',

      // the properties below are optional
      dataSetIdentifier: 'dataSetIdentifier',
    },
    staticValue: 'staticValue',
  },
  rangeMinimumValue: {
    parameter: 'parameter',
    rollingDate: {
      expression: 'expression',

      // the properties below are optional
      dataSetIdentifier: 'dataSetIdentifier',
    },
    staticValue: 'staticValue',
  },
  timeGranularity: 'timeGranularity',
};

Properties

NameTypeDescription
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.
excludePeriodConfiguration?IResolvable | ExcludePeriodConfigurationPropertyThe exclude period of the time range filter.
includeMaximum?boolean | IResolvableDetermines whether the maximum value in the filter value range should be included in the filtered results.
includeMinimum?boolean | IResolvableDetermines whether the minimum value in the filter value range should be included in the filtered results.
rangeMaximumValue?IResolvable | TimeRangeFilterValuePropertyThe maximum value for the filter value range.
rangeMinimumValue?IResolvable | TimeRangeFilterValuePropertyThe minimum value for the filter value range.
timeGranularity?stringThe level of time precision that is used to aggregate DateTime values.

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.

excludePeriodConfiguration?

Type: IResolvable | ExcludePeriodConfigurationProperty (optional)

The exclude period of the time range filter.


includeMaximum?

Type: boolean | IResolvable (optional)

Determines whether the maximum value in the filter value range should be included in the filtered results.


includeMinimum?

Type: boolean | IResolvable (optional)

Determines whether the minimum value in the filter value range should be included in the filtered results.


rangeMaximumValue?

Type: IResolvable | TimeRangeFilterValueProperty (optional)

The maximum value for the filter value range.


rangeMinimumValue?

Type: IResolvable | TimeRangeFilterValueProperty (optional)

The minimum value for the filter value range.


timeGranularity?

Type: string (optional)

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