storageBucketObject.csharp.md

storageBucketObject Submodule

Constructs

StorageBucketObject

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

Initializers

using HashiCorp.Cdktf.Providers.Google;

new StorageBucketObject(Construct Scope, string Id, StorageBucketObjectConfig Config);

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

private string ToString()

Returns a string representation of this construct.

AddOverride

private void AddOverride(string Path, object Value)

Path^Required

• Type: string

---

Value^Required

• Type: object

---

OverrideLogicalId

private void OverrideLogicalId(string NewLogicalId)

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

private void ResetOverrideLogicalId()

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

ToHclTerraform

private object ToHclTerraform()

ToMetadata

private object ToMetadata()

ToTerraform

private object ToTerraform()

Adds this resource to the terraform JSON output.

AddMoveTarget

private void AddMoveTarget(string MoveTarget)

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

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetBooleanAttribute

private IResolvable GetBooleanAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetBooleanMapAttribute

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetListAttribute

private string[] GetListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberAttribute

private double GetNumberAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberListAttribute

private double[] GetNumberListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberMapAttribute

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetStringAttribute

private string GetStringAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetStringMapAttribute

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

HasResourceMove

private object HasResourceMove()

ImportFrom

private void ImportFrom(string Id, TerraformProvider Provider = null)

Id^Required

• Type: string

---

Provider^Optional

• Type: HashiCorp.Cdktf.TerraformProvider

---

InterpolationForAttribute

private IResolvable InterpolationForAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

MoveFromId

private void MoveFromId(string Id)

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

private void MoveTo(string MoveTarget, object Index = null)

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: object

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

---

MoveToId

private void MoveToId(string Id)

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

private void PutCustomerEncryption(StorageBucketObjectCustomerEncryption Value)

Value^Required

• Type: StorageBucketObjectCustomerEncryption

---

PutRetention

private void PutRetention(StorageBucketObjectRetention Value)

Value^Required

• Type: StorageBucketObjectRetention

---

PutTimeouts

private void PutTimeouts(StorageBucketObjectTimeouts Value)

Value^Required

• Type: StorageBucketObjectTimeouts

---

ResetCacheControl

private void ResetCacheControl()

ResetContent

private void ResetContent()

ResetContentDisposition

private void ResetContentDisposition()

ResetContentEncoding

private void ResetContentEncoding()

ResetContentLanguage

private void ResetContentLanguage()

ResetContentType

private void ResetContentType()

ResetCustomerEncryption

private void ResetCustomerEncryption()

ResetDetectMd5Hash

private void ResetDetectMd5Hash()

ResetEventBasedHold

private void ResetEventBasedHold()

ResetId

private void ResetId()

ResetKmsKeyName

private void ResetKmsKeyName()

ResetMetadata

private void ResetMetadata()

ResetRetention

private void ResetRetention()

ResetSource

private void ResetSource()

ResetStorageClass

private void ResetStorageClass()

ResetTemporaryHold

private void ResetTemporaryHold()

ResetTimeouts

private void ResetTimeouts()

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

using HashiCorp.Cdktf.Providers.Google;

StorageBucketObject.IsConstruct(object X);

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: object

Any object.

---

IsTerraformElement

using HashiCorp.Cdktf.Providers.Google;

StorageBucketObject.IsTerraformElement(object X);

X^Required

• Type: object

---

IsTerraformResource

using HashiCorp.Cdktf.Providers.Google;

StorageBucketObject.IsTerraformResource(object X);

X^Required

• Type: object

---

GenerateConfigForImport

using HashiCorp.Cdktf.Providers.Google;

StorageBucketObject.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);

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.17.0/docs/resources/storage_bucket_object#import import section} in the documentation of this resource for the id to use

---

Provider^Optional

• Type: HashiCorp.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	HashiCorp.Cdktf.TerraformStack	No description.
Fqn	string	No description.
FriendlyUniqueId	string	No description.
TerraformMetaArguments	System.Collections.Generic.IDictionary<string, object>	No description.
TerraformResourceType	string	No description.
TerraformGeneratorMetadata	HashiCorp.Cdktf.TerraformProviderGeneratorMetadata	No description.
Connection	object	No description.
Count	object	No description.
DependsOn	string[]	No description.
ForEach	HashiCorp.Cdktf.ITerraformIterator	No description.
Lifecycle	HashiCorp.Cdktf.TerraformResourceLifecycle	No description.
Provider	HashiCorp.Cdktf.TerraformProvider	No description.
Provisioners	object[]	No description.
Crc32C	string	No description.
CustomerEncryption	StorageBucketObjectCustomerEncryptionOutputReference	No description.
Generation	double	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	object	No description.
IdInput	string	No description.
KmsKeyNameInput	string	No description.
MetadataInput	System.Collections.Generic.IDictionary<string, string>	No description.
NameInput	string	No description.
RetentionInput	StorageBucketObjectRetention	No description.
SourceInput	string	No description.
StorageClassInput	string	No description.
TemporaryHoldInput	object	No description.
TimeoutsInput	object	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	object	No description.
Id	string	No description.
KmsKeyName	string	No description.
Metadata	System.Collections.Generic.IDictionary<string, string>	No description.
Name	string	No description.
Source	string	No description.
StorageClass	string	No description.
TemporaryHold	object	No description.

---

Node^Required

public Node Node { get; }

• Type: Constructs.Node

The tree node.

---

CdktfStack^Required

public TerraformStack CdktfStack { get; }

• Type: HashiCorp.Cdktf.TerraformStack

---

Fqn^Required

public string Fqn { get; }

• Type: string

---

FriendlyUniqueId^Required

public string FriendlyUniqueId { get; }

• Type: string

---

TerraformMetaArguments^Required

public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }

• Type: System.Collections.Generic.IDictionary<string, object>

---

TerraformResourceType^Required

public string TerraformResourceType { get; }

• Type: string

---

TerraformGeneratorMetadata^Optional

public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }

• Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata

---

Connection^Optional

public object Connection { get; }

• Type: object

---

Count^Optional

public object Count { get; }

• Type: object

---

DependsOn^Optional

public string[] DependsOn { get; }

• Type: string[]

---

ForEach^Optional

public ITerraformIterator ForEach { get; }

• Type: HashiCorp.Cdktf.ITerraformIterator

---

Lifecycle^Optional

public TerraformResourceLifecycle Lifecycle { get; }

• Type: HashiCorp.Cdktf.TerraformResourceLifecycle

---

Provider^Optional

public TerraformProvider Provider { get; }

• Type: HashiCorp.Cdktf.TerraformProvider

---

Provisioners^Optional

public object[] Provisioners { get; }

• Type: object[]

---

Crc32C^Required

public string Crc32C { get; }

• Type: string

---

CustomerEncryption^Required

public StorageBucketObjectCustomerEncryptionOutputReference CustomerEncryption { get; }

• Type: StorageBucketObjectCustomerEncryptionOutputReference

---

Generation^Required

public double Generation { get; }

• Type: double

---

Md5Hash^Required

public string Md5Hash { get; }

• Type: string

---

MediaLink^Required

public string MediaLink { get; }

• Type: string

---

OutputName^Required

public string OutputName { get; }

• Type: string

---

Retention^Required

public StorageBucketObjectRetentionOutputReference Retention { get; }

• Type: StorageBucketObjectRetentionOutputReference

---

SelfLink^Required

public string SelfLink { get; }

• Type: string

---

Timeouts^Required

public StorageBucketObjectTimeoutsOutputReference Timeouts { get; }

• Type: StorageBucketObjectTimeoutsOutputReference

---

BucketInput^Optional

public string BucketInput { get; }

• Type: string

---

CacheControlInput^Optional

public string CacheControlInput { get; }

• Type: string

---

ContentDispositionInput^Optional

public string ContentDispositionInput { get; }

• Type: string

---

ContentEncodingInput^Optional

public string ContentEncodingInput { get; }

• Type: string

---

ContentInput^Optional

public string ContentInput { get; }

• Type: string

---

ContentLanguageInput^Optional

public string ContentLanguageInput { get; }

• Type: string

---

ContentTypeInput^Optional

public string ContentTypeInput { get; }

• Type: string

---

CustomerEncryptionInput^Optional

public StorageBucketObjectCustomerEncryption CustomerEncryptionInput { get; }

• Type: StorageBucketObjectCustomerEncryption

---

DetectMd5HashInput^Optional

public string DetectMd5HashInput { get; }

• Type: string

---

EventBasedHoldInput^Optional

public object EventBasedHoldInput { get; }

• Type: object

---

IdInput^Optional

public string IdInput { get; }

• Type: string

---

KmsKeyNameInput^Optional

public string KmsKeyNameInput { get; }

• Type: string

---

MetadataInput^Optional

public System.Collections.Generic.IDictionary<string, string> MetadataInput { get; }

• Type: System.Collections.Generic.IDictionary<string, string>

---

NameInput^Optional

public string NameInput { get; }

• Type: string

---

RetentionInput^Optional

public StorageBucketObjectRetention RetentionInput { get; }

• Type: StorageBucketObjectRetention

---

SourceInput^Optional

public string SourceInput { get; }

• Type: string

---

StorageClassInput^Optional

public string StorageClassInput { get; }

• Type: string

---

TemporaryHoldInput^Optional

public object TemporaryHoldInput { get; }

• Type: object

---

TimeoutsInput^Optional

public object TimeoutsInput { get; }

• Type: object

---

Bucket^Required

public string Bucket { get; }

• Type: string

---

CacheControl^Required

public string CacheControl { get; }

• Type: string

---

Content^Required

public string Content { get; }

• Type: string

---

ContentDisposition^Required

public string ContentDisposition { get; }

• Type: string

---

ContentEncoding^Required

public string ContentEncoding { get; }

• Type: string

---

ContentLanguage^Required

public string ContentLanguage { get; }

• Type: string

---

ContentType^Required

public string ContentType { get; }

• Type: string

---

DetectMd5Hash^Required

public string DetectMd5Hash { get; }

• Type: string

---

EventBasedHold^Required

public object EventBasedHold { get; }

• Type: object

---

Id^Required

public string Id { get; }

• Type: string

---

KmsKeyName^Required

public string KmsKeyName { get; }

• Type: string

---

Metadata^Required

public System.Collections.Generic.IDictionary<string, string> Metadata { get; }

• Type: System.Collections.Generic.IDictionary<string, string>

---

Name^Required

public string Name { get; }

• Type: string

---

Source^Required

public string Source { get; }

• Type: string

---

StorageClass^Required

public string StorageClass { get; }

• Type: string

---

TemporaryHold^Required

public object TemporaryHold { get; }

• Type: object

---

Constants

Name	Type	Description
TfResourceType	string	No description.

---

TfResourceType^Required

public string TfResourceType { get; }

• Type: string

---

Structs

StorageBucketObjectConfig

Initializer

using HashiCorp.Cdktf.Providers.Google;

new StorageBucketObjectConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string Bucket,
    string Name,
    string CacheControl = null,
    string Content = null,
    string ContentDisposition = null,
    string ContentEncoding = null,
    string ContentLanguage = null,
    string ContentType = null,
    StorageBucketObjectCustomerEncryption CustomerEncryption = null,
    string DetectMd5Hash = null,
    object EventBasedHold = null,
    string Id = null,
    string KmsKeyName = null,
    System.Collections.Generic.IDictionary<string, string> Metadata = null,
    StorageBucketObjectRetention Retention = null,
    string Source = null,
    string StorageClass = null,
    object TemporaryHold = null,
    StorageBucketObjectTimeouts Timeouts = null
};

Properties

Name	Type	Description
Connection	object	No description.
Count	object	No description.
DependsOn	HashiCorp.Cdktf.ITerraformDependable[]	No description.
ForEach	HashiCorp.Cdktf.ITerraformIterator	No description.
Lifecycle	HashiCorp.Cdktf.TerraformResourceLifecycle	No description.
Provider	HashiCorp.Cdktf.TerraformProvider	No description.
Provisioners	object[]	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.17.0/docs/resources/storage_bucket_object#detect_md5hash StorageBucketObject#detect_md5hash}.
EventBasedHold	object	Whether an object is under event-based hold.
Id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.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	System.Collections.Generic.IDictionary<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	object	Whether an object is under temporary hold.
Timeouts	StorageBucketObjectTimeouts	timeouts block.

---

Connection^Optional

public object Connection { get; set; }

• Type: object

---

Count^Optional

public object Count { get; set; }

• Type: object

---

DependsOn^Optional

public ITerraformDependable[] DependsOn { get; set; }

• Type: HashiCorp.Cdktf.ITerraformDependable[]

---

ForEach^Optional

public ITerraformIterator ForEach { get; set; }

• Type: HashiCorp.Cdktf.ITerraformIterator

---

Lifecycle^Optional

public TerraformResourceLifecycle Lifecycle { get; set; }

• Type: HashiCorp.Cdktf.TerraformResourceLifecycle

---

Provider^Optional

public TerraformProvider Provider { get; set; }

• Type: HashiCorp.Cdktf.TerraformProvider

---

Provisioners^Optional

public object[] Provisioners { get; set; }

• Type: object[]

---

Bucket^Required

public string Bucket { get; set; }

• Type: string

The name of the containing bucket.

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

---

Name^Required

public string Name { get; set; }

• 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.17.0/docs/resources/storage_bucket_object#name StorageBucketObject#name}

---

CacheControl^Optional

public string CacheControl { get; set; }

• 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.17.0/docs/resources/storage_bucket_object#cache_control StorageBucketObject#cache_control}

---

Content^Optional

public string Content { get; set; }

• 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.17.0/docs/resources/storage_bucket_object#content StorageBucketObject#content}

---

ContentDisposition^Optional

public string ContentDisposition { get; set; }

• Type: string

Content-Disposition of the object data.

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

---

ContentEncoding^Optional

public string ContentEncoding { get; set; }

• Type: string

Content-Encoding of the object data.

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

---

ContentLanguage^Optional

public string ContentLanguage { get; set; }

• Type: string

Content-Language of the object data.

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

---

ContentType^Optional

public string ContentType { get; set; }

• 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.17.0/docs/resources/storage_bucket_object#content_type StorageBucketObject#content_type}

---

CustomerEncryption^Optional

public StorageBucketObjectCustomerEncryption CustomerEncryption { get; set; }

• Type: StorageBucketObjectCustomerEncryption

customer_encryption block.

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

---

DetectMd5Hash^Optional

public string DetectMd5Hash { get; set; }

• Type: string

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

---

EventBasedHold^Optional

public object EventBasedHold { get; set; }

• Type: object

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.17.0/docs/resources/storage_bucket_object#event_based_hold StorageBucketObject#event_based_hold}

---

Id^Optional

public string Id { get; set; }

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.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 string KmsKeyName { get; set; }

• 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.17.0/docs/resources/storage_bucket_object#kms_key_name StorageBucketObject#kms_key_name}

---

Metadata^Optional

public System.Collections.Generic.IDictionary<string, string> Metadata { get; set; }

• Type: System.Collections.Generic.IDictionary<string, string>

User-provided metadata, in key/value pairs.

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

---

Retention^Optional

public StorageBucketObjectRetention Retention { get; set; }

• Type: StorageBucketObjectRetention

retention block.

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

---

Source^Optional

public string Source { get; set; }

• 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.17.0/docs/resources/storage_bucket_object#source StorageBucketObject#source}

---

StorageClass^Optional

public string StorageClass { get; set; }

• 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.17.0/docs/resources/storage_bucket_object#storage_class StorageBucketObject#storage_class}

---

TemporaryHold^Optional

public object TemporaryHold { get; set; }

• Type: object

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.17.0/docs/resources/storage_bucket_object#temporary_hold StorageBucketObject#temporary_hold}

---

Timeouts^Optional

public StorageBucketObjectTimeouts Timeouts { get; set; }

• Type: StorageBucketObjectTimeouts

timeouts block.

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

---

StorageBucketObjectCustomerEncryption

Initializer

using HashiCorp.Cdktf.Providers.Google;

new StorageBucketObjectCustomerEncryption {
    string EncryptionKey,
    string EncryptionAlgorithm = null
};

Properties

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

---

EncryptionKey^Required

public string EncryptionKey { get; set; }

• Type: string

Base64 encoded customer supplied encryption key.

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

---

EncryptionAlgorithm^Optional

public string EncryptionAlgorithm { get; set; }

• Type: string

The encryption algorithm. Default: AES256.

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

---

StorageBucketObjectRetention

Initializer

using HashiCorp.Cdktf.Providers.Google;

new StorageBucketObjectRetention {
    string Mode,
    string RetainUntilTime
};

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 string Mode { get; set; }

• Type: string

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

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

---

RetainUntilTime^Required

public string RetainUntilTime { get; set; }

• 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.17.0/docs/resources/storage_bucket_object#retain_until_time StorageBucketObject#retain_until_time}

---

StorageBucketObjectTimeouts

Initializer

using HashiCorp.Cdktf.Providers.Google;

new StorageBucketObjectTimeouts {
    string Create = null,
    string Delete = null,
    string Update = null
};

Properties

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

---

Create^Optional

public string Create { get; set; }

• Type: string

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

---

Delete^Optional

public string Delete { get; set; }

• Type: string

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

---

Update^Optional

public string Update { get; set; }

• Type: string

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

---

Classes

StorageBucketObjectCustomerEncryptionOutputReference

Initializers

using HashiCorp.Cdktf.Providers.Google;

new StorageBucketObjectCustomerEncryptionOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute);

Name	Type	Description
TerraformResource	HashiCorp.Cdktf.IInterpolatingParent	The parent resource.
TerraformAttribute	string	The attribute on the parent resource this class is referencing.

---

TerraformResource^Required

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

private string ComputeFqn()

GetAnyMapAttribute

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetBooleanAttribute

private IResolvable GetBooleanAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetBooleanMapAttribute

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetListAttribute

private string[] GetListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberAttribute

private double GetNumberAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberListAttribute

private double[] GetNumberListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberMapAttribute

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetStringAttribute

private string GetStringAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetStringMapAttribute

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

InterpolationForAttribute

private IResolvable InterpolationForAttribute(string Property)

Property^Required

• Type: string

---

Resolve

private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

Context^Required

• Type: HashiCorp.Cdktf.IResolveContext

---

ToString

private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

ResetEncryptionAlgorithm

private void ResetEncryptionAlgorithm()

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 string[] CreationStack { get; }

• 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 string Fqn { get; }

• Type: string

---

EncryptionAlgorithmInput^Optional

public string EncryptionAlgorithmInput { get; }

• Type: string

---

EncryptionKeyInput^Optional

public string EncryptionKeyInput { get; }

• Type: string

---

EncryptionAlgorithm^Required

public string EncryptionAlgorithm { get; }

• Type: string

---

EncryptionKey^Required

public string EncryptionKey { get; }

• Type: string

---

InternalValue^Optional

public StorageBucketObjectCustomerEncryption InternalValue { get; }

• Type: StorageBucketObjectCustomerEncryption

---

StorageBucketObjectRetentionOutputReference

Initializers

using HashiCorp.Cdktf.Providers.Google;

new StorageBucketObjectRetentionOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute);

Name	Type	Description
TerraformResource	HashiCorp.Cdktf.IInterpolatingParent	The parent resource.
TerraformAttribute	string	The attribute on the parent resource this class is referencing.

---

TerraformResource^Required

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

private string ComputeFqn()

GetAnyMapAttribute

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetBooleanAttribute

private IResolvable GetBooleanAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetBooleanMapAttribute

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetListAttribute

private string[] GetListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberAttribute

private double GetNumberAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberListAttribute

private double[] GetNumberListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberMapAttribute

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetStringAttribute

private string GetStringAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetStringMapAttribute

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

InterpolationForAttribute

private IResolvable InterpolationForAttribute(string Property)

Property^Required

• Type: string

---

Resolve

private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

Context^Required

• Type: HashiCorp.Cdktf.IResolveContext

---

ToString

private string ToString()

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 string[] CreationStack { get; }

• 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 string Fqn { get; }

• Type: string

---

ModeInput^Optional

public string ModeInput { get; }

• Type: string

---

RetainUntilTimeInput^Optional

public string RetainUntilTimeInput { get; }

• Type: string

---

Mode^Required

public string Mode { get; }

• Type: string

---

RetainUntilTime^Required

public string RetainUntilTime { get; }

• Type: string

---

InternalValue^Optional

public StorageBucketObjectRetention InternalValue { get; }

• Type: StorageBucketObjectRetention

---

StorageBucketObjectTimeoutsOutputReference

Initializers

using HashiCorp.Cdktf.Providers.Google;

new StorageBucketObjectTimeoutsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute);

Name	Type	Description
TerraformResource	HashiCorp.Cdktf.IInterpolatingParent	The parent resource.
TerraformAttribute	string	The attribute on the parent resource this class is referencing.

---

TerraformResource^Required

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

private string ComputeFqn()

GetAnyMapAttribute

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetBooleanAttribute

private IResolvable GetBooleanAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetBooleanMapAttribute

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetListAttribute

private string[] GetListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberAttribute

private double GetNumberAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberListAttribute

private double[] GetNumberListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberMapAttribute

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetStringAttribute

private string GetStringAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetStringMapAttribute

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

InterpolationForAttribute

private IResolvable InterpolationForAttribute(string Property)

Property^Required

• Type: string

---

Resolve

private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

Context^Required

• Type: HashiCorp.Cdktf.IResolveContext

---

ToString

private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

ResetCreate

private void ResetCreate()

ResetDelete

private void ResetDelete()

ResetUpdate

private void ResetUpdate()

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	object	No description.

---

CreationStack^Required

public string[] CreationStack { get; }

• 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 string Fqn { get; }

• Type: string

---

CreateInput^Optional

public string CreateInput { get; }

• Type: string

---

DeleteInput^Optional

public string DeleteInput { get; }

• Type: string

---

UpdateInput^Optional

public string UpdateInput { get; }

• Type: string

---

Create^Required

public string Create { get; }

• Type: string

---

Delete^Required

public string Delete { get; }

• Type: string

---

Update^Required

public string Update { get; }

• Type: string

---

InternalValue^Optional

public object InternalValue { get; }

• Type: object

---