Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
badra001 committed Apr 1, 2022
1 parent c2267fb commit bebb619
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 0 deletions.
7 changes: 7 additions & 0 deletions standard/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,12 @@ 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.

## Options :: object\_lock\_enable
This is usable on bucket creation, and it will allow you to add external to this module an object lock
configuration (aws\_s3\_object\_lock\_configuration). See the [AWS Object Lock](AWS Reference: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-overview.html)
and the [Terraform AWS Provider](https://registry.terraform.io/providers/hashicorp%20%20/aws/4.7.0/docs/resources/s3_bucket_object_lock_configuration) docs for
more details. Setting this after bucket creation is possible but requires a support tickets, so you're better off doing it up front.

# 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.
Expand Down Expand Up @@ -217,6 +223,7 @@ No modules.
| <a name="input_name_include_account"></a> [name\_include\_account](#input\_name\_include\_account) | Flag to determine if we include the AWS Account id in the resulting bucket name | `bool` | `false` | no |
| <a name="input_name_include_region"></a> [name\_include\_region](#input\_name\_include\_region) | Flag to determine if we include the full region name in the resulting bucket name | `bool` | `false` | no |
| <a name="input_name_include_region_compact"></a> [name\_include\_region\_compact](#input\_name\_include\_region\_compact) | Flag to determine if we the rewrite the full region name to a shorter region name if the resulting name > 63 characters. Only usable with name\_include\_region. | `bool` | `true` | no |
| <a name="input_object_lock_enabled"></a> [object\_lock\_enabled](#input\_object\_lock\_enabled) | Flag to enable object lock. This can only be set on bucket creation. See AWS documentation at https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-overview.html | `bool` | `false` | no |
| <a name="input_require_explicit_encryption"></a> [require\_explicit\_encryption](#input\_require\_explicit\_encryption) | When enabled, adds bucket policy to Deny unencrypted uploads and incorrect encryption header. Should not normally be needed. | `bool` | `false` | no |
| <a name="input_tags"></a> [tags](#input\_tags) | AWS Tags to apply to appropriate resources (S3, KMS). Do not include safeguard tags here, use the data\_safeguard field for such things. | `map(string)` | `{}` | no |

Expand Down
5 changes: 5 additions & 0 deletions standard/main.tf
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,11 @@
* ## Options :: name_enforce_region_compact
* This flag always compacts the region, no mater whehter the name is longer than 63 characters or not.
*
* ## Options :: object_lock_enable
* This is usable on bucket creation, and it will allow you to add external to this module an object lock
* configuration (aws_s3_object_lock_configuration). See the [AWS Object Lock](AWS Reference: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-overview.html)
* and the [Terraform AWS Provider](https://registry.terraform.io/providers/hashicorp%20%20/aws/4.7.0/docs/resources/s3_bucket_object_lock_configuration) docs for
* more details. Setting this after bucket creation is possible but requires a support tickets, so you're better off doing it up front.
*
* # Outputs
* One output of note is the `s3_module_settings`. With this, you can get the settings used when calling the
Expand Down
7 changes: 7 additions & 0 deletions title26/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,12 @@ 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.

## Options :: object_lock_enable
This is usable on bucket creation, and it will allow you to add external to this module an object lock
configuration (aws_s3_object_lock_configuration). See the [AWS Object Lock](AWS Reference: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-overview.html)
and the [Terraform AWS Provider](https://registry.terraform.io/providers/hashicorp%20%20/aws/4.7.0/docs/resources/s3_bucket_object_lock_configuration) docs for
more details. Setting this after bucket creation is possible but requires a support tickets, so you're better off doing it up front.

# 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.
Expand Down Expand Up @@ -216,6 +222,7 @@ No modules.
| <a name="input_name_include_account"></a> [name\_include\_account](#input\_name\_include\_account) | Flag to determine if we include the AWS Account id in the resulting bucket name | `bool` | `false` | no |
| <a name="input_name_include_region"></a> [name\_include\_region](#input\_name\_include\_region) | Flag to determine if we include the full region name in the resulting bucket name | `bool` | `false` | no |
| <a name="input_name_include_region_compact"></a> [name\_include\_region\_compact](#input\_name\_include\_region\_compact) | Flag to determine if we the rewrite the full region name to a shorter region name if the resulting name > 63 characters. Only usable with name\_include\_region. | `bool` | `true` | no |
| <a name="input_object_lock_enabled"></a> [object\_lock\_enabled](#input\_object\_lock\_enabled) | Flag to enable object lock. This can only be set on bucket creation. See AWS documentation at https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-overview.html | `bool` | `false` | no |
| <a name="input_require_explicit_encryption"></a> [require\_explicit\_encryption](#input\_require\_explicit\_encryption) | When enabled, adds bucket policy to Deny unencrypted uploads and incorrect encryption header. Should not normally be needed. | `bool` | `false` | no |
| <a name="input_tags"></a> [tags](#input\_tags) | AWS Tags to apply to appropriate resources (S3, KMS). Do not include safeguard tags here, use the data\_safeguard field for such things. | `map(string)` | `{}` | no |
Expand Down
6 changes: 6 additions & 0 deletions title26/main.tf
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,12 @@
* ## Options :: name_enforce_region_compact
* This flag always compacts the region, no mater whehter the name is longer than 63 characters or not.
*
* ## Options :: object_lock_enable
* This is usable on bucket creation, and it will allow you to add external to this module an object lock
* configuration (aws_s3_object_lock_configuration). See the [AWS Object Lock](AWS Reference: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-overview.html)
* and the [Terraform AWS Provider](https://registry.terraform.io/providers/hashicorp%20%20/aws/4.7.0/docs/resources/s3_bucket_object_lock_configuration) docs for
* more details. Setting this after bucket creation is possible but requires a support tickets, so you're better off doing it up front.
*
* # 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.
Expand Down

0 comments on commit bebb619

Please sign in to comment.