Class: AWSCDK::QuickSight::CfnTemplate::CategoryFilterProperty

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

Overview

A CategoryFilter filters text values.

For more information, see Adding text filters in the Amazon Quick Suite User Guide .

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(column:, configuration:, filter_id:, default_filter_control_configuration: nil) ⇒ CategoryFilterProperty

Returns a new instance of CategoryFilterProperty.

Parameters:



3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
 
# File 'quick_sight/cfn_template.rb', line 3402

def initialize(column:, configuration:, filter_id:, default_filter_control_configuration: nil)
  @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")
  @configuration = configuration.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::CategoryFilterConfigurationProperty.new(**configuration.transform_keys(&:to_sym)) : configuration
  Jsii::Type.check_type(@configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkNhdGVnb3J5RmlsdGVyQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "configuration")
  @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?
end

Instance Attribute Details

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

The column that the filter is applied to.

Returns:

See Also:



3417
3418
3419
 
# File 'quick_sight/cfn_template.rb', line 3417

def column
  @column
end

#configuration ⇒ AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTemplate::CategoryFilterConfigurationProperty (readonly)

The configuration for a CategoryFilter .

Returns:

See Also:



3422
3423
3424
 
# File 'quick_sight/cfn_template.rb', line 3422

def configuration
  @configuration
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:



3434
3435
3436
 
# File 'quick_sight/cfn_template.rb', line 3434

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:



3427
3428
3429
 
# File 'quick_sight/cfn_template.rb', line 3427

def filter_id
  @filter_id
end

Class Method Details

.jsii_properties ⇒ Object 



3436
3437
3438
3439
3440
3441
3442
3443
 
# File 'quick_sight/cfn_template.rb', line 3436

def self.jsii_properties
  {
    :column => "column",
    :configuration => "configuration",
    :filter_id => "filterId",
    :default_filter_control_configuration => "defaultFilterControlConfiguration",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
 
# File 'quick_sight/cfn_template.rb', line 3445

def to_jsii
  result = {}
  result.merge!({
    "column" => @column,
    "configuration" => @configuration,
    "filterId" => @filter_id,
    "defaultFilterControlConfiguration" => @default_filter_control_configuration,
  })
  result.compact
end