CfnBudgetProps

class aws_cdk.aws_budgets.CfnBudgetProps(*, budget, notifications_with_subscribers=None, resource_tags=None)

Bases: object

Properties for defining a CfnBudget.

Parameters:

• budget (Union[IResolvable, BudgetDataProperty, Dict[str, Any]]) – The budget object that you want to create.

• notifications_with_subscribers (Union[IResolvable, Sequence[Union[IResolvable, NotificationWithSubscribersProperty, Dict[str, Any]]], None]) – 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.

• resource_tags (Union[IResolvable, Sequence[Union[IResolvable, ResourceTagProperty, Dict[str, Any]]], None]) – An optional list of tags to associate with the specified budget. Each tag consists of a key and a value, and each key must be unique for the resource.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_budgets as budgets

# cost_filters: Any
# planned_budget_limits: Any

cfn_budget_props = budgets.CfnBudgetProps(
    budget=budgets.CfnBudget.BudgetDataProperty(
        budget_type="budgetType",
        time_unit="timeUnit",

        # the properties below are optional
        auto_adjust_data=budgets.CfnBudget.AutoAdjustDataProperty(
            auto_adjust_type="autoAdjustType",

            # the properties below are optional
            historical_options=budgets.CfnBudget.HistoricalOptionsProperty(
                budget_adjustment_period=123
            )
        ),
        budget_limit=budgets.CfnBudget.SpendProperty(
            amount=123,
            unit="unit"
        ),
        budget_name="budgetName",
        cost_filters=cost_filters,
        cost_types=budgets.CfnBudget.CostTypesProperty(
            include_credit=False,
            include_discount=False,
            include_other_subscription=False,
            include_recurring=False,
            include_refund=False,
            include_subscription=False,
            include_support=False,
            include_tax=False,
            include_upfront=False,
            use_amortized=False,
            use_blended=False
        ),
        planned_budget_limits=planned_budget_limits,
        time_period=budgets.CfnBudget.TimePeriodProperty(
            end="end",
            start="start"
        )
    ),

    # the properties below are optional
    notifications_with_subscribers=[budgets.CfnBudget.NotificationWithSubscribersProperty(
        notification=budgets.CfnBudget.NotificationProperty(
            comparison_operator="comparisonOperator",
            notification_type="notificationType",
            threshold=123,

            # the properties below are optional
            threshold_type="thresholdType"
        ),
        subscribers=[budgets.CfnBudget.SubscriberProperty(
            address="address",
            subscription_type="subscriptionType"
        )]
    )],
    resource_tags=[budgets.CfnBudget.ResourceTagProperty(
        key="key",

        # the properties below are optional
        value="value"
    )]
)

Attributes

budget

The budget object that you want to create.

See:

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

notifications_with_subscribers

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.

See:

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

resource_tags

An optional list of tags to associate with the specified budget.

Each tag consists of a key and a value, and each key must be unique for the resource.

See:

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