Budget (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.budgets.model.Budget

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Budget
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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 ARN pattern for a budget:

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

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

Budget()

Constructors
Constructor and Description
`Budget()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Budget`	`addCostFiltersEntry(String key, List<String> value)` Add a single CostFilters entry
`Budget`	`addPlannedBudgetLimitsEntry(String key, Spend value)` Add a single PlannedBudgetLimits entry
`Budget`	`clearCostFiltersEntries()` Removes all the entries added into CostFilters.
`Budget`	`clearPlannedBudgetLimitsEntries()` Removes all the entries added into PlannedBudgetLimits.
`Budget`	`clone()`
`boolean`	`equals(Object obj)`
`Spend`	`getBudgetLimit()` 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.
`String`	`getBudgetName()` The name of a budget.
`String`	`getBudgetType()` Whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.
`CalculatedSpend`	`getCalculatedSpend()` The actual and forecasted cost or usage that the budget tracks.
`Map<String,List<String>>`	`getCostFilters()` The cost filters, such as service or tag, that are applied to a budget.
`CostTypes`	`getCostTypes()` The types of costs that are included in this `COST` budget.
`Date`	`getLastUpdatedTime()` The last time that you updated this budget.
`Map<String,Spend>`	`getPlannedBudgetLimits()` A map containing multiple `BudgetLimit`, including current or future limits.
`TimePeriod`	`getTimePeriod()` The period of time that is covered by a budget.
`String`	`getTimeUnit()` The length of time until a budget resets the actual and forecasted spend.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setBudgetLimit(Spend 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.
`void`	`setBudgetName(String budgetName)` The name of a budget.
`void`	`setBudgetType(BudgetType budgetType)` Whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.
`void`	`setBudgetType(String budgetType)` Whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.
`void`	`setCalculatedSpend(CalculatedSpend calculatedSpend)` The actual and forecasted cost or usage that the budget tracks.
`void`	`setCostFilters(Map<String,List<String>> costFilters)` The cost filters, such as service or tag, that are applied to a budget.
`void`	`setCostTypes(CostTypes costTypes)` The types of costs that are included in this `COST` budget.
`void`	`setLastUpdatedTime(Date lastUpdatedTime)` The last time that you updated this budget.
`void`	`setPlannedBudgetLimits(Map<String,Spend> plannedBudgetLimits)` A map containing multiple `BudgetLimit`, including current or future limits.
`void`	`setTimePeriod(TimePeriod timePeriod)` The period of time that is covered by a budget.
`void`	`setTimeUnit(String timeUnit)` The length of time until a budget resets the actual and forecasted spend.
`void`	`setTimeUnit(TimeUnit timeUnit)` The length of time until a budget resets the actual and forecasted spend.
`String`	`toString()` Returns a string representation of this object.
`Budget`	`withBudgetLimit(Spend 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.
`Budget`	`withBudgetName(String budgetName)` The name of a budget.
`Budget`	`withBudgetType(BudgetType budgetType)` Whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.
`Budget`	`withBudgetType(String budgetType)` Whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.
`Budget`	`withCalculatedSpend(CalculatedSpend calculatedSpend)` The actual and forecasted cost or usage that the budget tracks.
`Budget`	`withCostFilters(Map<String,List<String>> costFilters)` The cost filters, such as service or tag, that are applied to a budget.
`Budget`	`withCostTypes(CostTypes costTypes)` The types of costs that are included in this `COST` budget.
`Budget`	`withLastUpdatedTime(Date lastUpdatedTime)` The last time that you updated this budget.
`Budget`	`withPlannedBudgetLimits(Map<String,Spend> plannedBudgetLimits)` A map containing multiple `BudgetLimit`, including current or future limits.
`Budget`	`withTimePeriod(TimePeriod timePeriod)` The period of time that is covered by a budget.
`Budget`	`withTimeUnit(String timeUnit)` The length of time until a budget resets the actual and forecasted spend.
`Budget`	`withTimeUnit(TimeUnit timeUnit)` The length of time until a budget resets the actual and forecasted spend.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Budget
```
public Budget()
```
- Method Detail
  - setBudgetName
```
public void setBudgetName(String budgetName)
```
    The name of a budget. The name must be unique within an account. The : and \ characters aren't allowed in BudgetName.
    
    Parameters:
    
    budgetName - The name of a budget. The name must be unique within an account. The : and \ characters aren't allowed in BudgetName.
  - getBudgetName
```
public String getBudgetName()
```
    The name of a budget. The name must be unique within an account. The : and \ characters aren't allowed in BudgetName.
    
    Returns:
    
    The name of a budget. The name must be unique within an account. The : and \ characters aren't allowed in BudgetName.
  - withBudgetName
```
public Budget withBudgetName(String budgetName)
```
    The name of a budget. The name must be unique within an account. The : and \ characters aren't allowed in BudgetName.
    
    Parameters:
    
    budgetName - The name of a budget. The name must be unique within an account. The : and \ characters aren't allowed in BudgetName.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBudgetLimit
```
public void setBudgetLimit(Spend 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, which 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.
    
    Parameters:
    
    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, which 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.
  - getBudgetLimit
```
public Spend getBudgetLimit()
```
    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, which 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.
    
    Returns:
    
    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, which 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.
  - withBudgetLimit
```
public Budget withBudgetLimit(Spend 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, which 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.
    
    Parameters:
    
    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, which 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getPlannedBudgetLimits
```
public Map<String,Spend> getPlannedBudgetLimits()
```
    A map containing multiple BudgetLimit, including current or future limits.
    
    PlannedBudgetLimits is available for cost or usage budget and supports 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 4 quarters of PlannedBudgetLimits value entries in standard calendar quarter increments. This must start from the current quarter and include the next 3 quarters. The key is the start of the quarter, UTC in epoch seconds.
    
    If the planned budget expires before 12 months for monthly or 4 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 will also contain BudgetLimit representing the current month or quarter limit present in PlannedBudgetLimits. This only applies to budgets created with PlannedBudgetLimits. Budgets created without PlannedBudgetLimits will only contain BudgetLimit, and no PlannedBudgetLimits.
    
    Returns:
    
    A map containing multiple BudgetLimit, including current or future limits.
    
    PlannedBudgetLimits is available for cost or usage budget and supports 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 4 quarters of PlannedBudgetLimits value entries in standard calendar quarter increments. This must start from the current quarter and include the next 3 quarters. The key is the start of the quarter, UTC in epoch seconds.
    
    If the planned budget expires before 12 months for monthly or 4 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 will also contain BudgetLimit representing the current month or quarter limit present in PlannedBudgetLimits. This only applies to budgets created with PlannedBudgetLimits. Budgets created without PlannedBudgetLimits will only contain BudgetLimit, and no PlannedBudgetLimits.
  - setPlannedBudgetLimits
```
public void setPlannedBudgetLimits(Map<String,Spend> plannedBudgetLimits)
```
    A map containing multiple BudgetLimit, including current or future limits.
    
    PlannedBudgetLimits is available for cost or usage budget and supports 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 4 quarters of PlannedBudgetLimits value entries in standard calendar quarter increments. This must start from the current quarter and include the next 3 quarters. The key is the start of the quarter, UTC in epoch seconds.
    
    If the planned budget expires before 12 months for monthly or 4 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 will also contain BudgetLimit representing the current month or quarter limit present in PlannedBudgetLimits. This only applies to budgets created with PlannedBudgetLimits. Budgets created without PlannedBudgetLimits will only contain BudgetLimit, and no PlannedBudgetLimits.
    
    Parameters:
    
    plannedBudgetLimits - A map containing multiple BudgetLimit, including current or future limits.
    
    PlannedBudgetLimits is available for cost or usage budget and supports 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 4 quarters of PlannedBudgetLimits value entries in standard calendar quarter increments. This must start from the current quarter and include the next 3 quarters. The key is the start of the quarter, UTC in epoch seconds.
    
    If the planned budget expires before 12 months for monthly or 4 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 will also contain BudgetLimit representing the current month or quarter limit present in PlannedBudgetLimits. This only applies to budgets created with PlannedBudgetLimits. Budgets created without PlannedBudgetLimits will only contain BudgetLimit, and no PlannedBudgetLimits.
  - withPlannedBudgetLimits
```
public Budget withPlannedBudgetLimits(Map<String,Spend> plannedBudgetLimits)
```
    A map containing multiple BudgetLimit, including current or future limits.
    
    PlannedBudgetLimits is available for cost or usage budget and supports 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 4 quarters of PlannedBudgetLimits value entries in standard calendar quarter increments. This must start from the current quarter and include the next 3 quarters. The key is the start of the quarter, UTC in epoch seconds.
    
    If the planned budget expires before 12 months for monthly or 4 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 will also contain BudgetLimit representing the current month or quarter limit present in PlannedBudgetLimits. This only applies to budgets created with PlannedBudgetLimits. Budgets created without PlannedBudgetLimits will only contain BudgetLimit, and no PlannedBudgetLimits.
    
    Parameters:
    
    plannedBudgetLimits - A map containing multiple BudgetLimit, including current or future limits.
    
    PlannedBudgetLimits is available for cost or usage budget and supports 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 4 quarters of PlannedBudgetLimits value entries in standard calendar quarter increments. This must start from the current quarter and include the next 3 quarters. The key is the start of the quarter, UTC in epoch seconds.
    
    If the planned budget expires before 12 months for monthly or 4 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 will also contain BudgetLimit representing the current month or quarter limit present in PlannedBudgetLimits. This only applies to budgets created with PlannedBudgetLimits. Budgets created without PlannedBudgetLimits will only contain BudgetLimit, and no PlannedBudgetLimits.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addPlannedBudgetLimitsEntry
```
public Budget addPlannedBudgetLimitsEntry(String key,
                                          Spend value)
```
    Add a single PlannedBudgetLimits entry
    
    See Also:
    
    withPlannedBudgetLimits(java.util.Map<java.lang.String, com.amazonaws.services.budgets.model.Spend>)
  - clearPlannedBudgetLimitsEntries
```
public Budget clearPlannedBudgetLimitsEntries()
```
    Removes all the entries added into PlannedBudgetLimits.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getCostFilters
```
public Map<String,List<String>> getCostFilters()
```
    The cost filters, such as service or tag, that are applied to a budget.
    
    AWS Budgets supports the following services as a filter for RI budgets:
    - Amazon Elastic Compute Cloud - Compute
    - Amazon Redshift
    - Amazon Relational Database Service
    - Amazon ElastiCache
    - Amazon Elasticsearch Service
    Returns:
    The cost filters, such as service or tag, that are applied to a budget.
    
    AWS Budgets supports the following services as a filter for RI budgets:
    
    Amazon Elastic Compute Cloud - Compute
    
    Amazon Redshift
    
    Amazon Relational Database Service
    
    Amazon ElastiCache
    
    Amazon Elasticsearch Service
  - setCostFilters
```
public void setCostFilters(Map<String,List<String>> costFilters)
```
    The cost filters, such as service or tag, that are applied to a budget.
    
    AWS Budgets supports the following services as a filter for RI budgets:
    - Amazon Elastic Compute Cloud - Compute
    - Amazon Redshift
    - Amazon Relational Database Service
    - Amazon ElastiCache
    - Amazon Elasticsearch Service
    Parameters:
    costFilters - The cost filters, such as service or tag, that are applied to a budget.
    
    AWS Budgets supports the following services as a filter for RI budgets:
    
    Amazon Elastic Compute Cloud - Compute
    
    Amazon Redshift
    
    Amazon Relational Database Service
    
    Amazon ElastiCache
    
    Amazon Elasticsearch Service
  - withCostFilters
```
public Budget withCostFilters(Map<String,List<String>> costFilters)
```
    The cost filters, such as service or tag, that are applied to a budget.
    
    AWS Budgets supports the following services as a filter for RI budgets:
    - Amazon Elastic Compute Cloud - Compute
    - Amazon Redshift
    - Amazon Relational Database Service
    - Amazon ElastiCache
    - Amazon Elasticsearch Service
    Parameters:
    costFilters - The cost filters, such as service or tag, that are applied to a budget.
    
    AWS Budgets supports the following services as a filter for RI budgets:
    
    Amazon Elastic Compute Cloud - Compute
    
    Amazon Redshift
    
    Amazon Relational Database Service
    
    Amazon ElastiCache
    
    Amazon Elasticsearch Service
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addCostFiltersEntry
```
public Budget addCostFiltersEntry(String key,
                                  List<String> value)
```
    Add a single CostFilters entry
    
    See Also:
    
    withCostFilters(java.util.Map<java.lang.String, java.util.List<java.lang.String>>)
  - clearCostFiltersEntries
```
public Budget clearCostFiltersEntries()
```
    Removes all the entries added into CostFilters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCostTypes
```
public void setCostTypes(CostTypes 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.
    
    Parameters:
    
    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.
  - getCostTypes
```
public CostTypes getCostTypes()
```
    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.
    
    Returns:
    
    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.
  - withCostTypes
```
public Budget withCostTypes(CostTypes 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTimeUnit
```
public void setTimeUnit(String timeUnit)
```
    The length of time until a budget resets the actual and forecasted spend.
    
    Parameters:
    
    timeUnit - The length of time until a budget resets the actual and forecasted spend.
    
    See Also:
    
    TimeUnit
  - getTimeUnit
```
public String getTimeUnit()
```
    The length of time until a budget resets the actual and forecasted spend.
    
    Returns:
    
    The length of time until a budget resets the actual and forecasted spend.
    
    See Also:
    
    TimeUnit
  - withTimeUnit
```
public Budget withTimeUnit(String timeUnit)
```
    The length of time until a budget resets the actual and forecasted spend.
    
    Parameters:
    
    timeUnit - The length of time until a budget resets the actual and forecasted spend.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TimeUnit
  - setTimeUnit
```
public void setTimeUnit(TimeUnit timeUnit)
```
    The length of time until a budget resets the actual and forecasted spend.
    
    Parameters:
    
    timeUnit - The length of time until a budget resets the actual and forecasted spend.
    
    See Also:
    
    TimeUnit
  - withTimeUnit
```
public Budget withTimeUnit(TimeUnit timeUnit)
```
    The length of time until a budget resets the actual and forecasted spend.
    
    Parameters:
    
    timeUnit - The length of time until a budget resets the actual and forecasted spend.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TimeUnit
  - setTimePeriod
```
public void setTimePeriod(TimePeriod 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. The end date must come before 06/15/87 00:00 UTC.
    
    If you create your budget and don't specify a start date, AWS defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose DAILY, and didn't set a start date, AWS set your start date to 01/24/18 00:00 UTC. If you chose MONTHLY, AWS set your start date to 01/01/18 00:00 UTC. 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.
    
    You can change either date with the UpdateBudget operation.
    
    After the end date, AWS deletes the budget and all associated notifications and subscribers.
    
    Parameters:
    
    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. The end date must come before 06/15/87 00:00 UTC.
    
    If you create your budget and don't specify a start date, AWS defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose DAILY, and didn't set a start date, AWS set your start date to 01/24/18 00:00 UTC. If you chose MONTHLY, AWS set your start date to 01/01/18 00:00 UTC. 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.
    
    You can change either date with the UpdateBudget operation.
    
    After the end date, AWS deletes the budget and all associated notifications and subscribers.
  - getTimePeriod
```
public TimePeriod getTimePeriod()
```
    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. The end date must come before 06/15/87 00:00 UTC.
    
    If you create your budget and don't specify a start date, AWS defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose DAILY, and didn't set a start date, AWS set your start date to 01/24/18 00:00 UTC. If you chose MONTHLY, AWS set your start date to 01/01/18 00:00 UTC. 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.
    
    You can change either date with the UpdateBudget operation.
    
    After the end date, AWS deletes the budget and all associated notifications and subscribers.
    
    Returns:
    
    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. The end date must come before 06/15/87 00:00 UTC.
    
    If you create your budget and don't specify a start date, AWS defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose DAILY, and didn't set a start date, AWS set your start date to 01/24/18 00:00 UTC. If you chose MONTHLY, AWS set your start date to 01/01/18 00:00 UTC. 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.
    
    You can change either date with the UpdateBudget operation.
    
    After the end date, AWS deletes the budget and all associated notifications and subscribers.
  - withTimePeriod
```
public Budget withTimePeriod(TimePeriod 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. The end date must come before 06/15/87 00:00 UTC.
    
    If you create your budget and don't specify a start date, AWS defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose DAILY, and didn't set a start date, AWS set your start date to 01/24/18 00:00 UTC. If you chose MONTHLY, AWS set your start date to 01/01/18 00:00 UTC. 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.
    
    You can change either date with the UpdateBudget operation.
    
    After the end date, AWS deletes the budget and all associated notifications and subscribers.
    
    Parameters:
    
    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. The end date must come before 06/15/87 00:00 UTC.
    
    If you create your budget and don't specify a start date, AWS defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose DAILY, and didn't set a start date, AWS set your start date to 01/24/18 00:00 UTC. If you chose MONTHLY, AWS set your start date to 01/01/18 00:00 UTC. 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.
    
    You can change either date with the UpdateBudget operation.
    
    After the end date, AWS deletes the budget and all associated notifications and subscribers.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCalculatedSpend
```
public void setCalculatedSpend(CalculatedSpend calculatedSpend)
```
    The actual and forecasted cost or usage that the budget tracks.
    
    Parameters:
    
    calculatedSpend - The actual and forecasted cost or usage that the budget tracks.
  - getCalculatedSpend
```
public CalculatedSpend getCalculatedSpend()
```
    The actual and forecasted cost or usage that the budget tracks.
    
    Returns:
    
    The actual and forecasted cost or usage that the budget tracks.
  - withCalculatedSpend
```
public Budget withCalculatedSpend(CalculatedSpend calculatedSpend)
```
    The actual and forecasted cost or usage that the budget tracks.
    
    Parameters:
    
    calculatedSpend - The actual and forecasted cost or usage that the budget tracks.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBudgetType
```
public void setBudgetType(String budgetType)
```
    Whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.
    
    Parameters:
    
    budgetType - Whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.
    
    See Also:
    
    BudgetType
  - getBudgetType
```
public String getBudgetType()
```
    Whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.
    
    Returns:
    
    Whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.
    
    See Also:
    
    BudgetType
  - withBudgetType
```
public Budget withBudgetType(String budgetType)
```
    Whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.
    
    Parameters:
    
    budgetType - Whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BudgetType
  - setBudgetType
```
public void setBudgetType(BudgetType budgetType)
```
    Whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.
    
    Parameters:
    
    budgetType - Whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.
    
    See Also:
    
    BudgetType
  - withBudgetType
```
public Budget withBudgetType(BudgetType budgetType)
```
    Whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.
    
    Parameters:
    
    budgetType - Whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BudgetType
  - setLastUpdatedTime
```
public void setLastUpdatedTime(Date lastUpdatedTime)
```
    The last time that you updated this budget.
    
    Parameters:
    
    lastUpdatedTime - The last time that you updated this budget.
  - getLastUpdatedTime
```
public Date getLastUpdatedTime()
```
    The last time that you updated this budget.
    
    Returns:
    
    The last time that you updated this budget.
  - withLastUpdatedTime
```
public Budget withLastUpdatedTime(Date lastUpdatedTime)
```
    The last time that you updated this budget.
    
    Parameters:
    
    lastUpdatedTime - The last time that you updated this budget.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Budget clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Budget

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Budget

Method Detail

setBudgetName

getBudgetName

withBudgetName

setBudgetLimit

getBudgetLimit

withBudgetLimit

getPlannedBudgetLimits

setPlannedBudgetLimits

withPlannedBudgetLimits

addPlannedBudgetLimitsEntry

clearPlannedBudgetLimitsEntries

getCostFilters

setCostFilters

withCostFilters

addCostFiltersEntry

clearCostFiltersEntries

setCostTypes

getCostTypes

withCostTypes

setTimeUnit

getTimeUnit

withTimeUnit

setTimeUnit

withTimeUnit

setTimePeriod

getTimePeriod

withTimePeriod

setCalculatedSpend

getCalculatedSpend

withCalculatedSpend

setBudgetType

getBudgetType

withBudgetType

setBudgetType

withBudgetType

setLastUpdatedTime

getLastUpdatedTime

withLastUpdatedTime

toString

equals

hashCode

clone

marshall