Skip to content

Commit 280d0f9

Browse files
anmolnagpalanmolnagpal
committed
update README.md
1 parent 184237a commit 280d0f9

File tree

1 file changed

+23
-28
lines changed

1 file changed

+23
-28
lines changed

‎README.md

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

1616
<a href="https://www.terraform.io">
17-
<img src="https://img.shields.io/badge/Terraform-v0.13-green" alt="Terraform">
17+
<img src="https://img.shields.io/badge/Terraform-v0.14-green" alt="Terraform">
1818
</a>
1919
<a href="LICENSE.md">
2020
<img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="Licence">
@@ -73,11 +73,10 @@ Here are some examples of how you can use this module in your inventory structur
7373
```hcl
7474
module "s3_bucket" {
7575
source = "clouddrove/s3/aws"
76-
version = "0.13.0"
77-
name = "secure-bucket"
78-
application = "clouddrove"
76+
version = "0.14.0"
77+
name = "clouddrove-secure-bucket"
7978
environment = "test"
80-
label_order = ["environment", "application", "name"]
79+
label_order = ["name", "environment"]
8180
versioning = true
8281
acl = "private"
8382
bucket_enabled = true
@@ -87,11 +86,10 @@ module "s3_bucket" {
8786
```hcl
8887
module "s3_bucket" {
8988
source = "clouddrove/s3/aws"
90-
version = "0.13.0"
91-
name = "encryption-bucket"
92-
application = "clouddrove"
89+
version = "0.14.0"
90+
name = "clouddrove-encryption-bucket"
9391
environment = "test"
94-
label_order = ["environment", "application", "name"]
92+
label_order = ["name", "environment"]
9593
versioning = true
9694
acl = "private"
9795
bucket_encryption_enabled = true
@@ -102,11 +100,10 @@ module "s3_bucket" {
102100
```hcl
103101
module "s3_bucket" {
104102
source = "clouddrove/s3/aws"
105-
version = "0.13.0"
106-
name = "logging-encryption-bucket"
107-
application = "clouddrove"
103+
version = "0.14.0"
104+
name = "clouddrove-logging-encryption-bucket"
108105
environment = "test"
109-
label_order = ["environment", "application", "name"]
106+
label_order = ["name", "environment"]
110107
versioning = true
111108
acl = "private"
112109
bucket_logging_encryption_enabled = true
@@ -119,11 +116,10 @@ module "s3_bucket" {
119116
```hcl
120117
module "s3_bucket" {
121118
source = "clouddrove/s3/aws"
122-
version = "0.13.0"
123-
name = "logging-bucket"
124-
application = "clouddrove"
119+
version = "0.14.0"
120+
name = "clouddrove-logging-bucket"
125121
environment = "test"
126-
label_order = ["environment", "application", "name"]
122+
label_order = ["name", "environment"]
127123
versioning = true
128124
acl = "private"
129125
bucket_logging_enabled = true
@@ -135,11 +131,10 @@ module "s3_bucket" {
135131
```hcl
136132
module "s3_bucket" {
137133
source = "clouddrove/s3/aws"
138-
version = "0.13.0"
139-
name = "website-bucket"
140-
application = "clouddrove"
134+
version = "0.14.0"
135+
name = "clouddrove-website-bucket"
141136
environment = "test"
142-
label_order = ["environment", "application", "name"]
137+
label_order = ["name", "environment"]
143138
versioning = true
144139
acl = "private"
145140
website_hosting_bucket = true
@@ -161,7 +156,7 @@ data "aws_iam_policy_document" "default" {
161156
identifiers = ["*"]
162157
}
163158
actions = ["s3:GetObject"]
164-
resources = ["arn:aws:s3:::test-website-bucket-clouddrove/*"]
159+
resources = ["arn:aws:s3:::clouddrove-website-bucket-test/*"]
165160
}
166161
}
167162
```
@@ -176,8 +171,7 @@ data "aws_iam_policy_document" "default" {
176171
| Name | Description | Type | Default | Required |
177172
|------|-------------|------|---------|:--------:|
178173
| acl | Canned ACL to apply to the S3 bucket. | `string` | `""` | no |
179-
| application | Application (e.g. `cd` or `clouddrove`). | `string` | `""` | no |
180-
| attributes | Additional attributes (e.g. `1`). | `list` | `[]` | no |
174+
| attributes | Additional attributes (e.g. `1`). | `list(any)` | `[]` | no |
181175
| aws\_iam\_policy\_document | Specifies the number of days after object creation when the object expires. | `string` | `""` | no |
182176
| bucket\_enabled | Enable simple S3. | `bool` | `false` | no |
183177
| bucket\_encryption\_enabled | Enable encryption of S3. | `bool` | `false` | no |
@@ -189,7 +183,7 @@ data "aws_iam_policy_document" "default" {
189183
| environment | Environment (e.g. `prod`, `dev`, `staging`). | `string` | `""` | no |
190184
| 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 |
191185
| 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 |
192-
| label\_order | Label order, e.g. `name`,`application`. | `list` | `[]` | no |
186+
| label\_order | Label order, e.g. `name`,`application`. | `list(any)` | `[]` | no |
193187
| lifecycle\_days\_to\_expiration | Specifies the number of days after object creation when the object expires. | `number` | `365` | no |
194188
| lifecycle\_days\_to\_glacier\_transition | Specifies the number of days after object creation when it will be moved to Glacier storage. | `number` | `180` | no |
195189
| lifecycle\_days\_to\_infrequent\_storage\_transition | Specifies the number of days after object creation when it will be moved to standard infrequent access storage. | `number` | `60` | no |
@@ -199,14 +193,15 @@ data "aws_iam_policy_document" "default" {
199193
| lifecycle\_glacier\_transition\_enabled | Specifies Glacier transition lifecycle rule status. | `bool` | `false` | no |
200194
| lifecycle\_infrequent\_storage\_object\_prefix | Object key prefix identifying one or more objects to which the lifecycle rule applies. | `string` | `""` | no |
201195
| lifecycle\_infrequent\_storage\_transition\_enabled | Specifies infrequent storage transition lifecycle rule status. | `bool` | `false` | no |
202-
| managedby | ManagedBy, eg 'CloudDrove' or 'AnmolNagpal'. | `string` | `"anmol@clouddrove.com"` | no |
196+
| managedby | ManagedBy, eg 'CloudDrove'. | `string` | `"hello@clouddrove.com"` | no |
203197
| mfa\_delete | Enable MFA delete for either Change the versioning state of your bucket or Permanently delete an object version. | `bool` | `false` | no |
204198
| name | Name (e.g. `app` or `cluster`). | `string` | `""` | no |
199+
| repository | Terraform current module repo | `string` | `"https://registry.terraform.io/modules/clouddrove/s3/aws"` | no |
205200
| sse\_algorithm | The server-side encryption algorithm to use. Valid values are AES256 and aws:kms. | `string` | `"AES256"` | no |
206-
| tags | Additional tags (e.g. map(`BusinessUnit`,`XYZ`). | `map` | `{}` | no |
201+
| tags | Additional tags (e.g. map(`BusinessUnit`,`XYZ`). | `map(any)` | `{}` | no |
207202
| target\_bucket | The name of the bucket that will receive the log objects. | `string` | `""` | no |
208203
| target\_prefix | To specify a key prefix for log objects. | `string` | `""` | no |
209-
| versioning | Enable Versioning of S3. | `bool` | `false` | no |
204+
| versioning | Enable Versioning of S3. | `bool` | `true` | no |
210205
| website\_error | An absolute path to the document to return in case of a 4XX error. | `string` | `"error.html"` | no |
211206
| website\_hosting\_bucket | Enable website hosting of S3. | `bool` | `false` | no |
212207
| website\_index | Amazon S3 returns this index document when requests are made to the root domain or any of the subfolders. | `string` | `"index.html"` | no |

0 commit comments

Comments
 (0)