Class: AWSCDK::QuickSight::CfnDashboard::SheetVisualScopingConfigurationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
quick_sight/cfn_dashboard.rb

Overview

The filter that is applied to the options.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope:, sheet_id:, visual_ids: nil) ⇒ SheetVisualScopingConfigurationProperty

Returns a new instance of SheetVisualScopingConfigurationProperty.

Parameters:

  • scope (String) —

    The scope of the applied entities. Choose one of the following options:.

  • sheet_id (String) —

    The selected sheet that the filter is applied to.

  • visual_ids (Array<String>, nil) (defaults to: nil) —

    The selected visuals that the filter is applied to.



27713
27714
27715
27716
27717
27718
27719
27720
 
# File 'quick_sight/cfn_dashboard.rb', line 27713

def initialize(scope:, sheet_id:, visual_ids: nil)
  @scope = scope
  Jsii::Type.check_type(@scope, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "scope")
  @sheet_id = sheet_id
  Jsii::Type.check_type(@sheet_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sheetId")
  @visual_ids = visual_ids
  Jsii::Type.check_type(@visual_ids, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "visualIds") unless @visual_ids.nil?
end

Instance Attribute Details

#scope ⇒ String (readonly)

The scope of the applied entities. Choose one of the following options:.

  • ALL_VISUALS
  • SELECTED_VISUALS

Returns:

  • (String)

See Also:



27729
27730
27731
 
# File 'quick_sight/cfn_dashboard.rb', line 27729

def scope
  @scope
end

#sheet_id ⇒ String (readonly)

The selected sheet that the filter is applied to.

Returns:

  • (String)

See Also:



27734
27735
27736
 
# File 'quick_sight/cfn_dashboard.rb', line 27734

def sheet_id
  @sheet_id
end

#visual_ids ⇒ Array<String>? (readonly)

The selected visuals that the filter is applied to.

Returns:

  • (Array<String>, nil)

See Also:



27739
27740
27741
 
# File 'quick_sight/cfn_dashboard.rb', line 27739

def visual_ids
  @visual_ids
end

Class Method Details

.jsii_properties ⇒ Object 



27741
27742
27743
27744
27745
27746
27747
 
# File 'quick_sight/cfn_dashboard.rb', line 27741

def self.jsii_properties
  {
    :scope => "scope",
    :sheet_id => "sheetId",
    :visual_ids => "visualIds",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



27749
27750
27751
27752
27753
27754
27755
27756
27757
 
# File 'quick_sight/cfn_dashboard.rb', line 27749

def to_jsii
  result = {}
  result.merge!({
    "scope" => @scope,
    "sheetId" => @sheet_id,
    "visualIds" => @visual_ids,
  })
  result.compact
end