AWS::Budgets::BudgetsAction

The AWS::Budgets::BudgetsAction resource enables you to take predefined actions that are initiated when a budget threshold has been exceeded. For more information, see Managing Your Costs with Budgets in the AWS Billing and Cost Management User Guide.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Budgets::BudgetsAction",
  "Properties" : {
      "ActionThreshold" : ActionThreshold,
      "ActionType" : String,
      "ApprovalModel" : String,
      "BudgetName" : String,
      "Definition" : Definition,
      "ExecutionRoleArn" : String,
      "NotificationType" : String,
      "ResourceTags" : [ ResourceTag, ... ],
      "Subscribers" : [ Subscriber, ... ]
    }
}

YAML

Type: AWS::Budgets::BudgetsAction
Properties:
  ActionThreshold: 
    ActionThreshold
  ActionType: String
  ApprovalModel: String
  BudgetName: String
  Definition: 
    Definition
  ExecutionRoleArn: String
  NotificationType: String
  ResourceTags: 
    - ResourceTag
  Subscribers: 
    - Subscriber

Properties

ActionThreshold

The trigger threshold of the action.

Required: Yes

Type: ActionThreshold

Update requires: No interruption

ActionType

The type of action. This defines the type of tasks that can be carried out by this action. This field also determines the format for definition.

Required: Yes

Type: String

Allowed values: APPLY_IAM_POLICY | APPLY_SCP_POLICY | RUN_SSM_DOCUMENTS

Update requires: Replacement

ApprovalModel

This specifies if the action needs manual or automatic approval.

Required: No

Type: String

Allowed values: AUTOMATIC | MANUAL

Update requires: No interruption

BudgetName

A string that represents the budget name. ":" and "\" characters aren't allowed.

Required: Yes

Type: String

Update requires: Replacement

Definition

Specifies all of the type-specific parameters.

Required: Yes

Type: Definition

Update requires: No interruption

ExecutionRoleArn

The role passed for action execution and reversion. Roles and actions must be in the same account.

Required: Yes

Type: String

Pattern: ^arn:(aws|aws-cn|aws-us-gov|us-iso-east-1|us-isob-east-1):iam::\d{12}:role(\u002F[\u0021-\u007F]+\u002F|\u002F)[\w+=,.@-]+$

Minimum: 32

Maximum: 618

Update requires: No interruption

NotificationType

The type of a notification.

Required: Yes

Type: String

Allowed values: ACTUAL | FORECASTED

Update requires: No interruption

ResourceTags

An optional list of tags to associate with the specified budget action. Each tag consists of a key and a value, and each key must be unique for the resource.

Required: No

Type: Array of ResourceTag

Minimum: 0

Maximum: 200

Update requires: No interruption

Subscribers

A list of subscribers.

Required: Yes

Type: Array of Subscriber

Minimum: 1

Maximum: 11

Update requires: No interruption

Return values

Fn::GetAtt

ActionId

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