Class: AWSCDK::QuickSight::CfnDashboard::TimeEqualityFilterProperty

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

Overview

A TimeEqualityFilter filters values that are equal to a given value.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(column:, filter_id:, default_filter_control_configuration: nil, parameter_name: nil, rolling_date: nil, time_granularity: nil, value: nil) ⇒ TimeEqualityFilterProperty

Returns a new instance of TimeEqualityFilterProperty.

Parameters:



30400
30401
30402
30403
30404
30405
30406
30407
30408
30409
30410
30411
30412
30413
30414
30415
 
# File 'quick_sight/cfn_dashboard.rb', line 30400

def initialize(column:, filter_id:, default_filter_control_configuration: nil, parameter_name: nil, rolling_date: nil, time_granularity: nil, value: nil)
  @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?
  @parameter_name = parameter_name
  Jsii::Type.check_type(@parameter_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "parameterName") unless @parameter_name.nil?
  @rolling_date = rolling_date.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::RollingDateConfigurationProperty.new(**rolling_date.transform_keys(&:to_sym)) : rolling_date
  Jsii::Type.check_type(@rolling_date, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5Sb2xsaW5nRGF0ZUNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "rollingDate") unless @rolling_date.nil?
  @time_granularity = time_granularity
  Jsii::Type.check_type(@time_granularity, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "timeGranularity") unless @time_granularity.nil?
  @value = value
  Jsii::Type.check_type(@value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "value") unless @value.nil?
end

Instance Attribute Details

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

The column that the filter is applied to.

Returns:

See Also:



30421
30422
30423
 
# File 'quick_sight/cfn_dashboard.rb', line 30421

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:



30433
30434
30435
 
# File 'quick_sight/cfn_dashboard.rb', line 30433

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:



30426
30427
30428
 
# File 'quick_sight/cfn_dashboard.rb', line 30426

def filter_id
  @filter_id
end

#parameter_name ⇒ String? (readonly)

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

This field is mutually exclusive to Value and RollingDate .

Returns:

  • (String, nil)

See Also:



30440
30441
30442
 
# File 'quick_sight/cfn_dashboard.rb', line 30440

def parameter_name
  @parameter_name
end

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

The rolling date input for the TimeEquality filter.

This field is mutually exclusive to Value and ParameterName .

Returns:

See Also:



30447
30448
30449
 
# File 'quick_sight/cfn_dashboard.rb', line 30447

def rolling_date
  @rolling_date
end

#time_granularity ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



30452
30453
30454
 
# File 'quick_sight/cfn_dashboard.rb', line 30452

def time_granularity
  @time_granularity
end

#value ⇒ String? (readonly)

The value of a TimeEquality filter.

This field is mutually exclusive to RollingDate and ParameterName .

Returns:

  • (String, nil)

See Also:



30459
30460
30461
 
# File 'quick_sight/cfn_dashboard.rb', line 30459

def value
  @value
end

Class Method Details

.jsii_properties ⇒ Object 



30461
30462
30463
30464
30465
30466
30467
30468
30469
30470
30471
 
# File 'quick_sight/cfn_dashboard.rb', line 30461

def self.jsii_properties
  {
    :column => "column",
    :filter_id => "filterId",
    :default_filter_control_configuration => "defaultFilterControlConfiguration",
    :parameter_name => "parameterName",
    :rolling_date => "rollingDate",
    :time_granularity => "timeGranularity",
    :value => "value",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



30473
30474
30475
30476
30477
30478
30479
30480
30481
30482
30483
30484
30485
 
# File 'quick_sight/cfn_dashboard.rb', line 30473

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