interface FilterScopeConfigurationProperty

Language	Type name
.NET	`Amazon.CDK.AWS.QuickSight.CfnDashboard.FilterScopeConfigurationProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnDashboard_FilterScopeConfigurationProperty`
Java	`software.amazon.awscdk.services.quicksight.CfnDashboard.FilterScopeConfigurationProperty`
Python	`aws_cdk.aws_quicksight.CfnDashboard.FilterScopeConfigurationProperty`
TypeScript	`aws-cdk-lib` » `aws_quicksight` » `CfnDashboard` » `FilterScopeConfigurationProperty`

The scope configuration for a FilterGroup .

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

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';

declare const allSheets: any;
const filterScopeConfigurationProperty: quicksight.CfnDashboard.FilterScopeConfigurationProperty = {
  allSheets: allSheets,
  selectedSheets: {
    sheetVisualScopingConfigurations: [{
      scope: 'scope',
      sheetId: 'sheetId',

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

Properties

Name	Type	Description
allSheets?	`any`	The configuration that applies a filter to all sheets.
selectedSheets?	`IResolvable` `\|` `SelectedSheetsFilterScopeConfigurationProperty`	The configuration for applying a filter to specific sheets.

allSheets?

Type: any (optional)

The configuration that applies a filter to all sheets.

When you choose AllSheets as the value for a FilterScopeConfiguration , this filter is applied to all visuals of all sheets in an Analysis, Dashboard, or Template. The AllSheetsFilterScopeConfiguration is chosen.

selectedSheets?

Type: IResolvable | SelectedSheetsFilterScopeConfigurationProperty (optional)

The configuration for applying a filter to specific sheets.