Class: AWSCDK::QuickSight::CfnDashboard::WhatIfRangeScenarioProperty

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

Overview

Provides the forecast to meet the target for a particular date range.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(end_date:, start_date:, value:) ⇒ WhatIfRangeScenarioProperty

Returns a new instance of WhatIfRangeScenarioProperty.

Parameters:

  • end_date (String) —

    The end date in the date range that you need the forecast results for.

  • start_date (String) —

    The start date in the date range that you need the forecast results for.

  • value (Numeric) —

    The target value that you want to meet for the provided date range.



33206
33207
33208
33209
33210
33211
33212
33213
 
# File 'quick_sight/cfn_dashboard.rb', line 33206

def initialize(end_date:, start_date:, value:)
  @end_date = end_date
  Jsii::Type.check_type(@end_date, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "endDate")
  @start_date = start_date
  Jsii::Type.check_type(@start_date, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "startDate")
  @value = value
  Jsii::Type.check_type(@value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "value")
end

Instance Attribute Details

#end_date ⇒ String (readonly)

The end date in the date range that you need the forecast results for.

Returns:

  • (String)

See Also:



33219
33220
33221
 
# File 'quick_sight/cfn_dashboard.rb', line 33219

def end_date
  @end_date
end

#start_date ⇒ String (readonly)

The start date in the date range that you need the forecast results for.

Returns:

  • (String)

See Also:



33224
33225
33226
 
# File 'quick_sight/cfn_dashboard.rb', line 33224

def start_date
  @start_date
end

#value ⇒ Numeric (readonly)

Note:

Default: - 0

The target value that you want to meet for the provided date range.

Returns:

  • (Numeric)

See Also:



33230
33231
33232
 
# File 'quick_sight/cfn_dashboard.rb', line 33230

def value
  @value
end

Class Method Details

.jsii_properties ⇒ Object 



33232
33233
33234
33235
33236
33237
33238
 
# File 'quick_sight/cfn_dashboard.rb', line 33232

def self.jsii_properties
  {
    :end_date => "endDate",
    :start_date => "startDate",
    :value => "value",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



33240
33241
33242
33243
33244
33245
33246
33247
33248
 
# File 'quick_sight/cfn_dashboard.rb', line 33240

def to_jsii
  result = {}
  result.merge!({
    "endDate" => @end_date,
    "startDate" => @start_date,
    "value" => @value,
  })
  result.compact
end