Skip to main content

Component: account-settings

This component is responsible for provisioning account level settings: IAM password policy, AWS Account Alias, EBS encryption, and Service Quotas.


Stack Level: Global

Here's an example snippet for how to use this component. It's suggested to apply this component to all accounts, so create a file stacks/catalog/account-settings.yaml with the following content and then import that file in each account's global stack (overriding any parameters as needed):

enabled: true
minimum_password_length: 20
maximum_password_age: 120
budgets_enabled: true
budgets_notifications_enabled: true
budgets_slack_username: AWS Budgets
budgets_slack_channel: aws-budgets-notifications
- name: 1000-total-monthly
budget_type: COST
limit_amount: "1000"
limit_unit: USD
time_unit: MONTHLY
- name: s3-3GB-limit-monthly
budget_type: USAGE
limit_amount: "3"
limit_unit: GB
time_unit: MONTHLY
- comparison_operator: GREATER_THAN
notification_type: FORECASTED
threshold_type: PERCENTAGE
threshold: 80
- slack
- comparison_operator: GREATER_THAN
notification_type: FORECASTED
threshold_type: PERCENTAGE
# We generate two forecast notifications. This makes sure that notice is taken,
# and hopefully action can be taken to prevent going over budget.
threshold: 100
- slack
- comparison_operator: GREATER_THAN
notification_type: ACTUAL
threshold_type: PERCENTAGE
threshold: 100
- slack
service_quotas_enabled: true
- quota_name: Subnets per VPC
service_code: vpc
value: 250
- quota_code: L-E79EC296 # aka `Security Groups per Region`
service_code: vpc
value: 500
- quota_code: L-F678F1CE # aka `VPC per Region`
service_code: vpc
value: null


terraform>= 1.0.0
aws>= 4.9.0


aws>= 4.9.0






additional_tag_mapAdditional 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.
attributesID 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.
budgetsA list of Budgets to be managed by this module, see
for a list of possible attributes. For a more specific example, see
budgets_enabledWhether or not this component should manage AWS Budgetsboolfalseno
budgets_notifications_enabledWhether or not to setup Slack notifications for Budgets. Set to true to create an SNS topic and Lambda function to send alerts to a Slack channel.boolfalseno
budgets_slack_channelThe name of the channel in Slack for notifications. Only used when budgets_notifications_enabled is truestring""no
budgets_slack_usernameThe username that will appear on Slack messages. Only used when budegets_notifications_enabled is truestring""no
budgets_slack_webhook_urlThe URL of Slack webhook. Only used when budgets_notifications_enabled is truestring""no
contextSingle 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.
"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": [
"name": null,
"namespace": null,
"regex_replace_chars": null,
"stage": null,
"tags": {},
"tenant": null
delimiterDelimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.
descriptor_formatsDescribe 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).
enabledSet to false to prevent the module from creating any resourcesboolnullno
environmentID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'stringnullno
id_length_limitLimit 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.
label_key_caseControls 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.
label_orderThe 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.
label_value_caseControls 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.
labels_as_tagsSet 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.
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.
maximum_password_ageThe number of days that an user password is validnumber190no
minimum_password_lengthMinimum number of characters allowed in an IAM user password. Integer between 6 and 128, per
nameID 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.
namespaceID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally uniquestringnullno
regex_replace_charsTerraform 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.
regionAWS Regionstringn/ayes
service_quotasA list of service quotas to manage or lookup.
To lookup the value of a service quota, set value = null and either quota_code or quota_name.
To manage a service quota, set value to a number. Service Quotas can only be managed via quota_code.
For a more specific example, see
service_quotas_enabledWhether or not this component should handle Service Quotasboolfalseno
stageID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'stringnullno
tagsAdditional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.
tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno


account_aliasAccount alias