storageBucketObject.typescript.md

storageBucketObject Submodule

Constructs

StorageBucketObject

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/storage_bucket_object google_storage_bucket_object}.

Initializers

import { storageBucketObject } from '@cdktf/provider-google'

new storageBucketObject.StorageBucketObject(scope: Construct, id: string, config: StorageBucketObjectConfig)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	StorageBucketObjectConfig	No description.

---

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

id^Required

• Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

config^Required

• Type: StorageBucketObjectConfig

---

Methods

Name	Description
toString	Returns a string representation of this construct.
addOverride	No description.
overrideLogicalId	Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId	Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform	No description.
toMetadata	No description.
toTerraform	Adds this resource to the terraform JSON output.
addMoveTarget	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
hasResourceMove	No description.
importFrom	No description.
interpolationForAttribute	No description.
moveFromId	Move the resource corresponding to "id" to this resource.
moveTo	Moves this resource to the target resource given by moveTarget.
moveToId	Moves this resource to the resource corresponding to "id".
putCustomerEncryption	No description.
putRetention	No description.
putTimeouts	No description.
resetCacheControl	No description.
resetContent	No description.
resetContentDisposition	No description.
resetContentEncoding	No description.
resetContentLanguage	No description.
resetContentType	No description.
resetCustomerEncryption	No description.
resetDetectMd5Hash	No description.
resetEventBasedHold	No description.
resetId	No description.
resetKmsKeyName	No description.
resetMetadata	No description.
resetRetention	No description.
resetSource	No description.
resetStorageClass	No description.
resetTemporaryHold	No description.
resetTimeouts	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

addOverride

public addOverride(path: string, value: any): void

path^Required

• Type: string

---

value^Required

• Type: any

---

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

Overrides the auto-generated logical ID with a specific ID.

newLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

---

resetOverrideLogicalId

public resetOverrideLogicalId(): void

Resets a previously passed logical Id to use the auto-generated logical id again.

toHclTerraform

public toHclTerraform(): any

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

addMoveTarget

public addMoveTarget(moveTarget: string): void

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTarget^Required

• Type: string

The string move target that will correspond to this resource.

---

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

hasResourceMove

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

importFrom

public importFrom(id: string, provider?: TerraformProvider): void

id^Required

• Type: string

---

provider^Optional

• Type: cdktf.TerraformProvider

---

interpolationForAttribute

public interpolationForAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

moveFromId

public moveFromId(id: string): void

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

id^Required

• Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

---

moveTo

public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

moveTarget^Required

• Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

---

index^Optional

• Type: string | number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

---

moveToId

public moveToId(id: string): void

Moves this resource to the resource corresponding to "id".

id^Required

• Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

---

putCustomerEncryption

public putCustomerEncryption(value: StorageBucketObjectCustomerEncryption): void

value^Required

• Type: StorageBucketObjectCustomerEncryption

---

putRetention

public putRetention(value: StorageBucketObjectRetention): void

value^Required

• Type: StorageBucketObjectRetention

---

putTimeouts

public putTimeouts(value: StorageBucketObjectTimeouts): void

value^Required

• Type: StorageBucketObjectTimeouts

---

resetCacheControl

public resetCacheControl(): void

resetContent

public resetContent(): void

resetContentDisposition

public resetContentDisposition(): void

resetContentEncoding

public resetContentEncoding(): void

resetContentLanguage

public resetContentLanguage(): void

resetContentType

public resetContentType(): void

resetCustomerEncryption

public resetCustomerEncryption(): void

resetDetectMd5Hash

public resetDetectMd5Hash(): void

resetEventBasedHold

public resetEventBasedHold(): void

resetId

public resetId(): void

resetKmsKeyName

public resetKmsKeyName(): void

resetMetadata

public resetMetadata(): void

resetRetention

public resetRetention(): void

resetSource

public resetSource(): void

resetStorageClass

public resetStorageClass(): void

resetTemporaryHold

public resetTemporaryHold(): void

resetTimeouts

public resetTimeouts(): void

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isTerraformElement	No description.
isTerraformResource	No description.
generateConfigForImport	Generates CDKTF code for importing a StorageBucketObject resource upon running "cdktf plan ".

---

isConstruct

import { storageBucketObject } from '@cdktf/provider-google'

storageBucketObject.StorageBucketObject.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

x^Required

• Type: any

Any object.

---

isTerraformElement

import { storageBucketObject } from '@cdktf/provider-google'

storageBucketObject.StorageBucketObject.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

import { storageBucketObject } from '@cdktf/provider-google'

storageBucketObject.StorageBucketObject.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

import { storageBucketObject } from '@cdktf/provider-google'

storageBucketObject.StorageBucketObject.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a StorageBucketObject resource upon running "cdktf plan ".

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

importToId^Required

• Type: string

The construct id used in the generated config for the StorageBucketObject to import.

---

importFromId^Required

• Type: string

The id of the existing StorageBucketObject that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/storage_bucket_object#import import section} in the documentation of this resource for the id to use

---

provider^Optional

• Type: cdktf.TerraformProvider

? Optional instance of the provider where the StorageBucketObject to import is found.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
cdktfStack	cdktf.TerraformStack	No description.
fqn	string	No description.
friendlyUniqueId	string	No description.
terraformMetaArguments	{[ key: string ]: any}	No description.
terraformResourceType	string	No description.
terraformGeneratorMetadata	cdktf.TerraformProviderGeneratorMetadata	No description.
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	string[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
crc32C	string	No description.
customerEncryption	StorageBucketObjectCustomerEncryptionOutputReference	No description.
generation	number	No description.
md5Hash	string	No description.
mediaLink	string	No description.
outputName	string	No description.
retention	StorageBucketObjectRetentionOutputReference	No description.
selfLink	string	No description.
timeouts	StorageBucketObjectTimeoutsOutputReference	No description.
bucketInput	string	No description.
cacheControlInput	string	No description.
contentDispositionInput	string	No description.
contentEncodingInput	string	No description.
contentInput	string	No description.
contentLanguageInput	string	No description.
contentTypeInput	string	No description.
customerEncryptionInput	StorageBucketObjectCustomerEncryption	No description.
detectMd5HashInput	string	No description.
eventBasedHoldInput	boolean | cdktf.IResolvable	No description.
idInput	string	No description.
kmsKeyNameInput	string	No description.
metadataInput	{[ key: string ]: string}	No description.
nameInput	string	No description.
retentionInput	StorageBucketObjectRetention	No description.
sourceInput	string	No description.
storageClassInput	string	No description.
temporaryHoldInput	boolean | cdktf.IResolvable	No description.
timeoutsInput	cdktf.IResolvable | StorageBucketObjectTimeouts	No description.
bucket	string	No description.
cacheControl	string	No description.
content	string	No description.
contentDisposition	string	No description.
contentEncoding	string	No description.
contentLanguage	string	No description.
contentType	string	No description.
detectMd5Hash	string	No description.
eventBasedHold	boolean | cdktf.IResolvable	No description.
id	string	No description.
kmsKeyName	string	No description.
metadata	{[ key: string ]: string}	No description.
name	string	No description.
source	string	No description.
storageClass	string	No description.
temporaryHold	boolean | cdktf.IResolvable	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: cdktf.TerraformStack

---

fqn^Required

public readonly fqn: string;

• Type: string

---

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

---

terraformMetaArguments^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

terraformResourceType^Required

public readonly terraformResourceType: string;

• Type: string

---

terraformGeneratorMetadata^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

• Type: cdktf.TerraformProviderGeneratorMetadata

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: string[];

• Type: string[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

crc32C^Required

public readonly crc32C: string;

• Type: string

---

customerEncryption^Required

public readonly customerEncryption: StorageBucketObjectCustomerEncryptionOutputReference;

• Type: StorageBucketObjectCustomerEncryptionOutputReference

---

generation^Required

public readonly generation: number;

• Type: number

---

md5Hash^Required

public readonly md5Hash: string;

• Type: string

---

mediaLink^Required

public readonly mediaLink: string;

• Type: string

---

outputName^Required

public readonly outputName: string;

• Type: string

---

retention^Required

public readonly retention: StorageBucketObjectRetentionOutputReference;

• Type: StorageBucketObjectRetentionOutputReference

---

selfLink^Required

public readonly selfLink: string;

• Type: string

---

timeouts^Required

public readonly timeouts: StorageBucketObjectTimeoutsOutputReference;

• Type: StorageBucketObjectTimeoutsOutputReference

---

bucketInput^Optional

public readonly bucketInput: string;

• Type: string

---

cacheControlInput^Optional

public readonly cacheControlInput: string;

• Type: string

---

contentDispositionInput^Optional

public readonly contentDispositionInput: string;

• Type: string

---

contentEncodingInput^Optional

public readonly contentEncodingInput: string;

• Type: string

---

contentInput^Optional

public readonly contentInput: string;

• Type: string

---

contentLanguageInput^Optional

public readonly contentLanguageInput: string;

• Type: string

---

contentTypeInput^Optional

public readonly contentTypeInput: string;

• Type: string

---

customerEncryptionInput^Optional

public readonly customerEncryptionInput: StorageBucketObjectCustomerEncryption;

• Type: StorageBucketObjectCustomerEncryption

---

detectMd5HashInput^Optional

public readonly detectMd5HashInput: string;

• Type: string

---

eventBasedHoldInput^Optional

public readonly eventBasedHoldInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

kmsKeyNameInput^Optional

public readonly kmsKeyNameInput: string;

• Type: string

---

metadataInput^Optional

public readonly metadataInput: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

nameInput^Optional

public readonly nameInput: string;

• Type: string

---

retentionInput^Optional

public readonly retentionInput: StorageBucketObjectRetention;

• Type: StorageBucketObjectRetention

---

sourceInput^Optional

public readonly sourceInput: string;

• Type: string

---

storageClassInput^Optional

public readonly storageClassInput: string;

• Type: string

---

temporaryHoldInput^Optional

public readonly temporaryHoldInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

timeoutsInput^Optional

public readonly timeoutsInput: IResolvable | StorageBucketObjectTimeouts;

• Type: cdktf.IResolvable | StorageBucketObjectTimeouts

---

bucket^Required

public readonly bucket: string;

• Type: string

---

cacheControl^Required

public readonly cacheControl: string;

• Type: string

---

content^Required

public readonly content: string;

• Type: string

---

contentDisposition^Required

public readonly contentDisposition: string;

• Type: string

---

contentEncoding^Required

public readonly contentEncoding: string;

• Type: string

---

contentLanguage^Required

public readonly contentLanguage: string;

• Type: string

---

contentType^Required

public readonly contentType: string;

• Type: string

---

detectMd5Hash^Required

public readonly detectMd5Hash: string;

• Type: string

---

eventBasedHold^Required

public readonly eventBasedHold: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

id^Required

public readonly id: string;

• Type: string

---

kmsKeyName^Required

public readonly kmsKeyName: string;

• Type: string

---

metadata^Required

public readonly metadata: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

name^Required

public readonly name: string;

• Type: string

---

source^Required

public readonly source: string;

• Type: string

---

storageClass^Required

public readonly storageClass: string;

• Type: string

---

temporaryHold^Required

public readonly temporaryHold: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

StorageBucketObjectConfig

Initializer

import { storageBucketObject } from '@cdktf/provider-google'

const storageBucketObjectConfig: storageBucketObject.StorageBucketObjectConfig = { ... }

Properties

Name	Type	Description
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	cdktf.ITerraformDependable[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
bucket	string	The name of the containing bucket.
name	string	The name of the object. If you're interpolating the name of this object, see output_name instead.
cacheControl	string	Cache-Control directive to specify caching behavior of object data.
content	string	Data as string to be uploaded.
contentDisposition	string	Content-Disposition of the object data.
contentEncoding	string	Content-Encoding of the object data.
contentLanguage	string	Content-Language of the object data.
contentType	string	Content-Type of the object data. Defaults to "application/octet-stream" or "text/plain; charset=utf-8".
customerEncryption	StorageBucketObjectCustomerEncryption	customer_encryption block.
detectMd5Hash	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/storage_bucket_object#detect_md5hash StorageBucketObject#detect_md5hash}.
eventBasedHold	boolean | cdktf.IResolvable	Whether an object is under event-based hold.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/storage_bucket_object#id StorageBucketObject#id}.
kmsKeyName	string	Resource name of the Cloud KMS key that will be used to encrypt the object.
metadata	{[ key: string ]: string}	User-provided metadata, in key/value pairs.
retention	StorageBucketObjectRetention	retention block.
source	string	A path to the data you want to upload. Must be defined if content is not.
storageClass	string	The StorageClass of the new bucket object.
temporaryHold	boolean | cdktf.IResolvable	Whether an object is under temporary hold.
timeouts	StorageBucketObjectTimeouts	timeouts block.

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: ITerraformDependable[];

• Type: cdktf.ITerraformDependable[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

bucket^Required

public readonly bucket: string;

• Type: string

The name of the containing bucket.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/storage_bucket_object#bucket StorageBucketObject#bucket}

---

name^Required

public readonly name: string;

• Type: string

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/storage_bucket_object#name StorageBucketObject#name}

---

cacheControl^Optional

public readonly cacheControl: string;

• Type: 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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/storage_bucket_object#cache_control StorageBucketObject#cache_control}

---

content^Optional

public readonly content: string;

• Type: string

Data as string to be uploaded.

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/storage_bucket_object#content StorageBucketObject#content}

---

contentDisposition^Optional

public readonly contentDisposition: string;

• Type: string

Content-Disposition of the object data.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/storage_bucket_object#content_disposition StorageBucketObject#content_disposition}

---

contentEncoding^Optional

public readonly contentEncoding: string;

• Type: string

Content-Encoding of the object data.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/storage_bucket_object#content_encoding StorageBucketObject#content_encoding}

---

contentLanguage^Optional

public readonly contentLanguage: string;

• Type: string

Content-Language of the object data.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/storage_bucket_object#content_language StorageBucketObject#content_language}

---

contentType^Optional

public readonly contentType: string;

• Type: string

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/storage_bucket_object#content_type StorageBucketObject#content_type}

---

customerEncryption^Optional

public readonly customerEncryption: StorageBucketObjectCustomerEncryption;

• Type: StorageBucketObjectCustomerEncryption

customer_encryption block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/storage_bucket_object#customer_encryption StorageBucketObject#customer_encryption}

---

detectMd5Hash^Optional

public readonly detectMd5Hash: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/storage_bucket_object#detect_md5hash StorageBucketObject#detect_md5hash}.

---

eventBasedHold^Optional

public readonly eventBasedHold: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

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).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/storage_bucket_object#event_based_hold StorageBucketObject#event_based_hold}

---

id^Optional

public readonly id: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/storage_bucket_object#id StorageBucketObject#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

---

kmsKeyName^Optional

public readonly kmsKeyName: string;

• Type: string

Resource name of the Cloud KMS key that will be used to encrypt the object.

Overrides the object metadata's kmsKeyName value, if any.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/storage_bucket_object#kms_key_name StorageBucketObject#kms_key_name}

---

metadata^Optional

public readonly metadata: {[ key: string ]: string};

• Type: {[ key: string ]: string}

User-provided metadata, in key/value pairs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/storage_bucket_object#metadata StorageBucketObject#metadata}

---

retention^Optional

public readonly retention: StorageBucketObjectRetention;

• Type: StorageBucketObjectRetention

retention block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/storage_bucket_object#retention StorageBucketObject#retention}

---

source^Optional

public readonly source: string;

• Type: string

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/storage_bucket_object#source StorageBucketObject#source}

---

storageClass^Optional

public readonly storageClass: string;

• Type: 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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/storage_bucket_object#storage_class StorageBucketObject#storage_class}

---

temporaryHold^Optional

public readonly temporaryHold: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Whether an object is under temporary hold.

While this flag is set to true, the object is protected against deletion and overwrites.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/storage_bucket_object#temporary_hold StorageBucketObject#temporary_hold}

---

timeouts^Optional

public readonly timeouts: StorageBucketObjectTimeouts;

• Type: StorageBucketObjectTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/storage_bucket_object#timeouts StorageBucketObject#timeouts}

---

StorageBucketObjectCustomerEncryption

Initializer

import { storageBucketObject } from '@cdktf/provider-google'

const storageBucketObjectCustomerEncryption: storageBucketObject.StorageBucketObjectCustomerEncryption = { ... }

Properties

Name	Type	Description
encryptionKey	string	Base64 encoded customer supplied encryption key.
encryptionAlgorithm	string	The encryption algorithm. Default: AES256.

---

encryptionKey^Required

public readonly encryptionKey: string;

• Type: string

Base64 encoded customer supplied encryption key.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/storage_bucket_object#encryption_key StorageBucketObject#encryption_key}

---

encryptionAlgorithm^Optional

public readonly encryptionAlgorithm: string;

• Type: string

The encryption algorithm. Default: AES256.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/storage_bucket_object#encryption_algorithm StorageBucketObject#encryption_algorithm}

---

StorageBucketObjectRetention

Initializer

import { storageBucketObject } from '@cdktf/provider-google'

const storageBucketObjectRetention: storageBucketObject.StorageBucketObjectRetention = { ... }

Properties

Name	Type	Description
mode	string	The object retention mode. Supported values include: "Unlocked", "Locked".
retainUntilTime	string	Time in RFC 3339 (e.g. 2030-01-01T02:03:04Z) until which object retention protects this object.

---

mode^Required

public readonly mode: string;

• Type: string

The object retention mode. Supported values include: "Unlocked", "Locked".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/storage_bucket_object#mode StorageBucketObject#mode}

---

retainUntilTime^Required

public readonly retainUntilTime: string;

• Type: string

Time in RFC 3339 (e.g. 2030-01-01T02:03:04Z) until which object retention protects this object.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/storage_bucket_object#retain_until_time StorageBucketObject#retain_until_time}

---

StorageBucketObjectTimeouts

Initializer

import { storageBucketObject } from '@cdktf/provider-google'

const storageBucketObjectTimeouts: storageBucketObject.StorageBucketObjectTimeouts = { ... }

Properties

Name	Type	Description
create	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/storage_bucket_object#create StorageBucketObject#create}.
delete	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/storage_bucket_object#delete StorageBucketObject#delete}.
update	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/storage_bucket_object#update StorageBucketObject#update}.

---

create^Optional

public readonly create: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/storage_bucket_object#create StorageBucketObject#create}.

---

delete^Optional

public readonly delete: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/storage_bucket_object#delete StorageBucketObject#delete}.

---

update^Optional

public readonly update: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/storage_bucket_object#update StorageBucketObject#update}.

---

Classes

StorageBucketObjectCustomerEncryptionOutputReference

Initializers

import { storageBucketObject } from '@cdktf/provider-google'

new storageBucketObject.StorageBucketObjectCustomerEncryptionOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

Methods

Name	Description
computeFqn	No description.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
interpolationForAttribute	No description.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.
resetEncryptionAlgorithm	No description.

---

computeFqn

public computeFqn(): string

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

---

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetEncryptionAlgorithm

public resetEncryptionAlgorithm(): void

Properties

Name	Type	Description
creationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	string	No description.
encryptionAlgorithmInput	string	No description.
encryptionKeyInput	string	No description.
encryptionAlgorithm	string	No description.
encryptionKey	string	No description.
internalValue	StorageBucketObjectCustomerEncryption	No description.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

encryptionAlgorithmInput^Optional

public readonly encryptionAlgorithmInput: string;

• Type: string

---

encryptionKeyInput^Optional

public readonly encryptionKeyInput: string;

• Type: string

---

encryptionAlgorithm^Required

public readonly encryptionAlgorithm: string;

• Type: string

---

encryptionKey^Required

public readonly encryptionKey: string;

• Type: string

---

internalValue^Optional

public readonly internalValue: StorageBucketObjectCustomerEncryption;

• Type: StorageBucketObjectCustomerEncryption

---

StorageBucketObjectRetentionOutputReference

Initializers

import { storageBucketObject } from '@cdktf/provider-google'

new storageBucketObject.StorageBucketObjectRetentionOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

Methods

Name	Description
computeFqn	No description.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
interpolationForAttribute	No description.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.

---

computeFqn

public computeFqn(): string

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

---

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name	Type	Description
creationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	string	No description.
modeInput	string	No description.
retainUntilTimeInput	string	No description.
mode	string	No description.
retainUntilTime	string	No description.
internalValue	StorageBucketObjectRetention	No description.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

modeInput^Optional

public readonly modeInput: string;

• Type: string

---

retainUntilTimeInput^Optional

public readonly retainUntilTimeInput: string;

• Type: string

---

mode^Required

public readonly mode: string;

• Type: string

---

retainUntilTime^Required

public readonly retainUntilTime: string;

• Type: string

---

internalValue^Optional

public readonly internalValue: StorageBucketObjectRetention;

• Type: StorageBucketObjectRetention

---

StorageBucketObjectTimeoutsOutputReference

Initializers

import { storageBucketObject } from '@cdktf/provider-google'

new storageBucketObject.StorageBucketObjectTimeoutsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

Methods

Name	Description
computeFqn	No description.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
interpolationForAttribute	No description.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.
resetCreate	No description.
resetDelete	No description.
resetUpdate	No description.

---

computeFqn

public computeFqn(): string

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

---

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetCreate

public resetCreate(): void

resetDelete

public resetDelete(): void

resetUpdate

public resetUpdate(): void

Properties

Name	Type	Description
creationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	string	No description.
createInput	string	No description.
deleteInput	string	No description.
updateInput	string	No description.
create	string	No description.
delete	string	No description.
update	string	No description.
internalValue	cdktf.IResolvable | StorageBucketObjectTimeouts	No description.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

createInput^Optional

public readonly createInput: string;

• Type: string

---

deleteInput^Optional

public readonly deleteInput: string;

• Type: string

---

updateInput^Optional

public readonly updateInput: string;

• Type: string

---

create^Required

public readonly create: string;

• Type: string

---

delete^Required

public readonly delete: string;

• Type: string

---

update^Required

public readonly update: string;

• Type: string

---

internalValue^Optional

public readonly internalValue: IResolvable | StorageBucketObjectTimeouts;

• Type: cdktf.IResolvable | StorageBucketObjectTimeouts

---