feat: Add collection_name to outputs (#35)

terraform-aws-modules · Jan 26, 2025 · 111032e · 111032e
1 parent 9649166
commit 111032e
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 0 deletions.
diff --git a/examples/collection/README.md b/examples/collection/README.md
@@ -63,6 +63,7 @@ No inputs.
 | <a name="output_opensearch_collection_private_kms_key_arn"></a> [opensearch\_collection\_private\_kms\_key\_arn](#output\_opensearch\_collection\_private\_kms\_key\_arn) | The ARN of the Amazon Web Services KMS key used to encrypt the collection |
 | <a name="output_opensearch_collection_private_lifecycle_policy"></a> [opensearch\_collection\_private\_lifecycle\_policy](#output\_opensearch\_collection\_private\_lifecycle\_policy) | The JSON policy document of the lifecycle policy |
 | <a name="output_opensearch_collection_private_lifecycle_policy_version"></a> [opensearch\_collection\_private\_lifecycle\_policy\_version](#output\_opensearch\_collection\_private\_lifecycle\_policy\_version) | The version of the lifecycle policy |
+| <a name="output_opensearch_collection_private_name"></a> [opensearch\_collection\_private\_name](#output\_opensearch\_collection\_private\_name) | Name of the collection |
 | <a name="output_opensearch_collection_private_network_policy"></a> [opensearch\_collection\_private\_network\_policy](#output\_opensearch\_collection\_private\_network\_policy) | The JSON policy document of the network policy |
 | <a name="output_opensearch_collection_private_network_policy_version"></a> [opensearch\_collection\_private\_network\_policy\_version](#output\_opensearch\_collection\_private\_network\_policy\_version) | The version of the network policy |
 | <a name="output_opensearch_collection_public_access_policy"></a> [opensearch\_collection\_public\_access\_policy](#output\_opensearch\_collection\_public\_access\_policy) | The JSON policy document of the access policy |
@@ -76,6 +77,7 @@ No inputs.
 | <a name="output_opensearch_collection_public_kms_key_arn"></a> [opensearch\_collection\_public\_kms\_key\_arn](#output\_opensearch\_collection\_public\_kms\_key\_arn) | The ARN of the Amazon Web Services KMS key used to encrypt the collection |
 | <a name="output_opensearch_collection_public_lifecycle_policy"></a> [opensearch\_collection\_public\_lifecycle\_policy](#output\_opensearch\_collection\_public\_lifecycle\_policy) | The JSON policy document of the lifecycle policy |
 | <a name="output_opensearch_collection_public_lifecycle_policy_version"></a> [opensearch\_collection\_public\_lifecycle\_policy\_version](#output\_opensearch\_collection\_public\_lifecycle\_policy\_version) | The version of the lifecycle policy |
+| <a name="output_opensearch_collection_public_name"></a> [opensearch\_collection\_public\_name](#output\_opensearch\_collection\_public\_name) | Name of the collection |
 | <a name="output_opensearch_collection_public_network_policy"></a> [opensearch\_collection\_public\_network\_policy](#output\_opensearch\_collection\_public\_network\_policy) | The JSON policy document of the network policy |
 | <a name="output_opensearch_collection_public_network_policy_version"></a> [opensearch\_collection\_public\_network\_policy\_version](#output\_opensearch\_collection\_public\_network\_policy\_version) | The version of the network policy |
 <!-- END_TF_DOCS -->

diff --git a/examples/collection/outputs.tf b/examples/collection/outputs.tf
@@ -27,6 +27,11 @@ output "opensearch_collection_public_id" {
   value       = module.opensearch_collection_public.id
 }
 
+output "opensearch_collection_public_name" {
+  description = "Name of the collection"
+  value       = module.opensearch_collection_public.name
+}
+
 output "opensearch_collection_public_encryption_policy_version" {
   description = "The version of the encryption policy"
   value       = module.opensearch_collection_public.encryption_policy_version
@@ -96,6 +101,11 @@ output "opensearch_collection_private_id" {
   value       = module.opensearch_collection_private.id
 }
 
+output "opensearch_collection_private_name" {
+  description = "Name of the collection"
+  value       = module.opensearch_collection_private.name
+}
+
 output "opensearch_collection_private_encryption_policy_version" {
   description = "The version of the encryption policy"
   value       = module.opensearch_collection_private.encryption_policy_version

diff --git a/modules/collection/README.md b/modules/collection/README.md
@@ -112,6 +112,7 @@ No modules.
 | <a name="output_kms_key_arn"></a> [kms\_key\_arn](#output\_kms\_key\_arn) | The ARN of the Amazon Web Services KMS key used to encrypt the collection |
 | <a name="output_lifecycle_policy"></a> [lifecycle\_policy](#output\_lifecycle\_policy) | The JSON policy document of the lifecycle policy |
 | <a name="output_lifecycle_policy_version"></a> [lifecycle\_policy\_version](#output\_lifecycle\_policy\_version) | The version of the lifecycle policy |
+| <a name="output_name"></a> [name](#output\_name) | Name of the collection |
 | <a name="output_network_policy"></a> [network\_policy](#output\_network\_policy) | The JSON policy document of the network policy |
 | <a name="output_network_policy_version"></a> [network\_policy\_version](#output\_network\_policy\_version) | The version of the network policy |
 <!-- END_TF_DOCS -->

diff --git a/modules/collection/outputs.tf b/modules/collection/outputs.tf
@@ -27,6 +27,11 @@ output "id" {
   value       = try(aws_opensearchserverless_collection.this[0].id, null)
 }
 
+output "name" {
+  description = "Name of the collection"
+  value       = try(aws_opensearchserverless_collection.this[0].name, null)
+}
+
 ################################################################################
 # Encryption Policy
 ################################################################################