Class: AWSCDK::QuickSight::CfnDashboard::RelativeDatesFilterProperty

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

Overview

A RelativeDatesFilter filters relative dates values.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(anchor_date_configuration:, column:, filter_id:, null_option:, relative_date_type:, time_granularity:, default_filter_control_configuration: nil, exclude_period_configuration: nil, minimum_granularity: nil, parameter_name: nil, relative_date_value: nil) ⇒ RelativeDatesFilterProperty

Returns a new instance of RelativeDatesFilterProperty.

Parameters:



25314
25315
25316
25317
25318
25319
25320
25321
25322
25323
25324
25325
25326
25327
25328
25329
25330
25331
25332
25333
25334
25335
25336
25337
 
# File 'quick_sight/cfn_dashboard.rb', line 25314

def initialize(anchor_date_configuration:, column:, filter_id:, null_option:, relative_date_type:, time_granularity:, default_filter_control_configuration: nil, exclude_period_configuration: nil, minimum_granularity: nil, parameter_name: nil, relative_date_value: nil)
  @anchor_date_configuration = anchor_date_configuration.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::AnchorDateConfigurationProperty.new(**anchor_date_configuration.transform_keys(&:to_sym)) : anchor_date_configuration
  Jsii::Type.check_type(@anchor_date_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5BbmNob3JEYXRlQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "anchorDateConfiguration")
  @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")
  @null_option = null_option
  Jsii::Type.check_type(@null_option, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nullOption")
  @relative_date_type = relative_date_type
  Jsii::Type.check_type(@relative_date_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "relativeDateType")
  @time_granularity = time_granularity
  Jsii::Type.check_type(@time_granularity, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "timeGranularity")
  @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?
  @exclude_period_configuration = exclude_period_configuration.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::ExcludePeriodConfigurationProperty.new(**exclude_period_configuration.transform_keys(&:to_sym)) : exclude_period_configuration
  Jsii::Type.check_type(@exclude_period_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5FeGNsdWRlUGVyaW9kQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "excludePeriodConfiguration") unless @exclude_period_configuration.nil?
  @minimum_granularity = minimum_granularity
  Jsii::Type.check_type(@minimum_granularity, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "minimumGranularity") unless @minimum_granularity.nil?
  @parameter_name = parameter_name
  Jsii::Type.check_type(@parameter_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "parameterName") unless @parameter_name.nil?
  @relative_date_value = relative_date_value
  Jsii::Type.check_type(@relative_date_value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "relativeDateValue") unless @relative_date_value.nil?
end

Instance Attribute Details

#anchor_date_configuration ⇒ AWSCDK::IResolvable, AWSCDK::QuickSight::CfnDashboard::AnchorDateConfigurationProperty (readonly)

The date configuration of the filter.

Returns:

See Also:



25343
25344
25345
 
# File 'quick_sight/cfn_dashboard.rb', line 25343

def anchor_date_configuration
  @anchor_date_configuration
end

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

The column that the filter is applied to.

Returns:

See Also:



25348
25349
25350
 
# File 'quick_sight/cfn_dashboard.rb', line 25348

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:



25385
25386
25387
 
# File 'quick_sight/cfn_dashboard.rb', line 25385

def default_filter_control_configuration
  @default_filter_control_configuration
end

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

The configuration for the exclude period of the filter.

Returns:

See Also:



25390
25391
25392
 
# File 'quick_sight/cfn_dashboard.rb', line 25390

def exclude_period_configuration
  @exclude_period_configuration
end

#filter_id ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



25353
25354
25355
 
# File 'quick_sight/cfn_dashboard.rb', line 25353

def filter_id
  @filter_id
end

#minimum_granularity ⇒ String? (readonly)

The minimum granularity (period granularity) of the relative dates filter.

Returns:

  • (String, nil)

See Also:



25395
25396
25397
 
# File 'quick_sight/cfn_dashboard.rb', line 25395

def minimum_granularity
  @minimum_granularity
end

#null_option ⇒ String (readonly)

This option determines how null values should be treated when filtering data.

  • ALL_VALUES : Include null values in filtered results.
  • NULLS_ONLY : Only include null values in filtered results.
  • NON_NULLS_ONLY : Exclude null values from filtered results.

Returns:

  • (String)

See Also:



25362
25363
25364
 
# File 'quick_sight/cfn_dashboard.rb', line 25362

def null_option
  @null_option
end

#parameter_name ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



25400
25401
25402
 
# File 'quick_sight/cfn_dashboard.rb', line 25400

def parameter_name
  @parameter_name
end

#relative_date_type ⇒ String (readonly)

The range date type of the filter. Choose one of the options below:.

  • PREVIOUS
  • THIS
  • LAST
  • NOW
  • NEXT

Returns:

  • (String)

See Also:



25373
25374
25375
 
# File 'quick_sight/cfn_dashboard.rb', line 25373

def relative_date_type
  @relative_date_type
end

#relative_date_value ⇒ Numeric? (readonly)

The date value of the filter.

Returns:

  • (Numeric, nil)

See Also:



25405
25406
25407
 
# File 'quick_sight/cfn_dashboard.rb', line 25405

def relative_date_value
  @relative_date_value
end

#time_granularity ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



25378
25379
25380
 
# File 'quick_sight/cfn_dashboard.rb', line 25378

def time_granularity
  @time_granularity
end

Class Method Details

.jsii_properties ⇒ Object 



25407
25408
25409
25410
25411
25412
25413
25414
25415
25416
25417
25418
25419
25420
25421
 
# File 'quick_sight/cfn_dashboard.rb', line 25407

def self.jsii_properties
  {
    :anchor_date_configuration => "anchorDateConfiguration",
    :column => "column",
    :filter_id => "filterId",
    :null_option => "nullOption",
    :relative_date_type => "relativeDateType",
    :time_granularity => "timeGranularity",
    :default_filter_control_configuration => "defaultFilterControlConfiguration",
    :exclude_period_configuration => "excludePeriodConfiguration",
    :minimum_granularity => "minimumGranularity",
    :parameter_name => "parameterName",
    :relative_date_value => "relativeDateValue",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



25423
25424
25425
25426
25427
25428
25429
25430
25431
25432
25433
25434
25435
25436
25437
25438
25439
 
# File 'quick_sight/cfn_dashboard.rb', line 25423

def to_jsii
  result = {}
  result.merge!({
    "anchorDateConfiguration" => @anchor_date_configuration,
    "column" => @column,
    "filterId" => @filter_id,
    "nullOption" => @null_option,
    "relativeDateType" => @relative_date_type,
    "timeGranularity" => @time_granularity,
    "defaultFilterControlConfiguration" => @default_filter_control_configuration,
    "excludePeriodConfiguration" => @exclude_period_configuration,
    "minimumGranularity" => @minimum_granularity,
    "parameterName" => @parameter_name,
    "relativeDateValue" => @relative_date_value,
  })
  result.compact
end