aws-cdk-lib.aws_quicksight.CfnDashboard.DrillDownFilterProperty

DrillDownFilterProperty Struct

The drill down filter for the column hierarchies.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

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 drillDownFilterProperty: quicksight.CfnDashboard.DrillDownFilterProperty = {
  categoryFilter: {
    categoryValues: ['categoryValues'],
    column: {
      columnName: 'columnName',

      // the properties below are optional
      dataSetIdentifier: 'dataSetIdentifier',
      topicIdentifier: 'topicIdentifier',
    },
  },
  numericEqualityFilter: {
    column: {
      columnName: 'columnName',

      // the properties below are optional
      dataSetIdentifier: 'dataSetIdentifier',
      topicIdentifier: 'topicIdentifier',
    },
    value: 123,
  },
  timeRangeFilter: {
    column: {
      columnName: 'columnName',

      // the properties below are optional
      dataSetIdentifier: 'dataSetIdentifier',
      topicIdentifier: 'topicIdentifier',
    },
    rangeMaximum: 'rangeMaximum',
    rangeMinimum: 'rangeMinimum',
    timeGranularity: 'timeGranularity',
  },
};

Properties

categoryFilter?optionalIResolvable | CfnDashboard.CategoryDrillDownFilterPropertycategory_filter?optionaltyping.Union[IResolvable, CategoryDrillDownFilterProperty]categoryFilter?optionalIResolvableCategoryFilter?optionalIResolvableCategoryFilter?optionalinterface{}#

The category type drill down filter.

This filter is used for string type columns.

numericEqualityFilter?optionalIResolvable | CfnDashboard.NumericEqualityDrillDownFilterPropertynumeric_equality_filter?optionaltyping.Union[IResolvable, NumericEqualityDrillDownFilterProperty]numericEqualityFilter?optionalIResolvableNumericEqualityFilter?optionalIResolvableNumericEqualityFilter?optionalinterface{}#

The numeric equality type drill down filter.

This filter is used for number type columns.

timeRangeFilter?optionalIResolvable | CfnDashboard.TimeRangeDrillDownFilterPropertytime_range_filter?optionaltyping.Union[IResolvable, TimeRangeDrillDownFilterProperty]timeRangeFilter?optionalIResolvableTimeRangeFilter?optionalIResolvableTimeRangeFilter?optionalinterface{}#

The time range drill down filter.

This filter is used for date time columns.