From 5186969a2da8183c90ad753e6d5a73ca57bafd27 Mon Sep 17 00:00:00 2001 From: badra001 Date: Tue, 1 Mar 2022 09:38:14 -0500 Subject: [PATCH] - add outputs - s3_requested_bucket_name - s3_module_settings --- CHANGELOG.md | 5 +++++ common/outputs.s3.tf | 21 +++++++++++++++++++++ common/version.tf | 2 +- standard/README.md | 24 ++++++++++++++++++++++++ standard/main.tf | 22 ++++++++++++++++++++++ title26/README.md | 24 ++++++++++++++++++++++++ title26/main.tf | 22 ++++++++++++++++++++++ 7 files changed, 119 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 45625e2..13e2b80 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -68,3 +68,8 @@ Provides standard and t26 S3 bucket construction. - ${s3_bucket_arn} in the template to get replaced with the created s3 bucket ARN - ${s3_bucket_id} in the template to get replaced with the created s3 bucket ID - ${kms_key_arn} in the template to get replaced with the provided or created KMS Key ARN + +* 2.4.4 -- 2022-03-01 + - add outputs + - s3_requested_bucket_name + - s3_module_settings diff --git a/common/outputs.s3.tf b/common/outputs.s3.tf index a29a743..af2a4d3 100644 --- a/common/outputs.s3.tf +++ b/common/outputs.s3.tf @@ -10,3 +10,24 @@ output "s3_bucket_id" { description = "Created S3 Bucket ID" value = aws_s3_bucket.this.id } + +output "s3_requested_bucket_name" { + description = "Requested S3 Bucket Name before prefix and other settings" + value = var.bucket_name +} + +output "s3_module_settings" { + description = "S3 module settings and values" + value = { + bucket_name = var.bucket_name + resulting_bucket_name = local.bucket_name + resulting_bucket_arn = aws_s3_bucket.this.arn + name_include_region = var.name_include_region + name_include_account = var.name_include_account + name_include_region_compact = var.name_include_region_compact + name_enforce_region_compact = var.name_enforce_region_compact + account_id = local.account_id + region = local.region + region_short = local.region_short + } +} diff --git a/common/version.tf b/common/version.tf index 31e4b38..59b218e 100644 --- a/common/version.tf +++ b/common/version.tf @@ -1,3 +1,3 @@ locals { - _module_version = "2.4.3" + _module_version = "2.4.4" } diff --git a/standard/README.md b/standard/README.md index 0d9689c..af5ac67 100644 --- a/standard/README.md +++ b/standard/README.md @@ -115,6 +115,28 @@ this shorter region value. ## Options :: name\_enforce\_region\_compact This flag always compacts the region, no mater whehter the name is longer than 63 characters or not. +# Outputs +One output of note is the `s3_module_settings`. With this, you can get the settings used when calling the +module, the original bucket name before prefix and suffixes, and other things. It is a map. + +```hcl +output "s3_module_settings" { + description = "S3 module settings and values" + value = { + bucket_name = var.bucket_name + resulting_bucket_name = local.bucket_name + resulting_bucket_arn = aws_s3_bucket.this.arn + name_include_region = var.name_include_region + name_include_account = var.name_include_account + name_include_region_compact = var.name_include_region_compact + name_enforce_region_compact = var.name_enforce_region_compact + account_id = local.account_id + region = local.region + region_short = local.region_short + } +} +``` + ## Requirements No requirements. @@ -193,3 +215,5 @@ No modules. | [kms\_key\_id](#output\_kms\_key\_id) | KMS Key ID. This is the created key id or the key id of kms\_key\_arn | | [s3\_bucket\_arn](#output\_s3\_bucket\_arn) | Created S3 Bucket ARN | | [s3\_bucket\_id](#output\_s3\_bucket\_id) | Created S3 Bucket ID | +| [s3\_module\_settings](#output\_s3\_module\_settings) | S3 module settings and values | +| [s3\_requested\_bucket\_name](#output\_s3\_requested\_bucket\_name) | Requested S3 Bucket Name before prefix and other settings | diff --git a/standard/main.tf b/standard/main.tf index e88605b..0f8b622 100644 --- a/standard/main.tf +++ b/standard/main.tf @@ -116,6 +116,28 @@ * ## Options :: name_enforce_region_compact * This flag always compacts the region, no mater whehter the name is longer than 63 characters or not. * +* +* # Outputs +* One output of note is the `s3_module_settings`. With this, you can get the settings used when calling the +* module, the original bucket name before prefix and suffixes, and other things. It is a map. +* +* ```hcl +* output "s3_module_settings" { +* description = "S3 module settings and values" +* value = { +* bucket_name = var.bucket_name +* resulting_bucket_name = local.bucket_name +* resulting_bucket_arn = aws_s3_bucket.this.arn +* name_include_region = var.name_include_region +* name_include_account = var.name_include_account +* name_include_region_compact = var.name_include_region_compact +* name_enforce_region_compact = var.name_enforce_region_compact +* account_id = local.account_id +* region = local.region +* region_short = local.region_short +* } +* } +* ``` */ locals { diff --git a/title26/README.md b/title26/README.md index cf21f26..97d0778 100644 --- a/title26/README.md +++ b/title26/README.md @@ -112,6 +112,28 @@ this shorter region value. ## Options :: name\_enforce\_region\_compact This flag always compacts the region, no mater whehter the name is longer than 63 characters or not. +# Outputs +One output of note is the `s3_module_settings`. With this, you can get the settings used when calling the +module, the original bucket name before prefix and suffixes, and other things. It is a map. + +```hcl +output "s3_module_settings" { + description = "S3 module settings and values" + value = { + bucket_name = var.bucket_name + resulting_bucket_name = local.bucket_name + resulting_bucket_arn = aws_s3_bucket.this.arn + name_include_region = var.name_include_region + name_include_account = var.name_include_account + name_include_region_compact = var.name_include_region_compact + name_enforce_region_compact = var.name_enforce_region_compact + account_id = local.account_id + region = local.region + region_short = local.region_short + } +} +``` + ## Requirements No requirements. @@ -190,3 +212,5 @@ No modules. | [kms\_key\_id](#output\_kms\_key\_id) | KMS Key ID. This is the created key id or the key id of kms\_key\_arn | | [s3\_bucket\_arn](#output\_s3\_bucket\_arn) | Created S3 Bucket ARN | | [s3\_bucket\_id](#output\_s3\_bucket\_id) | Created S3 Bucket ID | +| [s3\_module\_settings](#output\_s3\_module\_settings) | S3 module settings and values | +| [s3\_requested\_bucket\_name](#output\_s3\_requested\_bucket\_name) | Requested S3 Bucket Name before prefix and other settings | diff --git a/title26/main.tf b/title26/main.tf index 8fe244e..4078f27 100644 --- a/title26/main.tf +++ b/title26/main.tf @@ -112,6 +112,28 @@ * * ## Options :: name_enforce_region_compact * This flag always compacts the region, no mater whehter the name is longer than 63 characters or not. +* +* # Outputs +* One output of note is the `s3_module_settings`. With this, you can get the settings used when calling the +* module, the original bucket name before prefix and suffixes, and other things. It is a map. +* +* ```hcl +* output "s3_module_settings" { +* description = "S3 module settings and values" +* value = { +* bucket_name = var.bucket_name +* resulting_bucket_name = local.bucket_name +* resulting_bucket_arn = aws_s3_bucket.this.arn +* name_include_region = var.name_include_region +* name_include_account = var.name_include_account +* name_include_region_compact = var.name_include_region_compact +* name_enforce_region_compact = var.name_enforce_region_compact +* account_id = local.account_id +* region = local.region +* region_short = local.region_short +* } +* } +* ``` */ locals {