Google Cloud Storage Bucket Object

google_storage_bucket_object (Terraform)

The Bucket Object in Cloud Storage can be configured in Terraform with the resource name google_storage_bucket_object. The following sections describe 5 examples of how to use the resource and its parameters.

Example Usage from GitHub

Mevan96/ldap

resource "google_storage_bucket_object" "baseldapdomain" {
  name   = "resources/baseldapdomain.ldif"
  source = "resources/baseldapdomain.ldif"
  bucket = google_storage_bucket.ldap-config-bucket.name
}

Boeefkas/ldap

resource "google_storage_bucket_object" "baseldapdomain" {
  name   = "resources/baseldapdomain.ldif"
  source = "resources/baseldapdomain.ldif"
  bucket = google_storage_bucket.ldap-config-bucket.name
}

Shriyut/buildterraform

resource "google_storage_bucket_object" "archive_folder" {
  name = var.archive_folder_name
  content = var.archive_folder_content
  bucket = var.bucketname
}

john-hurringjr/test-modules

resource "google_storage_bucket_object" "org_node_stuff_vars" {
  bucket  = google_storage_bucket.gcs_bucket_for_backend_var_files.name
  name    = "01-org-node-stuff/"
  content = " "
}

inventive-technology/infrastructure-terraform-gcp-static-website-low-cost

resource "google_storage_bucket_object" "index" {
  name   = "index.html"
  source = "www/index.html"
  bucket = google_storage_bucket.public.name
  depends_on = [google_storage_default_object_access_control.public_rule]
}

Parameters

• bucket required - string

The name of the containing bucket.

• cache_control optional - string

Cache-Control directive to specify caching behavior of object data. If omitted and object is accessible to all anonymous users, the default will be public, max-age=3600

• content optional - string

Data as string to be uploaded. Must be defined if source is not. Note: The content field is marked as sensitive. To view the raw contents of the object, please define an output.

• content_disposition optional - string

Content-Disposition of the object data.

• content_encoding optional - string

Content-Encoding of the object data.

• content_language optional - string

Content-Language of the object data.

• content_type optional computed - string

Content-Type of the object data. Defaults to "application/octet-stream" or "text/plain; charset=utf-8".

• crc32c optional computed - string

Base 64 CRC32 hash of the uploaded data.

• detect_md5hash optional - string
• id optional computed - string
• kms_key_name optional computed - string

Resource name of the Cloud KMS key that will be used to encrypt the object. Overrides the object metadata's kmsKeyName value, if any.

• md5hash optional computed - string

Base 64 MD5 hash of the uploaded data.

• media_link optional computed - string

A url reference to download this object.

• metadata optional - map from string to string

User-provided metadata, in key/value pairs.

• name required - string

The name of the object. If you're interpolating the name of this object, see output_name instead.

• output_name optional computed - string

The name of the object. Use this field in interpolations with google_storage_object_acl to recreate google_storage_object_acl resources when your google_storage_bucket_object is recreated.

• self_link optional computed - string

A url reference to this object.

• source optional - string

A path to the data you want to upload. Must be defined if content is not.

• storage_class optional computed - string

The StorageClass of the new bucket object. Supported values include: MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, ARCHIVE. If not provided, this defaults to the bucket's default storage class or to a standard class.

Explanation in Terraform Registry

Creates a new object inside an existing bucket in Google cloud storage service (GCS). ACLs can be applied using the google_storage_object_acl resource. For more information see the official documentation and API.

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.

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.