[NDR-74] sqs output descriptions

Author: SWhyteAnswer

infrastructure/modules/sqs/README.md

@@ -89,11 +89,11 @@ module "sqs_queue" {
 
 | Name | Description |
 |------|-------------|
-| <a name="output_dlq_name"></a> [dlq\_name](#output\_dlq\_name) | n/a |
+| <a name="output_dlq_name"></a> [dlq\_name](#output\_dlq\_name) | Name of the dead-letter queue (DLQ), if created. |
 | <a name="output_endpoint"></a> [endpoint](#output\_endpoint) | The SQS queue ARN e.g. for use when setting the queue as the endpoint of an SNS topic. |
-| <a name="output_sqs_arn"></a> [sqs\_arn](#output\_sqs\_arn) | n/a |
-| <a name="output_sqs_id"></a> [sqs\_id](#output\_sqs\_id) | n/a |
-| <a name="output_sqs_read_policy_document"></a> [sqs\_read\_policy\_document](#output\_sqs\_read\_policy\_document) | n/a |
-| <a name="output_sqs_url"></a> [sqs\_url](#output\_sqs\_url) | n/a |
-| <a name="output_sqs_write_policy_document"></a> [sqs\_write\_policy\_document](#output\_sqs\_write\_policy\_document) | n/a |
+| <a name="output_sqs_arn"></a> [sqs\_arn](#output\_sqs\_arn) | Amazon Resource Name (ARN) of the primary SQS queue. |
+| <a name="output_sqs_id"></a> [sqs\_id](#output\_sqs\_id) | ID of the main SQS queue. |
+| <a name="output_sqs_read_policy_document"></a> [sqs\_read\_policy\_document](#output\_sqs\_read\_policy\_document) | IAM policy document granting read access to the SQS queue. |
+| <a name="output_sqs_url"></a> [sqs\_url](#output\_sqs\_url) | URL of the SQS queue for use with API clients or AWS SDKs. |
+| <a name="output_sqs_write_policy_document"></a> [sqs\_write\_policy\_document](#output\_sqs\_write\_policy\_document) | IAM policy document granting write access to the SQS queue. |
 <!-- END_TF_DOCS -->

infrastructure/modules/sqs/variable.tf

@@ -98,24 +98,31 @@ output "endpoint" {
 }
 
 output "sqs_arn" {
-  value = aws_sqs_queue.sqs_queue.arn
+  description = "Amazon Resource Name (ARN) of the primary SQS queue."
+  value       = aws_sqs_queue.sqs_queue.arn
 }
 
 output "sqs_id" {
-  value = aws_sqs_queue.sqs_queue.id
+  description = "ID of the main SQS queue."
+  value       = aws_sqs_queue.sqs_queue.id
 }
 
 output "sqs_url" {
-  value = aws_sqs_queue.sqs_queue.url
+  description = "URL of the SQS queue for use with API clients or AWS SDKs."
+  value       = aws_sqs_queue.sqs_queue.url
 }
 
 output "sqs_read_policy_document" {
-  value = data.aws_iam_policy_document.sqs_read_policy.json
+  description = "IAM policy document granting read access to the SQS queue."
+  value       = data.aws_iam_policy_document.sqs_read_policy.json
 }
 
 output "sqs_write_policy_document" {
-  value = data.aws_iam_policy_document.sqs_write_policy.json
+  description = "IAM policy document granting write access to the SQS queue."
+  value       = data.aws_iam_policy_document.sqs_write_policy.json
 }
+
 output "dlq_name" {
-  value = var.enable_dlq ? aws_sqs_queue.queue_deadletter[0].name : null
+  description = "Name of the dead-letter queue (DLQ), if created."
+  value       = var.enable_dlq ? aws_sqs_queue.queue_deadletter[0].name : null
 }