Class: AWSCDK::QuickSight::CfnDashboard::FilterGroupProperty

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

Overview

A grouping of individual filters. Filter groups are applied to the same group of visuals.

For more information, see Adding filter conditions (group filters) with AND and OR operators in the Amazon Quick Suite User Guide .

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(cross_dataset:, filter_group_id:, filters:, scope_configuration:, status: nil) ⇒ FilterGroupProperty

Returns a new instance of FilterGroupProperty.

Parameters:



10841
10842
10843
10844
10845
10846
10847
10848
10849
10850
10851
10852
 
# File 'quick_sight/cfn_dashboard.rb', line 10841

def initialize(cross_dataset:, filter_group_id:, filters:, scope_configuration:, status: nil)
  @cross_dataset = cross_dataset
  Jsii::Type.check_type(@cross_dataset, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "crossDataset")
  @filter_group_id = filter_group_id
  Jsii::Type.check_type(@filter_group_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "filterGroupId")
  @filters = filters
  Jsii::Type.check_type(@filters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5EYXNoYm9hcmQuRmlsdGVyUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "filters")
  @scope_configuration = scope_configuration.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::FilterScopeConfigurationProperty.new(**scope_configuration.transform_keys(&:to_sym)) : scope_configuration
  Jsii::Type.check_type(@scope_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5GaWx0ZXJTY29wZUNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "scopeConfiguration")
  @status = status
  Jsii::Type.check_type(@status, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "status") unless @status.nil?
end

Instance Attribute Details

#cross_dataset ⇒ String (readonly)

The filter new feature which can apply filter group to all data sets. Choose one of the following options:.

  • ALL_DATASETS
  • SINGLE_DATASET

Returns:

  • (String)

See Also:



10861
10862
10863
 
# File 'quick_sight/cfn_dashboard.rb', line 10861

def cross_dataset
  @cross_dataset
end

#filter_group_id ⇒ String (readonly)

The value that uniquely identifies a FilterGroup within a dashboard, template, or analysis.

Returns:

  • (String)

See Also:



10866
10867
10868
 
# File 'quick_sight/cfn_dashboard.rb', line 10866

def filter_group_id
  @filter_group_id
end

#filters ⇒ AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::QuickSight::CfnDashboard::FilterProperty> (readonly)

The list of filters that are present in a FilterGroup .

Returns:

See Also:



10871
10872
10873
 
# File 'quick_sight/cfn_dashboard.rb', line 10871

def filters
  @filters
end

#scope_configuration ⇒ AWSCDK::IResolvable, AWSCDK::QuickSight::CfnDashboard::FilterScopeConfigurationProperty (readonly)

The configuration that specifies what scope to apply to a FilterGroup .

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

Returns:

See Also:



10878
10879
10880
 
# File 'quick_sight/cfn_dashboard.rb', line 10878

def scope_configuration
  @scope_configuration
end

#status ⇒ String? (readonly)

The status of the FilterGroup .

Returns:

  • (String, nil)

See Also:



10883
10884
10885
 
# File 'quick_sight/cfn_dashboard.rb', line 10883

def status
  @status
end

Class Method Details

.jsii_properties ⇒ Object 



10885
10886
10887
10888
10889
10890
10891
10892
10893
 
# File 'quick_sight/cfn_dashboard.rb', line 10885

def self.jsii_properties
  {
    :cross_dataset => "crossDataset",
    :filter_group_id => "filterGroupId",
    :filters => "filters",
    :scope_configuration => "scopeConfiguration",
    :status => "status",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



10895
10896
10897
10898
10899
10900
10901
10902
10903
10904
10905
 
# File 'quick_sight/cfn_dashboard.rb', line 10895

def to_jsii
  result = {}
  result.merge!({
    "crossDataset" => @cross_dataset,
    "filterGroupId" => @filter_group_id,
    "filters" => @filters,
    "scopeConfiguration" => @scope_configuration,
    "status" => @status,
  })
  result.compact
end