Class: AWSCDK::Budgets::CfnBudget::TimePeriodProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Budgets::CfnBudget::TimePeriodProperty

Defined in:

budgets/cfn_budget.rb

Overview

The period of time that is covered by a budget.

The period has a start date and an end date. The start date must come before the end date. There are no restrictions on the end date.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-timeperiod.html

Instance Attribute Summary

• #_end ⇒ String^? readonly

  The end date for a budget.

• #start ⇒ String^? readonly

  The start date for a budget.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(_end: nil, start: nil) ⇒ TimePeriodProperty constructor

  A new instance of TimePeriodProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(_end: nil, start: nil) ⇒ TimePeriodProperty

Returns a new instance of TimePeriodProperty.

Parameters:

• _end (String, nil) (defaults to: nil) —

  The end date for a budget.

• start (String, nil) (defaults to: nil) —

  The start date for a budget.

# File 'budgets/cfn_budget.rb', line 1464

def initialize(_end: nil, start: nil)
  @_end = _end
  Jsii::Type.check_type(@_end, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "end") unless @_end.nil?
  @start = start
  Jsii::Type.check_type(@start, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "start") unless @start.nil?
end

Instance Attribute Details

#_end ⇒ String^? (readonly)

The end date for a budget.

If you didn't specify an end date, AWS set your end date to 06/15/87 00:00 UTC . The defaults are the same for the Billing and Cost Management console and the API.

After the end date, AWS deletes the budget and all the associated notifications and subscribers. You can change your end date with the UpdateBudget operation.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-timeperiod.html#cfn-budgets-budget-timeperiod-end

# File 'budgets/cfn_budget.rb', line 1479

def _end
  @_end
end

#start ⇒ String^? (readonly)

The start date for a budget.

If you created your budget and didn't specify a start date, the start date defaults to the start of the chosen time period (MONTHLY, QUARTERLY, or ANNUALLY). For example, if you create your budget on January 24, 2019, choose MONTHLY , and don't set a start date, the start date defaults to 01/01/19 00:00 UTC . The defaults are the same for the Billing and Cost Management console and the API.

You can change your start date with the UpdateBudget operation.

Valid values depend on the value of BudgetType :

• If BudgetType is COST or USAGE : Valid values are MONTHLY , QUARTERLY , and ANNUALLY .
• If BudgetType is RI_UTILIZATION or RI_COVERAGE : Valid values are DAILY , MONTHLY , QUARTERLY , and ANNUALLY .

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-timeperiod.html#cfn-budgets-budget-timeperiod-start

# File 'budgets/cfn_budget.rb', line 1493

def start
  @start
end

Class Method Details

.jsii_properties ⇒ Object

# File 'budgets/cfn_budget.rb', line 1495

def self.jsii_properties
  {
    :_end => "end",
    :start => "start",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'budgets/cfn_budget.rb', line 1502

def to_jsii
  result = {}
  result.merge!({
    "end" => @_end,
    "start" => @start,
  })
  result.compact
end