Top / Amazon Web Service / AWS Budgets / Budget Action

AWS Budgets Budget Action

This page shows how to write Terraform and CloudFormation for AWS Budgets Budget Action and write them securely.

terraform-logo

Review your .tf file for AWS best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

aws_budgets_budget_action (Terraform)

The Budget Action in AWS Budgets can be configured in Terraform with the resource name aws_budgets_budget_action. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

An example could not be found in GitHub.

Review your Terraform file for AWS best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

Parameters

The following arguments are supported:

  • account_id - (Optional) The ID of the target account for budget. Will use current user's account_id by default if omitted.
  • budget_name - (Required) The name of a budget.
  • action_threshold - (Required) The trigger threshold of the action. See Action Threshold.
  • action_type - (Required) 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. Valid values are APPLY_IAM_POLICY, APPLY_SCP_POLICY, and RUN_SSM_DOCUMENTS.
  • approval_model - (Required) This specifies if the action needs manual or automatic approval. Valid values are AUTOMATIC and MANUAL.
  • definition - (Required) Specifies all of the type-specific parameters. See Definition.
  • execution_role_arn - (Required) The role passed for action execution and reversion. Roles and actions must be in the same account.
  • notification_type - (Required) The type of a notification. Valid values are ACTUAL or FORECASTED.
  • subscriber - (Required) A list of subscribers. See Subscriber.

Action Threshold

  • action_threshold_type - (Required) The type of threshold for a notification. Valid values are PERCENTAGE or ABSOLUTE_VALUE.
  • action_threshold_value - (Required) The threshold of a notification.

Subscriber

  • address - (Required) The address that AWS sends budget notifications to, either an SNS topic or an email.
  • subscription_type - (Required) The type of notification that AWS sends to a subscriber. Valid values are SNS or EMAIL.

Definition

  • iam_action_definition - (Optional) The AWS Identity and Access Management (IAM) action definition details. See IAM Action Definition.
  • ssm_action_definition - (Optional) The AWS Systems Manager (SSM) action definition details. See SSM Action Definition.
  • scp_action_definition - (Optional) The service control policies (SCPs) action definition details. See SCP Action Definition.

IAM Action Definition

  • policy_arn - (Required) The Amazon Resource Name (ARN) of the policy to be attached.
  • groups - (Optional) A list of groups to be attached. There must be at least one group.
  • roles - (Optional) A list of roles to be attached. There must be at least one role.
  • users - (Optional) A list of users to be attached. There must be at least one user.

SCP Action Definition

  • policy_id - (Required) The policy ID attached.
  • target_ids - (Optional) A list of target IDs.

SSM Action Definition

  • action_sub_type - (Required) The action subType. Valid values are STOP_EC2_INSTANCES or STOP_RDS_INSTANCES.
  • instance_ids - (Required) The EC2 and RDS instance IDs.
  • region - (Required) The Region to run the SSM document.

In addition to all arguments above, the following attributes are exported:

  • action_id - The id of the budget action.
  • id - ID of resource.
  • arn - The ARN of the budget action.
  • status - The status of the budget action.

>> from Terraform Registry

Explanation in Terraform Registry

Provides a budget action resource. Budget actions are cost savings controls that run either automatically on your behalf or by using a workflow approval process.

>> from Terraform Registry

AWS::Budgets::BudgetsAction (CloudFormation)

The BudgetsAction in Budgets can be configured in CloudFormation with the resource name AWS::Budgets::BudgetsAction. The following sections describe 1 example of how to use the resource and its parameters.

Example Usage from GitHub

template.json#L267
    "AWS::Budgets::BudgetsAction": {
      "Type": "AWS::Budgets::BudgetsAction",
      "Properties": {}
    },
    "AWS::LakeFormation::Resource": {
      "Type": "AWS::LakeFormation::Resource",

Parameters

>> from AWS CloudFormation Documentation

Explanation in CloudFormation Registry

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.

>> from AWS CloudFormation Documentation

The Other Related AWS Budgets Resources

Frequently asked questions

What is AWS Budgets Budget Action?

AWS Budgets Budget Action is a resource for Budgets of Amazon Web Service. Settings can be wrote in Terraform and CloudFormation.

Where can I find the example code for the AWS Budgets Budget Action?

For CloudFormation, the mhlabs/aws-icons-directory source code example is useful. See the CloudFormation Example section for further details.

security-icon

Automate config file reviews on your commits

Fix issues in your infrastructure as code with auto-generated patches.

Table of Contents