com.amazonaws.services.budgets.model

Class Budget

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:budgetservice::AccountId:budget/budgetName

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Budget()

Method Summary

Modifier and Type	Method and Description
Budget	addCostFiltersEntry(String key, List<String> value)
Budget	clearCostFiltersEntries() Removes all the entries added into CostFilters.
Budget	clone()
boolean	equals(Object obj)
Spend	getBudgetLimit() The total amount of cost, usage, RI utilization, or RI coverage that you want to track with your budget.
String	getBudgetName() The name of a budget.
String	getBudgetType() Whether this budget tracks monetary costs, usage, RI utilization, or RI 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 region, 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.
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)
void	setBudgetLimit(Spend budgetLimit) The total amount of cost, usage, RI utilization, or RI 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 monetary costs, usage, RI utilization, or RI coverage.
void	setBudgetType(String budgetType) Whether this budget tracks monetary costs, usage, RI utilization, or RI 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 region, 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	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, or RI 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 monetary costs, usage, RI utilization, or RI coverage.
Budget	withBudgetType(String budgetType) Whether this budget tracks monetary costs, usage, RI utilization, or RI 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 region, 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	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

finalize, 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 accounts. The : and \ characters aren't allowed in BudgetName.

Parameters:

budgetName - The name of a budget. The name must be unique within accounts. The : and \ characters aren't allowed in BudgetName.

getBudgetName

public String getBudgetName()

The name of a budget. The name must be unique within accounts. The : and \ characters aren't allowed in BudgetName.

Returns:

The name of a budget. The name must be unique within accounts. 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 accounts. The : and \ characters aren't allowed in BudgetName.

Parameters:

budgetName - The name of a budget. The name must be unique within accounts. 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, or RI coverage that you want to track with your budget.

BudgetLimit is required for cost or usage budgets, but optional for RI utilization or coverage budgets. RI utilization or coverage budgets default to 100, which is the only valid value for RI utilization or coverage budgets.

Parameters:

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

BudgetLimit is required for cost or usage budgets, but optional for RI utilization or coverage budgets. RI utilization or coverage budgets default to 100, which is the only valid value for RI utilization or coverage budgets.

getBudgetLimit

public Spend getBudgetLimit()

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

BudgetLimit is required for cost or usage budgets, but optional for RI utilization or coverage budgets. RI utilization or coverage budgets default to 100, which is the only valid value for RI utilization or coverage budgets.

Returns:

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

BudgetLimit is required for cost or usage budgets, but optional for RI utilization or coverage budgets. RI utilization or coverage budgets default to 100, which is the only valid value for RI utilization or coverage budgets.

withBudgetLimit

public Budget withBudgetLimit(Spend budgetLimit)

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

BudgetLimit is required for cost or usage budgets, but optional for RI utilization or coverage budgets. RI utilization or coverage budgets default to 100, which is the only valid value for RI utilization or coverage budgets.

Parameters:

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

BudgetLimit is required for cost or usage budgets, but optional for RI utilization or coverage budgets. RI utilization or coverage budgets default to 100, which is the only valid value for RI utilization or coverage budgets.

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 region, 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 region, 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 region, 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 region, 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 region, 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 region, 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)

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, and RI_COVERAGE budgets do not have CostTypes.

Parameters:

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

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

getCostTypes

public CostTypes getCostTypes()

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

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

Returns:

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

USAGE, RI_UTILIZATION, and RI_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, and RI_COVERAGE budgets do not have CostTypes.

Parameters:

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

USAGE, RI_UTILIZATION, and RI_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. DAILY is available only for RI_UTILIZATION and RI_COVERAGE budgets.

Parameters:

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.

See Also:

TimeUnit

getTimeUnit

public String getTimeUnit()

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

Returns:

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

See Also:

TimeUnit

withTimeUnit

public Budget withTimeUnit(String 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.

Parameters:

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.

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. DAILY is available only for RI_UTILIZATION and RI_COVERAGE budgets.

Parameters:

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.

See Also:

TimeUnit

withTimeUnit

public Budget withTimeUnit(TimeUnit 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.

Parameters:

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.

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 monetary costs, usage, RI utilization, or RI coverage.

Parameters:

budgetType - Whether this budget tracks monetary costs, usage, RI utilization, or RI coverage.

See Also:

BudgetType

getBudgetType

public String getBudgetType()

Whether this budget tracks monetary costs, usage, RI utilization, or RI coverage.

Returns:

Whether this budget tracks monetary costs, usage, RI utilization, or RI coverage.

See Also:

BudgetType

withBudgetType

public Budget withBudgetType(String budgetType)

Whether this budget tracks monetary costs, usage, RI utilization, or RI coverage.

Parameters:

budgetType - Whether this budget tracks monetary costs, usage, RI utilization, or RI 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 monetary costs, usage, RI utilization, or RI coverage.

Parameters:

budgetType - Whether this budget tracks monetary costs, usage, RI utilization, or RI coverage.

See Also:

BudgetType

withBudgetType

public Budget withBudgetType(BudgetType budgetType)

Whether this budget tracks monetary costs, usage, RI utilization, or RI coverage.

Parameters:

budgetType - Whether this budget tracks monetary costs, usage, RI utilization, or RI 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)

Specified by:

marshall in interface StructuredPojo