Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Promote public_access_prevention field on google_storage_bucket resource to GA, add to documentation #12766

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .changelog/6683.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```release-note:enhancement
storage: Promoted `public_access_prevention` field on `google_storage_bucket` resource to GA
```
18 changes: 17 additions & 1 deletion google/resource_storage_bucket.go
Original file line number Diff line number Diff line change
Expand Up @@ -386,6 +386,12 @@ func resourceStorageBucket() *schema.Resource {
},
Description: `The bucket's custom location configuration, which specifies the individual regions that comprise a dual-region bucket. If the bucket is designated a single or multi-region, the parameters are empty.`,
},
"public_access_prevention": {
Type: schema.TypeString,
Optional: true,
Computed: true,
Description: `Prevents public access to a bucket.`,
},
},
UseJSONNumber: true,
}
Expand Down Expand Up @@ -650,7 +656,7 @@ func resourceStorageBucketUpdate(d *schema.ResourceData, meta interface{}) error
}
}

if d.HasChange("uniform_bucket_level_access") {
if d.HasChange("uniform_bucket_level_access") || d.HasChange("public_access_prevention") {
sb.IamConfiguration = expandIamConfiguration(d)
}

Expand Down Expand Up @@ -1142,6 +1148,10 @@ func expandIamConfiguration(d *schema.ResourceData) *storage.BucketIamConfigurat
},
}

if v, ok := d.GetOk("public_access_prevention"); ok {
cfg.PublicAccessPrevention = v.(string)
}

return cfg
}

Expand Down Expand Up @@ -1506,6 +1516,12 @@ func setStorageBucket(d *schema.ResourceData, config *Config, res *storage.Bucke
}
}

if res.IamConfiguration != nil && res.IamConfiguration.PublicAccessPrevention != "" {
if err := d.Set("public_access_prevention", res.IamConfiguration.PublicAccessPrevention); err != nil {
return fmt.Errorf("Error setting public_access_prevention: %s", err)
}
}

if res.Billing == nil {
if err := d.Set("requester_pays", nil); err != nil {
return fmt.Errorf("Error setting requester_pays: %s", err)
Expand Down
33 changes: 33 additions & 0 deletions google/resource_storage_bucket_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -866,6 +866,28 @@ func TestAccStorageBucket_encryption(t *testing.T) {
})
}

func TestAccStorageBucket_publicAccessPrevention(t *testing.T) {
t.Parallel()

bucketName := fmt.Sprintf("tf-test-acl-bucket-%d", randInt(t))

vcrTest(t, resource.TestCase{
PreCheck: func() { testAccPreCheck(t) },
Providers: testAccProviders,
Steps: []resource.TestStep{
{
Config: testAccStorageBucket_publicAccessPrevention(bucketName, "enforced"),
},
{
ResourceName: "google_storage_bucket.bucket",
ImportState: true,
ImportStateVerify: true,
ImportStateVerifyIgnore: []string{"force_destroy"},
},
},
})
}

func TestAccStorageBucket_uniformBucketAccessOnly(t *testing.T) {
t.Parallel()

Expand Down Expand Up @@ -1785,6 +1807,17 @@ resource "google_storage_bucket" "bucket" {
`, bucketName, enabled)
}

func testAccStorageBucket_publicAccessPrevention(bucketName string, prevention string) string {
return fmt.Sprintf(`
resource "google_storage_bucket" "bucket" {
name = "%s"
location = "US"
public_access_prevention = "%s"
force_destroy = true
}
`, bucketName, prevention)
}

func testAccStorageBucket_encryption(context map[string]interface{}) string {
return Nprintf(`
resource "google_project" "acceptance" {
Expand Down
15 changes: 15 additions & 0 deletions website/docs/r/storage_bucket.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,19 @@ resource "google_storage_bucket" "auto-expire" {
}
}
```

## Example Usage - Enabling public access prevention

```hcl
resource "google_storage_bucket" "auto-expire" {
name = "no-public-access-bucket"
location = "US"
force_destroy = true

public_access_prevention = "enforced"
}
```

## Argument Reference

The following arguments are supported:
Expand Down Expand Up @@ -101,6 +114,8 @@ The following arguments are supported:

* `uniform_bucket_level_access` - (Optional, Default: false) Enables [Uniform bucket-level access](https://cloud.google.com/storage/docs/uniform-bucket-level-access) access to a bucket.

* `public_access_prevention` - (Optional) Prevents public access to a bucket. Acceptable values are "inherited" or "enforced". If "inherited", the bucket uses [public access prevention](https://cloud.google.com/storage/docs/public-access-prevention). only if the bucket is subject to the public access prevention organization policy constraint. Defaults to "inherited".

* `custom_placement_config` - (Optional) The bucket's custom location configuration, which specifies the individual regions that comprise a dual-region bucket. If the bucket is designated a single or multi-region, the parameters are empty. Structure is [documented below](#nested_custom_placement_config).

<a name="nested_lifecycle_rule"></a>The `lifecycle_rule` block supports:
Expand Down