interface DrillDownFilterProperty

Language	Type name
.NET	Amazon.CDK.AWS.QuickSight.CfnTemplate.DrillDownFilterProperty
Java	software.amazon.awscdk.services.quicksight.CfnTemplate.DrillDownFilterProperty
Python	aws_cdk.aws_quicksight.CfnTemplate.DrillDownFilterProperty
TypeScript	@aws-cdk/aws-quicksight » CfnTemplate » DrillDownFilterProperty

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.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as quicksight from '@aws-cdk/aws-quicksight';
const drillDownFilterProperty: quicksight.CfnTemplate.DrillDownFilterProperty = {
  categoryFilter: {
    categoryValues: ['categoryValues'],
    column: {
      columnName: 'columnName',
      dataSetIdentifier: 'dataSetIdentifier',
    },
  },
  numericEqualityFilter: {
    column: {
      columnName: 'columnName',
      dataSetIdentifier: 'dataSetIdentifier',
    },
    value: 123,
  },
  timeRangeFilter: {
    column: {
      columnName: 'columnName',
      dataSetIdentifier: 'dataSetIdentifier',
    },
    rangeMaximum: 'rangeMaximum',
    rangeMinimum: 'rangeMinimum',
    timeGranularity: 'timeGranularity',
  },
};

Properties

Name	Type	Description
categoryFilter?	IResolvable | CategoryDrillDownFilterProperty	The category type drill down filter.
numericEqualityFilter?	IResolvable | NumericEqualityDrillDownFilterProperty	The numeric equality type drill down filter.
timeRangeFilter?	IResolvable | TimeRangeDrillDownFilterProperty	The time range drill down filter.

---

categoryFilter?

Type: IResolvable | CategoryDrillDownFilterProperty (optional)

The category type drill down filter.

This filter is used for string type columns.

---

numericEqualityFilter?

Type: IResolvable | NumericEqualityDrillDownFilterProperty (optional)

The numeric equality type drill down filter.

This filter is used for number type columns.

---

timeRangeFilter?

Type: IResolvable | TimeRangeDrillDownFilterProperty (optional)

The time range drill down filter.

This filter is used for date time columns.