Class: AWSCDK::QuickSight::CfnTemplate::FilterGroupProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
quick_sight/cfn_template.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:



9896
9897
9898
9899
9900
9901
9902
9903
9904
9905
9906
9907
 
# File 'quick_sight/cfn_template.rb', line 9896

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("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5UZW1wbGF0ZS5GaWx0ZXJQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "filters")
  @scope_configuration = scope_configuration.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::FilterScopeConfigurationProperty.new(**scope_configuration.transform_keys(&:to_sym)) : scope_configuration
  Jsii::Type.check_type(@scope_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkZpbHRlclNjb3BlQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "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:



9916
9917
9918
 
# File 'quick_sight/cfn_template.rb', line 9916

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:



9921
9922
9923
 
# File 'quick_sight/cfn_template.rb', line 9921

def filter_group_id
  @filter_group_id
end

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

The list of filters that are present in a FilterGroup .

Returns:

See Also:



9926
9927
9928
 
# File 'quick_sight/cfn_template.rb', line 9926

def filters
  @filters
end

#scope_configuration ⇒ AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTemplate::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:



9933
9934
9935
 
# File 'quick_sight/cfn_template.rb', line 9933

def scope_configuration
  @scope_configuration
end

#status ⇒ String? (readonly)

The status of the FilterGroup .

Returns:

  • (String, nil)

See Also:



9938
9939
9940
 
# File 'quick_sight/cfn_template.rb', line 9938

def status
  @status
end

Class Method Details

.jsii_properties ⇒ Object 



9940
9941
9942
9943
9944
9945
9946
9947
9948
 
# File 'quick_sight/cfn_template.rb', line 9940

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 



9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
 
# File 'quick_sight/cfn_template.rb', line 9950

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