Google Cloud Storage Bucket Access Control

This page shows how to write Terraform for Cloud Storage Bucket Access Control and write them securely.

google_storage_bucket_access_control (Terraform)

The Bucket Access Control in Cloud Storage can be configured in Terraform with the resource name google_storage_bucket_access_control. The following sections describe 2 examples of how to use the resource and its parameters.

Example Usage from GitHub

bucket.tf#L9
resource "google_storage_bucket_access_control" "access-control-stock-ticker-bucket" {
  bucket = google_storage_bucket.stock-ticker-bucket.name
  entity = "user-keith.blix@gmail.com"
  role   = "OWNER"
}

main.tf#L8
resource "google_storage_bucket_access_control" "public_rule" {
  bucket = google_storage_bucket.assets.name
  role   = "READER"
  entity = "allUsers"

Review your Terraform file for Google best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

Parameters

The name of the bucket.

  • domain optional computed - string

The domain associated with the entity.

  • email optional computed - string

The email address associated with the entity.

The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.

  • id optional computed - string
  • role optional - string

The access permission for the entity. Possible values: ["OWNER", "READER", "WRITER"]

Explanation in Terraform Registry

Bucket ACLs can be managed authoritatively using the storage_bucket_acl resource. Do not use these two resources in conjunction to manage the same bucket. The BucketAccessControls resource manages the Access Control List (ACLs) for a single entity/role pairing on a bucket. ACLs let you specify who has access to your data and to what extent. There are three roles that can be assigned to an entity: READERs can get the bucket, though no acl property will be returned, and list the bucket's objects. WRITERs are READERs, and they can insert objects into the bucket and delete the bucket's objects. OWNERs are WRITERs, and they can get the acl property of a bucket, update a bucket, and call all BucketAccessControls methods on the bucket. For more information, see Access Control, with the caveat that this API uses READER, WRITER, and OWNER instead of READ, WRITE, and FULL_CONTROL. To get more information about BucketAccessControl, see:

Tips: Best Practices for The Other Google Cloud Storage Resources

In addition to the google_storage_bucket, Google Cloud Storage has the other resources that should be configured for security reasons. Please check some examples of those resources and precautions.

risk-label

google_storage_bucket

Ensure uniform bucket-level access of your GCS bucket is enabled

It is better to enable uniform bucket-level access of the GCS bucket. Uniform bucket-level access unifies and simplifies how you grant access to resources in the bucket.

Review your Google Cloud Storage settings

In addition to the above, there are other security points you should be aware of making sure that your .tf files are protected in Shisho Cloud.

Frequently asked questions

What is Google Cloud Storage Bucket Access Control?

Google Cloud Storage Bucket Access Control is a resource for Cloud Storage of Google Cloud Platform. Settings can be wrote in Terraform.

Where can I find the example code for the Google Cloud Storage Bucket Access Control?

For Terraform, the Blixk/basic_terraform_infrastructure and hizzuu/plate-terraform source code examples are useful. See the Terraform Example section for further details.