Version: Latest

account-settings

This component is responsible for provisioning account level settings: AWS Account Alias, EBS encryption, S3 block public access, alternate contacts, and SSM session preferences.

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
        billing_contact:
          name: "John Doe"
          title: "CFO" 
          email_address: "[email protected]"
          phone_number: "+1-555-123-4567"
        operations_contact:
          name: "Jane Smith"
          title: "DevOps Lead"
          email_address: "[email protected]"
          phone_number: "+1-555-234-5678"
        security_contact:
          name: "Bob Wilson"
          title: "CISO"
          email_address: "[email protected]"
          phone_number: "+1-555-345-6789"
        ssm_session_preferences_enabled: true
        ssm_session_idle_timeout_minutes: 30

Variables

Required Variables

region (string) required: AWS Region

Optional Variables

account_alias (string) optional

The IAM account alias. If not set, uses the module ID

Default value: null

account_alias_enabled (bool) optional

Whether to create the IAM account alias

Default value: true

billing_contact optional

Billing alternate contact information

Type:

object({
name          = string
title         = string
email_address = string
phone_number  = string
})

Default value: null

ebs_default_encryption_enabled (bool) optional

Whether to enable EBS default encryption

Default value: true

ebs_default_kms_key_arn (string) optional

The ARN of the KMS key for EBS default encryption. If not set, uses the AWS-managed key.

Default value: null

import_account_alias (string) optional

Set to the existing IAM account alias to import it into Terraform state. Set to null after successful import.

Default value: null

operations_contact optional

Operations alternate contact information

Type:

object({
name          = string
title         = string
email_address = string
phone_number  = string
})

Default value: null

s3_block_public_access_enabled (bool) optional

Whether to enable S3 account-level public access block

Default value: true

s3_block_public_acls (bool) optional

Whether to block public ACLs

Default value: true

s3_block_public_policy (bool) optional

Whether to block public bucket policies

Default value: true

s3_ignore_public_acls (bool) optional

Whether to ignore public ACLs

Default value: true

s3_restrict_public_buckets (bool) optional

Whether to restrict public buckets

Default value: true

security_contact optional

Security alternate contact information

Type:

object({
name          = string
title         = string
email_address = string
phone_number  = string
})

Default value: null

ssm_session_idle_timeout_minutes (number) optional

The idle session timeout in minutes for SSM Session Manager. AWS default is 20 minutes.

Default value: 20

ssm_session_preferences_enabled (bool) optional

Whether to configure SSM Session Manager preferences (idle timeout)

Default value: false

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

account_alias: The IAM account alias
billing_contact_configured: Whether billing contact was configured
ebs_encryption_configured: Whether EBS default encryption was configured
operations_contact_configured: Whether operations contact was configured
s3_public_access_block_configured: Whether S3 public access block was configured
security_contact_configured: Whether security contact was configured
ssm_session_idle_timeout_minutes: The configured SSM session idle timeout in minutes
ssm_session_preferences_configured: Whether SSM Session Manager preferences were configured

Dependencies

Requirements

terraform, version: >= 1.7.0
aws, version: >= 4.9.0, < 6.0.0

Providers

aws, version: >= 4.9.0, < 6.0.0

Modules

Name	Version	Source	Description
`this`	0.25.0	`cloudposse/label/null`	n/a

Resources

The following resources are used by this module:

aws_account_alternate_contact.billing (resource)
aws_account_alternate_contact.operations (resource)
aws_account_alternate_contact.security (resource)
aws_ebs_default_kms_key.this (resource)
aws_ebs_encryption_by_default.this (resource)
aws_iam_account_alias.this (resource)
aws_s3_account_public_access_block.this (resource)
aws_ssm_document.session_manager_prefs (resource)

Data Sources

The following data sources are used by this module:

Usage​

Variables​

Required Variables​

Optional Variables​

Context Variables​

Outputs​

Dependencies​

Requirements​

Providers​

Modules​

Resources​

Data Sources​

Usage

Variables

Required Variables

Optional Variables

Context Variables

Outputs

Dependencies

Requirements

Providers

Modules

Resources

Data Sources