Class: AWSCDK::QuickSight::CfnDashboard::TopBottomFilterProperty

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



30851
30852
30853
30854
30855
30856
30857
30858
30859
30860
30861
30862
30863
30864
30865
30866
 
# File 'quick_sight/cfn_dashboard.rb', line 30851

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("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5EYXNoYm9hcmQuQWdncmVnYXRpb25Tb3J0Q29uZmlndXJhdGlvblByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "aggregationSortConfigurations")
  @column = column.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::ColumnIdentifierProperty.new(**column.transform_keys(&:to_sym)) : column
  Jsii::Type.check_type(@column, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5Db2x1bW5JZGVudGlmaWVyUHJvcGVydHkifV19fQ==")), "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::CfnDashboard::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("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5EZWZhdWx0RmlsdGVyQ29udHJvbENvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "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::CfnDashboard::AggregationSortConfigurationProperty> (readonly)

The aggregation and sort configuration of the top bottom filter.

Returns:

See Also:



30872
30873
30874
 
# File 'quick_sight/cfn_dashboard.rb', line 30872

def aggregation_sort_configurations
  @aggregation_sort_configurations
end

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

The column that the filter is applied to.

Returns:

See Also:



30877
30878
30879
 
# File 'quick_sight/cfn_dashboard.rb', line 30877

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:



30889
30890
30891
 
# File 'quick_sight/cfn_dashboard.rb', line 30889

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:



30882
30883
30884
 
# File 'quick_sight/cfn_dashboard.rb', line 30882

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:



30894
30895
30896
 
# File 'quick_sight/cfn_dashboard.rb', line 30894

def limit
  @limit
end

#parameter_name ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



30899
30900
30901
 
# File 'quick_sight/cfn_dashboard.rb', line 30899

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:



30904
30905
30906
 
# File 'quick_sight/cfn_dashboard.rb', line 30904

def time_granularity
  @time_granularity
end

Class Method Details

.jsii_properties ⇒ Object 



30906
30907
30908
30909
30910
30911
30912
30913
30914
30915
30916
 
# File 'quick_sight/cfn_dashboard.rb', line 30906

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 



30918
30919
30920
30921
30922
30923
30924
30925
30926
30927
30928
30929
30930
 
# File 'quick_sight/cfn_dashboard.rb', line 30918

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