Class: AWSCDK::QuickSight::CfnTemplate::FilterScopeConfigurationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::QuickSight::CfnTemplate::FilterScopeConfigurationProperty

Defined in:

quick_sight/cfn_template.rb

Overview

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-template-filterscopeconfiguration.html

Instance Attribute Summary

• #all_sheets ⇒ Object^? readonly

  The configuration that applies a filter to all sheets.

• #selected_sheets ⇒ AWSCDK::IResolvable, ... readonly

  The configuration for applying a filter to specific sheets.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(all_sheets: nil, selected_sheets: nil) ⇒ FilterScopeConfigurationProperty constructor

  A new instance of FilterScopeConfigurationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(all_sheets: nil, selected_sheets: nil) ⇒ FilterScopeConfigurationProperty

Returns a new instance of FilterScopeConfigurationProperty.

Parameters:

• all_sheets (Object, nil) (defaults to: nil) —

  The configuration that applies a filter to all sheets.

• selected_sheets (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTemplate::SelectedSheetsFilterScopeConfigurationProperty, nil) (defaults to: nil) —

  The configuration for applying a filter to specific sheets.

# File 'quick_sight/cfn_template.rb', line 10414

def initialize(all_sheets: nil, selected_sheets: nil)
  @all_sheets = all_sheets
  Jsii::Type.check_type(@all_sheets, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "allSheets") unless @all_sheets.nil?
  @selected_sheets = selected_sheets.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::SelectedSheetsFilterScopeConfigurationProperty.new(**selected_sheets.transform_keys(&:to_sym)) : selected_sheets
  Jsii::Type.check_type(@selected_sheets, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlNlbGVjdGVkU2hlZXRzRmlsdGVyU2NvcGVDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "selectedSheets") unless @selected_sheets.nil?
end

Instance Attribute Details

#all_sheets ⇒ Object^? (readonly)

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.

Returns:

• (Object, nil)

See Also:

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

# File 'quick_sight/cfn_template.rb', line 10427

def all_sheets
  @all_sheets
end

#selected_sheets ⇒ AWSCDK::IResolvable, ... (readonly)

The configuration for applying a filter to specific sheets.

Returns:

• (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTemplate::SelectedSheetsFilterScopeConfigurationProperty, nil)

See Also:

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

# File 'quick_sight/cfn_template.rb', line 10432

def selected_sheets
  @selected_sheets
end

Class Method Details

.jsii_properties ⇒ Object

# File 'quick_sight/cfn_template.rb', line 10434

def self.jsii_properties
  {
    :all_sheets => "allSheets",
    :selected_sheets => "selectedSheets",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'quick_sight/cfn_template.rb', line 10441

def to_jsii
  result = {}
  result.merge!({
    "allSheets" => @all_sheets,
    "selectedSheets" => @selected_sheets,
  })
  result.compact
end