Class: AWSCDK::QuickSight::CfnTemplate::TimeEqualityFilterProperty

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



27644
27645
27646
27647
27648
27649
27650
27651
27652
27653
27654
27655
27656
27657
27658
27659
 
# File 'quick_sight/cfn_template.rb', line 27644

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::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?
  @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::CfnTemplate::RollingDateConfigurationProperty.new(**rolling_date.transform_keys(&:to_sym)) : rolling_date
  Jsii::Type.check_type(@rolling_date, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlJvbGxpbmdEYXRlQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "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::CfnTemplate::ColumnIdentifierProperty (readonly)

The column that the filter is applied to.

Returns:

See Also:



27665
27666
27667
 
# File 'quick_sight/cfn_template.rb', line 27665

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:



27677
27678
27679
 
# File 'quick_sight/cfn_template.rb', line 27677

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:



27670
27671
27672
 
# File 'quick_sight/cfn_template.rb', line 27670

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:



27684
27685
27686
 
# File 'quick_sight/cfn_template.rb', line 27684

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:



27691
27692
27693
 
# File 'quick_sight/cfn_template.rb', line 27691

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:



27696
27697
27698
 
# File 'quick_sight/cfn_template.rb', line 27696

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:



27703
27704
27705
 
# File 'quick_sight/cfn_template.rb', line 27703

def value
  @value
end

Class Method Details

.jsii_properties ⇒ Object 



27705
27706
27707
27708
27709
27710
27711
27712
27713
27714
27715
 
# File 'quick_sight/cfn_template.rb', line 27705

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 



27717
27718
27719
27720
27721
27722
27723
27724
27725
27726
27727
27728
27729
 
# File 'quick_sight/cfn_template.rb', line 27717

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