Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. storage
  5. BucketObject
Google Cloud v8.25.1 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.storage.BucketObject

Explore with Pulumi AI

Google Cloud v8.25.1 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-gcp

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

A datasource can be used to retrieve the data of the stored object:

  • gcp.storage.getBucketObjectContent: Retrieves the content within a specified bucket object in Google Cloud Storage Service (GCS)

Example Usage

Example creating a public object in an existing image-store bucket.

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const picture = new gcp.storage.BucketObject("picture", {
    name: "butterfly01",
    source: new pulumi.asset.FileAsset("/images/nature/garden-tiger-moth.jpg"),
    bucket: "image-store",
});
Copy
import pulumi
import pulumi_gcp as gcp

picture = gcp.storage.BucketObject("picture",
    name="butterfly01",
    source=pulumi.FileAsset("/images/nature/garden-tiger-moth.jpg"),
    bucket="image-store")
Copy
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/storage"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := storage.NewBucketObject(ctx, "picture", &storage.BucketObjectArgs{
			Name:   pulumi.String("butterfly01"),
			Source: pulumi.NewFileAsset("/images/nature/garden-tiger-moth.jpg"),
			Bucket: pulumi.String("image-store"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var picture = new Gcp.Storage.BucketObject("picture", new()
    {
        Name = "butterfly01",
        Source = new FileAsset("/images/nature/garden-tiger-moth.jpg"),
        Bucket = "image-store",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.storage.BucketObject;
import com.pulumi.gcp.storage.BucketObjectArgs;
import com.pulumi.asset.FileAsset;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var picture = new BucketObject("picture", BucketObjectArgs.builder()
            .name("butterfly01")
            .source(new FileAsset("/images/nature/garden-tiger-moth.jpg"))
            .bucket("image-store")
            .build());

    }
}
Copy
resources:
  picture:
    type: gcp:storage:BucketObject
    properties:
      name: butterfly01
      source:
        fn::FileAsset: /images/nature/garden-tiger-moth.jpg
      bucket: image-store
Copy

Example creating an empty folder in an existing image-store bucket.

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const emptyFolder = new gcp.storage.BucketObject("empty_folder", {
    name: "empty_folder/",
    content: " ",
    bucket: "image-store",
});
Copy
import pulumi
import pulumi_gcp as gcp

empty_folder = gcp.storage.BucketObject("empty_folder",
    name="empty_folder/",
    content=" ",
    bucket="image-store")
Copy
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/storage"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := storage.NewBucketObject(ctx, "empty_folder", &storage.BucketObjectArgs{
			Name:    pulumi.String("empty_folder/"),
			Content: pulumi.String(" "),
			Bucket:  pulumi.String("image-store"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var emptyFolder = new Gcp.Storage.BucketObject("empty_folder", new()
    {
        Name = "empty_folder/",
        Content = " ",
        Bucket = "image-store",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.storage.BucketObject;
import com.pulumi.gcp.storage.BucketObjectArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var emptyFolder = new BucketObject("emptyFolder", BucketObjectArgs.builder()
            .name("empty_folder/")
            .content(" ")
            .bucket("image-store")
            .build());

    }
}
Copy
resources:
  emptyFolder:
    type: gcp:storage:BucketObject
    name: empty_folder
    properties:
      name: empty_folder/
      content: ' '
      bucket: image-store
Copy

Create BucketObject Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new BucketObject(name: string, args: BucketObjectArgs, opts?: CustomResourceOptions);
@overload
def BucketObject(resource_name: str,
                 args: BucketObjectArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def BucketObject(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 bucket: Optional[str] = None,
                 cache_control: Optional[str] = None,
                 content: Optional[str] = None,
                 content_disposition: Optional[str] = None,
                 content_encoding: Optional[str] = None,
                 content_language: Optional[str] = None,
                 content_type: Optional[str] = None,
                 customer_encryption: Optional[BucketObjectCustomerEncryptionArgs] = None,
                 detect_md5hash: Optional[str] = None,
                 event_based_hold: Optional[bool] = None,
                 kms_key_name: Optional[str] = None,
                 metadata: Optional[Mapping[str, str]] = None,
                 name: Optional[str] = None,
                 retention: Optional[BucketObjectRetentionArgs] = None,
                 source: Optional[Union[pulumi.Asset, pulumi.Archive]] = None,
                 storage_class: Optional[str] = None,
                 temporary_hold: Optional[bool] = None)
func NewBucketObject(ctx *Context, name string, args BucketObjectArgs, opts ...ResourceOption) (*BucketObject, error)
public BucketObject(string name, BucketObjectArgs args, CustomResourceOptions? opts = null)
public BucketObject(String name, BucketObjectArgs args)
public BucketObject(String name, BucketObjectArgs args, CustomResourceOptions options)

type: gcp:storage:BucketObject
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. BucketObjectArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. BucketObjectArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. BucketObjectArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. BucketObjectArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. BucketObjectArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var bucketObjectResource = new Gcp.Storage.BucketObject("bucketObjectResource", new()
{
    Bucket = "string",
    CacheControl = "string",
    Content = "string",
    ContentDisposition = "string",
    ContentEncoding = "string",
    ContentLanguage = "string",
    ContentType = "string",
    CustomerEncryption = new Gcp.Storage.Inputs.BucketObjectCustomerEncryptionArgs
    {
        EncryptionKey = "string",
        EncryptionAlgorithm = "string",
    },
    DetectMd5hash = "string",
    EventBasedHold = false,
    KmsKeyName = "string",
    Metadata = 
    {
        { "string", "string" },
    },
    Name = "string",
    Retention = new Gcp.Storage.Inputs.BucketObjectRetentionArgs
    {
        Mode = "string",
        RetainUntilTime = "string",
    },
    Source = new StringAsset("content"),
    StorageClass = "string",
    TemporaryHold = false,
});
Copy
example, err := storage.NewBucketObject(ctx, "bucketObjectResource", &storage.BucketObjectArgs{
	Bucket:             pulumi.String("string"),
	CacheControl:       pulumi.String("string"),
	Content:            pulumi.String("string"),
	ContentDisposition: pulumi.String("string"),
	ContentEncoding:    pulumi.String("string"),
	ContentLanguage:    pulumi.String("string"),
	ContentType:        pulumi.String("string"),
	CustomerEncryption: &storage.BucketObjectCustomerEncryptionArgs{
		EncryptionKey:       pulumi.String("string"),
		EncryptionAlgorithm: pulumi.String("string"),
	},
	DetectMd5hash:  pulumi.String("string"),
	EventBasedHold: pulumi.Bool(false),
	KmsKeyName:     pulumi.String("string"),
	Metadata: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name: pulumi.String("string"),
	Retention: &storage.BucketObjectRetentionArgs{
		Mode:            pulumi.String("string"),
		RetainUntilTime: pulumi.String("string"),
	},
	Source:        pulumi.NewStringAsset("content"),
	StorageClass:  pulumi.String("string"),
	TemporaryHold: pulumi.Bool(false),
})
Copy
var bucketObjectResource = new BucketObject("bucketObjectResource", BucketObjectArgs.builder()
    .bucket("string")
    .cacheControl("string")
    .content("string")
    .contentDisposition("string")
    .contentEncoding("string")
    .contentLanguage("string")
    .contentType("string")
    .customerEncryption(BucketObjectCustomerEncryptionArgs.builder()
        .encryptionKey("string")
        .encryptionAlgorithm("string")
        .build())
    .detectMd5hash("string")
    .eventBasedHold(false)
    .kmsKeyName("string")
    .metadata(Map.of("string", "string"))
    .name("string")
    .retention(BucketObjectRetentionArgs.builder()
        .mode("string")
        .retainUntilTime("string")
        .build())
    .source(new StringAsset("content"))
    .storageClass("string")
    .temporaryHold(false)
    .build());
Copy
bucket_object_resource = gcp.storage.BucketObject("bucketObjectResource",
    bucket="string",
    cache_control="string",
    content="string",
    content_disposition="string",
    content_encoding="string",
    content_language="string",
    content_type="string",
    customer_encryption={
        "encryption_key": "string",
        "encryption_algorithm": "string",
    },
    detect_md5hash="string",
    event_based_hold=False,
    kms_key_name="string",
    metadata={
        "string": "string",
    },
    name="string",
    retention={
        "mode": "string",
        "retain_until_time": "string",
    },
    source=pulumi.StringAsset("content"),
    storage_class="string",
    temporary_hold=False)
Copy
const bucketObjectResource = new gcp.storage.BucketObject("bucketObjectResource", {
    bucket: "string",
    cacheControl: "string",
    content: "string",
    contentDisposition: "string",
    contentEncoding: "string",
    contentLanguage: "string",
    contentType: "string",
    customerEncryption: {
        encryptionKey: "string",
        encryptionAlgorithm: "string",
    },
    detectMd5hash: "string",
    eventBasedHold: false,
    kmsKeyName: "string",
    metadata: {
        string: "string",
    },
    name: "string",
    retention: {
        mode: "string",
        retainUntilTime: "string",
    },
    source: new pulumi.asset.StringAsset("content"),
    storageClass: "string",
    temporaryHold: false,
});
Copy
type: gcp:storage:BucketObject
properties:
    bucket: string
    cacheControl: string
    content: string
    contentDisposition: string
    contentEncoding: string
    contentLanguage: string
    contentType: string
    customerEncryption:
        encryptionAlgorithm: string
        encryptionKey: string
    detectMd5hash: string
    eventBasedHold: false
    kmsKeyName: string
    metadata:
        string: string
    name: string
    retention:
        mode: string
        retainUntilTime: string
    source:
        fn::StringAsset: content
    storageClass: string
    temporaryHold: false
Copy

BucketObject Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The BucketObject resource accepts the following input properties:

Bucket
This property is required.
Changes to this property will trigger replacement.
string
The name of the containing bucket.
CacheControl Changes to this property will trigger replacement. 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 string
Data as string to be uploaded. Must be defined if source is not. Note: The content field is marked as sensitive.
ContentDisposition Changes to this property will trigger replacement. string
Content-Disposition of the object data.
ContentEncoding Changes to this property will trigger replacement. string
Content-Encoding of the object data.
ContentLanguage Changes to this property will trigger replacement. string
Content-Language of the object data.
ContentType Changes to this property will trigger replacement. string
Content-Type of the object data. Defaults to "application/octet-stream" or "text/plain; charset=utf-8".
CustomerEncryption BucketObjectCustomerEncryption
Enables object encryption with Customer-Supplied Encryption Key (CSEK). Google documentation about CSEK. Structure is documented below.
DetectMd5hash string
EventBasedHold bool
Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), such objects will be subject to bucket-level retention (if any).
KmsKeyName Changes to this property will trigger replacement. string
The resource name of the Cloud KMS key that will be used to encrypt the object.
Metadata Changes to this property will trigger replacement. Dictionary<string, string>

User-provided metadata, in key/value pairs.

One of the following is required:

Name Changes to this property will trigger replacement. string
The name of the object. If you're interpolating the name of this object, see output_name instead.
Retention BucketObjectRetention
The object retention settings for the object. The retention settings allow an object to be retained until a provided date. Structure is documented below.
Source Changes to this property will trigger replacement. AssetOrArchive
A path to the data you want to upload. Must be defined if content is not.

StorageClass Changes to this property will trigger replacement. 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.
TemporaryHold bool
Whether an object is under temporary hold. While this flag is set to true, the object is protected against deletion and overwrites.
Bucket
This property is required.
Changes to this property will trigger replacement.
string
The name of the containing bucket.
CacheControl Changes to this property will trigger replacement. 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 string
Data as string to be uploaded. Must be defined if source is not. Note: The content field is marked as sensitive.
ContentDisposition Changes to this property will trigger replacement. string
Content-Disposition of the object data.
ContentEncoding Changes to this property will trigger replacement. string
Content-Encoding of the object data.
ContentLanguage Changes to this property will trigger replacement. string
Content-Language of the object data.
ContentType Changes to this property will trigger replacement. string
Content-Type of the object data. Defaults to "application/octet-stream" or "text/plain; charset=utf-8".
CustomerEncryption BucketObjectCustomerEncryptionArgs
Enables object encryption with Customer-Supplied Encryption Key (CSEK). Google documentation about CSEK. Structure is documented below.
DetectMd5hash string
EventBasedHold bool
Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), such objects will be subject to bucket-level retention (if any).
KmsKeyName Changes to this property will trigger replacement. string
The resource name of the Cloud KMS key that will be used to encrypt the object.
Metadata Changes to this property will trigger replacement. map[string]string

User-provided metadata, in key/value pairs.

One of the following is required:

Name Changes to this property will trigger replacement. string
The name of the object. If you're interpolating the name of this object, see output_name instead.
Retention BucketObjectRetentionArgs
The object retention settings for the object. The retention settings allow an object to be retained until a provided date. Structure is documented below.
Source Changes to this property will trigger replacement. pulumi.AssetOrArchive
A path to the data you want to upload. Must be defined if content is not.

StorageClass Changes to this property will trigger replacement. 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.
TemporaryHold bool
Whether an object is under temporary hold. While this flag is set to true, the object is protected against deletion and overwrites.
bucket
This property is required.
Changes to this property will trigger replacement.
String
The name of the containing bucket.
cacheControl Changes to this property will trigger replacement. 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 String
Data as string to be uploaded. Must be defined if source is not. Note: The content field is marked as sensitive.
contentDisposition Changes to this property will trigger replacement. String
Content-Disposition of the object data.
contentEncoding Changes to this property will trigger replacement. String
Content-Encoding of the object data.
contentLanguage Changes to this property will trigger replacement. String
Content-Language of the object data.
contentType Changes to this property will trigger replacement. String
Content-Type of the object data. Defaults to "application/octet-stream" or "text/plain; charset=utf-8".
customerEncryption BucketObjectCustomerEncryption
Enables object encryption with Customer-Supplied Encryption Key (CSEK). Google documentation about CSEK. Structure is documented below.
detectMd5hash String
eventBasedHold Boolean
Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), such objects will be subject to bucket-level retention (if any).
kmsKeyName Changes to this property will trigger replacement. String
The resource name of the Cloud KMS key that will be used to encrypt the object.
metadata Changes to this property will trigger replacement. Map<String,String>

User-provided metadata, in key/value pairs.

One of the following is required:

name Changes to this property will trigger replacement. String
The name of the object. If you're interpolating the name of this object, see output_name instead.
retention BucketObjectRetention
The object retention settings for the object. The retention settings allow an object to be retained until a provided date. Structure is documented below.
source Changes to this property will trigger replacement. AssetOrArchive
A path to the data you want to upload. Must be defined if content is not.

storageClass Changes to this property will trigger replacement. 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.
temporaryHold Boolean
Whether an object is under temporary hold. While this flag is set to true, the object is protected against deletion and overwrites.
bucket
This property is required.
Changes to this property will trigger replacement.
string
The name of the containing bucket.
cacheControl Changes to this property will trigger replacement. 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 string
Data as string to be uploaded. Must be defined if source is not. Note: The content field is marked as sensitive.
contentDisposition Changes to this property will trigger replacement. string
Content-Disposition of the object data.
contentEncoding Changes to this property will trigger replacement. string
Content-Encoding of the object data.
contentLanguage Changes to this property will trigger replacement. string
Content-Language of the object data.
contentType Changes to this property will trigger replacement. string
Content-Type of the object data. Defaults to "application/octet-stream" or "text/plain; charset=utf-8".
customerEncryption BucketObjectCustomerEncryption
Enables object encryption with Customer-Supplied Encryption Key (CSEK). Google documentation about CSEK. Structure is documented below.
detectMd5hash string
eventBasedHold boolean
Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), such objects will be subject to bucket-level retention (if any).
kmsKeyName Changes to this property will trigger replacement. string
The resource name of the Cloud KMS key that will be used to encrypt the object.
metadata Changes to this property will trigger replacement. {[key: string]: string}

User-provided metadata, in key/value pairs.

One of the following is required:

name Changes to this property will trigger replacement. string
The name of the object. If you're interpolating the name of this object, see output_name instead.
retention BucketObjectRetention
The object retention settings for the object. The retention settings allow an object to be retained until a provided date. Structure is documented below.
source Changes to this property will trigger replacement. pulumi.asset.Asset | pulumi.asset.Archive
A path to the data you want to upload. Must be defined if content is not.

storageClass Changes to this property will trigger replacement. 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.
temporaryHold boolean
Whether an object is under temporary hold. While this flag is set to true, the object is protected against deletion and overwrites.
bucket
This property is required.
Changes to this property will trigger replacement.
str
The name of the containing bucket.
cache_control Changes to this property will trigger replacement. str
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 str
Data as string to be uploaded. Must be defined if source is not. Note: The content field is marked as sensitive.
content_disposition Changes to this property will trigger replacement. str
Content-Disposition of the object data.
content_encoding Changes to this property will trigger replacement. str
Content-Encoding of the object data.
content_language Changes to this property will trigger replacement. str
Content-Language of the object data.
content_type Changes to this property will trigger replacement. str
Content-Type of the object data. Defaults to "application/octet-stream" or "text/plain; charset=utf-8".
customer_encryption BucketObjectCustomerEncryptionArgs
Enables object encryption with Customer-Supplied Encryption Key (CSEK). Google documentation about CSEK. Structure is documented below.
detect_md5hash str
event_based_hold bool
Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), such objects will be subject to bucket-level retention (if any).
kms_key_name Changes to this property will trigger replacement. str
The resource name of the Cloud KMS key that will be used to encrypt the object.
metadata Changes to this property will trigger replacement. Mapping[str, str]

User-provided metadata, in key/value pairs.

One of the following is required:

name Changes to this property will trigger replacement. str
The name of the object. If you're interpolating the name of this object, see output_name instead.
retention BucketObjectRetentionArgs
The object retention settings for the object. The retention settings allow an object to be retained until a provided date. Structure is documented below.
source Changes to this property will trigger replacement. Union[pulumi.Asset, pulumi.Archive]
A path to the data you want to upload. Must be defined if content is not.

storage_class Changes to this property will trigger replacement. str
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.
temporary_hold bool
Whether an object is under temporary hold. While this flag is set to true, the object is protected against deletion and overwrites.
bucket
This property is required.
Changes to this property will trigger replacement.
String
The name of the containing bucket.
cacheControl Changes to this property will trigger replacement. 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 String
Data as string to be uploaded. Must be defined if source is not. Note: The content field is marked as sensitive.
contentDisposition Changes to this property will trigger replacement. String
Content-Disposition of the object data.
contentEncoding Changes to this property will trigger replacement. String
Content-Encoding of the object data.
contentLanguage Changes to this property will trigger replacement. String
Content-Language of the object data.
contentType Changes to this property will trigger replacement. String
Content-Type of the object data. Defaults to "application/octet-stream" or "text/plain; charset=utf-8".
customerEncryption Property Map
Enables object encryption with Customer-Supplied Encryption Key (CSEK). Google documentation about CSEK. Structure is documented below.
detectMd5hash String
eventBasedHold Boolean
Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), such objects will be subject to bucket-level retention (if any).
kmsKeyName Changes to this property will trigger replacement. String
The resource name of the Cloud KMS key that will be used to encrypt the object.
metadata Changes to this property will trigger replacement. Map<String>

User-provided metadata, in key/value pairs.

One of the following is required:

name Changes to this property will trigger replacement. String
The name of the object. If you're interpolating the name of this object, see output_name instead.
retention Property Map
The object retention settings for the object. The retention settings allow an object to be retained until a provided date. Structure is documented below.
source Changes to this property will trigger replacement. Asset
A path to the data you want to upload. Must be defined if content is not.

storageClass Changes to this property will trigger replacement. 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.
temporaryHold Boolean
Whether an object is under temporary hold. While this flag is set to true, the object is protected against deletion and overwrites.

Outputs

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

Crc32c string
(Computed) Base 64 CRC32 hash of the uploaded data.
Generation int
(Computed) The content generation of this object. Used for object versioning and soft delete.
Id string
The provider-assigned unique ID for this managed resource.
Md5hash string
(Computed) Base 64 MD5 hash of the uploaded data.
MediaLink string
(Computed) A url reference to download this object.
OutputName string
(Computed) The name of the object. Use this field in interpolations with gcp.storage.ObjectACL to recreate gcp.storage.ObjectACL resources when your gcp.storage.BucketObject is recreated.
SelfLink string
(Computed) A url reference to this object.
Crc32c string
(Computed) Base 64 CRC32 hash of the uploaded data.
Generation int
(Computed) The content generation of this object. Used for object versioning and soft delete.
Id string
The provider-assigned unique ID for this managed resource.
Md5hash string
(Computed) Base 64 MD5 hash of the uploaded data.
MediaLink string
(Computed) A url reference to download this object.
OutputName string
(Computed) The name of the object. Use this field in interpolations with gcp.storage.ObjectACL to recreate gcp.storage.ObjectACL resources when your gcp.storage.BucketObject is recreated.
SelfLink string
(Computed) A url reference to this object.
crc32c String
(Computed) Base 64 CRC32 hash of the uploaded data.
generation Integer
(Computed) The content generation of this object. Used for object versioning and soft delete.
id String
The provider-assigned unique ID for this managed resource.
md5hash String
(Computed) Base 64 MD5 hash of the uploaded data.
mediaLink String
(Computed) A url reference to download this object.
outputName String
(Computed) The name of the object. Use this field in interpolations with gcp.storage.ObjectACL to recreate gcp.storage.ObjectACL resources when your gcp.storage.BucketObject is recreated.
selfLink String
(Computed) A url reference to this object.
crc32c string
(Computed) Base 64 CRC32 hash of the uploaded data.
generation number
(Computed) The content generation of this object. Used for object versioning and soft delete.
id string
The provider-assigned unique ID for this managed resource.
md5hash string
(Computed) Base 64 MD5 hash of the uploaded data.
mediaLink string
(Computed) A url reference to download this object.
outputName string
(Computed) The name of the object. Use this field in interpolations with gcp.storage.ObjectACL to recreate gcp.storage.ObjectACL resources when your gcp.storage.BucketObject is recreated.
selfLink string
(Computed) A url reference to this object.
crc32c str
(Computed) Base 64 CRC32 hash of the uploaded data.
generation int
(Computed) The content generation of this object. Used for object versioning and soft delete.
id str
The provider-assigned unique ID for this managed resource.
md5hash str
(Computed) Base 64 MD5 hash of the uploaded data.
media_link str
(Computed) A url reference to download this object.
output_name str
(Computed) The name of the object. Use this field in interpolations with gcp.storage.ObjectACL to recreate gcp.storage.ObjectACL resources when your gcp.storage.BucketObject is recreated.
self_link str
(Computed) A url reference to this object.
crc32c String
(Computed) Base 64 CRC32 hash of the uploaded data.
generation Number
(Computed) The content generation of this object. Used for object versioning and soft delete.
id String
The provider-assigned unique ID for this managed resource.
md5hash String
(Computed) Base 64 MD5 hash of the uploaded data.
mediaLink String
(Computed) A url reference to download this object.
outputName String
(Computed) The name of the object. Use this field in interpolations with gcp.storage.ObjectACL to recreate gcp.storage.ObjectACL resources when your gcp.storage.BucketObject is recreated.
selfLink String
(Computed) A url reference to this object.

Look up Existing BucketObject Resource

Get an existing BucketObject 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?: BucketObjectState, opts?: CustomResourceOptions): BucketObject
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        bucket: Optional[str] = None,
        cache_control: Optional[str] = None,
        content: Optional[str] = None,
        content_disposition: Optional[str] = None,
        content_encoding: Optional[str] = None,
        content_language: Optional[str] = None,
        content_type: Optional[str] = None,
        crc32c: Optional[str] = None,
        customer_encryption: Optional[BucketObjectCustomerEncryptionArgs] = None,
        detect_md5hash: Optional[str] = None,
        event_based_hold: Optional[bool] = None,
        generation: Optional[int] = None,
        kms_key_name: Optional[str] = None,
        md5hash: Optional[str] = None,
        media_link: Optional[str] = None,
        metadata: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        output_name: Optional[str] = None,
        retention: Optional[BucketObjectRetentionArgs] = None,
        self_link: Optional[str] = None,
        source: Optional[Union[pulumi.Asset, pulumi.Archive]] = None,
        storage_class: Optional[str] = None,
        temporary_hold: Optional[bool] = None) -> BucketObject
func GetBucketObject(ctx *Context, name string, id IDInput, state *BucketObjectState, opts ...ResourceOption) (*BucketObject, error)
public static BucketObject Get(string name, Input<string> id, BucketObjectState? state, CustomResourceOptions? opts = null)
public static BucketObject get(String name, Output<String> id, BucketObjectState state, CustomResourceOptions options)
resources:  _:    type: gcp:storage:BucketObject    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Bucket Changes to this property will trigger replacement. string
The name of the containing bucket.
CacheControl Changes to this property will trigger replacement. 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 string
Data as string to be uploaded. Must be defined if source is not. Note: The content field is marked as sensitive.
ContentDisposition Changes to this property will trigger replacement. string
Content-Disposition of the object data.
ContentEncoding Changes to this property will trigger replacement. string
Content-Encoding of the object data.
ContentLanguage Changes to this property will trigger replacement. string
Content-Language of the object data.
ContentType Changes to this property will trigger replacement. string
Content-Type of the object data. Defaults to "application/octet-stream" or "text/plain; charset=utf-8".
Crc32c string
(Computed) Base 64 CRC32 hash of the uploaded data.
CustomerEncryption BucketObjectCustomerEncryption
Enables object encryption with Customer-Supplied Encryption Key (CSEK). Google documentation about CSEK. Structure is documented below.
DetectMd5hash string
EventBasedHold bool
Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), such objects will be subject to bucket-level retention (if any).
Generation int
(Computed) The content generation of this object. Used for object versioning and soft delete.
KmsKeyName Changes to this property will trigger replacement. string
The resource name of the Cloud KMS key that will be used to encrypt the object.
Md5hash string
(Computed) Base 64 MD5 hash of the uploaded data.
MediaLink string
(Computed) A url reference to download this object.
Metadata Changes to this property will trigger replacement. Dictionary<string, string>

User-provided metadata, in key/value pairs.

One of the following is required:

Name Changes to this property will trigger replacement. string
The name of the object. If you're interpolating the name of this object, see output_name instead.
OutputName string
(Computed) The name of the object. Use this field in interpolations with gcp.storage.ObjectACL to recreate gcp.storage.ObjectACL resources when your gcp.storage.BucketObject is recreated.
Retention BucketObjectRetention
The object retention settings for the object. The retention settings allow an object to be retained until a provided date. Structure is documented below.
SelfLink string
(Computed) A url reference to this object.
Source Changes to this property will trigger replacement. AssetOrArchive
A path to the data you want to upload. Must be defined if content is not.

StorageClass Changes to this property will trigger replacement. 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.
TemporaryHold bool
Whether an object is under temporary hold. While this flag is set to true, the object is protected against deletion and overwrites.
Bucket Changes to this property will trigger replacement. string
The name of the containing bucket.
CacheControl Changes to this property will trigger replacement. 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 string
Data as string to be uploaded. Must be defined if source is not. Note: The content field is marked as sensitive.
ContentDisposition Changes to this property will trigger replacement. string
Content-Disposition of the object data.
ContentEncoding Changes to this property will trigger replacement. string
Content-Encoding of the object data.
ContentLanguage Changes to this property will trigger replacement. string
Content-Language of the object data.
ContentType Changes to this property will trigger replacement. string
Content-Type of the object data. Defaults to "application/octet-stream" or "text/plain; charset=utf-8".
Crc32c string
(Computed) Base 64 CRC32 hash of the uploaded data.
CustomerEncryption BucketObjectCustomerEncryptionArgs
Enables object encryption with Customer-Supplied Encryption Key (CSEK). Google documentation about CSEK. Structure is documented below.
DetectMd5hash string
EventBasedHold bool
Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), such objects will be subject to bucket-level retention (if any).
Generation int
(Computed) The content generation of this object. Used for object versioning and soft delete.
KmsKeyName Changes to this property will trigger replacement. string
The resource name of the Cloud KMS key that will be used to encrypt the object.
Md5hash string
(Computed) Base 64 MD5 hash of the uploaded data.
MediaLink string
(Computed) A url reference to download this object.
Metadata Changes to this property will trigger replacement. map[string]string

User-provided metadata, in key/value pairs.

One of the following is required:

Name Changes to this property will trigger replacement. string
The name of the object. If you're interpolating the name of this object, see output_name instead.
OutputName string
(Computed) The name of the object. Use this field in interpolations with gcp.storage.ObjectACL to recreate gcp.storage.ObjectACL resources when your gcp.storage.BucketObject is recreated.
Retention BucketObjectRetentionArgs
The object retention settings for the object. The retention settings allow an object to be retained until a provided date. Structure is documented below.
SelfLink string
(Computed) A url reference to this object.
Source Changes to this property will trigger replacement. pulumi.AssetOrArchive
A path to the data you want to upload. Must be defined if content is not.

StorageClass Changes to this property will trigger replacement. 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.
TemporaryHold bool
Whether an object is under temporary hold. While this flag is set to true, the object is protected against deletion and overwrites.
bucket Changes to this property will trigger replacement. String
The name of the containing bucket.
cacheControl Changes to this property will trigger replacement. 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 String
Data as string to be uploaded. Must be defined if source is not. Note: The content field is marked as sensitive.
contentDisposition Changes to this property will trigger replacement. String
Content-Disposition of the object data.
contentEncoding Changes to this property will trigger replacement. String
Content-Encoding of the object data.
contentLanguage Changes to this property will trigger replacement. String
Content-Language of the object data.
contentType Changes to this property will trigger replacement. String
Content-Type of the object data. Defaults to "application/octet-stream" or "text/plain; charset=utf-8".
crc32c String
(Computed) Base 64 CRC32 hash of the uploaded data.
customerEncryption BucketObjectCustomerEncryption
Enables object encryption with Customer-Supplied Encryption Key (CSEK). Google documentation about CSEK. Structure is documented below.
detectMd5hash String
eventBasedHold Boolean
Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), such objects will be subject to bucket-level retention (if any).
generation Integer
(Computed) The content generation of this object. Used for object versioning and soft delete.
kmsKeyName Changes to this property will trigger replacement. String
The resource name of the Cloud KMS key that will be used to encrypt the object.
md5hash String
(Computed) Base 64 MD5 hash of the uploaded data.
mediaLink String
(Computed) A url reference to download this object.
metadata Changes to this property will trigger replacement. Map<String,String>

User-provided metadata, in key/value pairs.

One of the following is required:

name Changes to this property will trigger replacement. String
The name of the object. If you're interpolating the name of this object, see output_name instead.
outputName String
(Computed) The name of the object. Use this field in interpolations with gcp.storage.ObjectACL to recreate gcp.storage.ObjectACL resources when your gcp.storage.BucketObject is recreated.
retention BucketObjectRetention
The object retention settings for the object. The retention settings allow an object to be retained until a provided date. Structure is documented below.
selfLink String
(Computed) A url reference to this object.
source Changes to this property will trigger replacement. AssetOrArchive
A path to the data you want to upload. Must be defined if content is not.

storageClass Changes to this property will trigger replacement. 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.
temporaryHold Boolean
Whether an object is under temporary hold. While this flag is set to true, the object is protected against deletion and overwrites.
bucket Changes to this property will trigger replacement. string
The name of the containing bucket.
cacheControl Changes to this property will trigger replacement. 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 string
Data as string to be uploaded. Must be defined if source is not. Note: The content field is marked as sensitive.
contentDisposition Changes to this property will trigger replacement. string
Content-Disposition of the object data.
contentEncoding Changes to this property will trigger replacement. string
Content-Encoding of the object data.
contentLanguage Changes to this property will trigger replacement. string
Content-Language of the object data.
contentType Changes to this property will trigger replacement. string
Content-Type of the object data. Defaults to "application/octet-stream" or "text/plain; charset=utf-8".
crc32c string
(Computed) Base 64 CRC32 hash of the uploaded data.
customerEncryption BucketObjectCustomerEncryption
Enables object encryption with Customer-Supplied Encryption Key (CSEK). Google documentation about CSEK. Structure is documented below.
detectMd5hash string
eventBasedHold boolean
Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), such objects will be subject to bucket-level retention (if any).
generation number
(Computed) The content generation of this object. Used for object versioning and soft delete.
kmsKeyName Changes to this property will trigger replacement. string
The resource name of the Cloud KMS key that will be used to encrypt the object.
md5hash string
(Computed) Base 64 MD5 hash of the uploaded data.
mediaLink string
(Computed) A url reference to download this object.
metadata Changes to this property will trigger replacement. {[key: string]: string}

User-provided metadata, in key/value pairs.

One of the following is required:

name Changes to this property will trigger replacement. string
The name of the object. If you're interpolating the name of this object, see output_name instead.
outputName string
(Computed) The name of the object. Use this field in interpolations with gcp.storage.ObjectACL to recreate gcp.storage.ObjectACL resources when your gcp.storage.BucketObject is recreated.
retention BucketObjectRetention
The object retention settings for the object. The retention settings allow an object to be retained until a provided date. Structure is documented below.
selfLink string
(Computed) A url reference to this object.
source Changes to this property will trigger replacement. pulumi.asset.Asset | pulumi.asset.Archive
A path to the data you want to upload. Must be defined if content is not.

storageClass Changes to this property will trigger replacement. 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.
temporaryHold boolean
Whether an object is under temporary hold. While this flag is set to true, the object is protected against deletion and overwrites.
bucket Changes to this property will trigger replacement. str
The name of the containing bucket.
cache_control Changes to this property will trigger replacement. str
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 str
Data as string to be uploaded. Must be defined if source is not. Note: The content field is marked as sensitive.
content_disposition Changes to this property will trigger replacement. str
Content-Disposition of the object data.
content_encoding Changes to this property will trigger replacement. str
Content-Encoding of the object data.
content_language Changes to this property will trigger replacement. str
Content-Language of the object data.
content_type Changes to this property will trigger replacement. str
Content-Type of the object data. Defaults to "application/octet-stream" or "text/plain; charset=utf-8".
crc32c str
(Computed) Base 64 CRC32 hash of the uploaded data.
customer_encryption BucketObjectCustomerEncryptionArgs
Enables object encryption with Customer-Supplied Encryption Key (CSEK). Google documentation about CSEK. Structure is documented below.
detect_md5hash str
event_based_hold bool
Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), such objects will be subject to bucket-level retention (if any).
generation int
(Computed) The content generation of this object. Used for object versioning and soft delete.
kms_key_name Changes to this property will trigger replacement. str
The resource name of the Cloud KMS key that will be used to encrypt the object.
md5hash str
(Computed) Base 64 MD5 hash of the uploaded data.
media_link str
(Computed) A url reference to download this object.
metadata Changes to this property will trigger replacement. Mapping[str, str]

User-provided metadata, in key/value pairs.

One of the following is required:

name Changes to this property will trigger replacement. str
The name of the object. If you're interpolating the name of this object, see output_name instead.
output_name str
(Computed) The name of the object. Use this field in interpolations with gcp.storage.ObjectACL to recreate gcp.storage.ObjectACL resources when your gcp.storage.BucketObject is recreated.
retention BucketObjectRetentionArgs
The object retention settings for the object. The retention settings allow an object to be retained until a provided date. Structure is documented below.
self_link str
(Computed) A url reference to this object.
source Changes to this property will trigger replacement. Union[pulumi.Asset, pulumi.Archive]
A path to the data you want to upload. Must be defined if content is not.

storage_class Changes to this property will trigger replacement. str
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.
temporary_hold bool
Whether an object is under temporary hold. While this flag is set to true, the object is protected against deletion and overwrites.
bucket Changes to this property will trigger replacement. String
The name of the containing bucket.
cacheControl Changes to this property will trigger replacement. 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 String
Data as string to be uploaded. Must be defined if source is not. Note: The content field is marked as sensitive.
contentDisposition Changes to this property will trigger replacement. String
Content-Disposition of the object data.
contentEncoding Changes to this property will trigger replacement. String
Content-Encoding of the object data.
contentLanguage Changes to this property will trigger replacement. String
Content-Language of the object data.
contentType Changes to this property will trigger replacement. String
Content-Type of the object data. Defaults to "application/octet-stream" or "text/plain; charset=utf-8".
crc32c String
(Computed) Base 64 CRC32 hash of the uploaded data.
customerEncryption Property Map
Enables object encryption with Customer-Supplied Encryption Key (CSEK). Google documentation about CSEK. Structure is documented below.
detectMd5hash String
eventBasedHold Boolean
Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), such objects will be subject to bucket-level retention (if any).
generation Number
(Computed) The content generation of this object. Used for object versioning and soft delete.
kmsKeyName Changes to this property will trigger replacement. String
The resource name of the Cloud KMS key that will be used to encrypt the object.
md5hash String
(Computed) Base 64 MD5 hash of the uploaded data.
mediaLink String
(Computed) A url reference to download this object.
metadata Changes to this property will trigger replacement. Map<String>

User-provided metadata, in key/value pairs.

One of the following is required:

name Changes to this property will trigger replacement. String
The name of the object. If you're interpolating the name of this object, see output_name instead.
outputName String
(Computed) The name of the object. Use this field in interpolations with gcp.storage.ObjectACL to recreate gcp.storage.ObjectACL resources when your gcp.storage.BucketObject is recreated.
retention Property Map
The object retention settings for the object. The retention settings allow an object to be retained until a provided date. Structure is documented below.
selfLink String
(Computed) A url reference to this object.
source Changes to this property will trigger replacement. Asset
A path to the data you want to upload. Must be defined if content is not.

storageClass Changes to this property will trigger replacement. 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.
temporaryHold Boolean
Whether an object is under temporary hold. While this flag is set to true, the object is protected against deletion and overwrites.

Supporting Types

BucketObjectCustomerEncryption
, BucketObjectCustomerEncryptionArgs

EncryptionKey
This property is required.
Changes to this property will trigger replacement.
string
Base64 encoded Customer-Supplied Encryption Key.
EncryptionAlgorithm Changes to this property will trigger replacement. string
Encryption algorithm. Default: AES256
EncryptionKey
This property is required.
Changes to this property will trigger replacement.
string
Base64 encoded Customer-Supplied Encryption Key.
EncryptionAlgorithm Changes to this property will trigger replacement. string
Encryption algorithm. Default: AES256
encryptionKey
This property is required.
Changes to this property will trigger replacement.
String
Base64 encoded Customer-Supplied Encryption Key.
encryptionAlgorithm Changes to this property will trigger replacement. String
Encryption algorithm. Default: AES256
encryptionKey
This property is required.
Changes to this property will trigger replacement.
string
Base64 encoded Customer-Supplied Encryption Key.
encryptionAlgorithm Changes to this property will trigger replacement. string
Encryption algorithm. Default: AES256
encryption_key
This property is required.
Changes to this property will trigger replacement.
str
Base64 encoded Customer-Supplied Encryption Key.
encryption_algorithm Changes to this property will trigger replacement. str
Encryption algorithm. Default: AES256
encryptionKey
This property is required.
Changes to this property will trigger replacement.
String
Base64 encoded Customer-Supplied Encryption Key.
encryptionAlgorithm Changes to this property will trigger replacement. String
Encryption algorithm. Default: AES256

BucketObjectRetention
, BucketObjectRetentionArgs

Mode This property is required. string
The retention policy mode. Either Locked or Unlocked.
RetainUntilTime This property is required. string
The time to retain the object until in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

Mode This property is required. string
The retention policy mode. Either Locked or Unlocked.
RetainUntilTime This property is required. string
The time to retain the object until in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

mode This property is required. String
The retention policy mode. Either Locked or Unlocked.
retainUntilTime This property is required. String
The time to retain the object until in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

mode This property is required. string
The retention policy mode. Either Locked or Unlocked.
retainUntilTime This property is required. string
The time to retain the object until in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

mode This property is required. str
The retention policy mode. Either Locked or Unlocked.
retain_until_time This property is required. str
The time to retain the object until in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

mode This property is required. String
The retention policy mode. Either Locked or Unlocked.
retainUntilTime This property is required. String
The time to retain the object until in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

Import

This resource does not support import.

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Google Cloud (GCP) Classic pulumi/pulumi-gcp
License
Apache-2.0
Notes
This Pulumi package is based on the google-beta Terraform Provider.
Google Cloud v8.25.1 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-gcp