Class: AWSCDK::QuickSight::CfnTemplate::WhatIfRangeScenarioProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::QuickSight::CfnTemplate::WhatIfRangeScenarioProperty

Defined in:

quick_sight/cfn_template.rb

Overview

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-whatifrangescenario.html

Instance Attribute Summary

• #end_date ⇒ String readonly

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

• #start_date ⇒ String readonly

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

• #value ⇒ Numeric readonly

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

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

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

  A new instance of WhatIfRangeScenarioProperty.

• #to_jsii ⇒ Object

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.

# File 'quick_sight/cfn_template.rb', line 30407

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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-whatifrangescenario.html#cfn-quicksight-template-whatifrangescenario-enddate

# File 'quick_sight/cfn_template.rb', line 30420

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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-whatifrangescenario.html#cfn-quicksight-template-whatifrangescenario-startdate

# File 'quick_sight/cfn_template.rb', line 30425

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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-whatifrangescenario.html#cfn-quicksight-template-whatifrangescenario-value

# File 'quick_sight/cfn_template.rb', line 30431

def value
  @value
end

Class Method Details

.jsii_properties ⇒ Object

# File 'quick_sight/cfn_template.rb', line 30433

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

Instance Method Details

#to_jsii ⇒ Object

# File 'quick_sight/cfn_template.rb', line 30441

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