aws-cdk-lib.aws_quicksight.CfnDashboard.PredefinedHierarchyProperty

interface PredefinedHierarchyProperty

LanguageType name
.NETAmazon.CDK.AWS.QuickSight.CfnDashboard.PredefinedHierarchyProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnDashboard_PredefinedHierarchyProperty
Javasoftware.amazon.awscdk.services.quicksight.CfnDashboard.PredefinedHierarchyProperty
Pythonaws_cdk.aws_quicksight.CfnDashboard.PredefinedHierarchyProperty
TypeScript aws-cdk-lib » aws_quicksight » CfnDashboard » 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 { aws_quicksight as quicksight } from 'aws-cdk-lib';
const predefinedHierarchyProperty: quicksight.CfnDashboard.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

NameTypeDescription
columnsIResolvable | IResolvable | ColumnIdentifierProperty[]The list of columns that define the predefined hierarchy.
hierarchyIdstringThe 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.