Class CfnBudget
- All Implemented Interfaces:
IConstruct
,IDependable
,IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
AWS::Budgets::Budget
.
The AWS::Budgets::Budget
resource allows customers to take pre-defined actions that will trigger once a budget threshold has been exceeded. creates, replaces, or deletes budgets for Billing and Cost Management. For more information, see Managing Your Costs with Budgets in the AWS Billing and Cost Management User Guide .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.budgets.*; Object costFilters; Object plannedBudgetLimits; CfnBudget cfnBudget = CfnBudget.Builder.create(this, "MyCfnBudget") .budget(BudgetDataProperty.builder() .budgetType("budgetType") .timeUnit("timeUnit") // the properties below are optional .autoAdjustData(AutoAdjustDataProperty.builder() .autoAdjustType("autoAdjustType") // the properties below are optional .historicalOptions(HistoricalOptionsProperty.builder() .budgetAdjustmentPeriod(123) .build()) .build()) .budgetLimit(SpendProperty.builder() .amount(123) .unit("unit") .build()) .budgetName("budgetName") .costFilters(costFilters) .costTypes(CostTypesProperty.builder() .includeCredit(false) .includeDiscount(false) .includeOtherSubscription(false) .includeRecurring(false) .includeRefund(false) .includeSubscription(false) .includeSupport(false) .includeTax(false) .includeUpfront(false) .useAmortized(false) .useBlended(false) .build()) .plannedBudgetLimits(plannedBudgetLimits) .timePeriod(TimePeriodProperty.builder() .end("end") .start("start") .build()) .build()) // the properties below are optional .notificationsWithSubscribers(List.of(NotificationWithSubscribersProperty.builder() .notification(NotificationProperty.builder() .comparisonOperator("comparisonOperator") .notificationType("notificationType") .threshold(123) // the properties below are optional .thresholdType("thresholdType") .build()) .subscribers(List.of(SubscriberProperty.builder() .address("address") .subscriptionType("subscriptionType") .build())) .build())) .build();
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
Example:static interface
Represents the output of theCreateBudget
operation.static final class
A fluent builder forCfnBudget
.static interface
The types of cost that are included in aCOST
budget, such as tax and subscriptions.static interface
Example:static interface
A notification that's associated with a budget.static interface
A notification with subscribers.static interface
The amount of cost or usage that's measured for a budget.static interface
TheSubscriber
property type specifies who to notify for a Billing and Cost Management budget notification.static interface
The period of time that is covered by a budget.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionThe budget object that you want to create.A notification that you want to associate with a budget.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setBudget
(IResolvable value) The budget object that you want to create.void
The budget object that you want to create.void
A notification that you want to associate with a budget.void
A notification that you want to associate with a budget.Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnBudget
protected CfnBudget(software.amazon.jsii.JsiiObjectRef objRef) -
CfnBudget
protected CfnBudget(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnBudget
@Stability(Stable) public CfnBudget(@NotNull Construct scope, @NotNull String id, @NotNull CfnBudgetProps props) Create a newAWS::Budgets::Budget
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
props
-- resource properties.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
-- tree inspector to collect and process attributes.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getBudget
The budget object that you want to create. -
setBudget
The budget object that you want to create. -
setBudget
The budget object that you want to create. -
getNotificationsWithSubscribers
A notification that you want to associate with a budget.A budget can have up to five notifications, and each notification can have one SNS subscriber and up to 10 email subscribers. If you include notifications and subscribers in your
CreateBudget
call, AWS creates the notifications and subscribers for you. -
setNotificationsWithSubscribers
A notification that you want to associate with a budget.A budget can have up to five notifications, and each notification can have one SNS subscriber and up to 10 email subscribers. If you include notifications and subscribers in your
CreateBudget
call, AWS creates the notifications and subscribers for you. -
setNotificationsWithSubscribers
A notification that you want to associate with a budget.A budget can have up to five notifications, and each notification can have one SNS subscriber and up to 10 email subscribers. If you include notifications and subscribers in your
CreateBudget
call, AWS creates the notifications and subscribers for you.
-