This documentation is for the developer preview release of the AWS CDK. Do not use this version of the AWS CDK in production. Subsequent releases of the AWS CDK will likely include breaking changes.

@aws-cdk/aws-budgets

The CDK Construct Library for AWS Budgets

This module is part of the AWS Cloud Development Kit project.

Reference

View in Nuget

csproj:

<PackageReference Include="Amazon.CDK.AWS.Budgets" Version="0.25.3" />

dotnet:

dotnet add package Amazon.CDK.AWS.Budgets --version 0.25.3

packages.config:

<package id="Amazon.CDK.AWS.Budgets" version="0.25.3" />

View in Maven Central

Apache Buildr:

'software.amazon.awscdk:budgets:jar:0.25.3'

Apache Ivy:

<dependency groupId="software.amazon.awscdk" name="budgets" rev="0.25.3"/>

Apache Maven:

<dependency>
  <groupId>software.amazon.awscdk</groupId>
  <artifactId>budgets</artifactId>
  <version>0.25.3</version>
</dependency>

Gradle / Grails:

compile 'software.amazon.awscdk:budgets:0.25.3'

Groovy Grape:

@Grapes(
@Grab(group='software.amazon.awscdk', module='budgets', version='0.25.3')
)

View in NPM

npm:

$ npm i @aws-cdk/aws-budgets@0.25.3

package.json:

{
  "@aws-cdk/aws-budgets": "^0.25.3"
}

yarn:

$ yarn add @aws-cdk/aws-budgets@0.25.3

View in NPM

npm:

$ npm i @aws-cdk/aws-budgets@0.25.3

package.json:

{
  "@aws-cdk/aws-budgets": "^0.25.3"
}

yarn:

$ yarn add @aws-cdk/aws-budgets@0.25.3

CfnBudget

class @aws-cdk/aws-budgets.CfnBudget(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.Budgets;
import software.amazon.awscdk.services.budgets.CfnBudget;
const { CfnBudget } = require('@aws-cdk/aws-budgets');
import { CfnBudget } from '@aws-cdk/aws-budgets';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
budgetName
Type:string (readonly)
propertyOverrides
Type:CfnBudgetProps (readonly)
class BudgetDataProperty

Language-specific names:

using Amazon.CDK.AWS.Budgets;
import software.amazon.awscdk.services.budgets.CfnBudget.BudgetDataProperty;
// CfnBudget.BudgetDataProperty is an interface
import { CfnBudget.BudgetDataProperty } from '@aws-cdk/aws-budgets';
budgetType

CfnBudget.BudgetDataProperty.BudgetType

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-budgetdata.html#cfn-budgets-budget-budgetdata-budgettype

Type:string
timeUnit

CfnBudget.BudgetDataProperty.TimeUnit

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-budgetdata.html#cfn-budgets-budget-budgetdata-timeunit

Type:string
budgetLimit

CfnBudget.BudgetDataProperty.BudgetLimit

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-budgetdata.html#cfn-budgets-budget-budgetdata-budgetlimit

Type:@aws-cdk/cdk.Token or SpendProperty (optional)
budgetName

CfnBudget.BudgetDataProperty.BudgetName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-budgetdata.html#cfn-budgets-budget-budgetdata-budgetname

Type:string (optional)
costFilters

CfnBudget.BudgetDataProperty.CostFilters

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-budgetdata.html#cfn-budgets-budget-budgetdata-costfilters

Type:json or @aws-cdk/cdk.Token (optional)
costTypes

CfnBudget.BudgetDataProperty.CostTypes

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-budgetdata.html#cfn-budgets-budget-budgetdata-costtypes

Type:@aws-cdk/cdk.Token or CostTypesProperty (optional)
timePeriod

CfnBudget.BudgetDataProperty.TimePeriod

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-budgetdata.html#cfn-budgets-budget-budgetdata-timeperiod

Type:@aws-cdk/cdk.Token or TimePeriodProperty (optional)
class CostTypesProperty

Language-specific names:

using Amazon.CDK.AWS.Budgets;
import software.amazon.awscdk.services.budgets.CfnBudget.CostTypesProperty;
// CfnBudget.CostTypesProperty is an interface
import { CfnBudget.CostTypesProperty } from '@aws-cdk/aws-budgets';
includeCredit

CfnBudget.CostTypesProperty.IncludeCredit

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costtypes.html#cfn-budgets-budget-costtypes-includecredit

Type:boolean or @aws-cdk/cdk.Token (optional)
includeDiscount

CfnBudget.CostTypesProperty.IncludeDiscount

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costtypes.html#cfn-budgets-budget-costtypes-includediscount

Type:boolean or @aws-cdk/cdk.Token (optional)
includeOtherSubscription

CfnBudget.CostTypesProperty.IncludeOtherSubscription

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costtypes.html#cfn-budgets-budget-costtypes-includeothersubscription

Type:boolean or @aws-cdk/cdk.Token (optional)
includeRecurring

CfnBudget.CostTypesProperty.IncludeRecurring

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costtypes.html#cfn-budgets-budget-costtypes-includerecurring

Type:boolean or @aws-cdk/cdk.Token (optional)
includeRefund

CfnBudget.CostTypesProperty.IncludeRefund

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costtypes.html#cfn-budgets-budget-costtypes-includerefund

Type:boolean or @aws-cdk/cdk.Token (optional)
includeSubscription

CfnBudget.CostTypesProperty.IncludeSubscription

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costtypes.html#cfn-budgets-budget-costtypes-includesubscription

Type:boolean or @aws-cdk/cdk.Token (optional)
includeSupport

CfnBudget.CostTypesProperty.IncludeSupport

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costtypes.html#cfn-budgets-budget-costtypes-includesupport

Type:boolean or @aws-cdk/cdk.Token (optional)
includeTax

CfnBudget.CostTypesProperty.IncludeTax

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costtypes.html#cfn-budgets-budget-costtypes-includetax

Type:boolean or @aws-cdk/cdk.Token (optional)
includeUpfront

CfnBudget.CostTypesProperty.IncludeUpfront

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costtypes.html#cfn-budgets-budget-costtypes-includeupfront

Type:boolean or @aws-cdk/cdk.Token (optional)
useAmortized

CfnBudget.CostTypesProperty.UseAmortized

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costtypes.html#cfn-budgets-budget-costtypes-useamortized

Type:boolean or @aws-cdk/cdk.Token (optional)
useBlended

CfnBudget.CostTypesProperty.UseBlended

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costtypes.html#cfn-budgets-budget-costtypes-useblended

Type:boolean or @aws-cdk/cdk.Token (optional)
class NotificationProperty

Language-specific names:

using Amazon.CDK.AWS.Budgets;
import software.amazon.awscdk.services.budgets.CfnBudget.NotificationProperty;
// CfnBudget.NotificationProperty is an interface
import { CfnBudget.NotificationProperty } from '@aws-cdk/aws-budgets';
comparisonOperator

CfnBudget.NotificationProperty.ComparisonOperator

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-notification.html#cfn-budgets-budget-notification-comparisonoperator

Type:string
notificationType

CfnBudget.NotificationProperty.NotificationType

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-notification.html#cfn-budgets-budget-notification-notificationtype

Type:string
threshold

CfnBudget.NotificationProperty.Threshold

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-notification.html#cfn-budgets-budget-notification-threshold

Type:number or @aws-cdk/cdk.Token
thresholdType

CfnBudget.NotificationProperty.ThresholdType

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-notification.html#cfn-budgets-budget-notification-thresholdtype

Type:string (optional)
class NotificationWithSubscribersProperty

Language-specific names:

using Amazon.CDK.AWS.Budgets;
import software.amazon.awscdk.services.budgets.CfnBudget.NotificationWithSubscribersProperty;
// CfnBudget.NotificationWithSubscribersProperty is an interface
import { CfnBudget.NotificationWithSubscribersProperty } from '@aws-cdk/aws-budgets';
notification

CfnBudget.NotificationWithSubscribersProperty.Notification

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-notificationwithsubscribers.html#cfn-budgets-budget-notificationwithsubscribers-notification

Type:@aws-cdk/cdk.Token or NotificationProperty
subscribers

CfnBudget.NotificationWithSubscribersProperty.Subscribers

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-notificationwithsubscribers.html#cfn-budgets-budget-notificationwithsubscribers-subscribers

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or SubscriberProperty)[]
class SpendProperty

Language-specific names:

using Amazon.CDK.AWS.Budgets;
import software.amazon.awscdk.services.budgets.CfnBudget.SpendProperty;
// CfnBudget.SpendProperty is an interface
import { CfnBudget.SpendProperty } from '@aws-cdk/aws-budgets';
amount

CfnBudget.SpendProperty.Amount

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-spend.html#cfn-budgets-budget-spend-amount

Type:number or @aws-cdk/cdk.Token
unit

CfnBudget.SpendProperty.Unit

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-spend.html#cfn-budgets-budget-spend-unit

Type:string
class SubscriberProperty

Language-specific names:

using Amazon.CDK.AWS.Budgets;
import software.amazon.awscdk.services.budgets.CfnBudget.SubscriberProperty;
// CfnBudget.SubscriberProperty is an interface
import { CfnBudget.SubscriberProperty } from '@aws-cdk/aws-budgets';
address

CfnBudget.SubscriberProperty.Address

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-subscriber.html#cfn-budgets-budget-subscriber-address

Type:string
subscriptionType

CfnBudget.SubscriberProperty.SubscriptionType

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-subscriber.html#cfn-budgets-budget-subscriber-subscriptiontype

Type:string
class TimePeriodProperty

Language-specific names:

using Amazon.CDK.AWS.Budgets;
import software.amazon.awscdk.services.budgets.CfnBudget.TimePeriodProperty;
// CfnBudget.TimePeriodProperty is an interface
import { CfnBudget.TimePeriodProperty } from '@aws-cdk/aws-budgets';
end

CfnBudget.TimePeriodProperty.End

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-timeperiod.html#cfn-budgets-budget-timeperiod-end

Type:string (optional)
start

CfnBudget.TimePeriodProperty.Start

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-timeperiod.html#cfn-budgets-budget-timeperiod-start

Type:string (optional)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnBudgetProps (interface)

class @aws-cdk/aws-budgets.CfnBudgetProps

Language-specific names:

using Amazon.CDK.AWS.Budgets;
import software.amazon.awscdk.services.budgets.CfnBudgetProps;
// CfnBudgetProps is an interface
import { CfnBudgetProps } from '@aws-cdk/aws-budgets';
budget

AWS::Budgets::Budget.Budget

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-budgets-budget.html#cfn-budgets-budget-budget

Type:BudgetDataProperty or @aws-cdk/cdk.Token
notificationsWithSubscribers

AWS::Budgets::Budget.NotificationsWithSubscribers

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-budgets-budget.html#cfn-budgets-budget-notificationswithsubscribers

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or NotificationWithSubscribersProperty)[] (optional)