AWS::Budgets::Budget AutoAdjustData

Determine the budget amount for an auto-adjusting budget.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "AutoAdjustType" : String,
  "HistoricalOptions" : HistoricalOptions
}

YAML

  AutoAdjustType: String
  HistoricalOptions: 
    HistoricalOptions

Properties

AutoAdjustType

The string that defines whether your budget auto-adjusts based on historical or forecasted data.

Required: Yes

Type: String

Allowed values: HISTORICAL | FORECAST

Update requires: No interruption

HistoricalOptions

The parameters that define or describe the historical data that your auto-adjusting budget is based on.

Required: No

Type: HistoricalOptions

Update requires: No interruption

Examples

Creating an auto-adjusting AWS budget based on historical data

The following example creates an auto-adjusting AWS budget based on historical data with a 6 months adjustment period. The maximum value of the budget adjustment period depends on the TimeUnit granularity of the budget. For example, if you set TimeUnit to use the MONTHLY value, then the maximum value of BudgetAdjustmentPeriod is 12. For more information, see BudgetAdjustmentPeriod in HistoricalOptions.

JSON

{
    "Resources": {
        "BudgetExample": {
            "Type": "AWS::Budgets::Budget",
            "Properties": {
                "Budget": {
                    "BudgetType": "COST",
                    "TimeUnit": "MONTHLY",
                    "AutoAdjustData": {
                        "AutoAdjustType": "HISTORICAL",
                        "HistoricalOptions": {
                            "BudgetAdjustmentPeriod": 6
                        }
                    }
                }
            }
        }
    }
}

YAML

Resources:
  BudgetExample:
    Type: "AWS::Budgets::Budget"
    Properties:
      Budget:
        BudgetType: COST
        TimeUnit: MONTHLY
        AutoAdjustData:
          AutoAdjustType: HISTORICAL
          HistoricalOptions:
              BudgetAdjustmentPeriod: 6