This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::Budgets::BudgetsAction
<a name="aws-resource-budgets-budgetsaction"></a>

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](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/budgets-managing-costs.html) in the *AWS Billing and Cost Management User Guide*.

## Syntax
<a name="aws-resource-budgets-budgetsaction-syntax"></a>

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

### JSON
<a name="aws-resource-budgets-budgetsaction-syntax.json"></a>

```
{
  "Type" : "AWS::Budgets::BudgetsAction",
  "Properties" : {
      "[ActionThreshold](#cfn-budgets-budgetsaction-actionthreshold)" : ActionThreshold,
      "[ActionType](#cfn-budgets-budgetsaction-actiontype)" : String,
      "[ApprovalModel](#cfn-budgets-budgetsaction-approvalmodel)" : String,
      "[BudgetName](#cfn-budgets-budgetsaction-budgetname)" : String,
      "[Definition](#cfn-budgets-budgetsaction-definition)" : Definition,
      "[ExecutionRoleArn](#cfn-budgets-budgetsaction-executionrolearn)" : String,
      "[NotificationType](#cfn-budgets-budgetsaction-notificationtype)" : String,
      "[ResourceTags](#cfn-budgets-budgetsaction-resourcetags)" : [ ResourceTag, ... ],
      "[Subscribers](#cfn-budgets-budgetsaction-subscribers)" : [ Subscriber, ... ]
    }
}
```

### YAML
<a name="aws-resource-budgets-budgetsaction-syntax.yaml"></a>

```
Type: AWS::Budgets::BudgetsAction
Properties:
  [ActionThreshold](#cfn-budgets-budgetsaction-actionthreshold): 
    ActionThreshold
  [ActionType](#cfn-budgets-budgetsaction-actiontype): String
  [ApprovalModel](#cfn-budgets-budgetsaction-approvalmodel): String
  [BudgetName](#cfn-budgets-budgetsaction-budgetname): String
  [Definition](#cfn-budgets-budgetsaction-definition): 
    Definition
  [ExecutionRoleArn](#cfn-budgets-budgetsaction-executionrolearn): String
  [NotificationType](#cfn-budgets-budgetsaction-notificationtype): String
  [ResourceTags](#cfn-budgets-budgetsaction-resourcetags): 
    - ResourceTag
  [Subscribers](#cfn-budgets-budgetsaction-subscribers): 
    - Subscriber
```

## Properties
<a name="aws-resource-budgets-budgetsaction-properties"></a>

`ActionThreshold`  <a name="cfn-budgets-budgetsaction-actionthreshold"></a>
The trigger threshold of the action.  
*Required*: Yes  
*Type*: [ActionThreshold](aws-properties-budgets-budgetsaction-actionthreshold.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ActionType`  <a name="cfn-budgets-budgetsaction-actiontype"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ApprovalModel`  <a name="cfn-budgets-budgetsaction-approvalmodel"></a>
This specifies if the action needs manual or automatic approval.  
*Required*: No  
*Type*: String  
*Allowed values*: `AUTOMATIC | MANUAL`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`BudgetName`  <a name="cfn-budgets-budgetsaction-budgetname"></a>
A string that represents the budget name. ":" and "\$1" characters aren't allowed.  
*Required*: Yes  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Definition`  <a name="cfn-budgets-budgetsaction-definition"></a>
Specifies all of the type-specific parameters.  
*Required*: Yes  
*Type*: [Definition](aws-properties-budgets-budgetsaction-definition.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ExecutionRoleArn`  <a name="cfn-budgets-budgetsaction-executionrolearn"></a>
The role passed for action execution and reversion. Roles and actions must be in the same account.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^arn:aws(-eusc|-cn|-us-gov|-iso|-iso-[a-z]{1})?:iam::\d{12}:role(\u002F[\u0021-\u007F]+\u002F|\u002F)[\w+=,.@-]+$`  
*Minimum*: `32`  
*Maximum*: `618`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`NotificationType`  <a name="cfn-budgets-budgetsaction-notificationtype"></a>
The type of a notification.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `ACTUAL | FORECASTED`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ResourceTags`  <a name="cfn-budgets-budgetsaction-resourcetags"></a>
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](aws-properties-budgets-budgetsaction-resourcetag.md)  
*Minimum*: `0`  
*Maximum*: `200`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Subscribers`  <a name="cfn-budgets-budgetsaction-subscribers"></a>
A list of subscribers.  
*Required*: Yes  
*Type*: Array of [Subscriber](aws-properties-budgets-budgetsaction-subscriber.md)  
*Minimum*: `1`  
*Maximum*: `11`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-budgets-budgetsaction-return-values"></a>

### Fn::GetAtt
<a name="aws-resource-budgets-budgetsaction-return-values-fn--getatt"></a>

#### 
<a name="aws-resource-budgets-budgetsaction-return-values-fn--getatt-fn--getatt"></a>

`ActionId`  <a name="ActionId-fn::getatt"></a>
A system-generated universally unique identifier (UUID) for the action.