Skip to content

Commit 10b996b

Browse files
authored
docs(bucket): make acl deprecation message clearer (#1698)
The previous deprecation message was not clear from a user point of view. Update it for users to be clearer.
1 parent b48ff1a commit 10b996b

File tree

3 files changed

+5
-8
lines changed

3 files changed

+5
-8
lines changed

docs/resources/object_bucket.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ For more information, see [the documentation](https://www.scaleway.com/en/docs/o
1414
```hcl
1515
resource "scaleway_object_bucket" "some_bucket" {
1616
name = "some-unique-name"
17-
acl = "private"
1817
tags = {
1918
key = "value"
2019
}
@@ -27,7 +26,6 @@ resource "scaleway_object_bucket" "some_bucket" {
2726
resource "scaleway_object_bucket" "main"{
2827
name = "mybuckectid"
2928
region = "fr-par"
30-
acl = "private"
3129
3230
# This lifecycle configuration rule will make that all objects that got a filter key that start with (path1/) be transferred
3331
# from their default storage class (STANDARD, ONEZONE_IA) to GLACIER after 120 days counting
@@ -112,15 +110,14 @@ The following arguments are supported:
112110

113111
* `name` - (Required) The name of the bucket.
114112
* `tags` - (Optional) A list of tags (key / value) for the bucket.
115-
* `acl` - (Optional) The canned ACL you want to apply to the bucket.
113+
* `acl` - (Optional)(Deprecated) The canned ACL you want to apply to the bucket.
116114
* `region` - (Optional) The [region](https://developers.scaleway.com/en/quickstart/#region-definition) in which the bucket should be created.
117115
* `versioning` - (Optional) A state of [versioning](https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html) (documented below)
118116
* `cors_rule` - (Optional) A rule of [Cross-Origin Resource Sharing](https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) (documented below).
119117
* `force_destroy` - (Optional) Enable deletion of objects in bucket before destroying, locked objects or under legal hold are also deleted and **not** recoverable
120118

121-
## The ACL
122-
123-
Please check the [canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl_overview.html#canned-acl)
119+
The `acl` attribute is deprecated. See [scaleway_object_bucket_acl](object_bucket_acl.md) resource documentation.
120+
Please check the [canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl_overview.html#canned-acl) documentation for supported values.
124121

125122
The `CORS` object supports the following:
126123

docs/resources/object_bucket_acl.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: |-
44
Manages Scaleway object storage bucket ACL resource.
55
---
66

7-
# scaleway_object_bucket
7+
# scaleway_object_bucket_acl
88

99
Creates and manages Scaleway object storage bucket ACL.
1010
For more information, see [the documentation](https://www.scaleway.com/en/docs/storage/object/concepts/#access-control-list-(acl)).

scaleway/resource_object_bucket.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ func resourceScalewayObjectBucket() *schema.Resource {
5454
s3.ObjectCannedACLPublicReadWrite,
5555
s3.ObjectCannedACLAuthenticatedRead,
5656
}, false),
57-
Deprecated: "ACL is deprecated. Please use resource_bucket_acl instead.",
57+
Deprecated: "ACL attribute is deprecated. Please use the resource scaleway_object_bucket_acl instead.",
5858
},
5959
"tags": {
6060
Type: schema.TypeMap,

0 commit comments

Comments
 (0)