Skip to content

Commit f64693a

Browse files
terraform-docs: automated action
1 parent c5c589c commit f64693a

File tree

2 files changed

+25
-10
lines changed

2 files changed

+25
-10
lines changed

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Terraform module to deploy production-ready applications and services on an exis
3939

4040
| Name | Description | Type | Default | Required |
4141
|------|-------------|------|---------|:--------:|
42-
| <a name="input_acm_amazon_issued_certificates"></a> [acm\_amazon\_issued\_certificates](#input\_acm\_amazon\_issued\_certificates) | Amazon-issued ACM certificates to create. | `any` | `{}` | no |
42+
| <a name="input_acm_certificates"></a> [acm\_certificates](#input\_acm\_certificates) | ACM certificates to create. | <pre>map(object({<br> domain_name = string<br> subject_alternative_names = optional(list(string), [])<br> validation_method = optional(string)<br> key_algorithm = optional(string)<br> validation_option = optional(object({<br> domain_name = string<br> validation_domain = string<br> }))<br> tags = optional(map(string), {})<br> record_zone_id = string<br> record_allow_overwrite = optional(bool)<br> }))</pre> | `{}` | no |
4343
| <a name="input_capacity_provider_default_auto_scaling_group_arn"></a> [capacity\_provider\_default\_auto\_scaling\_group\_arn](#input\_capacity\_provider\_default\_auto\_scaling\_group\_arn) | ARN for this Auto Scaling Group. | `string` | `null` | no |
4444
| <a name="input_capacity_providers"></a> [capacity\_providers](#input\_capacity\_providers) | Capacity Providers to associate with the ECS Cluster. | `any` | `{}` | no |
4545
| <a name="input_cluster_name"></a> [cluster\_name](#input\_cluster\_name) | (Required) Name of the cluster. | `string` | n/a | yes |
@@ -56,6 +56,8 @@ Terraform module to deploy production-ready applications and services on an exis
5656

5757
| Name | Description |
5858
|------|-------------|
59+
| <a name="output_acm_certificates_arns"></a> [acm\_certificates\_arns](#output\_acm\_certificates\_arns) | ARNs of the ACM certificates. |
60+
| <a name="output_acm_certificates_ids"></a> [acm\_certificates\_ids](#output\_acm\_certificates\_ids) | Identifiers of the ACM certificates. |
5961
| <a name="output_alb_arn"></a> [alb\_arn](#output\_alb\_arn) | ARN of the load balancer. |
6062
| <a name="output_alb_dns_name"></a> [alb\_dns\_name](#output\_alb\_dns\_name) | DNS name of the load balancer. |
6163
| <a name="output_alb_listener_rules_arns"></a> [alb\_listener\_rules\_arns](#output\_alb\_listener\_rules\_arns) | ARNs of the Listener Rules. |
@@ -65,8 +67,6 @@ Terraform module to deploy production-ready applications and services on an exis
6567
| <a name="output_alb_target_groups_arns"></a> [alb\_target\_groups\_arns](#output\_alb\_target\_groups\_arns) | ARNs of the Target Groups. |
6668
| <a name="output_alb_target_groups_ids"></a> [alb\_target\_groups\_ids](#output\_alb\_target\_groups\_ids) | Identifiers of the Target Groups. |
6769
| <a name="output_alb_zone_id"></a> [alb\_zone\_id](#output\_alb\_zone\_id) | Canonical hosted zone ID of the Load Balancer. |
68-
| <a name="output_amazon_issued_acm_certificates_arns"></a> [amazon\_issued\_acm\_certificates\_arns](#output\_amazon\_issued\_acm\_certificates\_arns) | ARNs of the Amazon issued ACM certificates. |
69-
| <a name="output_amazon_issued_acm_certificates_validation_records"></a> [amazon\_issued\_acm\_certificates\_validation\_records](#output\_amazon\_issued\_acm\_certificates\_validation\_records) | Validation Records of the Amazon issued ACM certificates. |
7070
| <a name="output_capacity_provider_arns"></a> [capacity\_provider\_arns](#output\_capacity\_provider\_arns) | ARNs for the ECS Capacity Providers. |
7171
| <a name="output_capacity_provider_ecs_cluster_capacity_providers_id"></a> [capacity\_provider\_ecs\_cluster\_capacity\_providers\_id](#output\_capacity\_provider\_ecs\_cluster\_capacity\_providers\_id) | Identifier for the ECS Cluster Capacity Providers. |
7272
| <a name="output_capacity_provider_ids"></a> [capacity\_provider\_ids](#output\_capacity\_provider\_ids) | Identifiers for the ECS Capacity Providers. |

modules/acm/README.md

+22-7
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,21 @@
11
<!-- BEGIN_TF_DOCS -->
22
# acm
33

4-
This sub-module creates the Amazon-issued certificates for given domains with `validation_option` configuration.
4+
This sub-module creates the Amazon-issued certificate for a given domain with `validation_option` configuration.
55

66
## Presets
77

8+
### ACM Certificate
9+
810
- The `validation_method` is set to `DNS` as the recommended method, and can be overridden to use `EMAIL` method if required.
911

12+
### Route53 Record
13+
14+
- The `allow_override` is set to `true` as the default option, and can be overridden to `false` if required.
15+
1016
## Notes
1117

12-
- ACM certificates are created before destroying existing ones (to update the configuration), which is the recommended practice.
13-
- The sub-module outputs the corresponding validation records for every Amazon-issued ACM certificate created. This can be further used to complete the validation by creating the Route53 DNS records.
18+
- ACM certificate is created before destroying the existing one (to update the configuration), which is the recommended practice.
1419

1520
## Requirements
1621

@@ -32,19 +37,29 @@ No modules.
3237

3338
| Name | Type |
3439
|------|------|
35-
| [aws_acm_certificate.amazon_issued](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/acm_certificate) | resource |
40+
| [aws_acm_certificate.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/acm_certificate) | resource |
41+
| [aws_acm_certificate_validation.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/acm_certificate_validation) | resource |
42+
| [aws_route53_record.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/route53_record) | resource |
3643

3744
## Inputs
3845

3946
| Name | Description | Type | Default | Required |
4047
|------|-------------|------|---------|:--------:|
41-
| <a name="input_amazon_issued_certificates"></a> [amazon\_issued\_certificates](#input\_amazon\_issued\_certificates) | List of Amazon-issued certificates to ACM create. | <pre>map(object({<br> domain_name = string<br> subject_alternative_names = optional(list(string), [])<br> validation_method = optional(string, "DNS")<br> key_algorithm = optional(string, null)<br> validation_option = optional(object({<br> domain_name = string<br> validation_domain = string<br> }))<br> tags = optional(map(string), {})<br> }))</pre> | `{}` | no |
48+
| <a name="input_certificate_domain_name"></a> [certificate\_domain\_name](#input\_certificate\_domain\_name) | (Required) Domain name for which the certificate should be issued. | `string` | n/a | yes |
49+
| <a name="input_certificate_key_algorithm"></a> [certificate\_key\_algorithm](#input\_certificate\_key\_algorithm) | (Optional) Specifies the algorithm of the public and private key pair that your Amazon issued certificate uses to encrypt data. | `string` | `null` | no |
50+
| <a name="input_certificate_subject_alternative_names"></a> [certificate\_subject\_alternative\_names](#input\_certificate\_subject\_alternative\_names) | (Optional) Set of domains that should be SANs in the issued certificate. | `list(string)` | `[]` | no |
51+
| <a name="input_certificate_validation_method"></a> [certificate\_validation\_method](#input\_certificate\_validation\_method) | (Optional) Which method to use for validation. DNS or EMAIL are valid. | `string` | `"DNS"` | no |
52+
| <a name="input_certificate_validation_option"></a> [certificate\_validation\_option](#input\_certificate\_validation\_option) | (Optional) Configuration block used to specify information about the initial validation of each domain name. | <pre>object({<br> domain_name = string<br> validation_domain = string<br> })</pre> | `null` | no |
53+
| <a name="input_record_allow_overwrite"></a> [record\_allow\_overwrite](#input\_record\_allow\_overwrite) | (Optional) Allow creation of this record in Terraform to overwrite an existing record, if any. | `bool` | `true` | no |
54+
| <a name="input_record_zone_id"></a> [record\_zone\_id](#input\_record\_zone\_id) | (Required) Hosted zone ID for a CloudFront distribution, S3 bucket, ELB, or Route 53 hosted zone. | `string` | n/a | yes |
4255
| <a name="input_tags"></a> [tags](#input\_tags) | (Optional) Map of tags to assign to the resource. | `map(string)` | `{}` | no |
4356

4457
## Outputs
4558

4659
| Name | Description |
4760
|------|-------------|
48-
| <a name="output_amazon_issued_acm_certificates_arns"></a> [amazon\_issued\_acm\_certificates\_arns](#output\_amazon\_issued\_acm\_certificates\_arns) | ARNs of the Amazon issued ACM certificates. |
49-
| <a name="output_amazon_issued_acm_certificates_validation_records"></a> [amazon\_issued\_acm\_certificates\_validation\_records](#output\_amazon\_issued\_acm\_certificates\_validation\_records) | Validation Records of the Amazon issued ACM certificates. |
61+
| <a name="output_acm_certificate_arn"></a> [acm\_certificate\_arn](#output\_acm\_certificate\_arn) | ARN of the ACM certificate. |
62+
| <a name="output_acm_certificate_id"></a> [acm\_certificate\_id](#output\_acm\_certificate\_id) | ARN of the ACM certificate. |
63+
| <a name="output_acm_certificate_validation_id"></a> [acm\_certificate\_validation\_id](#output\_acm\_certificate\_validation\_id) | Identifier of the ACM certificate validation resource. |
64+
| <a name="output_route53_records_ids"></a> [route53\_records\_ids](#output\_route53\_records\_ids) | Identifiers of the Validation Records of the ACM certificate. |
5065
<!-- END_TF_DOCS -->

0 commit comments

Comments
 (0)