Skip to content

This component is responsible for provisioning: S3 bucket, CloudFront distribution for a Single Page Application, ACM placed in us-east-1 regardless of the stack region (requirement of CloudFront)

Notifications You must be signed in to change notification settings

cloudposse-terraform-components/aws-spa-s3-cloudfront

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

25 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Project Banner

Latest ReleaseSlack Community

This component is responsible for provisioning:

  • S3 bucket
  • CloudFront distribution for a Single Page Application
  • ACM placed in us-east-1 regardless of the stack region (requirement of CloudFront)

NOTE: The component does not use the ACM created by dns-delegated, because the ACM region has to be us-east-1.

Usage

Stack Level: Regional

Here are some example snippets for how to use this component:

An import for all instantiations of the spa-s3-cloudfront component can be created at stacks/spa/spa-defaults.yaml:

components:
  terraform:
    spa-s3-cloudfront:
      vars:
        # lookup GitHub Runner IAM role via remote state
        github_runners_deployment_principal_arn_enabled: true
        github_runners_component_name: github-runners
        github_runners_tenant_name: core
        github_runners_environment_name: ue2
        github_runners_stage_name: auto
        origin_force_destroy: false
        origin_versioning_enabled: true
        origin_block_public_acls: true
        origin_block_public_policy: true
        origin_ignore_public_acls: true
        origin_restrict_public_buckets: true
        origin_encryption_enabled: true
        cloudfront_index_document: index.html
        cloudfront_ipv6_enabled: false
        cloudfront_compress: true
        cloudfront_default_root_object: index.html
        cloudfront_viewer_protocol_policy: redirect-to-https

An import for all instantiations for a specific SPA can be created at stacks/spa/example-spa.yaml:

components:
  terraform:
    example-spa:
      component: spa-s3-cloudfront
      vars:
        name: example-spa
        site_subdomain: example-spa
        cloudfront_allowed_methods:
          - GET
          - HEAD
        cloudfront_cached_methods:
          - GET
          - HEAD
        cloudfront_custom_error_response:
          - error_caching_min_ttl: 1
            error_code: 403
            response_code: 200
            response_page_path: /index.html
        cloudfront_default_ttl: 60
        cloudfront_min_ttl: 60
        cloudfront_max_ttl: 60

Finally, the spa-s3-cloudfront component can be instantiated in a stack config:

import:
  - spa/example-spa

components:
  terraform:
    example-spa:
      component: spa-s3-cloudfront
      settings:
        spacelift:
          workspace_enabled: true
      vars: {}

Failover Origins

Failover origins are supported via var.failover_s3_origin_name and var.failover_s3_origin_region.

Preview Environments

SPA Preview environments (i.e. subdomain.example.com mapping to a /subdomain path in the S3 bucket) powered by Lambda@Edge are supported via var.preview_environment_enabled. See the both the variable description and inline documentation for an extensive explanation for how these preview environments work.

Customizing Lambda@Edge

This component supports customizing Lambda@Edge functions for the CloudFront distribution. All Lambda@Edge function configuration is deep merged before being passed to the cloudposse/cloudfront-s3-cdn/aws//modules/lambda@edge module. You can add additional functions and overwrite existing functions as such:

import:
  - catalog/spa-s3-cloudfront/defaults

components:
  terraform:
    refarch-docs-site-spa:
      metadata:
        component: spa-s3-cloudfront
        inherits:
          - spa-s3-cloudfront-defaults
      vars:
        enabled: true
        lambda_edge_functions:
          viewer_request: # overwrite existing function
            source: null # this overwrites the 404 viewer request source with deep merging
            source_zip: "./dist/lambda_edge_paywall_viewer_request.zip"
            runtime: "nodejs16.x"
            handler: "index.handler"
            event_type: "viewer-request"
            include_body: false
          viewer_response: # new function
            source_zip: "./dist/lambda_edge_paywall_viewer_response.zip"
            runtime: "nodejs16.x"
            handler: "index.handler"
            event_type: "viewer-response"
            include_body: false

Requirements

Name Version
terraform >= 1.0.0
aws >= 4.9.0

Providers

Name Version
aws >= 4.9.0
aws.failover >= 4.9.0

Modules

Name Source Version
acm_request_certificate cloudposse/acm-request-certificate/aws 0.18.0
dns_delegated cloudposse/stack-config/yaml//modules/remote-state 1.5.0
gha_assume_role ../account-map/modules/team-assume-role-policy n/a
gha_role_name cloudposse/label/null 0.25.0
github_runners cloudposse/stack-config/yaml//modules/remote-state 1.5.0
iam_roles ../account-map/modules/iam-roles n/a
lambda_edge cloudposse/cloudfront-s3-cdn/aws//modules/lambda@edge 0.92.0
lambda_edge_functions cloudposse/config/yaml//modules/deepmerge 1.0.2
spa_web cloudposse/cloudfront-s3-cdn/aws 0.95.0
this cloudposse/label/null 0.25.0
utils cloudposse/utils/aws 1.3.0
waf cloudposse/stack-config/yaml//modules/remote-state 1.5.0

Resources

Name Type
aws_cloudfront_cache_policy.created_cache_policies resource
aws_cloudfront_origin_request_policy.created_origin_request_policies resource
aws_iam_policy.additional_lambda_edge_permission resource
aws_iam_role.github_actions resource
aws_iam_role_policy_attachment.additional_lambda_edge_permission resource
aws_shield_protection.shield_protection resource
aws_iam_policy_document.additional_lambda_edge_permission data source
aws_iam_policy_document.github_actions_iam_policy data source
aws_s3_bucket.failover_bucket 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
block_origin_public_access_enabled When set to 'true' the s3 origin bucket will have public access block enabled. bool true no
cloudfront_access_log_bucket_name When cloudfront_access_log_create_bucket is false, this is the name of the existing S3 Bucket where
CloudFront Access Logs are to be delivered and is required. IGNORED when cloudfront_access_log_create_bucket is true.
string "" no
cloudfront_access_log_bucket_name_rendering_enabled If set to true, then the CloudFront origin access logs bucket name will be rendered by calling format("%v-%v-%v-%v", var.namespace, var.environment, var.stage, var.cloudfront_access_log_bucket_name).
Otherwise, the value for cloudfront_access_log_bucket_name will need to be the globally unique name of the access logs bucket.

For example, if this component produces an origin bucket named eg-ue1-devplatform-example and cloudfront_access_log_bucket_name is set to
example-cloudfront-access-logs, then the bucket name will be rendered to be eg-ue1-devplatform-example-cloudfront-access-logs.
bool false no
cloudfront_access_log_create_bucket When true and cloudfront_access_logging_enabled is also true, this module will create a new,
separate S3 bucket to receive CloudFront Access Logs.
bool true no
cloudfront_access_log_prefix Prefix to use for CloudFront Access Log object keys. Defaults to no prefix. string "" no
cloudfront_access_log_prefix_rendering_enabled Whether or not to dynamically render ${module.this.id} at the end of var.cloudfront_access_log_prefix. bool false no
cloudfront_allowed_methods List of allowed methods (e.g. GET, PUT, POST, DELETE, HEAD) for AWS CloudFront. list(string)
[
"DELETE",
"GET",
"HEAD",
"OPTIONS",
"PATCH",
"POST",
"PUT"
]
no
cloudfront_aws_shield_protection_enabled Enable or disable AWS Shield Advanced protection for the CloudFront distribution. If set to 'true', a subscription to AWS Shield Advanced must exist in this account. bool false no
cloudfront_aws_waf_component_name The name of the component used when deploying WAF ACL string "waf" no
cloudfront_aws_waf_environment The environment where the WAF ACL for CloudFront distribution exists. string null no
cloudfront_aws_waf_protection_enabled Enable or disable AWS WAF for the CloudFront distribution.

This assumes that the aws-waf-acl-default-cloudfront component has been deployed to the regional stack corresponding
to var.waf_acl_environment.
bool true no
cloudfront_cached_methods List of cached methods (e.g. GET, PUT, POST, DELETE, HEAD). list(string)
[
"GET",
"HEAD"
]
no
cloudfront_compress Compress content for web requests that include Accept-Encoding: gzip in the request header. bool false no
cloudfront_custom_error_response List of one or more custom error response element maps.
list(object({
error_caching_min_ttl = optional(string, "10")
error_code = string
response_code = string
response_page_path = string
}))
[] no
cloudfront_default_root_object Object that CloudFront return when requests the root URL. string "index.html" no
cloudfront_default_ttl Default amount of time (in seconds) that an object is in a CloudFront cache. number 60 no
cloudfront_index_document Amazon S3 returns this index document when requests are made to the root domain or any of the subfolders. string "index.html" no
cloudfront_ipv6_enabled Set to true to enable an AAAA DNS record to be set as well as the A record. bool true no
cloudfront_lambda_function_association A config block that configures the CloudFront distribution with lambda@edge functions for specific events.
list(object({
event_type = string
include_body = bool
lambda_arn = string
}))
[] no
cloudfront_max_ttl Maximum amount of time (in seconds) that an object is in a CloudFront cache. number 31536000 no
cloudfront_min_ttl Minimum amount of time that you want objects to stay in CloudFront caches. number 0 no
cloudfront_viewer_protocol_policy Limit the protocol users can use to access content. One of allow-all, https-only, or redirect-to-https. string "redirect-to-https" no
comment Any comments you want to include about the distribution. string "Managed by Terraform" 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_origins A list of additional custom website origins for this distribution.
list(object({
domain_name = string
origin_id = string
origin_path = string
custom_headers = list(object({
name = string
value = string
}))
custom_origin_config = object({
http_port = number
https_port = number
origin_protocol_policy = string
origin_ssl_protocols = list(string)
origin_keepalive_timeout = number
origin_read_timeout = number
})
}))
[] no
delimiter Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.
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_environment_name The environment where dns-delegated component is deployed to string "gbl" 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
external_aliases List of FQDN's - Used to set the Alternate Domain Names (CNAMEs) setting on CloudFront. No new Route53 records will be created for these.

Setting process_domain_validation_options to true may cause the component to fail if an external_alias DNS zone is not controlled by Terraform.

Setting preview_environment_enabled to true will cause this variable to be ignored.
list(string) [] no
failover_criteria_status_codes List of HTTP Status Codes to use as the origin group failover criteria. list(string)
[
403,
404,
500,
502
]
no
failover_s3_origin_environment The fixed name of the AWS Region where the
failover S3 origin exists. Setting this variable will enable use of a failover S3 origin, but it is required for the
failover S3 origin to exist beforehand. This variable is used in conjunction with var.failover_s3_origin_format to
build out the name of the Failover S3 origin in the specified region.

For example, if this component creates an origin of name eg-ue1-devplatform-example and this variable is set to uw1,
then it is expected that a bucket with the name eg-uw1-devplatform-example-failover exists in us-west-1.
string null no
failover_s3_origin_format If var.failover_s3_origin_environment is supplied, this is the format to use for the failover S3 origin bucket name when
building the name via format([format], var.namespace, var.failover_s3_origin_environment, var.stage, var.name)
and then looking it up via the aws_s3_bucket Data Source.

For example, if this component creates an origin of name eg-ue1-devplatform-example and var.failover_s3_origin_environment
is set to uw1, then it is expected that a bucket with the name eg-uw1-devplatform-example-failover exists in us-west-1.
string "%v-%v-%v-%v-failover" no
forward_cookies Specifies whether you want CloudFront to forward all or no cookies to the origin. Can be 'all' or 'none' string "none" no
forward_header_values A list of whitelisted header values to forward to the origin (incompatible with cache_policy_id) list(string)
[
"Access-Control-Request-Headers",
"Access-Control-Request-Method",
"Origin"
]
no
github_actions_allowed_repos A list of the GitHub repositories that are allowed to assume this role from GitHub Actions. For example,
["cloudposse/infra-live"]. Can contain "*" as wildcard.
If org part of repo name is omitted, "cloudposse" will be assumed.
list(string) [] no
github_actions_iam_role_attributes Additional attributes to add to the role name list(string) [] no
github_actions_iam_role_enabled Flag to toggle creation of an IAM Role that GitHub Actions can assume to access AWS resources bool false no
github_runners_component_name The name of the component that deploys GitHub Runners, used in remote-state lookup string "github-runners" no
github_runners_deployment_principal_arn_enabled A flag that is used to decide whether or not to include the GitHub Runner's IAM role in origin_deployment_principal_arns list bool true no
github_runners_environment_name The name of the environment where the CloudTrail bucket is provisioned string "ue2" no
github_runners_stage_name The stage name where the CloudTrail bucket is provisioned string "auto" no
github_runners_tenant_name The tenant name where the GitHub Runners are provisioned string null no
http_version The maximum HTTP version to support on the distribution. Allowed values are http1.1, http2, http2and3 and http3 string "http2" 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
lambda_edge_allowed_ssm_parameters The Lambda@Edge functions will be allowed to access the list of AWS SSM parameter with these ARNs list(string) [] no
lambda_edge_destruction_delay The delay, in Golang ParseDuration format, to wait before destroying the Lambda@Edge
functions.

This delay is meant to circumvent Lambda@Edge functions not being immediately deletable following their dissociation from
a CloudFront distribution, since they are replicated to CloudFront Edge servers around the world.

If set to null, no delay will be introduced.

By default, the delay is 20 minutes. This is because it takes about 3 minutes to destroy a CloudFront distribution, and
around 15 minutes until the Lambda@Edge function is available for deletion, in most cases.

For more information, see: hashicorp/terraform-provider-aws#1721.
string "20m" no
lambda_edge_functions Lambda@Edge functions to create.

The key of this map is the name of the Lambda@Edge function.

This map will be deep merged with each enabled default function. Use deep merge to change or overwrite specific values passed by those function objects.
map(object({
source = optional(list(object({
filename = string
content = string
})))
source_dir = optional(string)
source_zip = optional(string)
runtime = string
handler = string
event_type = string
include_body = bool
}))
{} no
lambda_edge_handler The default Lambda@Edge handler for all functions.

This value is deep merged in module.lambda_edge_functions with var.lambda_edge_functions and can be overwritten for any individual function.
string "index.handler" no
lambda_edge_runtime The default Lambda@Edge runtime for all functions.

This value is deep merged in module.lambda_edge_functions with var.lambda_edge_functions and can be overwritten for any individual function.
string "nodejs16.x" 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
ordered_cache An ordered list of cache behaviors resource for this distribution.
List in order of precedence (first match wins). This is in addition to the default cache policy.
Set target_origin_id to "" to specify the S3 bucket origin created by this module.
Set cache_policy_id to "" to use cache_policy_name for creating a new policy. At least one of the two must be set.
Set origin_request_policy_id to "" to use origin_request_policy_name for creating a new policy. At least one of the two must be set.
list(object({
target_origin_id = string
path_pattern = string

allowed_methods = list(string)
cached_methods = list(string)
compress = bool
trusted_signers = list(string)
trusted_key_groups = list(string)

cache_policy_name = optional(string)
cache_policy_id = optional(string)
origin_request_policy_name = optional(string)
origin_request_policy_id = optional(string)

viewer_protocol_policy = string
min_ttl = number
default_ttl = number
max_ttl = number
response_headers_policy_id = string

forward_query_string = bool
forward_header_values = list(string)
forward_cookies = string
forward_cookies_whitelisted_names = list(string)

lambda_function_association = list(object({
event_type = string
include_body = bool
lambda_arn = string
}))

function_association = list(object({
event_type = string
function_arn = string
}))

origin_request_policy = optional(object({
cookie_behavior = optional(string, "none")
header_behavior = optional(string, "none")
query_string_behavior = optional(string, "none")

cookies = optional(list(string), [])
headers = optional(list(string), [])
query_strings = optional(list(string), [])
}), {})
}))
[] no
origin_allow_ssl_requests_only Set to true in order to have the origin bucket require requests to use Secure Socket Layer (HTTPS/SSL). This will explicitly deny access to HTTP requests bool true no
origin_bucket Name of an existing S3 bucket to use as the origin. If this is not provided, this component will create a new s3 bucket using var.name and other context related inputs string null no
origin_deployment_actions List of actions to permit origin_deployment_principal_arns to perform on bucket and bucket prefixes (see origin_deployment_principal_arns) list(string)
[
"s3:PutObject",
"s3:PutObjectAcl",
"s3:GetObject",
"s3:DeleteObject",
"s3:ListBucket",
"s3:ListBucketMultipartUploads",
"s3:GetBucketLocation",
"s3:AbortMultipartUpload"
]
no
origin_deployment_principal_arns List of role ARNs to grant deployment permissions to the origin Bucket. list(string) [] no
origin_encryption_enabled When set to 'true' the origin Bucket will have aes256 encryption enabled by default. bool true no
origin_force_destroy A boolean string that indicates all objects should be deleted from the origin Bucket so that the Bucket can be destroyed without error. These objects are not recoverable. bool false no
origin_s3_access_log_bucket_name Name of the existing S3 bucket where S3 Access Logs for the origin Bucket will be delivered. Default is not to enable S3 Access Logging for the origin Bucket. string "" no
origin_s3_access_log_bucket_name_rendering_enabled If set to true, then the S3 origin access logs bucket name will be rendered by calling format("%v-%v-%v-%v", var.namespace, var.environment, var.stage, var.origin_s3_access_log_bucket_name).
Otherwise, the value for origin_s3_access_log_bucket_name will need to be the globally unique name of the access logs bucket.

For example, if this component produces an origin bucket named eg-ue1-devplatform-example and origin_s3_access_log_bucket_name is set to
example-s3-access-logs, then the bucket name will be rendered to be eg-ue1-devplatform-example-s3-access-logs.
bool false no
origin_s3_access_log_prefix Prefix to use for S3 Access Log object keys. Defaults to logs/${module.this.id} string "" no
origin_s3_access_logging_enabled Set true to deliver S3 Access Logs to the origin_s3_access_log_bucket_name bucket.
Defaults to false if origin_s3_access_log_bucket_name is empty (the default), true otherwise.
Must be set explicitly if the access log bucket is being created at the same time as this module is being invoked.
bool null no
origin_versioning_enabled Enable or disable versioning for the origin Bucket. Versioning is a means of keeping multiple variants of an object in the same bucket. bool false no
parent_zone_name Parent domain name of site to publish. Defaults to format(parent_zone_name_pattern, stage, environment). string "" no
preview_environment_enabled Enable or disable SPA Preview Environments via Lambda@Edge, i.e. mapping subdomain.example.com to the /subdomain
path in the origin S3 bucket.

This variable implicitly affects the following variables:

* s3_website_enabled
* s3_website_password_enabled
* block_origin_public_access_enabled
* origin_allow_ssl_requests_only
* forward_header_values
* cloudfront_default_ttl
* cloudfront_min_ttl
* cloudfront_max_ttl
* cloudfront_lambda_function_association
bool false no
process_domain_validation_options Flag to enable/disable processing of the record to add to the DNS zone to complete certificate validation bool true 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
s3_object_ownership Specifies the S3 object ownership control on the origin bucket. Valid values are ObjectWriter, BucketOwnerPreferred, and 'BucketOwnerEnforced'. string "ObjectWriter" no
s3_origins A list of S3 origins (in addition to the one created by this component) for this distribution.
S3 buckets configured as websites are custom_origins, not s3_origins.
Specifying s3_origin_config.origin_access_identity as null or "" will have it translated to the origin_access_identity used by the origin created by this component.
list(object({
domain_name = string
origin_id = string
origin_path = string
s3_origin_config = object({
origin_access_identity = string
})
}))
[] no
s3_website_enabled Set to true to enable the created S3 bucket to serve as a website independently of CloudFront,
and to use that website as the origin.

Setting preview_environment_enabled will implicitly set this to true.
bool false no
s3_website_password_enabled If set to true, and s3_website_enabled is also true, a password will be required in the Referrer field of the
HTTP request in order to access the website, and CloudFront will be configured to pass this password in its requests.
This will make it much harder for people to bypass CloudFront and access the S3 website directly via its website endpoint.
bool false no
site_fqdn Fully qualified domain name of site to publish. Overrides site_subdomain and parent_zone_name. string "" no
site_subdomain Subdomain to plug into site_name_pattern to make site FQDN. string "" no
stage ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' string null 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
cloudfront_distribution_alias Cloudfront Distribution Alias Record.
cloudfront_distribution_domain_name Cloudfront Distribution Domain Name.
cloudfront_distribution_identity_arn CloudFront Distribution Origin Access Identity IAM ARN.
failover_s3_bucket_name Failover Origin bucket name, if enabled.
github_actions_iam_role_arn ARN of IAM role for GitHub Actions
github_actions_iam_role_name Name of IAM role for GitHub Actions
origin_s3_bucket_arn Origin bucket ARN.
origin_s3_bucket_name Origin bucket name.

References

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.

Related Projects

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

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!

🌎 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-2024 Cloud Posse, LLC

README footer

Beacon

About

This component is responsible for provisioning: S3 bucket, CloudFront distribution for a Single Page Application, ACM placed in us-east-1 regardless of the stack region (requirement of CloudFront)

Topics

Resources

Code of conduct

Security policy

Stars

Watchers

Forks

Sponsor this project

 

Packages

No packages published

Languages