software.amazon.awscdk.services.budgets

Class CfnBudget

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.budgets.CfnBudget

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:16.188Z")
 @Stability(value=Stable)
public class CfnBudget
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Budgets::Budget`.

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

Nested Classes

Modifier and Type	Class and Description
static interface	CfnBudget.BudgetDataProperty Example:
static class	CfnBudget.Builder A fluent builder for CfnBudget.
static interface	CfnBudget.CostTypesProperty Example:
static interface	CfnBudget.NotificationProperty Example:
static interface	CfnBudget.NotificationWithSubscribersProperty Example:
static interface	CfnBudget.SpendProperty Example:
static interface	CfnBudget.SubscriberProperty Example:
static interface	CfnBudget.TimePeriodProperty Example:

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnBudget(software.constructs.Construct scope, String id, CfnBudgetProps props) Create a new `AWS::Budgets::Budget`.
protected	CfnBudget(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnBudget(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Object	getBudget() `AWS::Budgets::Budget.Budget`.
protected Map<String,Object>	getCfnProperties()
Object	getNotificationsWithSubscribers() `AWS::Budgets::Budget.NotificationsWithSubscribers`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setBudget(CfnBudget.BudgetDataProperty value) `AWS::Budgets::Budget.Budget`.
void	setBudget(IResolvable value) `AWS::Budgets::Budget.Budget`.
void	setNotificationsWithSubscribers(IResolvable value) `AWS::Budgets::Budget.NotificationsWithSubscribers`.
void	setNotificationsWithSubscribers(List<Object> value) `AWS::Budgets::Budget.NotificationsWithSubscribers`.

Methods inherited from class software.amazon.awscdk.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.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnBudget

protected CfnBudget(software.amazon.jsii.JsiiObjectRef objRef)

CfnBudget

protected CfnBudget(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnBudget

@Stability(value=Stable)
public CfnBudget(@NotNull
                                          software.constructs.Construct scope,
                                          @NotNull
                                          String id,
                                          @NotNull
                                          CfnBudgetProps props)

Create a new `AWS::Budgets::Budget`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getBudget

@Stability(value=Stable)
 @NotNull
public Object getBudget()

`AWS::Budgets::Budget.Budget`.

setBudget

@Stability(value=Stable)
public void setBudget(@NotNull
                                               CfnBudget.BudgetDataProperty value)

`AWS::Budgets::Budget.Budget`.

setBudget

@Stability(value=Stable)
public void setBudget(@NotNull
                                               IResolvable value)

`AWS::Budgets::Budget.Budget`.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getNotificationsWithSubscribers

@Stability(value=Stable)
 @Nullable
public Object getNotificationsWithSubscribers()

`AWS::Budgets::Budget.NotificationsWithSubscribers`.

setNotificationsWithSubscribers

@Stability(value=Stable)
public void setNotificationsWithSubscribers(@Nullable
                                                                     IResolvable value)

`AWS::Budgets::Budget.NotificationsWithSubscribers`.

setNotificationsWithSubscribers

@Stability(value=Stable)
public void setNotificationsWithSubscribers(@Nullable
                                                                     List<Object> value)

`AWS::Budgets::Budget.NotificationsWithSubscribers`.