CfnBudget

class aws_cdk.aws_budgets.CfnBudget(scope, id, *, budget, notifications_with_subscribers=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::Budgets::Budget.

CloudformationResource

AWS::Budgets::Budget

Link

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

Create a new AWS::Budgets::Budget.

Parameters

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

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

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

# Example automatically generated. See https://github.com/aws/jsii/issues/826
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}
Parameters
  • path (str) –

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

Return type

None

add_property_deletion_override(property_path)

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

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

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

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

Any

inspect(inspector)

(experimental) Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Stability

experimental

Return type

None

override_logical_id(new_logical_id)

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

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::Budgets::Budget'
budget

AWS::Budgets::Budget.Budget.

Link

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

Return type

Union[BudgetDataProperty, IResolvable]

cfn_options

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

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

logical_id

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

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The construct tree node associated with this construct.

Return type

ConstructNode

notifications_with_subscribers

AWS::Budgets::Budget.NotificationsWithSubscribers.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, NotificationWithSubscribersProperty]], None]

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Return type

str

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

BudgetDataProperty

class CfnBudget.BudgetDataProperty(*, budget_type, time_unit, budget_limit=None, budget_name=None, cost_filters=None, cost_types=None, planned_budget_limits=None, time_period=None)

Bases: object

Parameters
  • budget_type (str) – CfnBudget.BudgetDataProperty.BudgetType.

  • time_unit (str) – CfnBudget.BudgetDataProperty.TimeUnit.

  • budget_limit (Union[IResolvable, SpendProperty, None]) – CfnBudget.BudgetDataProperty.BudgetLimit.

  • budget_name (Optional[str]) – CfnBudget.BudgetDataProperty.BudgetName.

  • cost_filters (Optional[Any]) – CfnBudget.BudgetDataProperty.CostFilters.

  • cost_types (Union[IResolvable, CostTypesProperty, None]) – CfnBudget.BudgetDataProperty.CostTypes.

  • planned_budget_limits (Optional[Any]) – CfnBudget.BudgetDataProperty.PlannedBudgetLimits.

  • time_period (Union[IResolvable, TimePeriodProperty, None]) – CfnBudget.BudgetDataProperty.TimePeriod.

Link

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

Attributes

budget_limit

CfnBudget.BudgetDataProperty.BudgetLimit.

Link

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

Return type

Union[IResolvable, SpendProperty, None]

budget_name

CfnBudget.BudgetDataProperty.BudgetName.

Link

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

Return type

Optional[str]

budget_type

CfnBudget.BudgetDataProperty.BudgetType.

Link

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

Return type

str

cost_filters

CfnBudget.BudgetDataProperty.CostFilters.

Link

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

Return type

Any

cost_types

CfnBudget.BudgetDataProperty.CostTypes.

Link

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

Return type

Union[IResolvable, CostTypesProperty, None]

planned_budget_limits

CfnBudget.BudgetDataProperty.PlannedBudgetLimits.

Link

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

Return type

Any

time_period

CfnBudget.BudgetDataProperty.TimePeriod.

Link

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

Return type

Union[IResolvable, TimePeriodProperty, None]

time_unit

CfnBudget.BudgetDataProperty.TimeUnit.

Link

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

Return type

str

CostTypesProperty

class CfnBudget.CostTypesProperty(*, include_credit=None, include_discount=None, include_other_subscription=None, include_recurring=None, include_refund=None, include_subscription=None, include_support=None, include_tax=None, include_upfront=None, use_amortized=None, use_blended=None)

Bases: object

Parameters
  • include_credit (Union[bool, IResolvable, None]) – CfnBudget.CostTypesProperty.IncludeCredit.

  • include_discount (Union[bool, IResolvable, None]) – CfnBudget.CostTypesProperty.IncludeDiscount.

  • include_other_subscription (Union[bool, IResolvable, None]) – CfnBudget.CostTypesProperty.IncludeOtherSubscription.

  • include_recurring (Union[bool, IResolvable, None]) – CfnBudget.CostTypesProperty.IncludeRecurring.

  • include_refund (Union[bool, IResolvable, None]) – CfnBudget.CostTypesProperty.IncludeRefund.

  • include_subscription (Union[bool, IResolvable, None]) – CfnBudget.CostTypesProperty.IncludeSubscription.

  • include_support (Union[bool, IResolvable, None]) – CfnBudget.CostTypesProperty.IncludeSupport.

  • include_tax (Union[bool, IResolvable, None]) – CfnBudget.CostTypesProperty.IncludeTax.

  • include_upfront (Union[bool, IResolvable, None]) – CfnBudget.CostTypesProperty.IncludeUpfront.

  • use_amortized (Union[bool, IResolvable, None]) – CfnBudget.CostTypesProperty.UseAmortized.

  • use_blended (Union[bool, IResolvable, None]) – CfnBudget.CostTypesProperty.UseBlended.

Link

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

Attributes

include_credit

CfnBudget.CostTypesProperty.IncludeCredit.

Link

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

Return type

Union[bool, IResolvable, None]

include_discount

CfnBudget.CostTypesProperty.IncludeDiscount.

Link

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

Return type

Union[bool, IResolvable, None]

include_other_subscription

CfnBudget.CostTypesProperty.IncludeOtherSubscription.

Link

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

Return type

Union[bool, IResolvable, None]

include_recurring

CfnBudget.CostTypesProperty.IncludeRecurring.

Link

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

Return type

Union[bool, IResolvable, None]

include_refund

CfnBudget.CostTypesProperty.IncludeRefund.

Link

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

Return type

Union[bool, IResolvable, None]

include_subscription

CfnBudget.CostTypesProperty.IncludeSubscription.

Link

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

Return type

Union[bool, IResolvable, None]

include_support

CfnBudget.CostTypesProperty.IncludeSupport.

Link

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

Return type

Union[bool, IResolvable, None]

include_tax

CfnBudget.CostTypesProperty.IncludeTax.

Link

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

Return type

Union[bool, IResolvable, None]

include_upfront

CfnBudget.CostTypesProperty.IncludeUpfront.

Link

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

Return type

Union[bool, IResolvable, None]

use_amortized

CfnBudget.CostTypesProperty.UseAmortized.

Link

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

Return type

Union[bool, IResolvable, None]

use_blended

CfnBudget.CostTypesProperty.UseBlended.

Link

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

Return type

Union[bool, IResolvable, None]

NotificationProperty

class CfnBudget.NotificationProperty(*, comparison_operator, notification_type, threshold, threshold_type=None)

Bases: object

Parameters
  • comparison_operator (str) – CfnBudget.NotificationProperty.ComparisonOperator.

  • notification_type (str) – CfnBudget.NotificationProperty.NotificationType.

  • threshold (Union[int, float]) – CfnBudget.NotificationProperty.Threshold.

  • threshold_type (Optional[str]) – CfnBudget.NotificationProperty.ThresholdType.

Link

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

Attributes

comparison_operator

CfnBudget.NotificationProperty.ComparisonOperator.

Link

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

Return type

str

notification_type

CfnBudget.NotificationProperty.NotificationType.

Link

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

Return type

str

threshold

CfnBudget.NotificationProperty.Threshold.

Link

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

Return type

Union[int, float]

threshold_type

CfnBudget.NotificationProperty.ThresholdType.

Link

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

Return type

Optional[str]

NotificationWithSubscribersProperty

class CfnBudget.NotificationWithSubscribersProperty(*, notification, subscribers)

Bases: object

Parameters
Link

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

Attributes

notification

CfnBudget.NotificationWithSubscribersProperty.Notification.

Link

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

Return type

Union[IResolvable, NotificationProperty]

subscribers

CfnBudget.NotificationWithSubscribersProperty.Subscribers.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, SubscriberProperty]]]

SpendProperty

class CfnBudget.SpendProperty(*, amount, unit)

Bases: object

Parameters
  • amount (Union[int, float]) – CfnBudget.SpendProperty.Amount.

  • unit (str) – CfnBudget.SpendProperty.Unit.

Link

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

Attributes

amount

CfnBudget.SpendProperty.Amount.

Link

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

Return type

Union[int, float]

unit

CfnBudget.SpendProperty.Unit.

Link

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

Return type

str

SubscriberProperty

class CfnBudget.SubscriberProperty(*, address, subscription_type)

Bases: object

Parameters
  • address (str) – CfnBudget.SubscriberProperty.Address.

  • subscription_type (str) – CfnBudget.SubscriberProperty.SubscriptionType.

Link

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

Attributes

address

CfnBudget.SubscriberProperty.Address.

Link

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

Return type

str

subscription_type

CfnBudget.SubscriberProperty.SubscriptionType.

Link

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

Return type

str

TimePeriodProperty

class CfnBudget.TimePeriodProperty(*, end=None, start=None)

Bases: object

Parameters
  • end (Optional[str]) – CfnBudget.TimePeriodProperty.End.

  • start (Optional[str]) – CfnBudget.TimePeriodProperty.Start.

Link

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

Attributes

end

CfnBudget.TimePeriodProperty.End.

Link

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

Return type

Optional[str]

start

CfnBudget.TimePeriodProperty.Start.

Link

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

Return type

Optional[str]