Class: AWSCDK::QuickSight::CfnAnalysis::FilterGroupProperty

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



10088
10089
10090
10091
10092
10093
10094
10095
10096
10097
10098
10099
 
# File 'quick_sight/cfn_analysis.rb', line 10088

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



10108
10109
10110
 
# File 'quick_sight/cfn_analysis.rb', line 10108

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:



10113
10114
10115
 
# File 'quick_sight/cfn_analysis.rb', line 10113

def filter_group_id
  @filter_group_id
end

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

The list of filters that are present in a FilterGroup .

Returns:

See Also:



10118
10119
10120
 
# File 'quick_sight/cfn_analysis.rb', line 10118

def filters
  @filters
end

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



10125
10126
10127
 
# File 'quick_sight/cfn_analysis.rb', line 10125

def scope_configuration
  @scope_configuration
end

#status ⇒ String? (readonly)

The status of the FilterGroup .

Returns:

  • (String, nil)

See Also:



10130
10131
10132
 
# File 'quick_sight/cfn_analysis.rb', line 10130

def status
  @status
end

Class Method Details

.jsii_properties ⇒ Object 



10132
10133
10134
10135
10136
10137
10138
10139
10140
 
# File 'quick_sight/cfn_analysis.rb', line 10132

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 



10142
10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
 
# File 'quick_sight/cfn_analysis.rb', line 10142

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