Package software.amazon.awscdk.services.quicksight

Interface CfnTemplate.FilterScopeConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTemplate.FilterScopeConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnTemplate

@Stability(Stable)
public static interface CfnTemplate.FilterScopeConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.quicksight.*;
 Object allSheets;
 FilterScopeConfigurationProperty filterScopeConfigurationProperty = FilterScopeConfigurationProperty.builder()
         .allSheets(allSheets)
         .selectedSheets(SelectedSheetsFilterScopeConfigurationProperty.builder()
                 .sheetVisualScopingConfigurations(List.of(SheetVisualScopingConfigurationProperty.builder()
                         .scope("scope")
                         .sheetId("sheetId")
                         // the properties below are optional
                         .visualIds(List.of("visualIds"))
                         .build()))
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterscopeconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnTemplate.FilterScopeConfigurationProperty.Builder	A builder for CfnTemplate.FilterScopeConfigurationProperty
static final class	CfnTemplate.FilterScopeConfigurationProperty.Jsii$Proxy	An implementation for CfnTemplate.FilterScopeConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnTemplate.FilterScopeConfigurationProperty.Builder	builder()
default Object	getAllSheets()	The configuration that applies a filter to all sheets.
default Object	getSelectedSheets()	The configuration for applying a filter to specific sheets.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAllSheets

@Stability(Stable)
@Nullable
default Object getAllSheets()

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-template-filterscopeconfiguration.html#cfn-quicksight-template-filterscopeconfiguration-allsheets

getSelectedSheets

@Stability(Stable)
@Nullable
default Object getSelectedSheets()

The configuration for applying a filter to specific sheets.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filterscopeconfiguration.html#cfn-quicksight-template-filterscopeconfiguration-selectedsheets

builder

@Stability(Stable)
static CfnTemplate.FilterScopeConfigurationProperty.Builder builder()

Returns:

a CfnTemplate.FilterScopeConfigurationProperty.Builder of CfnTemplate.FilterScopeConfigurationProperty