interface FilterGroupProperty

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

A grouping of individual filters. Filter groups are applied to the same group of visuals.

For more information, see Adding filter conditions (group filters) with AND and OR operators in the Amazon QuickSight User Guide .

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 filterGroupProperty: quicksight.CfnAnalysis.FilterGroupProperty = {
  crossDataset: 'crossDataset',
  filterGroupId: 'filterGroupId',
  filters: [{
    categoryFilter: {
      column: {
        columnName: 'columnName',
        dataSetIdentifier: 'dataSetIdentifier',
      },
      configuration: {
        customFilterConfiguration: {
          matchOperator: 'matchOperator',
          nullOption: 'nullOption',

          // the properties below are optional
          categoryValue: 'categoryValue',
          parameterName: 'parameterName',
          selectAllOptions: 'selectAllOptions',
        },
        customFilterListConfiguration: {
          matchOperator: 'matchOperator',
          nullOption: 'nullOption',

          // the properties below are optional
          categoryValues: ['categoryValues'],
          selectAllOptions: 'selectAllOptions',
        },
        filterListConfiguration: {
          matchOperator: 'matchOperator',

          // the properties below are optional
          categoryValues: ['categoryValues'],
          selectAllOptions: 'selectAllOptions',
        },
      },
      filterId: 'filterId',
    },
    numericEqualityFilter: {
      column: {
        columnName: 'columnName',
        dataSetIdentifier: 'dataSetIdentifier',
      },
      filterId: 'filterId',
      matchOperator: 'matchOperator',
      nullOption: 'nullOption',

      // the properties below are optional
      aggregationFunction: {
        categoricalAggregationFunction: 'categoricalAggregationFunction',
        dateAggregationFunction: 'dateAggregationFunction',
        numericalAggregationFunction: {
          percentileAggregation: {
            percentileValue: 123,
          },
          simpleNumericalAggregation: 'simpleNumericalAggregation',
        },
      },
      parameterName: 'parameterName',
      selectAllOptions: 'selectAllOptions',
      value: 123,
    },
    numericRangeFilter: {
      column: {
        columnName: 'columnName',
        dataSetIdentifier: 'dataSetIdentifier',
      },
      filterId: 'filterId',
      nullOption: 'nullOption',

      // the properties below are optional
      aggregationFunction: {
        categoricalAggregationFunction: 'categoricalAggregationFunction',
        dateAggregationFunction: 'dateAggregationFunction',
        numericalAggregationFunction: {
          percentileAggregation: {
            percentileValue: 123,
          },
          simpleNumericalAggregation: 'simpleNumericalAggregation',
        },
      },
      includeMaximum: false,
      includeMinimum: false,
      rangeMaximum: {
        parameter: 'parameter',
        staticValue: 123,
      },
      rangeMinimum: {
        parameter: 'parameter',
        staticValue: 123,
      },
      selectAllOptions: 'selectAllOptions',
    },
    relativeDatesFilter: {
      anchorDateConfiguration: {
        anchorOption: 'anchorOption',
        parameterName: 'parameterName',
      },
      column: {
        columnName: 'columnName',
        dataSetIdentifier: 'dataSetIdentifier',
      },
      filterId: 'filterId',
      nullOption: 'nullOption',
      relativeDateType: 'relativeDateType',
      timeGranularity: 'timeGranularity',

      // the properties below are optional
      excludePeriodConfiguration: {
        amount: 123,
        granularity: 'granularity',

        // the properties below are optional
        status: 'status',
      },
      minimumGranularity: 'minimumGranularity',
      parameterName: 'parameterName',
      relativeDateValue: 123,
    },
    timeEqualityFilter: {
      column: {
        columnName: 'columnName',
        dataSetIdentifier: 'dataSetIdentifier',
      },
      filterId: 'filterId',

      // the properties below are optional
      parameterName: 'parameterName',
      timeGranularity: 'timeGranularity',
      value: 'value',
    },
    timeRangeFilter: {
      column: {
        columnName: 'columnName',
        dataSetIdentifier: 'dataSetIdentifier',
      },
      filterId: 'filterId',
      nullOption: 'nullOption',

      // the properties below are optional
      excludePeriodConfiguration: {
        amount: 123,
        granularity: 'granularity',

        // the properties below are optional
        status: 'status',
      },
      includeMaximum: false,
      includeMinimum: false,
      rangeMaximumValue: {
        parameter: 'parameter',
        rollingDate: {
          expression: 'expression',

          // the properties below are optional
          dataSetIdentifier: 'dataSetIdentifier',
        },
        staticValue: 'staticValue',
      },
      rangeMinimumValue: {
        parameter: 'parameter',
        rollingDate: {
          expression: 'expression',

          // the properties below are optional
          dataSetIdentifier: 'dataSetIdentifier',
        },
        staticValue: 'staticValue',
      },
      timeGranularity: 'timeGranularity',
    },
    topBottomFilter: {
      aggregationSortConfigurations: [{
        aggregationFunction: {
          categoricalAggregationFunction: 'categoricalAggregationFunction',
          dateAggregationFunction: 'dateAggregationFunction',
          numericalAggregationFunction: {
            percentileAggregation: {
              percentileValue: 123,
            },
            simpleNumericalAggregation: 'simpleNumericalAggregation',
          },
        },
        column: {
          columnName: 'columnName',
          dataSetIdentifier: 'dataSetIdentifier',
        },
        sortDirection: 'sortDirection',
      }],
      column: {
        columnName: 'columnName',
        dataSetIdentifier: 'dataSetIdentifier',
      },
      filterId: 'filterId',

      // the properties below are optional
      limit: 123,
      parameterName: 'parameterName',
      timeGranularity: 'timeGranularity',
    },
  }],
  scopeConfiguration: {
    selectedSheets: {
      sheetVisualScopingConfigurations: [{
        scope: 'scope',
        sheetId: 'sheetId',

        // the properties below are optional
        visualIds: ['visualIds'],
      }],
    },
  },

  // the properties below are optional
  status: 'status',
};

Properties

Name	Type	Description
crossDataset	string	The filter new feature which can apply filter group to all data sets. Choose one of the following options:.
filterGroupId	string	The value that uniquely identifies a FilterGroup within a dashboard, template, or analysis.
filters	IResolvable | IResolvable | FilterProperty[]	The list of filters that are present in a FilterGroup .
scopeConfiguration	IResolvable | FilterScopeConfigurationProperty	The configuration that specifies what scope to apply to a FilterGroup .
status?	string	The status of the FilterGroup .

---

crossDataset

Type: string

The filter new feature which can apply filter group to all data sets. Choose one of the following options:.

• ALL_DATASETS
• SINGLE_DATASET

---

filterGroupId

Type: string

The value that uniquely identifies a FilterGroup within a dashboard, template, or analysis.

---

filters

Type: IResolvable | IResolvable | FilterProperty[]

The list of filters that are present in a FilterGroup .

---

scopeConfiguration

Type: IResolvable | FilterScopeConfigurationProperty

The configuration that specifies what scope to apply to a FilterGroup .

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

---

status?

Type: string (optional)

The status of the FilterGroup .