Class CfnBudget
The AWS::Budgets::Budget
resource allows customers to take pre-defined actions that will trigger once a budget threshold has been exceeded.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.Budgets
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnBudget : CfnResource, IInspectable
Syntax (vb)
Public Class CfnBudget
Inherits CfnResource
Implements IInspectable
Remarks
creates, replaces, or deletes budgets for Billing and Cost Management. For more information, see Managing Your Costs with Budgets in the AWS 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;
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
}
},
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
},
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(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnBudget(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnBudget(Construct, String, ICfnBudgetProps) |
Properties
AttrId | |
Budget | The budget object that you want to create. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnBudget(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnBudget(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnBudget(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnBudget(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnBudget(Construct, String, ICfnBudgetProps)
public CfnBudget(Construct scope, string id, ICfnBudgetProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnBudgetProps
Resource properties.
Properties
AttrId
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
Budget
The budget object that you want to create.
public virtual object Budget { get; set; }
Property Value
System.Object
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
NotificationsWithSubscribers
A notification that you want to associate with a budget.
public virtual object NotificationsWithSubscribers { get; set; }
Property Value
System.Object
ResourceTags
An optional list of tags to associate with the specified budget.
public virtual object ResourceTags { get; set; }
Property Value
System.Object
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>