software.amazon.awssdk.services.budgets.model

Class Budget

java.lang.Object

software.amazon.awssdk.services.budgets.model.Budget

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Budget.Builder,Budget>

@Generated(value="software.amazon.awssdk:codegen")
public final class Budget
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Budget.Builder,Budget>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Budget.Builder

Method Summary

Modifier and Type	Method and Description
Spend	budgetLimit() The total amount of cost, usage, RI utilization, or RI coverage that you want to track with your budget.
String	budgetName() The name of a budget.
BudgetType	budgetType() Whether this budget tracks monetary costs, usage, RI utilization, or RI coverage.
String	budgetTypeAsString() Whether this budget tracks monetary costs, usage, RI utilization, or RI coverage.
static Budget.Builder	builder()
CalculatedSpend	calculatedSpend() The actual and forecasted cost or usage that the budget tracks.
Map<String,List<String>>	costFilters() The cost filters, such as service or region, that are applied to a budget.
CostTypes	costTypes() The types of costs that are included in this COST budget.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	lastUpdatedTime() The last time that you updated this budget.
List<SdkField<?>>	sdkFields()
static Class<? extends Budget.Builder>	serializableBuilderClass()
TimePeriod	timePeriod() The period of time that is covered by a budget.
TimeUnit	timeUnit() The length of time until a budget resets the actual and forecasted spend.
String	timeUnitAsString() The length of time until a budget resets the actual and forecasted spend.
Budget.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

budgetName

public String budgetName()

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.

budgetLimit

public 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.

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.

costFilters

public 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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

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

costTypes

public CostTypes costTypes()

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.

timeUnit

public 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.

If the service returns an enum value that is not available in the current SDK version, timeUnit will return TimeUnit.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from timeUnitAsString().

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

timeUnitAsString

public String timeUnitAsString()

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

If the service returns an enum value that is not available in the current SDK version, timeUnit will return TimeUnit.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from timeUnitAsString().

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

timePeriod

public 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.

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.

calculatedSpend

public CalculatedSpend calculatedSpend()

The actual and forecasted cost or usage that the budget tracks.

Returns:

The actual and forecasted cost or usage that the budget tracks.

budgetType

public BudgetType budgetType()

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

If the service returns an enum value that is not available in the current SDK version, budgetType will return BudgetType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from budgetTypeAsString().

Returns:

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

See Also:

BudgetType

budgetTypeAsString

public String budgetTypeAsString()

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

If the service returns an enum value that is not available in the current SDK version, budgetType will return BudgetType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from budgetTypeAsString().

Returns:

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

See Also:

BudgetType

lastUpdatedTime

public Instant lastUpdatedTime()

The last time that you updated this budget.

Returns:

The last time that you updated this budget.

toBuilder

public Budget.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<Budget.Builder,Budget>

Returns:

a builder for type T

builder

public static Budget.Builder builder()

serializableBuilderClass

public static Class<? extends Budget.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.