Class CfnBudgetsAction

The AWS::Budgets::BudgetsAction resource enables you to take predefined actions that are initiated when a budget threshold has been exceeded.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnBudgetsAction

Implements

IInspectable

IBudgetsActionRef

IConstruct

IDependable

IEnvironmentAware

ITaggableV2

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.Budgets

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnBudgetsAction : CfnResource, IInspectable, IBudgetsActionRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Syntax (vb)

Public Class CfnBudgetsAction Inherits CfnResource Implements IInspectable, IBudgetsActionRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Remarks

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-budgetsaction.html

CloudformationResource: AWS::Budgets::BudgetsAction

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 cfnBudgetsAction = new CfnBudgetsAction(this, "MyCfnBudgetsAction", new CfnBudgetsActionProps {
                 ActionThreshold = new ActionThresholdProperty {
                     Type = "type",
                     Value = 123
                 },
                 ActionType = "actionType",
                 BudgetName = "budgetName",
                 Definition = new DefinitionProperty {
                     IamActionDefinition = new IamActionDefinitionProperty {
                         PolicyArn = "policyArn",

                         // the properties below are optional
                         Groups = new [] { "groups" },
                         Roles = new [] { "roles" },
                         Users = new [] { "users" }
                     },
                     ScpActionDefinition = new ScpActionDefinitionProperty {
                         PolicyId = "policyId",
                         TargetIds = new [] { "targetIds" }
                     },
                     SsmActionDefinition = new SsmActionDefinitionProperty {
                         InstanceIds = new [] { "instanceIds" },
                         Region = "region",
                         Subtype = "subtype"
                     }
                 },
                 ExecutionRoleArn = "executionRoleArn",
                 NotificationType = "notificationType",
                 Subscribers = new [] { new SubscriberProperty {
                     Address = "address",
                     Type = "type"
                 } },

                 // the properties below are optional
                 ApprovalModel = "approvalModel",
                 ResourceTags = new [] { new ResourceTagProperty {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnBudgetsAction(Construct, string, ICfnBudgetsActionProps)

Create a new AWS::Budgets::BudgetsAction.

Properties

ActionThreshold	The trigger threshold of the action.
ActionType	The type of action.
ApprovalModel	This specifies if the action needs manual or automatic approval.
AttrActionId	A system-generated universally unique identifier (UUID) for the action.
BudgetName	A string that represents the budget name.
BudgetsActionRef	A reference to a BudgetsAction resource.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CdkTagManager	Tag Manager which manages the tags for this resource.
CfnProperties	The `AWS::Budgets::BudgetsAction` resource enables you to take predefined actions that are initiated when a budget threshold has been exceeded.
Definition	Specifies all of the type-specific parameters.
ExecutionRoleArn	The role passed for action execution and reversion.
NotificationType	The type of a notification.
ResourceTags	An optional list of tags to associate with the specified budget action.
Subscribers	A list of subscribers.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnBudgetsAction(object)	Checks whether the given object is a CfnBudgetsAction.
RenderProperties(IDictionary<string, object>)	The `AWS::Budgets::BudgetsAction` resource enables you to take predefined actions that are initiated when a budget threshold has been exceeded.

Constructors

CfnBudgetsAction(Construct, string, ICfnBudgetsActionProps)

Create a new AWS::Budgets::BudgetsAction.

public CfnBudgetsAction(Construct scope, string id, ICfnBudgetsActionProps props)

Parameters

scope Construct: Scope in which this resource is defined.
id string: Construct identifier for this resource (unique in its scope).
props ICfnBudgetsActionProps: Resource properties.

Remarks

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-budgetsaction.html

CloudformationResource: AWS::Budgets::BudgetsAction

ExampleMetadata: fixture=_generated

Properties

ActionThreshold

The trigger threshold of the action.

public virtual object ActionThreshold { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnBudgetsAction.IActionThresholdProperty

ActionType

The type of action.

public virtual string ActionType { get; set; }

Property Value

string

Remarks

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-budgetsaction.html

CloudformationResource: AWS::Budgets::BudgetsAction

ExampleMetadata: fixture=_generated

ApprovalModel

This specifies if the action needs manual or automatic approval.

public virtual string? ApprovalModel { get; set; }

Property Value

string

Remarks

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-budgetsaction.html

CloudformationResource: AWS::Budgets::BudgetsAction

ExampleMetadata: fixture=_generated

AttrActionId

A system-generated universally unique identifier (UUID) for the action.

public virtual string AttrActionId { get; }

Property Value

string

Remarks

CloudformationAttribute: ActionId

BudgetName

A string that represents the budget name.

public virtual string BudgetName { get; set; }

Property Value

string

Remarks

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-budgetsaction.html

CloudformationResource: AWS::Budgets::BudgetsAction

ExampleMetadata: fixture=_generated

BudgetsActionRef

A reference to a BudgetsAction resource.

public virtual IBudgetsActionReference BudgetsActionRef { get; }

Property Value

IBudgetsActionReference

Remarks

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-budgetsaction.html

CloudformationResource: AWS::Budgets::BudgetsAction

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

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-budgetsaction.html

CloudformationResource: AWS::Budgets::BudgetsAction

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }

Property Value

TagManager

Remarks

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-budgetsaction.html

CloudformationResource: AWS::Budgets::BudgetsAction

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::Budgets::BudgetsAction resource enables you to take predefined actions that are initiated when a budget threshold has been exceeded.

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

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

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-budgetsaction.html

CloudformationResource: AWS::Budgets::BudgetsAction

ExampleMetadata: fixture=_generated

Definition

Specifies all of the type-specific parameters.

public virtual object Definition { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnBudgetsAction.IDefinitionProperty

ExecutionRoleArn

The role passed for action execution and reversion.

public virtual string ExecutionRoleArn { get; set; }

Property Value

string

Remarks

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-budgetsaction.html

CloudformationResource: AWS::Budgets::BudgetsAction

ExampleMetadata: fixture=_generated

NotificationType

The type of a notification.

public virtual string NotificationType { get; set; }

Property Value

string

Remarks

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-budgetsaction.html

CloudformationResource: AWS::Budgets::BudgetsAction

ExampleMetadata: fixture=_generated

ResourceTags

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

public virtual CfnBudgetsAction.IResourceTagProperty[]? ResourceTags { get; set; }

Property Value

IResourceTagProperty[]

Remarks

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-budgetsaction.html

CloudformationResource: AWS::Budgets::BudgetsAction

ExampleMetadata: fixture=_generated

Subscribers

A list of subscribers.

public virtual object Subscribers { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnBudgetsAction.ISubscriberProperty)[]

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

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-budgetsaction.html

CloudformationResource: AWS::Budgets::BudgetsAction

ExampleMetadata: fixture=_generated

IsCfnBudgetsAction(object)

Checks whether the given object is a CfnBudgetsAction.

public static bool IsCfnBudgetsAction(object x)

Parameters

x object

Returns

bool

Remarks

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-budgetsaction.html

CloudformationResource: AWS::Budgets::BudgetsAction

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::Budgets::BudgetsAction resource enables you to take predefined actions that are initiated when a budget threshold has been exceeded.

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

Remarks

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-budgetsaction.html

CloudformationResource: AWS::Budgets::BudgetsAction

ExampleMetadata: fixture=_generated

Implements

IInspectable

IBudgetsActionRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggableV2