aws-cdk-lib.aws_quicksight.CfnTemplate.ColumnHierarchyProperty

ColumnHierarchyProperty Struct

The option that determines the hierarchy of the fields for a visual element.

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 columnHierarchyProperty: quicksight.CfnTemplate.ColumnHierarchyProperty = {
  dateTimeHierarchy: {
    hierarchyId: 'hierarchyId',

    // the properties below are optional
    drillDownFilters: [{
      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',
      },
    }],
  },
  explicitHierarchy: {
    columns: [{
      columnName: 'columnName',

      // the properties below are optional
      dataSetIdentifier: 'dataSetIdentifier',
      topicIdentifier: 'topicIdentifier',
    }],
    hierarchyId: 'hierarchyId',

    // the properties below are optional
    drillDownFilters: [{
      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',
      },
    }],
  },
  predefinedHierarchy: {
    columns: [{
      columnName: 'columnName',

      // the properties below are optional
      dataSetIdentifier: 'dataSetIdentifier',
      topicIdentifier: 'topicIdentifier',
    }],
    hierarchyId: 'hierarchyId',

    // the properties below are optional
    drillDownFilters: [{
      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

dateTimeHierarchy?optionalIResolvable | CfnTemplate.DateTimeHierarchyPropertydate_time_hierarchy?optionaltyping.Union[IResolvable, DateTimeHierarchyProperty]dateTimeHierarchy?optionalIResolvableDateTimeHierarchy?optionalIResolvableDateTimeHierarchy?optionalinterface{}#

The option that determines the hierarchy of any `DateTime` fields.

explicitHierarchy?optionalIResolvable | CfnTemplate.ExplicitHierarchyPropertyexplicit_hierarchy?optionaltyping.Union[IResolvable, ExplicitHierarchyProperty]explicitHierarchy?optionalIResolvableExplicitHierarchy?optionalIResolvableExplicitHierarchy?optionalinterface{}#

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.

predefinedHierarchy?optionalIResolvable | CfnTemplate.PredefinedHierarchyPropertypredefined_hierarchy?optionaltyping.Union[IResolvable, PredefinedHierarchyProperty]predefinedHierarchy?optionalIResolvablePredefinedHierarchy?optionalIResolvablePredefinedHierarchy?optionalinterface{}#

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.