Class CfnBudget.BudgetDataProperty
Represents the output of the CreateBudget
operation.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Budgets
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class BudgetDataProperty : Object, CfnBudget.IBudgetDataProperty
Syntax (vb)
Public Class BudgetDataProperty
Inherits Object
Implements CfnBudget.IBudgetDataProperty
Remarks
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
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Budgets;
var costFilters;
var plannedBudgetLimits;
var budgetDataProperty = new BudgetDataProperty {
BudgetType = "budgetType",
TimeUnit = "timeUnit",
// the properties below are optional
AutoAdjustData = new AutoAdjustDataProperty {
AutoAdjustType = "autoAdjustType",
// the properties below are optional
HistoricalOptions = new HistoricalOptionsProperty {
BudgetAdjustmentPeriod = 123
}
},
BudgetLimit = new SpendProperty {
Amount = 123,
Unit = "unit"
},
BudgetName = "budgetName",
CostFilters = costFilters,
CostTypes = new CostTypesProperty {
IncludeCredit = false,
IncludeDiscount = false,
IncludeOtherSubscription = false,
IncludeRecurring = false,
IncludeRefund = false,
IncludeSubscription = false,
IncludeSupport = false,
IncludeTax = false,
IncludeUpfront = false,
UseAmortized = false,
UseBlended = false
},
PlannedBudgetLimits = plannedBudgetLimits,
TimePeriod = new TimePeriodProperty {
End = "end",
Start = "start"
}
};
Synopsis
Constructors
BudgetDataProperty() |
Properties
AutoAdjustData | Determine the budget amount for an auto-adjusting budget. |
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. |
BudgetName | The name of a budget. |
BudgetType | Specifies whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage. |
CostFilters | The cost filters, such as |
CostTypes | The types of costs that are included in this |
PlannedBudgetLimits | A map containing multiple |
TimePeriod | The period of time that is covered by a budget. |
TimeUnit | The length of time until a budget resets the actual and forecasted spend. |
Constructors
BudgetDataProperty()
public BudgetDataProperty()
Properties
AutoAdjustData
Determine the budget amount for an auto-adjusting budget.
public object AutoAdjustData { get; set; }
Property Value
System.Object
Remarks
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.
public object BudgetLimit { get; set; }
Property Value
System.Object
Remarks
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.
BudgetName
The name of a budget.
public string BudgetName { get; set; }
Property Value
System.String
Remarks
The value must be unique within an account.
BudgetName
can't include :
and </code> characters. If you don't include value for
BudgetName
in the template, Billing and Cost Management assigns your budget a randomly generated name.
BudgetType
Specifies whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.
public string BudgetType { get; set; }
Property Value
System.String
Remarks
CostFilters
The cost filters, such as Region
, Service
, LinkedAccount
, Tag
, or CostCategory
, that are applied to a budget.
public object CostFilters { get; set; }
Property Value
System.Object
Remarks
AWS Budgets supports the following services as a Service
filter for RI budgets:
CostTypes
The types of costs that are included in this COST
budget.
public object CostTypes { get; set; }
Property Value
System.Object
Remarks
USAGE
, RI_UTILIZATION
, RI_COVERAGE
, SAVINGS_PLANS_UTILIZATION
, and SAVINGS_PLANS_COVERAGE
budgets do not have CostTypes
.
PlannedBudgetLimits
A map containing multiple BudgetLimit
, including current or future limits.
public object PlannedBudgetLimits { get; set; }
Property Value
System.Object
Remarks
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
.
TimePeriod
The period of time that is covered by a budget.
public object TimePeriod { get; set; }
Property Value
System.Object
Remarks
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.
TimeUnit
The length of time until a budget resets the actual and forecasted spend.
public string TimeUnit { get; set; }
Property Value
System.String
Remarks
DAILY
is available only for RI_UTILIZATION
and RI_COVERAGE
budgets.