Package software.amazon.awscdk.services.budgets

Interface CfnBudget.TimePeriodProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBudget.TimePeriodProperty.Jsii$Proxy

Enclosing class:

CfnBudget

@Stability(Stable)
public static interface CfnBudget.TimePeriodProperty
extends software.amazon.jsii.JsiiSerializable

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.budgets.*;
 TimePeriodProperty timePeriodProperty = TimePeriodProperty.builder()
         .end("end")
         .start("start")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnBudget.TimePeriodProperty.Builder	A builder for CfnBudget.TimePeriodProperty
static final class	CfnBudget.TimePeriodProperty.Jsii$Proxy	An implementation for CfnBudget.TimePeriodProperty

Method Summary

Modifier and Type	Method	Description
static CfnBudget.TimePeriodProperty.Builder	builder()
default String	getEnd()	The end date for a budget.
default String	getStart()	The start date for a budget.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEnd

@Stability(Stable)
@Nullable
default String getEnd()

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 AWS 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.

See Also:

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

getStart

@Stability(Stable)
@Nullable
default String getStart()

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 AWS 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 .

See Also:

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

builder

@Stability(Stable)
static CfnBudget.TimePeriodProperty.Builder builder()

Returns:

a CfnBudget.TimePeriodProperty.Builder of CfnBudget.TimePeriodProperty