Module: `budgets`

Terraform module to create AWS Budgets and an associated SNS topic and Lambda function to send notifications to Slack.

Usage

For a complete example, see examples/complete.

For automated tests of the complete example using bats and Terratest (which tests and deploys the example on AWS), see test.

# Create a standard label resource. See [null-label](https://github.com/cloudposse/terraform-null-label/#terraform-null-label--)
module "label" {
  source  = "cloudposse/label/null"
  # Cloud Posse recommends pinning every module to a specific version, though usually you want to use the current one
  # version = "x.x.x"

  namespace = "eg"
  name      = "example"
}

locals {
  budgets = [
    {
      name            = "budget-ec2-monthly"
      budget_type     = "COST"
      limit_amount    = "1200"
      limit_unit      = "USD"
      time_period_end = "2087-06-15_00:00"
      time_unit       = "MONTHLY"

      cost_filter = {
        Service = ["Amazon Elastic Compute Cloud - Compute"]
      }

      notification = {
        comparison_operator = "GREATER_THAN"
        threshold           = "100"
        threshold_type      = "PERCENTAGE"
        notification_type   = "FORECASTED"
      }
    },
    {
      name         = "100-total-monthly"
      budget_type  = "COST"
      limit_amount = "100"
      limit_unit   = "USD"
      time_unit    = "MONTHLY"
    },
    {
      name         = "s3-3GB-limit-monthly"
      budget_type  = "USAGE"
      limit_amount = "3"
      limit_unit   = "GB"
      time_unit    = "MONTHLY"
    }
  ]
}

module "budgets" {
  source  = "cloudposse/budgets/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"

  budgets = local.budgets

  # create an SNS topic and lambda for Slack notifications
  notifications_enabled = true
  slack_webhook_url     = "https://slack-webhook-url"
  slack_username        = "AWS Budgets"
  slack_channel         = "notifications"

  # encrypt SNS topic, this also creates a KMS CMK that allows `budgets.amazonaws.com` to use it
  encryption_enabled = true

  context = module.label.this
}

Examples

Here is an example of using this module:

examples/complete - complete example of using this module

Variables

Required Variables

Optional Variables

budgets (any) optional

A list of Budgets to be managed by this module, see https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/budgets_budget#argument-reference
for a list of possible attributes. For a more specific example, see examples/complete/fixtures.us-east-2.tfvars in this repository.

Default value: [ ]

encryption_enabled (bool) optional

Whether or not to use encryption. If set to true and no custom value for KMS key (kms_master_key_id) is provided, a KMS key is created.

Default value: true

kms_enable_key_rotation (bool) optional

Specifies whether key rotation is enabled

Default value: true

kms_key_deletion_window_in_days (number) optional

Duration in days after which the key is deleted after destruction of the resources

Default value: 7

kms_master_key_id (string) optional

The ID of a KMS CMK to be used for encryption (see https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-sns-policy.html#protect-sns-sse for appropriate key policies).

Default value: null

notifications_enabled (bool) optional

Whether or not to setup Slack notifications. Set to true to create an SNS topic and Lambda function to send alerts to Slack.

Default value: false

slack_channel (string) optional

The name of the channel in Slack for notifications. Only used when notifications_enabled is true

Default value: ""

slack_emoji (string) optional

A custom emoji that will appear on Slack messages

Default value: ":amazon-aws:"

slack_username (string) optional

The username that will appear on Slack messages. Only used when notifications_enabled is true

Default value: ""

slack_webhook_url (string) optional

The URL of Slack webhook. Only used when notifications_enabled is true

Default value: ""

vpc_security_group_ids (list(string)) optional

List of security group ids when the notifying Lambda Function should run in the VPC.

Default value: null

vpc_subnet_ids (list(string)) optional

List of subnet ids when the notifying Lambda Function should run in the VPC. Usually private or intra subnets.

Default value: null

Context Variables

The following variables are defined in the context.tf file of this module and part of the terraform-null-label pattern.

additional_tag_map (map(string)) optional

Additional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration.

Required: No

Default value: { }

attributes (list(string)) optional

ID element. Additional attributes (e.g. workers or cluster) to add to id,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the delimiter
and treated as a single ID element.

Required: No

Default value: [ ]

context (any) optional

Single object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables as null to use default value.
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional_tag_map, which are merged.

Required: No

Default value:

{
  "additional_tag_map": {},
  "attributes": [],
  "delimiter": null,
  "descriptor_formats": {},
  "enabled": true,
  "environment": null,
  "id_length_limit": null,
  "label_key_case": null,
  "label_order": [],
  "label_value_case": null,
  "labels_as_tags": [
    "unset"
  ],
  "name": null,
  "namespace": null,
  "regex_replace_chars": null,
  "stage": null,
  "tags": {},
  "tenant": null
}

delimiter (string) optional

Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.

Required: No

Default value: null

descriptor_formats (any) optional

Describe additional descriptors to be output in the descriptors output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
\{<br/> format = string<br/> labels = list(string)<br/> \}
(Type is any so the map values can later be enhanced to provide additional options.)
format is a Terraform format string to be passed to the format() function.
labels is a list of labels, in order, to pass to format() function.
Label values will be normalized before being passed to format() so they will be
identical to how they appear in id.
Default is {} (descriptors output will be empty).

Required: No

Default value: { }

enabled (bool) optional

Set to false to prevent the module from creating any resources
Required: No

Default value: null

environment (string) optional

ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: No

Default value: null

id_length_limit (number) optional

Limit id to this many characters (minimum 6).
Set to 0 for unlimited length.
Set to null for keep the existing setting, which defaults to 0.
Does not affect id_full.

Required: No

Default value: null

label_key_case (string) optional

Controls the letter case of the tags keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the tags input.
Possible values: lower, title, upper.
Default value: title.

Required: No

Default value: null

label_order (list(string)) optional

The order in which the labels (ID elements) appear in the id.
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.

Required: No

Default value: null

label_value_case (string) optional

Controls the letter case of ID elements (labels) as included in id,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the tags input.
Possible values: lower, title, upper and none (no transformation).
Set this to title and set delimiter to "" to yield Pascal Case IDs.
Default value: lower.

Required: No

Default value: null

labels_as_tags (set(string)) optional

Set of labels (ID elements) to include as tags in the tags output.
Default is to include all labels.
Tags with empty values will not be included in the tags output.
Set to [] to suppress all generated tags.
Notes:
The value of the name tag, if included, will be the id, not the name.
Unlike other null-label inputs, the initial setting of labels_as_tags cannot be
changed in later chained modules. Attempts to change it will be silently ignored.

Required: No

Default value:

[
  "default"
]

name (string) optional

ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as a tag.
The "name" tag is set to the full id string. There is no tag with the value of the name input.

Required: No

Default value: null

namespace (string) optional

ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: No

Default value: null

regex_replace_chars (string) optional

Terraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.

Required: No

Default value: null

stage (string) optional

ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: No

Default value: null

tags (map(string)) optional

Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.

Required: No

Default value: { }

tenant (string) optional

ID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: No

Default value: null

Outputs

budgets: List of Budgets that are being managed by this module
kms_key_arn: ARN of the KMS CMK that was created specifically for budget notifications
kms_key_id: ID of the KMS CMK that is used for SNS notifications
lambda_cloudwatch_log_group_arn: The ARN of the Log Group used by the Slack Notify Lambda
lambda_function_arn: The ARN of the Lambda function
lambda_function_invoke_arn: The ARN to be used for invoking lambda function from API Gateway
lambda_function_name: The name of the Lambda function
lambda_iam_role_arn: The ARN of the IAM role used by Lambda function
sns_topic_arn: ARN of the SNS topic created for notifications
sns_topic_name: The name of the SNS topic created for notifications

Dependencies

Requirements

terraform, version: >= 1.0
aws, version: >= 3.0

Providers

aws, version: >= 3.0

Modules

Name	Version	Source	Description
`kms_key`	0.12.1	`cloudposse/kms-key/aws`	n/a
`slack_notify_lambda`	0.9.0	`cloudposse/sns-lambda-notify-slack/aws`	n/a
`sns_topic`	0.21.0	`cloudposse/sns-topic/aws`	see https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-sns-policy.html
`this`	0.25.0	`cloudposse/label/null`	n/a

Resources

The following resources are used by this module:

aws_budgets_budget.default (resource)

Data Sources

The following data sources are used by this module:

aws_caller_identity.current (data source)
aws_iam_policy_document.kms_key_policy (data source)

Module: budgets

Usage​

Examples​

Variables​

Required Variables​

Optional Variables​

Context Variables​

Outputs​

Dependencies​

Requirements​

Providers​

Modules​

Resources​

Data Sources​

Module: `budgets`

Usage

Examples

Variables

Required Variables

Optional Variables

Context Variables

Outputs

Dependencies

Requirements

Providers

Modules

Resources

Data Sources