AWS::Budgets::Budget BudgetData - AWS CloudFormation
SyntaxPropertiesExamplesSee also

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Budgets::Budget BudgetData

Represents the output of the CreateBudget operation. The content consists of the detailed metadata and data file information, and the current status of the budget object.

This is the Amazon Resource Name (ARN) pattern for a budget:

arn:aws:budgets::AccountId:budget/budgetName

Syntax

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

JSON

{
  "AutoAdjustData" : AutoAdjustData,
  "BillingViewArn" : String,
  "BudgetLimit" : Spend,
  "BudgetName" : String,
  "BudgetType" : String,
  "CostFilters" : Json,
  "CostTypes" : CostTypes,
  "FilterExpression" : Expression,
  "Metrics" : [ String, ... ],
  "PlannedBudgetLimits" : Json,
  "TimePeriod" : TimePeriod,
  "TimeUnit" : String
}

Properties

AutoAdjustData

Determine the budget amount for an auto-adjusting budget.

Required: No

Type: AutoAdjustData

Update requires: No interruption

BillingViewArn

Property description not available.

Required: No

Type: String

Update requires: No interruption

BudgetLimit

The total amount of cost, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage that you want to track with your budget.

BudgetLimit is required for cost or usage budgets, but optional for RI or Savings Plans utilization or coverage budgets. RI and Savings Plans utilization or coverage budgets default to 100. This is the only valid value for RI or Savings Plans utilization or coverage budgets. You can't use BudgetLimit with PlannedBudgetLimits for CreateBudget and UpdateBudget actions.

Required: No

Type: Spend

Update requires: No interruption

BudgetName

The name of a budget. The value must be unique within an account. BudgetName can't include : and \ characters. If you don't include value for BudgetName in the template, Billing and Cost Management assigns your budget a randomly generated name.

Required: No

Type: String

Update requires: No interruption

BudgetType

Specifies whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.

Required: Yes

Type: String

Allowed values: USAGE | COST | RI_UTILIZATION | RI_COVERAGE | SAVINGS_PLANS_UTILIZATION | SAVINGS_PLANS_COVERAGE

Update requires: No interruption

CostFilters

The cost filters, such as Region, Service, LinkedAccount, Tag, or CostCategory, that are applied to a budget.

AWS Budgets supports the following services as a Service filter for RI budgets:

  • Amazon EC2

  • Amazon Redshift

  • Amazon Relational Database Service

  • Amazon ElastiCache

  • Amazon OpenSearch Service

Required: No

Type: Json

Update requires: No interruption

CostTypes

The types of costs that are included in this COST budget.

USAGE, RI_UTILIZATION, RI_COVERAGE, SAVINGS_PLANS_UTILIZATION, and SAVINGS_PLANS_COVERAGE budgets do not have CostTypes.

Required: No

Type: CostTypes

Update requires: No interruption

FilterExpression

Property description not available.

Required: No

Type: Expression

Update requires: No interruption

Metrics

Property description not available.

Required: No

Type: Array of String

Update requires: No interruption

PlannedBudgetLimits

A map containing multiple BudgetLimit, including current or future limits.

PlannedBudgetLimits is available for cost or usage budget and supports both monthly and quarterly TimeUnit.

For monthly budgets, provide 12 months of PlannedBudgetLimits values. This must start from the current month and include the next 11 months. The key is the start of the month, UTC in epoch seconds.

For quarterly budgets, provide four quarters of PlannedBudgetLimits value entries in standard calendar quarter increments. This must start from the current quarter and include the next three quarters. The key is the start of the quarter, UTC in epoch seconds.

If the planned budget expires before 12 months for monthly or four quarters for quarterly, provide the PlannedBudgetLimits values only for the remaining periods.

If the budget begins at a date in the future, provide PlannedBudgetLimits values from the start date of the budget.

After all of the BudgetLimit values in PlannedBudgetLimits are used, the budget continues to use the last limit as the BudgetLimit. At that point, the planned budget provides the same experience as a fixed budget.

DescribeBudget and DescribeBudgets response along with PlannedBudgetLimits also contain BudgetLimit representing the current month or quarter limit present in PlannedBudgetLimits. This only applies to budgets that are created with PlannedBudgetLimits. Budgets that are created without PlannedBudgetLimits only contain BudgetLimit. They don't contain PlannedBudgetLimits.

Required: No

Type: Json

Update requires: No interruption

TimePeriod

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.

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.

After the end date, AWS deletes the budget and all associated notifications and subscribers.

Required: No

Type: TimePeriod

Update requires: No interruption

TimeUnit

The length of time until a budget resets the actual and forecasted spend. DAILY is available only for RI_UTILIZATION and RI_COVERAGE budgets.

Required: Yes

Type: String

Allowed values: DAILY | MONTHLY | QUARTERLY | ANNUALLY | CUSTOM

Update requires: No interruption

Examples

Create a budget

The following example creates a budget and shows the format for the CostFilters parameter.

JSON

{
    "Budget": {
        "BudgetName": "Example S3 Usage Budget",
        "BudgetLimit": {
            "Amount": "100.0",
            "Unit": "GB"
        },
        "CostFilters": {
            "UsageType": [
                "APS1-APN1-AWS-Out-Bytes"
            ],
            "UsageTypeGroup": [
                "S3: Data Transfer - Region to Region (In)"
            ]
        },
        "CostTypes": {
            "IncludeTax": true,
            "IncludeSubscription": true,
            "UseBlended": false,
            "IncludeRefund": true,
            "IncludeCredit": true,
            "IncludeUpfront": true,
            "IncludeRecurring": true,
            "IncludeOtherSubscription": true,
            "IncludeSupport": true,
            "IncludeDiscount": true,
            "UseAmortized": false
        },
        "TimeUnit": "MONTHLY",
        "TimePeriod": {
            "Start": "2017-10-31T17:00:00-07:00",
            "End": "2087-06-14T17:00:00-07:00"
        },
        "CalculatedSpend": {
            "ActualSpend": {
                "Amount": "0.0",
                "Unit": "GB"
            }
        },
        "BudgetType": "USAGE"
    }
}

YAML

---
Budget:
  BudgetName: Example S3 Usage Budget
  BudgetLimit:
    Amount: '100.0'
    Unit: GB
  CostFilters:
    UsageType:
    - APS1-APN1-AWS-Out-Bytes
    UsageTypeGroup:
    - 'S3: Data Transfer - Region to Region (In)'
  CostTypes:
    IncludeTax: true
    IncludeSubscription: true
    UseBlended: false
    IncludeRefund: true
    IncludeCredit: true
    IncludeUpfront: true
    IncludeRecurring: true
    IncludeOtherSubscription: true
    IncludeSupport: true
    IncludeDiscount: true
    UseAmortized: false
  TimeUnit: MONTHLY
  TimePeriod:
    Start: '2017-10-31T17:00:00-07:00'
    End: '2087-06-14T17:00:00-07:00'
  CalculatedSpend:
    ActualSpend:
      Amount: '0.0'
      Unit: GB
  BudgetType: USAGE

See also

  • Budget in the AWS Cost Explorer Service Cost Management APIs