Class CfnBudgetsAction
The AWS::Budgets::BudgetsAction
resource enables you to take predefined actions that are initiated when a budget threshold has been exceeded.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.Budgets
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnBudgetsAction : CfnResource, IInspectable
Syntax (vb)
Public Class CfnBudgetsAction
Inherits CfnResource
Implements IInspectable
Remarks
For more information, see Managing Your Costs with Budgets in the AWS Billing and Cost Management User Guide .
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"
});
Synopsis
Constructors
CfnBudgetsAction(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnBudgetsAction(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnBudgetsAction(Construct, String, ICfnBudgetsActionProps) |
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. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Definition | Specifies all of the type-specific parameters. |
ExecutionRoleArn | The role passed for action execution and reversion. |
NotificationType | The type of a notification. |
Subscribers | A list of subscribers. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnBudgetsAction(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnBudgetsAction(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnBudgetsAction(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnBudgetsAction(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnBudgetsAction(Construct, String, ICfnBudgetsActionProps)
public CfnBudgetsAction(Construct scope, string id, ICfnBudgetsActionProps 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 ICfnBudgetsActionProps
Resource properties.
Properties
ActionThreshold
The trigger threshold of the action.
public virtual object ActionThreshold { get; set; }
Property Value
System.Object
ActionType
The type of action.
public virtual string ActionType { get; set; }
Property Value
System.String
ApprovalModel
This specifies if the action needs manual or automatic approval.
public virtual string ApprovalModel { get; set; }
Property Value
System.String
AttrActionId
A system-generated universally unique identifier (UUID) for the action.
public virtual string AttrActionId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ActionId
BudgetName
A string that represents the budget name.
public virtual string BudgetName { get; set; }
Property Value
System.String
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
Definition
Specifies all of the type-specific parameters.
public virtual object Definition { get; set; }
Property Value
System.Object
ExecutionRoleArn
The role passed for action execution and reversion.
public virtual string ExecutionRoleArn { get; set; }
Property Value
System.String
NotificationType
The type of a notification.
public virtual string NotificationType { get; set; }
Property Value
System.String
Subscribers
A list of subscribers.
public virtual object Subscribers { 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>