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 gcp.storage.BucketACL resource.

For more information see the official documentation and API.

Note: If the project id is not set on the resource or in the provider block it will be dynamically determined which will require enabling the compute api.

Create a Bucket Resource

new Bucket(name: string, args?: BucketArgs, opts?: CustomResourceOptions);

def Bucket(resource_name, opts=None, bucket_policy_only=None, cors=None, default_event_based_hold=None, encryption=None, force_destroy=None, labels=None, lifecycle_rules=None, location=None, logging=None, name=None, project=None, requester_pays=None, retention_policy=None, storage_class=None, versioning=None, website=None, __props__=None);

func NewBucket(ctx *Context, name string, args *BucketArgs, opts ...ResourceOption) (*Bucket, error)

public Bucket(string name, BucketArgs? args = null, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args BucketArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args BucketArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args BucketArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Bucket Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Bucket resource accepts the following input properties:

BucketPolicyOnly bool: Enables Bucket Policy Only access to a bucket.
Cors List<BucketCorArgs>: The bucket’s Cross-Origin Resource Sharing (CORS) configuration. Multiple blocks of this type are permitted. Structure is documented below.
DefaultEventBasedHold bool
Encryption BucketEncryptionArgs: The bucket’s encryption configuration.
ForceDestroy bool: When deleting a bucket, this boolean option will delete all contained objects. If you try to delete a bucket that contains objects, the provider will fail that run.
Labels Dictionary<string, string>: A set of key/value label pairs to assign to the bucket.
LifecycleRules List<BucketLifecycleRuleArgs>: The bucket’s Lifecycle Rules configuration. Multiple blocks of this type are permitted. Structure is documented below.
Location string: The GCS location
Logging BucketLoggingArgs: The bucket’s Access & Storage Logs configuration.
Name string: The name of the bucket.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
RequesterPays bool: Enables Requester Pays on a storage bucket.
RetentionPolicy BucketRetentionPolicyArgs: Configuration of the bucket’s data retention policy for how long objects in the bucket should be retained. Structure is documented below.
StorageClass string: The target Storage Class of objects affected by this Lifecycle Rule. Supported values include: MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE.
Versioning BucketVersioningArgs: The bucket’s Versioning configuration.
Website BucketWebsiteArgs: Configuration if the bucket acts as a website. Structure is documented below.

BucketPolicyOnly bool: Enables Bucket Policy Only access to a bucket.
Cors []BucketCor: The bucket’s Cross-Origin Resource Sharing (CORS) configuration. Multiple blocks of this type are permitted. Structure is documented below.
DefaultEventBasedHold bool
Encryption BucketEncryption: The bucket’s encryption configuration.
ForceDestroy bool: When deleting a bucket, this boolean option will delete all contained objects. If you try to delete a bucket that contains objects, the provider will fail that run.
Labels map[string]string: A set of key/value label pairs to assign to the bucket.
LifecycleRules []BucketLifecycleRule: The bucket’s Lifecycle Rules configuration. Multiple blocks of this type are permitted. Structure is documented below.
Location string: The GCS location
Logging BucketLogging: The bucket’s Access & Storage Logs configuration.
Name string: The name of the bucket.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
RequesterPays bool: Enables Requester Pays on a storage bucket.
RetentionPolicy BucketRetentionPolicy: Configuration of the bucket’s data retention policy for how long objects in the bucket should be retained. Structure is documented below.
StorageClass string: The target Storage Class of objects affected by this Lifecycle Rule. Supported values include: MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE.
Versioning BucketVersioning: The bucket’s Versioning configuration.
Website BucketWebsite: Configuration if the bucket acts as a website. Structure is documented below.

bucketPolicyOnly boolean: Enables Bucket Policy Only access to a bucket.
cors BucketCor[]: The bucket’s Cross-Origin Resource Sharing (CORS) configuration. Multiple blocks of this type are permitted. Structure is documented below.
defaultEventBasedHold boolean
encryption BucketEncryption: The bucket’s encryption configuration.
forceDestroy boolean: When deleting a bucket, this boolean option will delete all contained objects. If you try to delete a bucket that contains objects, the provider will fail that run.
labels {[key: string]: string}: A set of key/value label pairs to assign to the bucket.
lifecycleRules BucketLifecycleRule[]: The bucket’s Lifecycle Rules configuration. Multiple blocks of this type are permitted. Structure is documented below.
location string: The GCS location
logging BucketLogging: The bucket’s Access & Storage Logs configuration.
name string: The name of the bucket.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
requesterPays boolean: Enables Requester Pays on a storage bucket.
retentionPolicy BucketRetentionPolicy: Configuration of the bucket’s data retention policy for how long objects in the bucket should be retained. Structure is documented below.
storageClass string: The target Storage Class of objects affected by this Lifecycle Rule. Supported values include: MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE.
versioning BucketVersioning: The bucket’s Versioning configuration.
website BucketWebsite: Configuration if the bucket acts as a website. Structure is documented below.

bucket_policy_only bool: Enables Bucket Policy Only access to a bucket.
cors List[BucketCor]: The bucket’s Cross-Origin Resource Sharing (CORS) configuration. Multiple blocks of this type are permitted. Structure is documented below.
default_event_based_hold bool
encryption Dict[BucketEncryption]: The bucket’s encryption configuration.
force_destroy bool: When deleting a bucket, this boolean option will delete all contained objects. If you try to delete a bucket that contains objects, the provider will fail that run.
labels Dict[str, str]: A set of key/value label pairs to assign to the bucket.
lifecycle_rules List[BucketLifecycleRule]: The bucket’s Lifecycle Rules configuration. Multiple blocks of this type are permitted. Structure is documented below.
location str: The GCS location
logging Dict[BucketLogging]: The bucket’s Access & Storage Logs configuration.
name str: The name of the bucket.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
requester_pays bool: Enables Requester Pays on a storage bucket.
retention_policy Dict[BucketRetentionPolicy]: Configuration of the bucket’s data retention policy for how long objects in the bucket should be retained. Structure is documented below.
storage_class str: The target Storage Class of objects affected by this Lifecycle Rule. Supported values include: MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE.
versioning Dict[BucketVersioning]: The bucket’s Versioning configuration.
website Dict[BucketWebsite]: Configuration if the bucket acts as a website. Structure is documented below.

Outputs

All input properties are implicitly available as output properties. Additionally, the Bucket resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
SelfLink string: The URI of the created resource.
Url string: The base URL of the bucket, in the format gs://<bucket-name>.

Id string: The provider-assigned unique ID for this managed resource.
SelfLink string: The URI of the created resource.
Url string: The base URL of the bucket, in the format gs://<bucket-name>.

id string: The provider-assigned unique ID for this managed resource.
selfLink string: The URI of the created resource.
url string: The base URL of the bucket, in the format gs://<bucket-name>.

id str: The provider-assigned unique ID for this managed resource.
self_link str: The URI of the created resource.
url str: The base URL of the bucket, in the format gs://<bucket-name>.

Look up an Existing Bucket Resource

Get an existing Bucket resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: BucketState, opts?: CustomResourceOptions): Bucket

static get(resource_name, id, opts=None, bucket_policy_only=None, cors=None, default_event_based_hold=None, encryption=None, force_destroy=None, labels=None, lifecycle_rules=None, location=None, logging=None, name=None, project=None, requester_pays=None, retention_policy=None, self_link=None, storage_class=None, url=None, versioning=None, website=None, __props__=None);

func GetBucket(ctx *Context, name string, id IDInput, state *BucketState, opts ...ResourceOption) (*Bucket, error)

public static Bucket Get(string name, Input<string> id, BucketState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

BucketPolicyOnly bool: Enables Bucket Policy Only access to a bucket.
Cors List<BucketCorArgs>: The bucket’s Cross-Origin Resource Sharing (CORS) configuration. Multiple blocks of this type are permitted. Structure is documented below.
DefaultEventBasedHold bool
Encryption BucketEncryptionArgs: The bucket’s encryption configuration.
ForceDestroy bool: When deleting a bucket, this boolean option will delete all contained objects. If you try to delete a bucket that contains objects, the provider will fail that run.
Labels Dictionary<string, string>: A set of key/value label pairs to assign to the bucket.
LifecycleRules List<BucketLifecycleRuleArgs>: The bucket’s Lifecycle Rules configuration. Multiple blocks of this type are permitted. Structure is documented below.
Location string: The GCS location
Logging BucketLoggingArgs: The bucket’s Access & Storage Logs configuration.
Name string: The name of the bucket.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
RequesterPays bool: Enables Requester Pays on a storage bucket.
RetentionPolicy BucketRetentionPolicyArgs: Configuration of the bucket’s data retention policy for how long objects in the bucket should be retained. Structure is documented below.
SelfLink string: The URI of the created resource.
StorageClass string: The target Storage Class of objects affected by this Lifecycle Rule. Supported values include: MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE.
Url string: The base URL of the bucket, in the format gs://<bucket-name>.
Versioning BucketVersioningArgs: The bucket’s Versioning configuration.
Website BucketWebsiteArgs: Configuration if the bucket acts as a website. Structure is documented below.

BucketPolicyOnly bool: Enables Bucket Policy Only access to a bucket.
Cors []BucketCor: The bucket’s Cross-Origin Resource Sharing (CORS) configuration. Multiple blocks of this type are permitted. Structure is documented below.
DefaultEventBasedHold bool
Encryption BucketEncryption: The bucket’s encryption configuration.
ForceDestroy bool: When deleting a bucket, this boolean option will delete all contained objects. If you try to delete a bucket that contains objects, the provider will fail that run.
Labels map[string]string: A set of key/value label pairs to assign to the bucket.
LifecycleRules []BucketLifecycleRule: The bucket’s Lifecycle Rules configuration. Multiple blocks of this type are permitted. Structure is documented below.
Location string: The GCS location
Logging BucketLogging: The bucket’s Access & Storage Logs configuration.
Name string: The name of the bucket.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
RequesterPays bool: Enables Requester Pays on a storage bucket.
RetentionPolicy BucketRetentionPolicy: Configuration of the bucket’s data retention policy for how long objects in the bucket should be retained. Structure is documented below.
SelfLink string: The URI of the created resource.
StorageClass string: The target Storage Class of objects affected by this Lifecycle Rule. Supported values include: MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE.
Url string: The base URL of the bucket, in the format gs://<bucket-name>.
Versioning BucketVersioning: The bucket’s Versioning configuration.
Website BucketWebsite: Configuration if the bucket acts as a website. Structure is documented below.

bucketPolicyOnly boolean: Enables Bucket Policy Only access to a bucket.
cors BucketCor[]: The bucket’s Cross-Origin Resource Sharing (CORS) configuration. Multiple blocks of this type are permitted. Structure is documented below.
defaultEventBasedHold boolean
encryption BucketEncryption: The bucket’s encryption configuration.
forceDestroy boolean: When deleting a bucket, this boolean option will delete all contained objects. If you try to delete a bucket that contains objects, the provider will fail that run.
labels {[key: string]: string}: A set of key/value label pairs to assign to the bucket.
lifecycleRules BucketLifecycleRule[]: The bucket’s Lifecycle Rules configuration. Multiple blocks of this type are permitted. Structure is documented below.
location string: The GCS location
logging BucketLogging: The bucket’s Access & Storage Logs configuration.
name string: The name of the bucket.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
requesterPays boolean: Enables Requester Pays on a storage bucket.
retentionPolicy BucketRetentionPolicy: Configuration of the bucket’s data retention policy for how long objects in the bucket should be retained. Structure is documented below.
selfLink string: The URI of the created resource.
storageClass string: The target Storage Class of objects affected by this Lifecycle Rule. Supported values include: MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE.
url string: The base URL of the bucket, in the format gs://<bucket-name>.
versioning BucketVersioning: The bucket’s Versioning configuration.
website BucketWebsite: Configuration if the bucket acts as a website. Structure is documented below.

bucket_policy_only bool: Enables Bucket Policy Only access to a bucket.
cors List[BucketCor]: The bucket’s Cross-Origin Resource Sharing (CORS) configuration. Multiple blocks of this type are permitted. Structure is documented below.
default_event_based_hold bool
encryption Dict[BucketEncryption]: The bucket’s encryption configuration.
force_destroy bool: When deleting a bucket, this boolean option will delete all contained objects. If you try to delete a bucket that contains objects, the provider will fail that run.
labels Dict[str, str]: A set of key/value label pairs to assign to the bucket.
lifecycle_rules List[BucketLifecycleRule]: The bucket’s Lifecycle Rules configuration. Multiple blocks of this type are permitted. Structure is documented below.
location str: The GCS location
logging Dict[BucketLogging]: The bucket’s Access & Storage Logs configuration.
name str: The name of the bucket.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
requester_pays bool: Enables Requester Pays on a storage bucket.
retention_policy Dict[BucketRetentionPolicy]: Configuration of the bucket’s data retention policy for how long objects in the bucket should be retained. Structure is documented below.
self_link str: The URI of the created resource.
storage_class str: The target Storage Class of objects affected by this Lifecycle Rule. Supported values include: MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE.
url str: The base URL of the bucket, in the format gs://<bucket-name>.
versioning Dict[BucketVersioning]: The bucket’s Versioning configuration.
website Dict[BucketWebsite]: Configuration if the bucket acts as a website. Structure is documented below.

Supporting Types

BucketCor

See the input and output API doc for this type.

MaxAgeSeconds int: The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses.
Methods List<string>: 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”.
Origins List<string>: The list of Origins eligible to receive CORS response headers. Note: “*” is permitted in the list of origins, and means “any Origin”.
ResponseHeaders List<string>: The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains.

MaxAgeSeconds int: The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses.
Methods []string: 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”.
Origins []string: The list of Origins eligible to receive CORS response headers. Note: “*” is permitted in the list of origins, and means “any Origin”.
ResponseHeaders []string: The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains.

maxAgeSeconds number: The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses.
methods string[]: 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”.
origins string[]: The list of Origins eligible to receive CORS response headers. Note: “*” is permitted in the list of origins, and means “any Origin”.
responseHeaders string[]: The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains.

maxAgeSeconds float: The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses.
methods List[str]: 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”.
origins List[str]: The list of Origins eligible to receive CORS response headers. Note: “*” is permitted in the list of origins, and means “any Origin”.
responseHeaders List[str]: The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains.

BucketEncryption

See the input and output API doc for this type.

DefaultKmsKeyName string

DefaultKmsKeyName string

defaultKmsKeyName string

defaultKmsKeyName str

BucketLifecycleRule

See the input and output API doc for this type.

Action BucketLifecycleRuleActionArgs: The Lifecycle Rule’s action configuration. A single block of this type is supported. Structure is documented below.
Condition BucketLifecycleRuleConditionArgs: The Lifecycle Rule’s condition configuration. A single block of this type is supported. Structure is documented below.

Action BucketLifecycleRuleAction: The Lifecycle Rule’s action configuration. A single block of this type is supported. Structure is documented below.
Condition BucketLifecycleRuleCondition: The Lifecycle Rule’s condition configuration. A single block of this type is supported. Structure is documented below.

action BucketLifecycleRuleAction: The Lifecycle Rule’s action configuration. A single block of this type is supported. Structure is documented below.
condition BucketLifecycleRuleCondition: The Lifecycle Rule’s condition configuration. A single block of this type is supported. Structure is documented below.

action Dict[BucketLifecycleRuleAction]: The Lifecycle Rule’s action configuration. A single block of this type is supported. Structure is documented below.
condition Dict[BucketLifecycleRuleCondition]: The Lifecycle Rule’s condition configuration. A single block of this type is supported. Structure is documented below.

BucketLifecycleRuleAction

See the input and output API doc for this type.

Type string: The type of the action of this Lifecycle Rule. Supported values include: Delete and SetStorageClass.
StorageClass string: The target Storage Class of objects affected by this Lifecycle Rule. Supported values include: MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE.

Type string: The type of the action of this Lifecycle Rule. Supported values include: Delete and SetStorageClass.
StorageClass string: The target Storage Class of objects affected by this Lifecycle Rule. Supported values include: MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE.

type string: The type of the action of this Lifecycle Rule. Supported values include: Delete and SetStorageClass.
storageClass string: The target Storage Class of objects affected by this Lifecycle Rule. Supported values include: MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE.

type str: The type of the action of this Lifecycle Rule. Supported values include: Delete and SetStorageClass.
storage_class str: The target Storage Class of objects affected by this Lifecycle Rule. Supported values include: MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE.

BucketLifecycleRuleCondition

See the input and output API doc for this type.

Age int: Minimum age of an object in days to satisfy this condition.
CreatedBefore string: Creation date of an object in RFC 3339 (e.g. 2017-06-13) to satisfy this condition.
MatchesStorageClasses List<string>: Storage Class of objects to satisfy this condition. Supported values include: MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, STANDARD, DURABLE_REDUCED_AVAILABILITY.
NumNewerVersions int: Relevant only for versioned objects. The number of newer versions of an object to satisfy this condition.
WithState string: Match to live and/or archived objects. Unversioned buckets have only live objects. Supported values include: "LIVE", "ARCHIVED", "ANY".

Age int: Minimum age of an object in days to satisfy this condition.
CreatedBefore string: Creation date of an object in RFC 3339 (e.g. 2017-06-13) to satisfy this condition.
MatchesStorageClasses []string: Storage Class of objects to satisfy this condition. Supported values include: MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, STANDARD, DURABLE_REDUCED_AVAILABILITY.
NumNewerVersions int: Relevant only for versioned objects. The number of newer versions of an object to satisfy this condition.
WithState string: Match to live and/or archived objects. Unversioned buckets have only live objects. Supported values include: "LIVE", "ARCHIVED", "ANY".

age number: Minimum age of an object in days to satisfy this condition.
createdBefore string: Creation date of an object in RFC 3339 (e.g. 2017-06-13) to satisfy this condition.
matchesStorageClasses string[]: Storage Class of objects to satisfy this condition. Supported values include: MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, STANDARD, DURABLE_REDUCED_AVAILABILITY.
numNewerVersions number: Relevant only for versioned objects. The number of newer versions of an object to satisfy this condition.
withState string: Match to live and/or archived objects. Unversioned buckets have only live objects. Supported values include: "LIVE", "ARCHIVED", "ANY".

age float: Minimum age of an object in days to satisfy this condition.
createdBefore str: Creation date of an object in RFC 3339 (e.g. 2017-06-13) to satisfy this condition.
matchesStorageClasses List[str]: Storage Class of objects to satisfy this condition. Supported values include: MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, STANDARD, DURABLE_REDUCED_AVAILABILITY.
numNewerVersions float: Relevant only for versioned objects. The number of newer versions of an object to satisfy this condition.
withState str: Match to live and/or archived objects. Unversioned buckets have only live objects. Supported values include: "LIVE", "ARCHIVED", "ANY".

BucketLogging

See the input and output API doc for this type.

LogBucket string: The bucket that will receive log objects.
LogObjectPrefix string: The object prefix for log objects. If it’s not provided, by default GCS sets this to this bucket’s name.

LogBucket string: The bucket that will receive log objects.
LogObjectPrefix string: The object prefix for log objects. If it’s not provided, by default GCS sets this to this bucket’s name.

logBucket string: The bucket that will receive log objects.
logObjectPrefix string: The object prefix for log objects. If it’s not provided, by default GCS sets this to this bucket’s name.

logBucket str: The bucket that will receive log objects.
logObjectPrefix str: The object prefix for log objects. If it’s not provided, by default GCS sets this to this bucket’s name.

BucketRetentionPolicy

See the input and output API doc for this type.

RetentionPeriod int: The period of time, in seconds, that objects in the bucket must be retained and cannot be deleted, overwritten, or archived. The value must be less than 2,147,483,647 seconds.
IsLocked bool: If set to true, the bucket will be locked and permanently restrict edits to the bucket’s retention policy. Caution: Locking a bucket is an irreversible action.

RetentionPeriod int: The period of time, in seconds, that objects in the bucket must be retained and cannot be deleted, overwritten, or archived. The value must be less than 2,147,483,647 seconds.
IsLocked bool: If set to true, the bucket will be locked and permanently restrict edits to the bucket’s retention policy. Caution: Locking a bucket is an irreversible action.

retentionPeriod number: The period of time, in seconds, that objects in the bucket must be retained and cannot be deleted, overwritten, or archived. The value must be less than 2,147,483,647 seconds.
isLocked boolean: If set to true, the bucket will be locked and permanently restrict edits to the bucket’s retention policy. Caution: Locking a bucket is an irreversible action.

retentionPeriod float: The period of time, in seconds, that objects in the bucket must be retained and cannot be deleted, overwritten, or archived. The value must be less than 2,147,483,647 seconds.
isLocked bool: If set to true, the bucket will be locked and permanently restrict edits to the bucket’s retention policy. Caution: Locking a bucket is an irreversible action.

BucketVersioning

See the input and output API doc for this type.

Enabled bool: While set to true, versioning is fully enabled for this bucket.

Enabled bool: While set to true, versioning is fully enabled for this bucket.

enabled boolean: While set to true, versioning is fully enabled for this bucket.

enabled bool: While set to true, versioning is fully enabled for this bucket.

BucketWebsite

See the input and output API doc for this type.

MainPageSuffix string: Behaves as the bucket’s directory index where missing objects are treated as potential directories.
NotFoundPage string: The custom object to return when a requested resource is not found.

MainPageSuffix string: Behaves as the bucket’s directory index where missing objects are treated as potential directories.
NotFoundPage string: The custom object to return when a requested resource is not found.

mainPageSuffix string: Behaves as the bucket’s directory index where missing objects are treated as potential directories.
notFoundPage string: The custom object to return when a requested resource is not found.

mainPageSuffix str: Behaves as the bucket’s directory index where missing objects are treated as potential directories.
notFoundPage str: The custom object to return when a requested resource is not found.

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Bucket

Create a Bucket Resource

Bucket Resource Properties

Inputs

Outputs

Look up an Existing Bucket Resource

Supporting Types

BucketCor

BucketEncryption

BucketLifecycleRule

BucketLifecycleRuleAction

BucketLifecycleRuleCondition

BucketLogging

BucketRetentionPolicy

BucketVersioning

BucketWebsite

Package Details

On This Page