Skip to content

Commit f4b941c

Browse files
committed
update README.md
1 parent 323c26a commit f4b941c

File tree

1 file changed

+29
-20
lines changed

1 file changed

+29
-20
lines changed

README.md

Lines changed: 29 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,12 @@
44

55

66
<h1 align="center">
7-
Terraform DigitalOcean spaces
7+
Terraform Digitalocean spaces
88
</h1>
99

1010
<p align="center" style="font-size: 1.2rem;">
11-
Provides a bucket resource for Spaces, DigitalOcean's object storage product. </p>
11+
spaces are virtual networks containing resources that can communicate with each other in full isolation, using private IP addresses.
12+
</p>
1213

1314
<p align="center">
1415

@@ -26,10 +27,10 @@ Provides a bucket resource for Spaces, DigitalOcean's object storage product.
2627
<a href='https://facebook.com/sharer/sharer.php?u=https://github.com/clouddrove/terraform-digitalocean-spaces'>
2728
<img title="Share on Facebook" src="https://user-images.githubusercontent.com/50652676/62817743-4f64cb80-bb59-11e9-90c7-b057252ded50.png" />
2829
</a>
29-
<a href='https://www.linkedin.com/shareArticle?mini=true&title=Terraform+DigitalOcean+spaces&url=https://github.com/clouddrove/terraform-digitalocean-spaces'>
30+
<a href='https://www.linkedin.com/shareArticle?mini=true&title=Terraform+Digitalocean+spaces&url=https://github.com/clouddrove/terraform-digitalocean-spaces'>
3031
<img title="Share on LinkedIn" src="https://user-images.githubusercontent.com/50652676/62817742-4e339e80-bb59-11e9-87b9-a1f68cae1049.png" />
3132
</a>
32-
<a href='https://twitter.com/intent/tweet/?text=Terraform+DigitalOcean+spaces&url=https://github.com/clouddrove/terraform-digitalocean-spaces'>
33+
<a href='https://twitter.com/intent/tweet/?text=Terraform+Digitalocean+spaces&url=https://github.com/clouddrove/terraform-digitalocean-spaces'>
3334
<img title="Share on Twitter" src="https://user-images.githubusercontent.com/50652676/62817740-4c69db00-bb59-11e9-8a79-3580fbbf6d5c.png" />
3435
</a>
3536

@@ -71,13 +72,14 @@ This module has a few dependencies:
7172
Here is an example of how you can use this module in your inventory structure:
7273
```hcl
7374
module "spaces" {
74-
source = "terraform-do-modules/spaces/digitalocean"
75-
version = "0.15.0"
76-
name = "spaces"
77-
environment = "test"
78-
label_order = ["environment", "name"]
79-
enable_spaces = true
80-
region = "bangalore-1"
75+
source = "terraform-do-modules/spaces/digitalocean"
76+
version = "0.15.0"
77+
name = "clouddrove"
78+
environment = "test"
79+
label_order = ["name"]
80+
acl = "public-read"
81+
force_destroy = true
82+
region = "nyc3"
8183
}
8284
```
8385

@@ -90,23 +92,30 @@ Here is an example of how you can use this module in your inventory structure:
9092

9193
| Name | Description | Type | Default | Required |
9294
|------|-------------|------|---------|:--------:|
93-
| application | Application (e.g. `cd` or `clouddrove`). | `string` | `""` | no |
95+
| abort\_incomplete\_multipart\_upload\_days | Specifies the number of days after initiating a multipart upload when the multipart upload must be completed or else Spaces will abort the upload. | `number` | `null` | no |
96+
| acl | Canned ACL applied on bucket creation (private or public-read). | `string` | `null` | no |
97+
| attributes | Additional attributes (e.g. `1`). | `list(any)` | `[]` | no |
98+
| 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 |
99+
| date | pecifies the date/time after which you want applicable objects to expire. The argument uses RFC3339 format, e.g.(2020-03-22T15:03:55Z) or parts thereof e.g. 2019-02-28. | `string` | `null` | no |
94100
| delimiter | Delimiter to be used between `organization`, `environment`, `name` and `attributes`. | `string` | `"-"` | no |
95-
| description | A free-form text field up to a limit of 255 characters to describe the spaces. | `string` | `"spaces"` | no |
96-
| enable\_spaces | A boolean flag to enable/disable spaces. | `bool` | `true` | no |
97101
| environment | Environment (e.g. `prod`, `dev`, `staging`). | `string` | `""` | no |
98-
| label\_order | Label order, e.g. `name`,`application`. | `list` | `[]` | no |
102+
| expiration\_days | Specifies the number of days after object creation when the applicable objects will expire. | `number` | `null` | no |
103+
| expired\_object\_delete\_marker | On a versioned bucket (versioning-enabled or versioning-suspended bucket), setting this to true directs Spaces to delete expired object delete markers. | `string` | `""` | no |
104+
| force\_destroy | Unless true, the bucket will only be destroyed if empty (Defaults to false). | `bool` | `false` | no |
105+
| label\_order | Label order, e.g. `name`,`application`. | `list(any)` | `[]` | no |
99106
| name | Name (e.g. `app` or `cluster`). | `string` | `""` | no |
100-
| region | The region to create spaces, like `london-1` , `bangalore-1` ,`newyork-3` `toronto-1`. | `string` | `"bangalore-1"` | no |
107+
| noncurrent\_version\_expiration | On a versioned bucket (versioning-enabled or versioning-suspended bucket), setting this to true directs Spaces to delete expired object delete markers. | `string` | `""` | no |
108+
| prefix | (Optional, Forces new resource) Creates a unique bucket name beginning with the specified prefix. | `string` | `null` | no |
109+
| region | The region to create VPC, like `london-1` , `bangalore-1` ,`newyork-3` `toronto-1`. | `string` | `""` | no |
110+
| versioning | (Optional) A state of versioning (documented below). | `bool` | `true` | no |
101111

102112
## Outputs
103113

104114
| Name | Description |
105115
|------|-------------|
106-
| created\_at | The date and time of when the spaces was created. |
107-
| default | A boolean indicating whether or not the spaces is the default one for the region. |
108-
| id | The unique identifier for the spaces.. |
109-
| urn | The uniform resource name (URN) for the spaces. |
116+
| bucket\_domain\_name | The date and time of when the VPC was created. |
117+
| name | The date and time of when the VPC was created. |
118+
| urn | The uniform resource name (URN) for the VPC. |
110119

111120

112121

0 commit comments

Comments
 (0)