interface FilterScopeConfigurationProperty

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.QuickSight.Mixins.CfnDashboardPropsMixin.FilterScopeConfigurationProperty
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsquicksight/mixins#CfnDashboardPropsMixin_FilterScopeConfigurationProperty
Java	software.amazon.awscdk.mixins.preview.services.quicksight.mixins.CfnDashboardPropsMixin.FilterScopeConfigurationProperty
Python	aws_cdk.mixins_preview.aws_quicksight.mixins.CfnDashboardPropsMixin.FilterScopeConfigurationProperty
TypeScript	@aws-cdk/mixins-preview » aws_quicksight » mixins » CfnDashboardPropsMixin » 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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterscopeconfiguration.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as quicksight_mixins } from '@aws-cdk/mixins-preview/aws-quicksight';

declare const allSheets: any;
const filterScopeConfigurationProperty: quicksight_mixins.CfnDashboardPropsMixin.FilterScopeConfigurationProperty = {
  allSheets: allSheets,
  selectedSheets: {
    sheetVisualScopingConfigurations: [{
      scope: 'scope',
      sheetId: 'sheetId',
      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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterscopeconfiguration.html#cfn-quicksight-dashboard-filterscopeconfiguration-allsheets

---

selectedSheets?

Type: IResolvable | SelectedSheetsFilterScopeConfigurationProperty (optional)

The configuration for applying a filter to specific sheets.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterscopeconfiguration.html#cfn-quicksight-dashboard-filterscopeconfiguration-selectedsheets