You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+48-42Lines changed: 48 additions & 42 deletions
Original file line number
Diff line number
Diff line change
@@ -38,7 +38,7 @@
38
38
<hr>
39
39
40
40
41
-
We eat, drink, sleep and most importantly love **DevOps**. We are working towards stratergies for standardizing architecture while ensuring security for the infrastructure. We are strong believer of the philosophy <b>Bigger problems are always solved by breaking them into smaller manageable problems</b>. Resonating with microservices architecture, it is considered best-practice to run database, cluster, storage in smaller <b>connected yet manageable pieces</b> within the infrastructure.
41
+
We eat, drink, sleep and most importantly love **DevOps**. We are working towards strategies for standardizing architecture while ensuring security for the infrastructure. We are strong believer of the philosophy <b>Bigger problems are always solved by breaking them into smaller manageable problems</b>. Resonating with microservices architecture, it is considered best-practice to run database, cluster, storage in smaller <b>connected yet manageable pieces</b> within the infrastructure.
42
42
43
43
This module is basically combination of [Terraform open source](https://www.terraform.io/) and includes automatation tests and examples. It also helps to create and improve your infrastructure with minimalistic code instead of maintaining the whole infrastructure code yourself.
44
44
@@ -61,16 +61,18 @@ This module has a few dependencies:
61
61
62
62
63
63
64
+
64
65
## Examples
65
66
67
+
66
68
**IMPORTANT:** Since the `master` branch used in `source` varies based on new modifications, we suggest that you use the release versions [here](https://github.com/clouddrove/terraform-aws-s3/releases).
67
69
68
70
69
71
Here are some examples of how you can use this module in your inventory structure:
| 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 |
168
-
| 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 |
169
-
| label_order | Label order, e.g. `name`,`application`. | list |`<list>`| no |
170
-
| lifecycle_days_to_expiration | Specifies the number of days after object creation when the object expires. | number |`365`| no |
171
-
| lifecycle_days_to_glacier_transition | Specifies the number of days after object creation when it will be moved to Glacier storage. | number |`180`| no |
172
-
| 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 |
| lifecycle_infrequent_storage_object_prefix | Object key prefix identifying one or more objects to which the lifecycle rule applies. | string | `` | no |
| target_bucket | The name of the bucket that will receive the log objects. | string | `` | no |
184
-
| target_prefix | To specify a key prefix for log objects. | string | `` | no |
185
-
| versioning | Enable Versioning of S3. | bool |`false`| no |
186
-
| website_error | An absolute path to the document to return in case of a 4XX error. | string |`error.html`| no |
187
-
| website_hosting_bucket | Enable website hosting of S3. | bool |`false`| no |
188
-
| 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 |
161
+
| acl | Canned ACL to apply to the S3 bucket. | string |`""`| no |
162
+
| application | Application \(e.g. `cd` or `clouddrove`\). | string |`""`| no |
163
+
| attributes | Additional attributes \(e.g. `1`\). | list |`<list>`| no |
164
+
| aws\_iam\_policy\_document | Specifies the number of days after object creation when the object expires. | string |`""`| no |
| 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 |
173
+
| 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 |
174
+
| label\_order | Label order, e.g. `name`,`application`. | list |`<list>`| no |
175
+
| lifecycle\_days\_to\_expiration | Specifies the number of days after object creation when the object expires. | number |`"365"`| no |
176
+
| lifecycle\_days\_to\_glacier\_transition | Specifies the number of days after object creation when it will be moved to Glacier storage. | number |`"180"`| no |
177
+
| 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 |
| lifecycle\_infrequent\_storage\_object\_prefix | Object key prefix identifying one or more objects to which the lifecycle rule applies. | string |`""`| no |
| target\_bucket | The name of the bucket that will receive the log objects. | string |`""`| no |
190
+
| target\_prefix | To specify a key prefix for log objects. | string |`""`| no |
191
+
| versioning | Enable Versioning of S3. | bool |`"false"`| no |
192
+
| website\_error | An absolute path to the document to return in case of a 4XX error. | string |`"error.html"`| no |
193
+
| website\_hosting\_bucket | Enable website hosting of S3. | bool |`"false"`| no |
194
+
| 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 |
189
195
190
196
## Outputs
191
197
192
198
| Name | Description |
193
199
|------|-------------|
194
200
| arn | The ARN of the s3 bucket. |
195
-
|bucket_domain_name| The Domain of the s3 bucket. |
201
+
|bucket\_domain\_name| The Domain of the s3 bucket. |
196
202
| id | The ID of the s3 bucket. |
197
203
| tags | A mapping of tags to assign to the resource. |
198
204
199
205
200
206
201
-
## Testing
202
207
208
+
## Testing
203
209
In this module testing is performed with [terratest](https://github.com/gruntwork-io/terratest) and it creates a small piece of infrastructure, matches the output like ARN, ID and Tags name etc and destroy infrastructure in your AWS account. This testing is written in GO, so you need a [GO environment](https://golang.org/doc/install) in your system.
204
210
205
211
You need to run the following command in the testing folder:
@@ -212,7 +218,7 @@ You need to run the following command in the testing folder:
212
218
## Feedback
213
219
If you come accross a bug or have any feedback, please log it in our [issue tracker](https://github.com/clouddrove/terraform-aws-s3/issues), or feel free to drop us an email at [hello@clouddrove.com](mailto:hello@clouddrove.com).
214
220
215
-
If you have found it worth your time, go ahead and give us a * on [our GitHub](https://github.com/clouddrove/terraform-aws-s3)!
221
+
If you have found it worth your time, go ahead and give us a ★ on [our GitHub](https://github.com/clouddrove/terraform-aws-s3)!
216
222
217
223
## About us
218
224
@@ -227,4 +233,4 @@ At [CloudDrove][website], we offer expert guidance, implementation support and s
0 commit comments