README.md

March 24, 2026 Β· View on GitHub

Project Banner

Latest ReleaseSlack CommunityGet Support

This component is responsible for provisioning account-level settings: AWS Account Alias, EBS encryption, S3 block public access, alternate contacts, SSM session preferences, EBS snapshot block public access, EC2 instance metadata defaults, EC2 AMI block public access, and EMR block public access configuration.

Tip

πŸ‘½ Use Atmos with Terraform

Cloud Posse uses atmos to easily orchestrate multiple environments using Terraform.
Works with Github Actions, Atlantis, or Spacelift.

Watch demo of using Atmos with Terraform
Example of running atmos to manage infrastructure from our Quick Start tutorial.

Introduction

Warning

The latest version of this component (version 2) assumes you have Atmos Auth set up, and it has a very simple providers.tf.

If you are still using aws-teams and team-roles, update your component.yaml to use providers.depth-1.tf from cloudposse-terraform-components/mixins via:

mixins:
  # Use upstream mixin for providers.tf without account-map dependency
  - uri: https://raw.githubusercontent.com/cloudposse-terraform-components/mixins/{{ .Version }}/src/mixins/providers.depth-1.tf
    version: v0.3.2
    filename: providers.tf

to overwrite the current one.

Usage

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):

components:
  terraform:
    account-settings:
      vars:
        enabled: true
        account_alias_enabled: true
        s3_block_public_access_enabled: true
        ebs_default_encryption_enabled: true
        ebs_snapshot_block_public_access_enabled: true
        ec2_instance_metadata_defaults_enabled: true
        ec2_image_block_public_access_enabled: true
        emr_block_public_access_enabled: true
        ssm_block_public_document_sharing: true
        billing_contact:
          name: "John Doe"
          title: "CFO"
          email_address: "billing@example.com"
          phone_number: "+1-555-123-4567"
        operations_contact:
          name: "Jane Smith"
          title: "DevOps Lead"
          email_address: "ops@example.com"
          phone_number: "+1-555-234-5678"
        security_contact:
          name: "Bob Wilson"
          title: "CISO"
          email_address: "security@example.com"
          phone_number: "+1-555-345-6789"
        ssm_session_preferences_enabled: true
        ssm_session_idle_timeout_minutes: 30

Important

In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic approach for updating versions to avoid unexpected changes.

Requirements

NameVersion
terraform>= 1.7.0
aws>= 6.0.0

Providers

NameVersion
aws>= 6.0.0

Modules

NameSourceVersion
thiscloudposse/label/null0.25.0

Resources

NameType
aws_account_alternate_contact.billingresource
aws_account_alternate_contact.operationsresource
aws_account_alternate_contact.securityresource
aws_ebs_default_kms_key.thisresource
aws_ebs_encryption_by_default.thisresource
aws_ebs_snapshot_block_public_access.thisresource
aws_ec2_image_block_public_access.thisresource
aws_ec2_instance_metadata_defaults.thisresource
aws_emr_block_public_access_configuration.thisresource
aws_iam_account_alias.thisresource
aws_s3_account_public_access_block.thisresource
aws_ssm_document.session_manager_prefsresource
aws_ssm_service_setting.block_public_document_sharingresource

Inputs

NameDescriptionTypeDefaultRequired
account_aliasThe IAM account alias. If not set, uses the module IDstringnullno
account_alias_enabledWhether to create the IAM account aliasbooltrueno
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.
map(string){}no
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.
list(string)[]no
billing_contactBilling alternate contact information
object({
name = string
title = string
email_address = string
phone_number = string
})
nullno
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.
any
{
"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
}
no
delimiterDelimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.
stringnullno
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).
any{}no
ebs_default_encryption_enabledWhether to enable EBS default encryptionbooltrueno
ebs_default_kms_key_arnThe ARN of the KMS key for EBS default encryption. If not set, uses the AWS-managed key.stringnullno
ebs_snapshot_block_public_access_enabledWhether to enable EBS snapshot block public accessbooltrueno
ebs_snapshot_block_public_access_stateThe state of EBS snapshot block public access. Valid values are 'block-all-sharing', 'block-new-sharing', and 'unblocked'.string"block-all-sharing"no
ec2_image_block_public_access_enabledWhether to enable EC2 AMI block public accessbooltrueno
ec2_image_block_public_access_stateThe state of EC2 AMI block public access. Valid values are 'block-new-sharing' and 'unblocked'.string"block-new-sharing"no
ec2_instance_metadata_defaults_enabledWhether to configure EC2 instance metadata defaultsbooltrueno
ec2_instance_metadata_http_endpointWhether the instance metadata service is available. Valid values are 'enabled', 'disabled', and 'no-preference'.string"enabled"no
ec2_instance_metadata_http_put_response_hop_limitThe desired HTTP PUT response hop limit for instance metadata requests. Valid values are between 1 and 64, or -1 for no preference.number1no
ec2_instance_metadata_http_tokensWhether the instance metadata service requires session tokens (IMDSv2). Valid values are 'required', 'optional', and 'no-preference'.string"required"no
ec2_instance_metadata_tagsWhether to enable access to instance tags from the instance metadata service. Valid values are 'enabled', 'disabled', and 'no-preference'.string"enabled"no
emr_block_public_access_enabledWhether to configure EMR block public accessbooltrueno
emr_block_public_security_group_rulesWhether to block EMR clusters from being created with public security group rulesbooltrueno
emr_permitted_public_security_group_rule_rangesList of permitted port ranges for public security group rules in EMR. Each object must have min_range and max_range. Default is an empty list (no permitted ranges).
list(object({
min_range = number
max_range = number
}))
[]no
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.
numbernullno
import_account_aliasSet to the existing IAM account alias to import it into Terraform state. Set to null after successful import.stringnullno
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.
stringnullno
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.
list(string)nullno
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.
stringnullno
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.
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.
set(string)
[
"default"
]
no
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.
stringnullno
namespaceID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally uniquestringnullno
operations_contactOperations alternate contact information
object({
name = string
title = string
email_address = string
phone_number = string
})
nullno
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.
stringnullno
regionAWS Regionstringn/ayes
s3_block_public_access_enabledWhether to enable S3 account-level public access blockbooltrueno
s3_block_public_aclsWhether to block public ACLsbooltrueno
s3_block_public_policyWhether to block public bucket policiesbooltrueno
s3_ignore_public_aclsWhether to ignore public ACLsbooltrueno
s3_restrict_public_bucketsWhether to restrict public bucketsbooltrueno
security_contactSecurity alternate contact information
object({
name = string
title = string
email_address = string
phone_number = string
})
nullno
ssm_block_public_document_sharingWhether to block public document sharing in SSMboolfalseno
ssm_session_idle_timeout_minutesThe idle session timeout in minutes for SSM Session Manager. AWS default is 20 minutes.number20no
ssm_session_preferences_enabledWhether to configure SSM Session Manager preferences (idle timeout)boolfalseno
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.
map(string){}no
tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno

Outputs

NameDescription
account_aliasThe IAM account alias
billing_contact_configuredWhether billing contact was configured
ebs_encryption_configuredWhether EBS default encryption was configured
ebs_snapshot_block_public_access_configuredWhether EBS snapshot block public access was configured
ebs_snapshot_block_public_access_stateThe state of EBS snapshot block public access
ec2_image_block_public_access_configuredWhether EC2 AMI block public access was configured
ec2_image_block_public_access_stateThe state of EC2 AMI block public access
ec2_instance_metadata_defaults_configuredWhether EC2 instance metadata defaults were configured
emr_block_public_access_configuredWhether EMR block public access was configured
operations_contact_configuredWhether operations contact was configured
s3_public_access_block_configuredWhether S3 public access block was configured
security_contact_configuredWhether security contact was configured
ssm_block_public_document_sharing_configuredWhether SSM block public document sharing was configured
ssm_session_idle_timeout_minutesThe configured SSM session idle timeout in minutes
ssm_session_preferences_configuredWhether SSM Session Manager preferences were configured

Check out these related projects.

  • Cloud Posse Terraform Modules - Our collection of reusable Terraform modules used by our reference architectures.
  • Atmos - Atmos is like docker-compose but for your infrastructure

References

For additional context, refer to some of these links.

Tip

Use Terraform Reference Architectures for AWS

Use Cloud Posse's ready-to-go terraform architecture blueprints for AWS to get up and running quickly.

βœ… We build it together with your team.
βœ… Your team owns everything.
βœ… 100% Open Source and backed by fanatical support.

Request Quote

πŸ“š Learn More

Cloud Posse is the leading DevOps Accelerator for funded startups and enterprises.

Your team can operate like a pro today.

Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.

Day-0: Your Foundation for Success

  • Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
  • Deployment Strategy. Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.
  • Site Reliability Engineering. Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.
  • Security Baseline. Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.
  • GitOps. Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.

Request Quote

Day-2: Your Operational Mastery

  • Training. Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.
  • Support. Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.
  • Troubleshooting. Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.
  • Code Reviews. Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration.
  • Bug Fixes. Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.
  • Migration Assistance. Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.
  • Customer Workshops. Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.

Request Quote

✨ Contributing

This project is under active development, and we encourage contributions from our community.

Many thanks to our outstanding contributors:

For πŸ› bug reports & feature requests, please use the issue tracker.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

  1. Review our Code of Conduct and Contributor Guidelines.
  2. Fork the repo on GitHub
  3. Clone the project to your own machine
  4. Commit changes to your own branch
  5. Push your work back up to your fork
  6. Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

Running Terraform Tests

We use Atmos to streamline how Terraform tests are run. It centralizes configuration and wraps common test workflows with easy-to-use commands.

All tests are located in the test/ folder.

Under the hood, tests are powered by Terratest together with our internal Test Helpers library, providing robust infrastructure validation.

Setup dependencies:

To run tests:

  • Run all tests:
    atmos test run
    
  • Clean up test artifacts:
    atmos test clean
    
  • Explore additional test options:
    atmos test --help
    

The configuration for test commands is centrally managed. To review what's being imported, see the atmos.yaml file.

Learn more about our automated testing in our documentation or implementing custom commands with atmos.

🌎 Slack Community

Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.

πŸ“° Newsletter

Sign up for our newsletter and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. Dropped straight into your Inbox every week β€” and usually a 5-minute read.

πŸ“† Office Hours

Join us every Wednesday via Zoom for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a live Q&A that you can’t find anywhere else. It's FREE for everyone!

License

License

Preamble to the Apache License, Version 2.0

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.

Trademarks

All other trademarks referenced herein are the property of their respective owners.


Copyright Β© 2017-2026 Cloud Posse, LLC

README footer

Beacon