Skip to content

Latest commit

 

History

History
2815 lines (1757 loc) · 123 KB

storageBucketObject.go.md

File metadata and controls

2815 lines (1757 loc) · 123 KB

storageBucketObject Submodule

Constructs

StorageBucketObject

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

Initializers

import "github.com/cdktf/cdktf-provider-google-go/google/v14/storagebucketobject"

storagebucketobject.NewStorageBucketObject(scope Construct, id *string, config StorageBucketObjectConfig) StorageBucketObject
Name Type Description
scope github.com/aws/constructs-go/constructs/v10.Construct The scope in which to define this construct.
id *string The scoped construct ID.
config StorageBucketObjectConfig No description.

scopeRequired
  • Type: github.com/aws/constructs-go/constructs/v10.Construct

The scope in which to define this construct.


idRequired
  • Type: *string

The scoped construct ID.

Must be unique amongst siblings in the same scope


configRequired

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
func ToString() *string

Returns a string representation of this construct.

AddOverride
func AddOverride(path *string, value interface{})
pathRequired
  • Type: *string

valueRequired
  • Type: interface{}

OverrideLogicalId
func OverrideLogicalId(newLogicalId *string)

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

newLogicalIdRequired
  • Type: *string

The new logical ID to use for this stack element.


ResetOverrideLogicalId
func ResetOverrideLogicalId()

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

ToHclTerraform
func ToHclTerraform() interface{}
ToMetadata
func ToMetadata() interface{}
ToTerraform
func ToTerraform() interface{}

Adds this resource to the terraform JSON output.

AddMoveTarget
func AddMoveTarget(moveTarget *string)

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

moveTargetRequired
  • Type: *string

The string move target that will correspond to this resource.


GetAnyMapAttribute
func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
terraformAttributeRequired
  • Type: *string

GetBooleanAttribute
func GetBooleanAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string

GetBooleanMapAttribute
func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
terraformAttributeRequired
  • Type: *string

GetListAttribute
func GetListAttribute(terraformAttribute *string) *[]*string
terraformAttributeRequired
  • Type: *string

GetNumberAttribute
func GetNumberAttribute(terraformAttribute *string) *f64
terraformAttributeRequired
  • Type: *string

GetNumberListAttribute
func GetNumberListAttribute(terraformAttribute *string) *[]*f64
terraformAttributeRequired
  • Type: *string

GetNumberMapAttribute
func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64
terraformAttributeRequired
  • Type: *string

GetStringAttribute
func GetStringAttribute(terraformAttribute *string) *string
terraformAttributeRequired
  • Type: *string

GetStringMapAttribute
func GetStringMapAttribute(terraformAttribute *string) *map[string]*string
terraformAttributeRequired
  • Type: *string

HasResourceMove
func HasResourceMove() interface{}
ImportFrom
func ImportFrom(id *string, provider TerraformProvider)
idRequired
  • Type: *string

providerOptional
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

InterpolationForAttribute
func InterpolationForAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string

MoveFromId
func MoveFromId(id *string)

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.

idRequired
  • Type: *string

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


MoveTo
func MoveTo(moveTarget *string, index interface{})

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: *string

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


indexOptional
  • Type: interface{}

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


MoveToId
func MoveToId(id *string)

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

idRequired
  • Type: *string

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


PutCustomerEncryption
func PutCustomerEncryption(value StorageBucketObjectCustomerEncryption)
valueRequired

PutRetention
func PutRetention(value StorageBucketObjectRetention)
valueRequired

PutTimeouts
func PutTimeouts(value StorageBucketObjectTimeouts)
valueRequired

ResetCacheControl
func ResetCacheControl()
ResetContent
func ResetContent()
ResetContentDisposition
func ResetContentDisposition()
ResetContentEncoding
func ResetContentEncoding()
ResetContentLanguage
func ResetContentLanguage()
ResetContentType
func ResetContentType()
ResetCustomerEncryption
func ResetCustomerEncryption()
ResetDetectMd5Hash
func ResetDetectMd5Hash()
ResetEventBasedHold
func ResetEventBasedHold()
ResetId
func ResetId()
ResetKmsKeyName
func ResetKmsKeyName()
ResetMetadata
func ResetMetadata()
ResetRetention
func ResetRetention()
ResetSource
func ResetSource()
ResetStorageClass
func ResetStorageClass()
ResetTemporaryHold
func ResetTemporaryHold()
ResetTimeouts
func 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
import "github.com/cdktf/cdktf-provider-google-go/google/v14/storagebucketobject"

storagebucketobject.StorageBucketObject_IsConstruct(x interface{}) *bool

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.

xRequired
  • Type: interface{}

Any object.


IsTerraformElement
import "github.com/cdktf/cdktf-provider-google-go/google/v14/storagebucketobject"

storagebucketobject.StorageBucketObject_IsTerraformElement(x interface{}) *bool
xRequired
  • Type: interface{}

IsTerraformResource
import "github.com/cdktf/cdktf-provider-google-go/google/v14/storagebucketobject"

storagebucketobject.StorageBucketObject_IsTerraformResource(x interface{}) *bool
xRequired
  • Type: interface{}

GenerateConfigForImport
import "github.com/cdktf/cdktf-provider-google-go/google/v14/storagebucketobject"

storagebucketobject.StorageBucketObject_GenerateConfigForImport(scope Construct, importToId *string, importFromId *string, provider TerraformProvider) ImportableResource

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

scopeRequired
  • Type: github.com/aws/constructs-go/constructs/v10.Construct

The scope in which to define this construct.


importToIdRequired
  • Type: *string

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


importFromIdRequired
  • Type: *string

The id of the existing StorageBucketObject that should be imported.

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


providerOptional
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

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


Properties

Name Type Description
Node github.com/aws/constructs-go/constructs/v10.Node The tree node.
CdktfStack github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack No description.
Fqn *string No description.
FriendlyUniqueId *string No description.
TerraformMetaArguments *map[string]interface{} No description.
TerraformResourceType *string No description.
TerraformGeneratorMetadata github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata No description.
Connection interface{} No description.
Count interface{} No description.
DependsOn *[]*string No description.
ForEach github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator No description.
Lifecycle github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle No description.
Provider github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider No description.
Provisioners *[]interface{} No description.
Crc32C *string No description.
CustomerEncryption StorageBucketObjectCustomerEncryptionOutputReference No description.
Generation *f64 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 interface{} No description.
IdInput *string No description.
KmsKeyNameInput *string No description.
MetadataInput *map[string]*string No description.
NameInput *string No description.
RetentionInput StorageBucketObjectRetention No description.
SourceInput *string No description.
StorageClassInput *string No description.
TemporaryHoldInput interface{} No description.
TimeoutsInput interface{} 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 interface{} No description.
Id *string No description.
KmsKeyName *string No description.
Metadata *map[string]*string No description.
Name *string No description.
Source *string No description.
StorageClass *string No description.
TemporaryHold interface{} No description.

NodeRequired
func Node() Node
  • Type: github.com/aws/constructs-go/constructs/v10.Node

The tree node.


CdktfStackRequired
func CdktfStack() TerraformStack
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack

FqnRequired
func Fqn() *string
  • Type: *string

FriendlyUniqueIdRequired
func FriendlyUniqueId() *string
  • Type: *string

TerraformMetaArgumentsRequired
func TerraformMetaArguments() *map[string]interface{}
  • Type: *map[string]interface{}

TerraformResourceTypeRequired
func TerraformResourceType() *string
  • Type: *string

TerraformGeneratorMetadataOptional
func TerraformGeneratorMetadata() TerraformProviderGeneratorMetadata
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata

ConnectionOptional
func Connection() interface{}
  • Type: interface{}

CountOptional
func Count() interface{}
  • Type: interface{}

DependsOnOptional
func DependsOn() *[]*string
  • Type: *[]*string

ForEachOptional
func ForEach() ITerraformIterator
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator

LifecycleOptional
func Lifecycle() TerraformResourceLifecycle
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle

ProviderOptional
func Provider() TerraformProvider
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

ProvisionersOptional
func Provisioners() *[]interface{}
  • Type: *[]interface{}

Crc32CRequired
func Crc32C() *string
  • Type: *string

CustomerEncryptionRequired
func CustomerEncryption() StorageBucketObjectCustomerEncryptionOutputReference

GenerationRequired
func Generation() *f64
  • Type: *f64

Md5HashRequired
func Md5Hash() *string
  • Type: *string

MediaLinkRequired
func MediaLink() *string
  • Type: *string

OutputNameRequired
func OutputName() *string
  • Type: *string

RetentionRequired
func Retention() StorageBucketObjectRetentionOutputReference

SelfLinkRequired
func SelfLink() *string
  • Type: *string

TimeoutsRequired
func Timeouts() StorageBucketObjectTimeoutsOutputReference

BucketInputOptional
func BucketInput() *string
  • Type: *string

CacheControlInputOptional
func CacheControlInput() *string
  • Type: *string

ContentDispositionInputOptional
func ContentDispositionInput() *string
  • Type: *string

ContentEncodingInputOptional
func ContentEncodingInput() *string
  • Type: *string

ContentInputOptional
func ContentInput() *string
  • Type: *string

ContentLanguageInputOptional
func ContentLanguageInput() *string
  • Type: *string

ContentTypeInputOptional
func ContentTypeInput() *string
  • Type: *string

CustomerEncryptionInputOptional
func CustomerEncryptionInput() StorageBucketObjectCustomerEncryption

DetectMd5HashInputOptional
func DetectMd5HashInput() *string
  • Type: *string

EventBasedHoldInputOptional
func EventBasedHoldInput() interface{}
  • Type: interface{}

IdInputOptional
func IdInput() *string
  • Type: *string

KmsKeyNameInputOptional
func KmsKeyNameInput() *string
  • Type: *string

MetadataInputOptional
func MetadataInput() *map[string]*string
  • Type: *map[string]*string

NameInputOptional
func NameInput() *string
  • Type: *string

RetentionInputOptional
func RetentionInput() StorageBucketObjectRetention

SourceInputOptional
func SourceInput() *string
  • Type: *string

StorageClassInputOptional
func StorageClassInput() *string
  • Type: *string

TemporaryHoldInputOptional
func TemporaryHoldInput() interface{}
  • Type: interface{}

TimeoutsInputOptional
func TimeoutsInput() interface{}
  • Type: interface{}

BucketRequired
func Bucket() *string
  • Type: *string

CacheControlRequired
func CacheControl() *string
  • Type: *string

ContentRequired
func Content() *string
  • Type: *string

ContentDispositionRequired
func ContentDisposition() *string
  • Type: *string

ContentEncodingRequired
func ContentEncoding() *string
  • Type: *string

ContentLanguageRequired
func ContentLanguage() *string
  • Type: *string

ContentTypeRequired
func ContentType() *string
  • Type: *string

DetectMd5HashRequired
func DetectMd5Hash() *string
  • Type: *string

EventBasedHoldRequired
func EventBasedHold() interface{}
  • Type: interface{}

IdRequired
func Id() *string
  • Type: *string

KmsKeyNameRequired
func KmsKeyName() *string
  • Type: *string

MetadataRequired
func Metadata() *map[string]*string
  • Type: *map[string]*string

NameRequired
func Name() *string
  • Type: *string

SourceRequired
func Source() *string
  • Type: *string

StorageClassRequired
func StorageClass() *string
  • Type: *string

TemporaryHoldRequired
func TemporaryHold() interface{}
  • Type: interface{}

Constants

Name Type Description
TfResourceType *string No description.

TfResourceTypeRequired
func TfResourceType() *string
  • Type: *string

Structs

StorageBucketObjectConfig

Initializer

import "github.com/cdktf/cdktf-provider-google-go/google/v14/storagebucketobject"

&storagebucketobject.StorageBucketObjectConfig {
	Connection: interface{},
	Count: interface{},
	DependsOn: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable,
	ForEach: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator,
	Lifecycle: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle,
	Provider: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider,
	Provisioners: *[]interface{},
	Bucket: *string,
	Name: *string,
	CacheControl: *string,
	Content: *string,
	ContentDisposition: *string,
	ContentEncoding: *string,
	ContentLanguage: *string,
	ContentType: *string,
	CustomerEncryption: github.com/cdktf/cdktf-provider-google-go/google/v14.storageBucketObject.StorageBucketObjectCustomerEncryption,
	DetectMd5Hash: *string,
	EventBasedHold: interface{},
	Id: *string,
	KmsKeyName: *string,
	Metadata: *map[string]*string,
	Retention: github.com/cdktf/cdktf-provider-google-go/google/v14.storageBucketObject.StorageBucketObjectRetention,
	Source: *string,
	StorageClass: *string,
	TemporaryHold: interface{},
	Timeouts: github.com/cdktf/cdktf-provider-google-go/google/v14.storageBucketObject.StorageBucketObjectTimeouts,
}

Properties

Name Type Description
Connection interface{} No description.
Count interface{} No description.
DependsOn *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable No description.
ForEach github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator No description.
Lifecycle github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle No description.
Provider github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider No description.
Provisioners *[]interface{} 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.6.0/docs/resources/storage_bucket_object#detect_md5hash StorageBucketObject#detect_md5hash}.
EventBasedHold interface{} Whether an object is under event-based hold.
Id *string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.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 *map[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 interface{} Whether an object is under temporary hold.
Timeouts StorageBucketObjectTimeouts timeouts block.

ConnectionOptional
Connection interface{}
  • Type: interface{}

CountOptional
Count interface{}
  • Type: interface{}

DependsOnOptional
DependsOn *[]ITerraformDependable
  • Type: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable

ForEachOptional
ForEach ITerraformIterator
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator

LifecycleOptional
Lifecycle TerraformResourceLifecycle
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle

ProviderOptional
Provider TerraformProvider
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

ProvisionersOptional
Provisioners *[]interface{}
  • Type: *[]interface{}

BucketRequired
Bucket *string
  • Type: *string

The name of the containing bucket.

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


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


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


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


ContentDispositionOptional
ContentDisposition *string
  • Type: *string

Content-Disposition of the object data.

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


ContentEncodingOptional
ContentEncoding *string
  • Type: *string

Content-Encoding of the object data.

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


ContentLanguageOptional
ContentLanguage *string
  • Type: *string

Content-Language of the object data.

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


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


CustomerEncryptionOptional
CustomerEncryption StorageBucketObjectCustomerEncryption

customer_encryption block.

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


DetectMd5HashOptional
DetectMd5Hash *string
  • Type: *string

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


EventBasedHoldOptional
EventBasedHold interface{}
  • Type: interface{}

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


IdOptional
Id *string
  • Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.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.


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


MetadataOptional
Metadata *map[string]*string
  • Type: *map[string]*string

User-provided metadata, in key/value pairs.

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


RetentionOptional
Retention StorageBucketObjectRetention

retention block.

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


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


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


TemporaryHoldOptional
TemporaryHold interface{}
  • Type: interface{}

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


TimeoutsOptional
Timeouts StorageBucketObjectTimeouts

timeouts block.

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


StorageBucketObjectCustomerEncryption

Initializer

import "github.com/cdktf/cdktf-provider-google-go/google/v14/storagebucketobject"

&storagebucketobject.StorageBucketObjectCustomerEncryption {
	EncryptionKey: *string,
	EncryptionAlgorithm: *string,
}

Properties

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

EncryptionKeyRequired
EncryptionKey *string
  • Type: *string

Base64 encoded customer supplied encryption key.

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


EncryptionAlgorithmOptional
EncryptionAlgorithm *string
  • Type: *string

The encryption algorithm. Default: AES256.

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


StorageBucketObjectRetention

Initializer

import "github.com/cdktf/cdktf-provider-google-go/google/v14/storagebucketobject"

&storagebucketobject.StorageBucketObjectRetention {
	Mode: *string,
	RetainUntilTime: *string,
}

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.

ModeRequired
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.6.0/docs/resources/storage_bucket_object#mode StorageBucketObject#mode}


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


StorageBucketObjectTimeouts

Initializer

import "github.com/cdktf/cdktf-provider-google-go/google/v14/storagebucketobject"

&storagebucketobject.StorageBucketObjectTimeouts {
	Create: *string,
	Delete: *string,
	Update: *string,
}

Properties

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

CreateOptional
Create *string
  • Type: *string

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


DeleteOptional
Delete *string
  • Type: *string

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


UpdateOptional
Update *string
  • Type: *string

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


Classes

StorageBucketObjectCustomerEncryptionOutputReference

Initializers

import "github.com/cdktf/cdktf-provider-google-go/google/v14/storagebucketobject"

storagebucketobject.NewStorageBucketObjectCustomerEncryptionOutputReference(terraformResource IInterpolatingParent, terraformAttribute *string) StorageBucketObjectCustomerEncryptionOutputReference
Name Type Description
terraformResource github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent The parent resource.
terraformAttribute *string The attribute on the parent resource this class is referencing.

terraformResourceRequired
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • 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
func ComputeFqn() *string
GetAnyMapAttribute
func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
terraformAttributeRequired
  • Type: *string

GetBooleanAttribute
func GetBooleanAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string

GetBooleanMapAttribute
func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
terraformAttributeRequired
  • Type: *string

GetListAttribute
func GetListAttribute(terraformAttribute *string) *[]*string
terraformAttributeRequired
  • Type: *string

GetNumberAttribute
func GetNumberAttribute(terraformAttribute *string) *f64
terraformAttributeRequired
  • Type: *string

GetNumberListAttribute
func GetNumberListAttribute(terraformAttribute *string) *[]*f64
terraformAttributeRequired
  • Type: *string

GetNumberMapAttribute
func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64
terraformAttributeRequired
  • Type: *string

GetStringAttribute
func GetStringAttribute(terraformAttribute *string) *string
terraformAttributeRequired
  • Type: *string

GetStringMapAttribute
func GetStringMapAttribute(terraformAttribute *string) *map[string]*string
terraformAttributeRequired
  • Type: *string

InterpolationForAttribute
func InterpolationForAttribute(property *string) IResolvable
propertyRequired
  • Type: *string

Resolve
func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

_contextRequired
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext

ToString
func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

ResetEncryptionAlgorithm
func 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.

CreationStackRequired
func 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.


FqnRequired
func Fqn() *string
  • Type: *string

EncryptionAlgorithmInputOptional
func EncryptionAlgorithmInput() *string
  • Type: *string

EncryptionKeyInputOptional
func EncryptionKeyInput() *string
  • Type: *string

EncryptionAlgorithmRequired
func EncryptionAlgorithm() *string
  • Type: *string

EncryptionKeyRequired
func EncryptionKey() *string
  • Type: *string

InternalValueOptional
func InternalValue() StorageBucketObjectCustomerEncryption

StorageBucketObjectRetentionOutputReference

Initializers

import "github.com/cdktf/cdktf-provider-google-go/google/v14/storagebucketobject"

storagebucketobject.NewStorageBucketObjectRetentionOutputReference(terraformResource IInterpolatingParent, terraformAttribute *string) StorageBucketObjectRetentionOutputReference
Name Type Description
terraformResource github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent The parent resource.
terraformAttribute *string The attribute on the parent resource this class is referencing.

terraformResourceRequired
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • 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
func ComputeFqn() *string
GetAnyMapAttribute
func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
terraformAttributeRequired
  • Type: *string

GetBooleanAttribute
func GetBooleanAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string

GetBooleanMapAttribute
func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
terraformAttributeRequired
  • Type: *string

GetListAttribute
func GetListAttribute(terraformAttribute *string) *[]*string
terraformAttributeRequired
  • Type: *string

GetNumberAttribute
func GetNumberAttribute(terraformAttribute *string) *f64
terraformAttributeRequired
  • Type: *string

GetNumberListAttribute
func GetNumberListAttribute(terraformAttribute *string) *[]*f64
terraformAttributeRequired
  • Type: *string

GetNumberMapAttribute
func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64
terraformAttributeRequired
  • Type: *string

GetStringAttribute
func GetStringAttribute(terraformAttribute *string) *string
terraformAttributeRequired
  • Type: *string

GetStringMapAttribute
func GetStringMapAttribute(terraformAttribute *string) *map[string]*string
terraformAttributeRequired
  • Type: *string

InterpolationForAttribute
func InterpolationForAttribute(property *string) IResolvable
propertyRequired
  • Type: *string

Resolve
func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

_contextRequired
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext

ToString
func 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.

CreationStackRequired
func 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.


FqnRequired
func Fqn() *string
  • Type: *string

ModeInputOptional
func ModeInput() *string
  • Type: *string

RetainUntilTimeInputOptional
func RetainUntilTimeInput() *string
  • Type: *string

ModeRequired
func Mode() *string
  • Type: *string

RetainUntilTimeRequired
func RetainUntilTime() *string
  • Type: *string

InternalValueOptional
func InternalValue() StorageBucketObjectRetention

StorageBucketObjectTimeoutsOutputReference

Initializers

import "github.com/cdktf/cdktf-provider-google-go/google/v14/storagebucketobject"

storagebucketobject.NewStorageBucketObjectTimeoutsOutputReference(terraformResource IInterpolatingParent, terraformAttribute *string) StorageBucketObjectTimeoutsOutputReference
Name Type Description
terraformResource github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent The parent resource.
terraformAttribute *string The attribute on the parent resource this class is referencing.

terraformResourceRequired
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • 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
func ComputeFqn() *string
GetAnyMapAttribute
func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
terraformAttributeRequired
  • Type: *string

GetBooleanAttribute
func GetBooleanAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string

GetBooleanMapAttribute
func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
terraformAttributeRequired
  • Type: *string

GetListAttribute
func GetListAttribute(terraformAttribute *string) *[]*string
terraformAttributeRequired
  • Type: *string

GetNumberAttribute
func GetNumberAttribute(terraformAttribute *string) *f64
terraformAttributeRequired
  • Type: *string

GetNumberListAttribute
func GetNumberListAttribute(terraformAttribute *string) *[]*f64
terraformAttributeRequired
  • Type: *string

GetNumberMapAttribute
func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64
terraformAttributeRequired
  • Type: *string

GetStringAttribute
func GetStringAttribute(terraformAttribute *string) *string
terraformAttributeRequired
  • Type: *string

GetStringMapAttribute
func GetStringMapAttribute(terraformAttribute *string) *map[string]*string
terraformAttributeRequired
  • Type: *string

InterpolationForAttribute
func InterpolationForAttribute(property *string) IResolvable
propertyRequired
  • Type: *string

Resolve
func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

_contextRequired
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext

ToString
func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

ResetCreate
func ResetCreate()
ResetDelete
func ResetDelete()
ResetUpdate
func 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 interface{} No description.

CreationStackRequired
func 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.


FqnRequired
func Fqn() *string
  • Type: *string

CreateInputOptional
func CreateInput() *string
  • Type: *string

DeleteInputOptional
func DeleteInput() *string
  • Type: *string

UpdateInputOptional
func UpdateInput() *string
  • Type: *string

CreateRequired
func Create() *string
  • Type: *string

DeleteRequired
func Delete() *string
  • Type: *string

UpdateRequired
func Update() *string
  • Type: *string

InternalValueOptional
func InternalValue() interface{}
  • Type: interface{}