Class: AWSCDK::QuickSight::CfnTemplate::TopBottomFilterProperty

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

Overview

A TopBottomFilter filters values that are at the top or the bottom.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(aggregation_sort_configurations:, column:, filter_id:, default_filter_control_configuration: nil, limit: nil, parameter_name: nil, time_granularity: nil) ⇒ TopBottomFilterProperty

Returns a new instance of TopBottomFilterProperty.

Parameters:



28095
28096
28097
28098
28099
28100
28101
28102
28103
28104
28105
28106
28107
28108
28109
28110
 
# File 'quick_sight/cfn_template.rb', line 28095

def initialize(aggregation_sort_configurations:, column:, filter_id:, default_filter_control_configuration: nil, limit: nil, parameter_name: nil, time_granularity: nil)
  @aggregation_sort_configurations = aggregation_sort_configurations
  Jsii::Type.check_type(@aggregation_sort_configurations, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5UZW1wbGF0ZS5BZ2dyZWdhdGlvblNvcnRDb25maWd1cmF0aW9uUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "aggregationSortConfigurations")
  @column = column.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::ColumnIdentifierProperty.new(**column.transform_keys(&:to_sym)) : column
  Jsii::Type.check_type(@column, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkNvbHVtbklkZW50aWZpZXJQcm9wZXJ0eSJ9XX19")), "column")
  @filter_id = filter_id
  Jsii::Type.check_type(@filter_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "filterId")
  @default_filter_control_configuration = default_filter_control_configuration.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::DefaultFilterControlConfigurationProperty.new(**default_filter_control_configuration.transform_keys(&:to_sym)) : default_filter_control_configuration
  Jsii::Type.check_type(@default_filter_control_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkRlZmF1bHRGaWx0ZXJDb250cm9sQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "defaultFilterControlConfiguration") unless @default_filter_control_configuration.nil?
  @limit = limit
  Jsii::Type.check_type(@limit, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "limit") unless @limit.nil?
  @parameter_name = parameter_name
  Jsii::Type.check_type(@parameter_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "parameterName") unless @parameter_name.nil?
  @time_granularity = time_granularity
  Jsii::Type.check_type(@time_granularity, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "timeGranularity") unless @time_granularity.nil?
end

Instance Attribute Details

#aggregation_sort_configurations ⇒ AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTemplate::AggregationSortConfigurationProperty> (readonly)

The aggregation and sort configuration of the top bottom filter.

Returns:

See Also:



28116
28117
28118
 
# File 'quick_sight/cfn_template.rb', line 28116

def aggregation_sort_configurations
  @aggregation_sort_configurations
end

#column ⇒ AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTemplate::ColumnIdentifierProperty (readonly)

The column that the filter is applied to.

Returns:

See Also:



28121
28122
28123
 
# File 'quick_sight/cfn_template.rb', line 28121

def column
  @column
end

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

The default configurations for the associated controls.

This applies only for filters that are scoped to multiple sheets.

Returns:

See Also:



28133
28134
28135
 
# File 'quick_sight/cfn_template.rb', line 28133

def default_filter_control_configuration
  @default_filter_control_configuration
end

#filter_id ⇒ String (readonly)

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

Returns:

  • (String)

See Also:



28126
28127
28128
 
# File 'quick_sight/cfn_template.rb', line 28126

def filter_id
  @filter_id
end

#limit ⇒ Numeric? (readonly)

The number of items to include in the top bottom filter results.

Returns:

  • (Numeric, nil)

See Also:



28138
28139
28140
 
# File 'quick_sight/cfn_template.rb', line 28138

def limit
  @limit
end

#parameter_name ⇒ String? (readonly)

The parameter whose value should be used for the filter value.

Returns:

  • (String, nil)

See Also:



28143
28144
28145
 
# File 'quick_sight/cfn_template.rb', line 28143

def parameter_name
  @parameter_name
end

#time_granularity ⇒ String? (readonly)

The level of time precision that is used to aggregate DateTime values.

Returns:

  • (String, nil)

See Also:



28148
28149
28150
 
# File 'quick_sight/cfn_template.rb', line 28148

def time_granularity
  @time_granularity
end

Class Method Details

.jsii_properties ⇒ Object 



28150
28151
28152
28153
28154
28155
28156
28157
28158
28159
28160
 
# File 'quick_sight/cfn_template.rb', line 28150

def self.jsii_properties
  {
    :aggregation_sort_configurations => "aggregationSortConfigurations",
    :column => "column",
    :filter_id => "filterId",
    :default_filter_control_configuration => "defaultFilterControlConfiguration",
    :limit => "limit",
    :parameter_name => "parameterName",
    :time_granularity => "timeGranularity",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



28162
28163
28164
28165
28166
28167
28168
28169
28170
28171
28172
28173
28174
 
# File 'quick_sight/cfn_template.rb', line 28162

def to_jsii
  result = {}
  result.merge!({
    "aggregationSortConfigurations" => @aggregation_sort_configurations,
    "column" => @column,
    "filterId" => @filter_id,
    "defaultFilterControlConfiguration" => @default_filter_control_configuration,
    "limit" => @limit,
    "parameterName" => @parameter_name,
    "timeGranularity" => @time_granularity,
  })
  result.compact
end