Class CfnBudget

The AWS::Budgets::Budget resource allows customers to take pre-defined actions that will trigger once a budget threshold has been exceeded.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnBudget
Implements
IConstruct
IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.Budgets
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnBudget : CfnResource, IInspectable, IBudgetRef, IConstruct, IDependable, IEnvironmentAware
Syntax (vb)
Public Class CfnBudget Inherits CfnResource Implements IInspectable, IBudgetRef, IConstruct, IDependable, IEnvironmentAware
Remarks

creates, replaces, or deletes budgets for Billing and Cost Management. For more information, see Managing Your Costs with Budgets in the Billing and Cost Management User Guide .

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

CloudformationResource: AWS::Budgets::Budget

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Budgets;

             var costFilters;
             ExpressionProperty expressionProperty_;
             var plannedBudgetLimits;

             var cfnBudget = new CfnBudget(this, "MyCfnBudget", new CfnBudgetProps {
                 Budget = new BudgetDataProperty {
                     BudgetType = "budgetType",
                     TimeUnit = "timeUnit",

                     // the properties below are optional
                     AutoAdjustData = new AutoAdjustDataProperty {
                         AutoAdjustType = "autoAdjustType",

                         // the properties below are optional
                         HistoricalOptions = new HistoricalOptionsProperty {
                             BudgetAdjustmentPeriod = 123
                         }
                     },
                     BillingViewArn = "billingViewArn",
                     BudgetLimit = new SpendProperty {
                         Amount = 123,
                         Unit = "unit"
                     },
                     BudgetName = "budgetName",
                     CostFilters = costFilters,
                     CostTypes = new CostTypesProperty {
                         IncludeCredit = false,
                         IncludeDiscount = false,
                         IncludeOtherSubscription = false,
                         IncludeRecurring = false,
                         IncludeRefund = false,
                         IncludeSubscription = false,
                         IncludeSupport = false,
                         IncludeTax = false,
                         IncludeUpfront = false,
                         UseAmortized = false,
                         UseBlended = false
                     },
                     FilterExpression = new ExpressionProperty {
                         And = new [] { expressionProperty_ },
                         CostCategories = new CostCategoryValuesProperty {
                             Key = "key",
                             MatchOptions = new [] { "matchOptions" },
                             Values = new [] { "values" }
                         },
                         Dimensions = new ExpressionDimensionValuesProperty {
                             Key = "key",
                             MatchOptions = new [] { "matchOptions" },
                             Values = new [] { "values" }
                         },
                         Not = expressionProperty_,
                         Or = new [] { expressionProperty_ },
                         Tags = new TagValuesProperty {
                             Key = "key",
                             MatchOptions = new [] { "matchOptions" },
                             Values = new [] { "values" }
                         }
                     },
                     Metrics = new [] { "metrics" },
                     PlannedBudgetLimits = plannedBudgetLimits,
                     TimePeriod = new TimePeriodProperty {
                         End = "end",
                         Start = "start"
                     }
                 },

                 // the properties below are optional
                 NotificationsWithSubscribers = new [] { new NotificationWithSubscribersProperty {
                     Notification = new NotificationProperty {
                         ComparisonOperator = "comparisonOperator",
                         NotificationType = "notificationType",
                         Threshold = 123,

                         // the properties below are optional
                         ThresholdType = "thresholdType"
                     },
                     Subscribers = new [] { new SubscriberProperty {
                         Address = "address",
                         SubscriptionType = "subscriptionType"
                     } }
                 } },
                 ResourceTags = new [] { new ResourceTagProperty {
                     Key = "key",

                     // the properties below are optional
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnBudget(Construct, string, ICfnBudgetProps)

Create a new AWS::Budgets::Budget.

Properties

AttrId

The AWS::Budgets::Budget resource allows customers to take pre-defined actions that will trigger once a budget threshold has been exceeded.
Budget

The budget object that you want to create.
BudgetRef

A reference to a Budget resource.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties

The AWS::Budgets::Budget resource allows customers to take pre-defined actions that will trigger once a budget threshold has been exceeded.
NotificationsWithSubscribers

A notification that you want to associate with a budget.
ResourceTags

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

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
IsCfnBudget(object)

Checks whether the given object is a CfnBudget.
RenderProperties(IDictionary<string, object>)

The AWS::Budgets::Budget resource allows customers to take pre-defined actions that will trigger once a budget threshold has been exceeded.

Constructors

CfnBudget(Construct, string, ICfnBudgetProps)

Create a new AWS::Budgets::Budget.

public CfnBudget(Construct scope, string id, ICfnBudgetProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnBudgetProps

Resource properties.

Remarks

creates, replaces, or deletes budgets for Billing and Cost Management. For more information, see Managing Your Costs with Budgets in the Billing and Cost Management User Guide .

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

CloudformationResource: AWS::Budgets::Budget

ExampleMetadata: fixture=_generated

Properties

AttrId

The AWS::Budgets::Budget resource allows customers to take pre-defined actions that will trigger once a budget threshold has been exceeded.

public virtual string AttrId { get; }
Property Value

string

Remarks

CloudformationAttribute: Id

Budget

The budget object that you want to create.

public virtual object Budget { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnBudget.IBudgetDataProperty

BudgetRef

A reference to a Budget resource.

public virtual IBudgetReference BudgetRef { get; }
Property Value

IBudgetReference

Remarks

creates, replaces, or deletes budgets for Billing and Cost Management. For more information, see Managing Your Costs with Budgets in the Billing and Cost Management User Guide .

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

CloudformationResource: AWS::Budgets::Budget

ExampleMetadata: fixture=_generated

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

string

Remarks

creates, replaces, or deletes budgets for Billing and Cost Management. For more information, see Managing Your Costs with Budgets in the Billing and Cost Management User Guide .

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

CloudformationResource: AWS::Budgets::Budget

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::Budgets::Budget resource allows customers to take pre-defined actions that will trigger once a budget threshold has been exceeded.

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

IDictionary<string, object>

Overrides
Remarks

creates, replaces, or deletes budgets for Billing and Cost Management. For more information, see Managing Your Costs with Budgets in the Billing and Cost Management User Guide .

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

CloudformationResource: AWS::Budgets::Budget

ExampleMetadata: fixture=_generated

NotificationsWithSubscribers

A notification that you want to associate with a budget.

public virtual object? NotificationsWithSubscribers { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnBudget.INotificationWithSubscribersProperty)[]

ResourceTags

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

public virtual object? ResourceTags { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnBudget.IResourceTagProperty)[]

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

creates, replaces, or deletes budgets for Billing and Cost Management. For more information, see Managing Your Costs with Budgets in the Billing and Cost Management User Guide .

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

CloudformationResource: AWS::Budgets::Budget

ExampleMetadata: fixture=_generated

IsCfnBudget(object)

Checks whether the given object is a CfnBudget.

public static bool IsCfnBudget(object x)
Parameters
x object
Returns

bool

Remarks

creates, replaces, or deletes budgets for Billing and Cost Management. For more information, see Managing Your Costs with Budgets in the Billing and Cost Management User Guide .

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

CloudformationResource: AWS::Budgets::Budget

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::Budgets::Budget resource allows customers to take pre-defined actions that will trigger once a budget threshold has been exceeded.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props IDictionary<string, object>
Returns

IDictionary<string, object>

Overrides
Remarks

creates, replaces, or deletes budgets for Billing and Cost Management. For more information, see Managing Your Costs with Budgets in the Billing and Cost Management User Guide .

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

CloudformationResource: AWS::Budgets::Budget

ExampleMetadata: fixture=_generated

Implements

Constructs.IConstruct
Constructs.IDependable