add comment to reflect new version

terraform-modules · Mar 23, 2022 · 25dfa2f · 25dfa2f
1 parent 51cb6ff
commit 25dfa2f
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 6 deletions.
diff --git a/kms_key/README.md b/kms_key/README.md
@@ -27,9 +27,10 @@ output "simple-key-info" {
 ```
 
 ## Usage: Reference
+To use the new refactored module with the AWS provider v4.x, use `?ref=3`, otherwise leave this part off.
 ```hcl
 module "my-bucket" {
-  source = "git@github.e.it.census.gov:terraform-modules/aws-s3.git//standard"
+  source = "git@github.e.it.census.gov:terraform-modules/aws-s3.git//standard?ref=3"
 
   bucket_name       = "my-normalbucket"
   access_log_bucket = "my-logbucket"

diff --git a/kms_key/main.tf b/kms_key/main.tf
@@ -28,9 +28,10 @@
 * ```
 *
 * ## Usage: Reference
+* To use the new refactored module with the AWS provider v4.x, use `?ref=3`, otherwise leave this part off.
 * ```hcl
 * module "my-bucket" {
-*   source = "git@github.e.it.census.gov:terraform-modules/aws-s3.git//standard"
+*   source = "git@github.e.it.census.gov:terraform-modules/aws-s3.git//standard?ref=3"
 * 
 *   bucket_name       = "my-normalbucket"
 *   access_log_bucket = "my-logbucket"

diff --git a/standard/README.md b/standard/README.md
@@ -7,10 +7,11 @@ non-FTI Data.  This includes
 Other configurations such as versioning or data safegurad tagging (only on the bucket/keys) are oiptional
 
 # Usage
+To use the new refactored module with the AWS provider v4.x, use `?ref=3`, otherwise leave this part off.
 
 ```hcl
 module "my-bucket" {
-  source = "git@github.e.it.census.gov:terraform-modules/aws-s3.git//standard"
+  source = "git@github.e.it.census.gov:terraform-modules/aws-s3.git//standard?ref=3"
 
   bucket_name       = "my-normalbucket"
   access_log_bucket = "my-logbucket"
@@ -160,10 +161,14 @@ No modules.
 | [aws_kms_alias.key](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/kms_alias) | resource |
 | [aws_kms_key.key](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/kms_key) | resource |
 | [aws_s3_bucket.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket) | resource |
+| [aws_s3_bucket_acl.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_acl) | resource |
+| [aws_s3_bucket_logging.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_logging) | resource |
 | [aws_s3_bucket_object.this_objects](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_object) | resource |
 | [aws_s3_bucket_ownership_controls.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_ownership_controls) | resource |
 | [aws_s3_bucket_policy.policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_policy) | resource |
 | [aws_s3_bucket_public_access_block.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_public_access_block) | resource |
+| [aws_s3_bucket_server_side_encryption_configuration.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_server_side_encryption_configuration) | resource |
+| [aws_s3_bucket_versioning.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_versioning) | resource |
 | [null_resource.name_too_long](https://registry.terraform.io/providers/hashicorp/null/latest/docs/resources/resource) | resource |
 | [null_resource.policy_delay](https://registry.terraform.io/providers/hashicorp/null/latest/docs/resources/resource) | resource |
 | [aws_arn.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/arn) | data source |

diff --git a/standard/main.tf b/standard/main.tf
@@ -8,10 +8,11 @@
 * Other configurations such as versioning or data safegurad tagging (only on the bucket/keys) are oiptional
 * 
 * # Usage 
+* To use the new refactored module with the AWS provider v4.x, use `?ref=3`, otherwise leave this part off.
 *
 * ```hcl
 * module "my-bucket" {
-*   source = "git@github.e.it.census.gov:terraform-modules/aws-s3.git//standard"
+*   source = "git@github.e.it.census.gov:terraform-modules/aws-s3.git//standard?ref=3"
 * 
 *   bucket_name       = "my-normalbucket"
 *   access_log_bucket = "my-logbucket"

diff --git a/title26/README.md b/title26/README.md
@@ -7,10 +7,11 @@ FTI (Title26).  This includes
 - Server Access Logging
 
 # Usage
+To use the new refactored module with the AWS provider v4.x, use `?ref=3`, otherwise leave this part off.
 
 ```hcl
 module "mybucket" {
-  source = "git@github.e.it.census.gov:terraform-modules/aws-s3.git//title26"
+  source = "git@github.e.it.census.gov:terraform-modules/aws-s3.git//title26?ref=3"
 
   bucket_name = "myt26bucket"
   access_log_bucket = "mylogbucket"
@@ -157,10 +158,14 @@ No modules.
 | [aws_kms_alias.key](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/kms_alias) | resource |
 | [aws_kms_key.key](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/kms_key) | resource |
 | [aws_s3_bucket.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket) | resource |
+| [aws_s3_bucket_acl.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_acl) | resource |
+| [aws_s3_bucket_logging.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_logging) | resource |
 | [aws_s3_bucket_object.this_objects](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_object) | resource |
 | [aws_s3_bucket_ownership_controls.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_ownership_controls) | resource |
 | [aws_s3_bucket_policy.policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_policy) | resource |
 | [aws_s3_bucket_public_access_block.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_public_access_block) | resource |
+| [aws_s3_bucket_server_side_encryption_configuration.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_server_side_encryption_configuration) | resource |
+| [aws_s3_bucket_versioning.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_versioning) | resource |
 | [null_resource.name_too_long](https://registry.terraform.io/providers/hashicorp/null/latest/docs/resources/resource) | resource |
 | [null_resource.policy_delay](https://registry.terraform.io/providers/hashicorp/null/latest/docs/resources/resource) | resource |
 | [aws_arn.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/arn) | data source |

diff --git a/title26/main.tf b/title26/main.tf
@@ -8,10 +8,11 @@
 * - Server Access Logging
 * 
 * # Usage 
+* To use the new refactored module with the AWS provider v4.x, use `?ref=3`, otherwise leave this part off.
 *
 * ```hcl
 * module "mybucket" {
-*   source = "git@github.e.it.census.gov:terraform-modules/aws-s3.git//title26"
+*   source = "git@github.e.it.census.gov:terraform-modules/aws-s3.git//title26?ref=3"
 *
 *   bucket_name = "myt26bucket"
 *   access_log_bucket = "mylogbucket"