Component: amplify

This component is responsible for provisioning AWS Amplify apps, backend environments, branches, domain associations, and webhooks.

Usage

Stack Level: Regional

Here's an example for how to use this component:

# stacks/catalog/amplify/defaults.yaml
components:
  terraform:
    amplify/defaults:
      metadata:
        type: abstract
      settings:
        spacelift:
          workspace_enabled: true
      vars:
        enabled: true
        # https://docs.aws.amazon.com/amplify/latest/userguide/setting-up-GitHub-access.html
        github_personal_access_token_secret_path: "/amplify/github_personal_access_token"
        platform: "WEB"
        enable_auto_branch_creation: false
        enable_basic_auth: false
        enable_branch_auto_build: true
        enable_branch_auto_deletion: false
        iam_service_role_enabled: false
        environment_variables: {}
        dns_delegated_component_name: "dns-delegated"
        dns_delegated_environment_name: "gbl"

# stacks/catalog/amplify/example.yaml
import:
  - catalog/amplify/defaults

components:
  terraform:
    amplify/example:
      metadata:
        # Point to the Terraform component
        component: amplify
      inherits:
        # Inherit the default settings
        - amplify/defaults
      vars:
        name: "example"
        description: "example Amplify App"
        repository: "https://github.com/cloudposse/amplify-test2"
        platform: "WEB_COMPUTE"
        enable_auto_branch_creation: false
        enable_basic_auth: false
        enable_branch_auto_build: true
        enable_branch_auto_deletion: false
        iam_service_role_enabled: true
        # https://docs.aws.amazon.com/amplify/latest/userguide/ssr-CloudWatch-logs.html
        iam_service_role_actions:
          - "logs:CreateLogStream"
          - "logs:CreateLogGroup"
          - "logs:DescribeLogGroups"
          - "logs:PutLogEvents"
        custom_rules: []
        auto_branch_creation_patterns: []
        environment_variables:
          NEXT_PRIVATE_STANDALONE: false
          NEXT_PUBLIC_TEST: test
          _LIVE_UPDATES: '[{"pkg":"node","type":"nvm","version":"16"},{"pkg":"next-version","type":"internal","version":"13.1.1"}]'
        environments:
          main:
            branch_name: "main"
            enable_auto_build: true
            backend_enabled: false
            enable_performance_mode: false
            enable_pull_request_preview: false
            framework: "Next.js - SSR"
            stage: "PRODUCTION"
            environment_variables: {}
          develop:
            branch_name: "develop"
            enable_auto_build: true
            backend_enabled: false
            enable_performance_mode: false
            enable_pull_request_preview: false
            framework: "Next.js - SSR"
            stage: "DEVELOPMENT"
            environment_variables: {}
        domain_config:
          enable_auto_sub_domain: false
          wait_for_verification: false
          sub_domain:
            - branch_name: "main"
              prefix: "example-prod"
            - branch_name: "develop"
              prefix: "example-dev"
        subdomains_dns_records_enabled: true
        certificate_verification_dns_record_enabled: false

The amplify/example YAML configuration defines an Amplify app in AWS. The app is set up to use the Next.js framework with SSR (server-side rendering) and is linked to the GitHub repository "https://github.com/cloudposse/amplify-test2".

The app is set up to have two environments: main and develop. Each environment has different configuration settings, such as the branch name, framework, and stage. The main environment is set up for production, while the develop environments is set up for development.

The app is also configured to have custom subdomains for each environment, with prefixes such as example-prod and example-dev. The subdomains are configured to use DNS records, which are enabled through the subdomains_dns_records_enabled variable.

The app also has an IAM service role configured with specific IAM actions, and environment variables set up for each environment. Additionally, the app is configured to use the Atmos Spacelift workspace, as indicated by the workspace_enabled: true setting.

The amplify/example Atmos component extends the amplify/defaults component.

The amplify/example configuration is imported into the stacks/mixins/stage/dev.yaml stack config file to be provisioned in the dev account.

# stacks/mixins/stage/dev.yaml
import:
  - catalog/amplify/example

You can execute the following command to provision the Amplify app using Atmos:

atmos terraform apply amplify/example -s <stack>

Requirements

Name	Version
terraform	>= 1.3.0
aws	>= 4.9.0

Providers

Name	Version
aws	>= 4.9.0

Modules

Name	Source	Version
amplify_app	cloudposse/amplify-app/aws	0.2.1
certificate_verification_dns_record	cloudposse/route53-cluster-hostname/aws	0.12.3
dns_delegated	cloudposse/stack-config/yaml//modules/remote-state	1.5.0
iam_roles	../account-map/modules/iam-roles	n/a
subdomains_dns_record	cloudposse/route53-cluster-hostname/aws	0.12.3
this	cloudposse/label/null	0.25.0

Resources

Name	Type
aws_ssm_parameter.github_pat	data source

Inputs

Name	Description	Type	Default	Required
additional_tag_map	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.	map(string)	{}	no
attributes	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.	list(string)	[]	no
auto_branch_creation_config	The automated branch creation configuration for the Amplify app	object({ basic_auth_credentials = optional(string) build_spec = optional(string) enable_auto_build = optional(bool) enable_basic_auth = optional(bool) enable_performance_mode = optional(bool) enable_pull_request_preview = optional(bool) environment_variables = optional(map(string)) framework = optional(string) pull_request_environment_name = optional(string) stage = optional(string) })	null	no
auto_branch_creation_patterns	The automated branch creation glob patterns for the Amplify app	list(string)	[]	no
basic_auth_credentials	The credentials for basic authorization for the Amplify app	string	null	no
build_spec	The build specification (build spec) for the Amplify app. If not provided then it will use the amplify.yml at the root of your project / branch.	string	null	no
certificate_verification_dns_record_enabled	Whether or not to create DNS records for SSL certificate validation. If using the DNS zone from dns-delegated, the SSL certificate is already validated, and this variable must be set to false.	bool	false	no
context	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.	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
custom_rules	The custom rules to apply to the Amplify App	list(object({ condition = optional(string) source = string status = optional(string) target = string }))	[]	no
delimiter	Delimiter to be used between ID elements. Defaults to - (hyphen). Set to "" to use no delimiter at all.	string	null	no
description	The description for the Amplify app	string	null	no
descriptor_formats	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).	any	{}	no
dns_delegated_component_name	The component name of dns-delegated	string	"dns-delegated"	no
dns_delegated_environment_name	The environment name of dns-delegated	string	"gbl"	no
domain_config	Amplify custom domain configuration	object({ domain_name = optional(string) enable_auto_sub_domain = optional(bool, false) wait_for_verification = optional(bool, false) sub_domain = list(object({ branch_name = string prefix = string })) })	null	no
enable_auto_branch_creation	Enables automated branch creation for the Amplify app	bool	false	no
enable_basic_auth	Enables basic authorization for the Amplify app. This will apply to all branches that are part of this app.	bool	false	no
enable_branch_auto_build	Enables auto-building of branches for the Amplify App	bool	true	no
enable_branch_auto_deletion	Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository	bool	false	no
enabled	Set to false to prevent the module from creating any resources	bool	null	no
environment	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'	string	null	no
environment_variables	The environment variables for the Amplify app	map(string)	{}	no
environments	The configuration of the environments for the Amplify App	map(object({ branch_name = optional(string) backend_enabled = optional(bool, false) environment_name = optional(string) deployment_artifacts = optional(string) stack_name = optional(string) display_name = optional(string) description = optional(string) enable_auto_build = optional(bool) enable_basic_auth = optional(bool) enable_notification = optional(bool) enable_performance_mode = optional(bool) enable_pull_request_preview = optional(bool) environment_variables = optional(map(string)) framework = optional(string) pull_request_environment_name = optional(string) stage = optional(string) ttl = optional(number) webhook_enabled = optional(bool, false) }))	{}	no
github_personal_access_token_secret_path	Path to the GitHub personal access token in AWS Parameter Store	string	"/amplify/github_personal_access_token"	no
iam_service_role_actions	List of IAM policy actions for the AWS Identity and Access Management (IAM) service role for the Amplify app. If not provided, the default set of actions will be used for the role if the variable iam_service_role_enabled is set to true.	list(string)	[]	no
iam_service_role_arn	The AWS Identity and Access Management (IAM) service role for the Amplify app. If not provided, a new role will be created if the variable iam_service_role_enabled is set to true.	list(string)	[]	no
iam_service_role_enabled	Flag to create the IAM service role for the Amplify app	bool	false	no
id_length_limit	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.	number	null	no
label_key_case	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.	string	null	no
label_order	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.	list(string)	null	no
label_value_case	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.	string	null	no
labels_as_tags	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.	set(string)	[ "default" ]	no
name	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.	string	null	no
namespace	ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique	string	null	no
oauth_token	The OAuth token for a third-party source control system for the Amplify app. The OAuth token is used to create a webhook and a read-only deploy key. The OAuth token is not stored.	string	null	no
platform	The platform or framework for the Amplify app	string	"WEB"	no
regex_replace_chars	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.	string	null	no
region	AWS region	string	n/a	yes
repository	The repository for the Amplify app	string	null	no
stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	string	null	no
subdomains_dns_records_enabled	Whether or not to create DNS records for the Amplify app custom subdomains	bool	false	no
tags	Additional tags (e.g. {'BusinessUnit': 'XYZ'}). Neither the tag keys nor the tag values will be modified by this module.	map(string)	{}	no
tenant	ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for	string	null	no

Outputs

Name	Description
arn	Amplify App ARN
backend_environments	Created backend environments
branch_names	The names of the created Amplify branches
default_domain	Amplify App domain (non-custom)
domain_association_arn	ARN of the domain association
domain_association_certificate_verification_dns_record	The DNS record for certificate verification
name	Amplify App name
sub_domains	DNS records and the verified status for the subdomains
webhooks	Created webhooks