interface PredefinedHierarchyProperty

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

The option that determines the hierarchy of the fields that are defined during data preparation.

These fields are available to use in any analysis that uses the data source.

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 predefinedHierarchyProperty: quicksight.CfnTemplate.PredefinedHierarchyProperty = {
  columns: [{
    columnName: 'columnName',
    dataSetIdentifier: 'dataSetIdentifier',
  }],
  hierarchyId: 'hierarchyId',

  // the properties below are optional
  drillDownFilters: [{
    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
columns	IResolvable | IResolvable | ColumnIdentifierProperty[]	The list of columns that define the predefined hierarchy.
hierarchyId	string	The hierarchy ID of the predefined hierarchy.
drillDownFilters?	IResolvable | IResolvable | DrillDownFilterProperty[]	The option that determines the drill down filters for the predefined hierarchy.

---

columns

Type: IResolvable | IResolvable | ColumnIdentifierProperty[]

The list of columns that define the predefined hierarchy.

---

hierarchyId

Type: string

The hierarchy ID of the predefined hierarchy.

---

drillDownFilters?

Type: IResolvable | IResolvable | DrillDownFilterProperty[] (optional)

The option that determines the drill down filters for the predefined hierarchy.