google_storage_bucket

Creates a new bucket in Google cloud storage service (GCS). Once a bucket has been created, its location can't be changed. ACLs can be applied using the google_storage_bucket_acl resource. For more information see the official documentation and API.

Example Usage

Example creating a private bucket in standard storage, in the EU region.

resource "google_storage_bucket" "image-store" {
  name     = "image-store-bucket"
  location = "EU"

  website {
    main_page_suffix = "index.html"
    not_found_page   = "404.html"
  }
}

Argument Reference

The following arguments are supported:

• name - (Required) The name of the bucket.

• force_destroy - (Optional, Default: false) When deleting a bucket, this boolean option will delete all contained objects. If you try to delete a bucket that contains objects, Terraform will fail that run.

• location - (Optional, Default: 'US') The GCS location

• project - (Optional) The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

• storage_class - (Optional) The Storage Class of the new bucket. Supported values include: MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE.

• lifecycle_rule - (Optional) The bucket's Lifecycle Rules configuration. Multiple blocks of this type are permitted. Structure is documented below.

• versioning - (Optional) The bucket's Versioning configuration.

• website - (Optional) Configuration if the bucket acts as a website. Structure is documented below.

• cors - (Optional) The bucket's Cross-Origin Resource Sharing (CORS) configuration. Multiple blocks of this type are permitted. Structure is documented below.

• labels - (Optional) A set of key/value label pairs to assign to the bucket.

• logging - (Optional) The bucket's Access & Storage Logs configuration.

The lifecycle_rule block supports:

• action - (Required) The Lifecycle Rule's action configuration. A single block of this type is supported. Structure is documented below.

• condition - (Required) The Lifecycle Rule's condition configuration. A single block of this type is supported. Structure is documented below.

The action block supports:

• type - The type of the action of this Lifecycle Rule. Supported values include: Delete and SetStorageClass.

• storage_class - (Required if action type is SetStorageClass) The target Storage Class of objects affected by this Lifecycle Rule. Supported values include: MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE.

The condition block supports the following elements, and requires at least one to be defined:

• age - (Optional) Minimum age of an object in days to satisfy this condition.

• created_before - (Optional) Creation date of an object in RFC 3339 (e.g. 2017-06-13) to satisfy this condition.

• is_live - (Optional) Defaults to false to match archived objects. If true, this condition matches live objects. Unversioned buckets have only live objects.

• matches_storage_class - (Optional) Storage Class of objects to satisfy this condition. Supported values include: MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, STANDARD, DURABLE_REDUCED_AVAILABILITY.

• num_newer_versions - (Optional) Relevant only for versioned objects. The number of newer versions of an object to satisfy this condition.

The versioning block supports:

• enabled - (Optional) While set to true, versioning is fully enabled for this bucket.

The website block supports:

• main_page_suffix - (Optional) Behaves as the bucket's directory index where missing objects are treated as potential directories.

• not_found_page - (Optional) The custom object to return when a requested resource is not found.

The cors block supports:

• origin - (Optional) The list of Origins eligible to receive CORS response headers. Note: "*" is permitted in the list of origins, and means "any Origin".

• method - (Optional) The list of HTTP methods on which to include CORS response headers, (GET, OPTIONS, POST, etc) Note: "*" is permitted in the list of methods, and means "any method".

• response_header - (Optional) The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains.

• max_age_seconds - (Optional) The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses.

The logging block supports:

• log_bucket - (Required) The bucket that will receive log objects.

• log_object_prefix - (Optional, Computed) The object prefix for log objects. If it's not provided, by default GCS sets this to the log_bucket's name.

Attributes Reference

In addition to the arguments listed above, the following computed attributes are exported:

• self_link - The URI of the created resource.

• url - The base URL of the bucket, in the format gs://<bucket-name>.

Import

Storage buckets can be imported using the name, e.g.

$ terraform import google_storage_bucket.image-store image-store-bucket

Note that when importing a bucket (and only when importing), the Compute API needs to be enabled - you'll see an error with a link to the enablement page if it is not.