acm

This component is responsible for requesting an ACM certificate for a domain and adding a CNAME record to the DNS zone to complete certificate validation.

The ACM component is to manage an unlimited number of certificates, predominantly for vanity domains. While the dns-primary component has the ability to generate ACM certificates, it is very opinionated and can only manage one zone. In reality, companies have many branded domains associated with a load balancer, so we need to be able to generate more complicated certificates.

We have, as a convenience, the ability to create an ACM certificate as part of creating a DNS zone, whether primary or delegated. That convenience is limited to creating example.com and *.example.com when creating a zone for example.com. For example, Acme has delegated acct.acme.com and in addition to *.acct.acme.com needed an ACM certificate for *.usw2.acct.acme.com, so we use the ACM component to provision that, rather than extend the DNS primary or delegated components to take a list of additional certificates. Both are different views on the Single Responsibility Principle.

Usage

Stack Level: Global or Regional

Here's an example snippet for how to use this component.

components:
  terraform:
    acm:
      settings:
        spacelift:
          workspace_enabled: true
      vars:
        enabled: true
        domain_name: acme.com
        process_domain_validation_options: false
        validation_method: DNS
        # NOTE: The following subject alternative name is automatically added by the module.
        #       Additional entries can be added by providing this input.
        # subject_alternative_names:
        #   - "*.acme.com"

ACM using a private CA

components:
  terraform:
    acm:
      settings:
        spacelift:
          workspace_enabled: true
      vars:
        enabled: true
        domain_name: acme.com
        process_domain_validation_options: false
        dns_private_zone_enabled: true
        certificate_authority_component_name: private-ca-subordinate
        certificate_authority_stage_name: pca
        certificate_authority_environment_name: use2
        certificate_authority_component_key: subordinate

Variables

Required Variables

region (string) required: AWS Region

Optional Variables

certificate_authority_component_key (string) optional

Use this component key e.g. root or mgmt to read from the remote state to get the certificate_authority_arn if using an authority type of SUBORDINATE

Default value: null

certificate_authority_component_name (string) optional

Use this component name to read from the remote state to get the certificate_authority_arn if using an authority type of SUBORDINATE

Default value: null

certificate_authority_enabled (bool) optional

Whether to use the certificate authority or not

Default value: false

certificate_authority_environment_name (string) optional

Use this environment name to read from the remote state to get the certificate_authority_arn if using an authority type of SUBORDINATE

Default value: null

certificate_authority_stage_name (string) optional

Use this stage name to read from the remote state to get the certificate_authority_arn if using an authority type of SUBORDINATE

Default value: null

dns_delegated_component_name (string) optional

Use this component name to read from the remote state to get the dns_delegated zone ID

Default value: "dns-delegated"

dns_delegated_environment_name (string) optional

Use this environment name to read from the remote state to get the dns_delegated zone ID

Default value: "gbl"

dns_delegated_stage_name (string) optional

Use this stage name to read from the remote state to get the dns_delegated zone ID

Default value: null

dns_private_zone_enabled (bool) optional

Whether to set the zone to public or private

Default value: false

domain_name (string) optional

Root domain name

Default value: ""

domain_name_prefix (string) optional

Root domain name prefix to use with DNS delegated remote state

Default value: ""

process_domain_validation_options (bool) optional

Flag to enable/disable processing of the record to add to the DNS zone to complete certificate validation

Default value: false

subject_alternative_names (list(string)) optional

A list of domains that should be SANs in the issued certificate

Default value: [ ]

subject_alternative_names_prefixes (list(string)) optional

A list of domain prefixes to use with DNS delegated remote state that should be SANs in the issued certificate

Default value: [ ]

validation_method (string) optional

Method to use for validation, DNS or EMAIL

Default value: "DNS"

zone_name (string) optional

Name of the zone in which to place the DNS validation records to validate the certificate.
Typically a domain name. Default of "" actually defaults to domain_name.

Default value: ""

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

arn: The ARN of the certificate
domain_name: Certificate domain name
domain_validation_options: CNAME records that are added to the DNS zone to complete certificate validation
id: The ID of the certificate

Dependencies

Requirements

terraform, version: >= 1.0.0
aws, version: >= 4.9.0

Providers

aws, version: >= 4.9.0

Modules

Name	Version	Source	Description
`acm`	0.16.3	`cloudposse/acm-request-certificate/aws`	https://github.com/cloudposse/terraform-aws-acm-request-certificate
`dns_delegated`	1.5.0	`cloudposse/stack-config/yaml//modules/remote-state`	n/a
`iam_roles`	latest	`../account-map/modules/iam-roles`	n/a
`private_ca`	1.5.0	`cloudposse/stack-config/yaml//modules/remote-state`	n/a
`this`	0.25.0	`cloudposse/label/null`	n/a

Resources

The following resources are used by this module:

aws_ssm_parameter.acm_arn (resource)

Data Sources

The following data sources are used by this module:

aws_route53_zone.default (data source)

References

cloudposse/terraform-aws-components - Cloud Posse's upstream component

Usage​

Variables​

Required Variables​

Optional Variables​

Context Variables​

Outputs​

Dependencies​

Requirements​

Providers​

Modules​

Resources​

Data Sources​

References​

Usage

Variables

Required Variables

Optional Variables

Context Variables

Outputs

Dependencies

Requirements

Providers

Modules

Resources

Data Sources

References