Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
@sestrella
sestrella committed Dec 29, 2023
1 parent 9969315 commit a8230fd
Showing 1 changed file with 12 additions and 20 deletions.
32 changes: 12 additions & 20 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,8 @@

<!-- markdownlint-disable -->
# terraform-aws-amplify-app [![Latest Release](https://img.shields.io/github/release/cloudposse/terraform-aws-amplify-app.svg)](https://github.com/cloudposse/terraform-aws-amplify-app/releases/latest) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com) [![Discourse Forum](https://img.shields.io/discourse/https/ask.sweetops.com/posts.svg)](https://ask.sweetops.com/)
# terraform-aws-amplify-app<a href="https://cpco.io/homepage"><img align="right" src="https://cloudposse.com/logo-300x69.svg" width="150" /></a> [![Latest Release](https://img.shields.io/github/release/cloudposse/terraform-aws-amplify-app.svg)](https://github.com/cloudposse/terraform-aws-amplify-app/releases/latest) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com) [![Discourse Forum](https://img.shields.io/discourse/https/ask.sweetops.com/posts.svg)](https://ask.sweetops.com/)
<!-- markdownlint-restore -->

[![README Header][readme_header_img]][readme_header_link]

[![Cloud Posse][logo]](https://cpco.io/homepage)

<!--
Expand All @@ -31,20 +28,15 @@
Terraform module to provision AWS Amplify apps, backend environments, branches, domain associations, and webhooks.

---
> [!NOTE]
> This project is part of Cloud Posse's comprehensive ["SweetOps"](https://cpco.io/sweetops) approach towards DevOps.
> <a href="https://cpco.io/terraform-modules"><img src="https://docs.cloudposse.com/images/terraform-open-source-modules.svg" align="right" /></a>
>
> It's 100% Open Source and licensed under the [APACHE2](LICENSE).
>
> We literally have [*hundreds of terraform modules*][terraform_modules] that are Open Source and well-maintained. Check them out!
This project is part of our comprehensive ["SweetOps"](https://cpco.io/sweetops) approach towards DevOps.
<a href="https://cpco.io/terraform-modules"><img src="https://docs.cloudposse.com/images/terraform-open-source-modules.svg" align="right" /></a>


It's 100% Open Source and licensed under the [APACHE2](LICENSE).







We literally have [*hundreds of terraform modules*][terraform_modules] that are Open Source and well-maintained. Check them out!
[![README Header][readme_header_img]][readme_header_link]



Expand All @@ -57,7 +49,7 @@ We literally have [*hundreds of terraform modules*][terraform_modules] that are


> **Important**
> We do not pin modules to versions in our examples because of the
> We do not pin modules to versions in Cloud Posse's examples because of the
> difficulty of keeping the versions in the documentation in sync with the latest released versions.
> We highly recommend that in your code you pin the version to the exact version you are
> using so that your infrastructure remains stable, and update versions in a
Expand Down Expand Up @@ -264,7 +256,7 @@ Available targets:
| <a name="input_enabled"></a> [enabled](#input\_enabled) | Set to false to prevent the module from creating any resources | `bool` | `null` | no |
| <a name="input_environment"></a> [environment](#input\_environment) | ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' | `string` | `null` | no |
| <a name="input_environment_variables"></a> [environment\_variables](#input\_environment\_variables) | The environment variables for the Amplify app | `map(string)` | `{}` | no |
| <a name="input_environments"></a> [environments](#input\_environments) | The configuration of the environments for the Amplify App | <pre>map(object({<br> branch_name = optional(string)<br> backend_enabled = optional(bool, false)<br> environment_name = optional(string)<br> deployment_artifacts = optional(string)<br> stack_name = optional(string)<br> display_name = optional(string)<br> description = optional(string)<br> enable_auto_build = optional(bool)<br> enable_basic_auth = optional(bool)<br> enable_notification = optional(bool)<br> enable_performance_mode = optional(bool)<br> enable_pull_request_preview = optional(bool)<br> environment_variables = optional(map(string))<br> framework = optional(string)<br> pull_request_environment_name = optional(string)<br> stage = optional(string)<br> ttl = optional(number)<br> webhook_enabled = optional(bool, false)<br> }))</pre> | `{}` | no |
| <a name="input_environments"></a> [environments](#input\_environments) | The configuration of the environments for the Amplify App | <pre>map(object({<br> branch_name = optional(string)<br> basic_auth_credentials = optional(string)<br> backend_enabled = optional(bool, false)<br> environment_name = optional(string)<br> deployment_artifacts = optional(string)<br> stack_name = optional(string)<br> display_name = optional(string)<br> description = optional(string)<br> enable_auto_build = optional(bool)<br> enable_basic_auth = optional(bool)<br> enable_notification = optional(bool)<br> enable_performance_mode = optional(bool)<br> enable_pull_request_preview = optional(bool)<br> environment_variables = optional(map(string))<br> framework = optional(string)<br> pull_request_environment_name = optional(string)<br> stage = optional(string)<br> ttl = optional(number)<br> webhook_enabled = optional(bool, false)<br> }))</pre> | `{}` | no |
| <a name="input_iam_service_role_actions"></a> [iam\_service\_role\_actions](#input\_iam\_service\_role\_actions) | List of IAM policy actions for the AWS Identity and Access Management (IAM) service role for the Amplify app.<br>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 |
| <a name="input_iam_service_role_arn"></a> [iam\_service\_role\_arn](#input\_iam\_service\_role\_arn) | The AWS Identity and Access Management (IAM) service role for the Amplify app.<br>If not provided, a new role will be created if the variable `iam_service_role_enabled` is set to `true`. | `list(string)` | `[]` | no |
| <a name="input_iam_service_role_enabled"></a> [iam\_service\_role\_enabled](#input\_iam\_service\_role\_enabled) | Flag to create the IAM service role for the Amplify app | `bool` | `false` | no |
Expand Down Expand Up @@ -336,7 +328,7 @@ Please use the [issue tracker](https://github.com/cloudposse/terraform-aws-ampli

### 💻 Developing

If you are interested in being a contributor and want to get involved in developing this project or [help out](https://cpco.io/help-out) with our other projects, we would love to hear from you! Shoot us an [email][email].
If you are interested in being a contributor and want to get involved in developing this project or [help out](https://cpco.io/help-out) with Cloud Posse's other projects, we would love to hear from you! Shoot us an [email][email].

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

Expand Down

0 comments on commit a8230fd

Please sign in to comment.