Skip to content

Commit c3bf09f

Browse files
committed
update README.md
1 parent 409c2b2 commit c3bf09f

File tree

1 file changed

+26
-7
lines changed

1 file changed

+26
-7
lines changed

README.md

Lines changed: 26 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,16 @@
1414
<p align="center">
1515

1616
<a href="https://www.terraform.io">
17-
<img src="https://img.shields.io/badge/Terraform-v0.15-green" alt="Terraform">
17+
<img src="https://img.shields.io/badge/Terraform-v1.1.7-green" alt="Terraform">
1818
</a>
1919
<a href="LICENSE.md">
20-
<img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="Licence">
20+
<img src="https://img.shields.io/badge/License-APACHE-blue.svg" alt="Licence">
21+
</a>
22+
<a href="https://github.com/clouddrove/terraform-aws-s3/actions/workflows/tfsec.yml">
23+
<img src="https://github.com/clouddrove/terraform-aws-s3/actions/workflows/tfsec.yml/badge.svg" alt="tfsec">
24+
</a>
25+
<a href="https://github.com/clouddrove/terraform-aws-s3/actions/workflows/terraform.yml">
26+
<img src="https://github.com/clouddrove/terraform-aws-s3/actions/workflows/terraform.yml/badge.svg" alt="static-checks">
2127
</a>
2228

2329

@@ -73,7 +79,7 @@ Here are some examples of how you can use this module in your inventory structur
7379
```hcl
7480
module "s3_bucket" {
7581
source = "clouddrove/s3/aws"
76-
version = "0.15.0"
82+
version = "1.0.1"
7783
name = "clouddrove-secure-bucket"
7884
environment = "test"
7985
label_order = ["name", "environment"]
@@ -86,7 +92,7 @@ module "s3_bucket" {
8692
```hcl
8793
module "s3_bucket" {
8894
source = "clouddrove/s3/aws"
89-
version = "0.15.0"
95+
version = "1.0.1"
9096
name = "clouddrove-encryption-bucket"
9197
environment = "test"
9298
label_order = ["name", "environment"]
@@ -100,7 +106,7 @@ module "s3_bucket" {
100106
```hcl
101107
module "s3_bucket" {
102108
source = "clouddrove/s3/aws"
103-
version = "0.15.0"
109+
version = "1.0.1"
104110
name = "clouddrove-logging-encryption-bucket"
105111
environment = "test"
106112
label_order = ["name", "environment"]
@@ -116,7 +122,7 @@ module "s3_bucket" {
116122
```hcl
117123
module "s3_bucket" {
118124
source = "clouddrove/s3/aws"
119-
version = "0.15.0"
125+
version = "1.0.1"
120126
name = "clouddrove-logging-bucket"
121127
environment = "test"
122128
label_order = ["name", "environment"]
@@ -131,7 +137,7 @@ module "s3_bucket" {
131137
```hcl
132138
module "s3_bucket" {
133139
source = "clouddrove/s3/aws"
134-
version = "0.15.0"
140+
version = "1.0.1"
135141
name = "clouddrove-website-bucket"
136142
environment = "test"
137143
label_order = ["name", "environment"]
@@ -195,10 +201,19 @@ data "aws_iam_policy_document" "default" {
195201
| acceleration\_status | Sets the accelerate configuration of an existing bucket. Can be Enabled or Suspended | `bool` | `false` | no |
196202
| acl | Canned ACL to apply to the S3 bucket. | `string` | `null` | no |
197203
| acl\_grants | A list of policy grants for the bucket. Conflicts with `acl`. Set `acl` to `null` to use this. | <pre>list(object({<br> id = string<br> type = string<br> permission = string<br> uri = string<br> }))</pre> | `null` | no |
204+
| attach\_deny\_insecure\_transport\_policy | Controls if S3 bucket should have deny non-SSL transport policy attached | `bool` | `false` | no |
205+
| attach\_elb\_log\_delivery\_policy | Controls if S3 bucket should have ELB log delivery policy attached | `bool` | `false` | no |
206+
| attach\_lb\_log\_delivery\_policy | Controls if S3 bucket should have ALB/NLB log delivery policy attached | `bool` | `false` | no |
207+
| attach\_policy | Controls if S3 bucket should have bucket policy attached (set to `true` to use value of `policy` as bucket policy) | `bool` | `false` | no |
208+
| attach\_public\_policy | Controls if a user defined public bucket policy will be attached (set to `false` to allow upstream to apply defaults to the bucket) | `bool` | `true` | no |
209+
| attach\_require\_latest\_tls\_policy | Controls if S3 bucket should require the latest version of TLS | `bool` | `false` | no |
198210
| attributes | Additional attributes (e.g. `1`). | `list(any)` | `[]` | no |
199211
| aws\_iam\_policy\_document | Specifies the number of days after object creation when the object expires. | `string` | `""` | no |
212+
| block\_public\_acls | Whether Amazon S3 should block public ACLs for this bucket. | `bool` | `false` | no |
213+
| block\_public\_policy | Whether Amazon S3 should block public bucket policies for this bucket. | `bool` | `false` | no |
200214
| bucket\_policy | Conditionally create S3 bucket policy. | `bool` | `false` | no |
201215
| bucket\_prefix | (Optional, Forces new resource) Creates a unique bucket name beginning with the specified prefix. | `string` | `null` | no |
216+
| control\_object\_ownership | Whether to manage S3 Bucket Ownership Controls on this bucket. | `bool` | `false` | no |
202217
| cors\_rule | CORS Configuration specification for this bucket | <pre>list(object({<br> allowed_headers = list(string)<br> allowed_methods = list(string)<br> allowed_origins = list(string)<br> expose_headers = list(string)<br> max_age_seconds = number<br> }))</pre> | `null` | no |
203218
| create\_bucket | Conditionally create S3 bucket. | `bool` | `true` | no |
204219
| delimiter | Delimiter to be used between `organization`, `environment`, `name` and `attributes`. | `string` | `"-"` | no |
@@ -209,6 +224,7 @@ data "aws_iam_policy_document" "default" {
209224
| error\_document | he name of the error document for the website | `string` | `"error.html"` | no |
210225
| force\_destroy | A boolean that indicates all objects should be deleted from the bucket so that the bucket can be destroyed without error. These objects are not recoverable. | `bool` | `false` | no |
211226
| grants | ACL Policy grant.conflict with acl.set acl null to use this | <pre>list(object({<br> id = string<br> type = string<br> permissions = list(string)<br> uri = string<br> }))</pre> | `null` | no |
227+
| ignore\_public\_acls | Whether Amazon S3 should ignore public ACLs for this bucket. | `bool` | `false` | no |
212228
| index\_document | The name of the index document for the website | `string` | `"index.html"` | no |
213229
| kms\_master\_key\_id | The AWS KMS master key ID used for the SSE-KMS encryption. This can only be used when you set the value of sse\_algorithm as aws:kms. The default aws/s3 AWS KMS master key is used if this element is absent while the sse\_algorithm is aws:kms. | `string` | `""` | no |
214230
| label\_order | Label order, e.g. `name`,`application`. | `list(any)` | `[]` | no |
@@ -230,10 +246,13 @@ data "aws_iam_policy_document" "default" {
230246
| mfa\_delete | Enable MFA delete for either Change the versioning state of your bucket or Permanently delete an object version. | `bool` | `false` | no |
231247
| name | Name (e.g. `app` or `cluster`). | `string` | `""` | no |
232248
| object\_lock\_configuration | With S3 Object Lock, you can store objects using a write-once-read-many (WORM) model. Object Lock can help prevent objects from being deleted or overwritten for a fixed amount of time or indefinitely. | <pre>object({<br> mode = string #Valid values are GOVERNANCE and COMPLIANCE.<br> days = number<br> years = number<br> })</pre> | `null` | no |
249+
| object\_ownership | Object ownership. Valid values: BucketOwnerEnforced, BucketOwnerPreferred or ObjectWriter. 'BucketOwnerEnforced': ACLs are disabled, and the bucket owner automatically owns and has full control over every object in the bucket. 'BucketOwnerPreferred': Objects uploaded to the bucket change ownership to the bucket owner if the objects are uploaded with the bucket-owner-full-control canned ACL. 'ObjectWriter': The uploading account will own the object if the object is uploaded with the bucket-owner-full-control canned ACL. | `string` | `"ObjectWriter"` | no |
233250
| owner\_id | The canonical user ID associated with the AWS account. | `string` | `""` | no |
234251
| redirect | The redirect behavior for every request to this bucket's website endpoint | `string` | `"documents/"` | no |
252+
| replication\_configuration | Map containing cross-region replication configuration. | `any` | `{}` | no |
235253
| repository | Terraform current module repo | `string` | `"https://github.com/clouddrove/terraform-aws-s3"` | no |
236254
| request\_payer | Specifies who should bear the cost of Amazon S3 data transfer. Can be either BucketOwner or Requester. By default, the owner of the S3 bucket would incur the costs of any data transfer | `bool` | `false` | no |
255+
| restrict\_public\_buckets | Whether Amazon S3 should restrict public bucket policies for this bucket. | `bool` | `false` | no |
237256
| routing\_rule | ist of rules that define when a redirect is applied and the redirect behavior | `string` | `"docs/"` | no |
238257
| sse\_algorithm | The server-side encryption algorithm to use. Valid values are AES256 and aws:kms. | `string` | `"AES256"` | no |
239258
| tags | Additional tags (e.g. map(`BusinessUnit`,`XYZ`). | `map(any)` | `{}` | no |

0 commit comments

Comments
 (0)