aws-cdk-lib.aws_quicksight.CfnDashboard.ExplicitHierarchyProperty

interface ExplicitHierarchyProperty

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

The option that determines the hierarchy of the fields that are built within a visual's field wells.

These fields can't be duplicated to other visuals.

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 explicitHierarchyProperty: quicksight.CfnDashboard.ExplicitHierarchyProperty = {
  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 explicit hierarchy.
hierarchyIdstringThe hierarchy ID of the explicit hierarchy.
drillDownFilters?IResolvable | IResolvable | DrillDownFilterProperty[]The option that determines the drill down filters for the explicit hierarchy.

columns

Type: IResolvable | IResolvable | ColumnIdentifierProperty[]

The list of columns that define the explicit hierarchy.


hierarchyId

Type: string

The hierarchy ID of the explicit hierarchy.


drillDownFilters?

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

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