BucketObjectArgs class

The set of arguments for BucketObject. The set of arguments for BucketObject.

Constructors

BucketObjectArgs({required Input<String> bucket, Input<String?>? cacheControl, Input<String?>? content, Input<String?>? contentDisposition, Input<String?>? contentEncoding, Input<String?>? contentLanguage, Input<String?>? contentType, Input<BucketObjectContexts?>? contexts, Input<BucketObjectCustomerEncryption?>? customerEncryption, Input<String?>? deletionPolicy, Input<String?>? detectMd5hash, Input<bool?>? eventBasedHold, Input<bool?>? forceEmptyContentType, Input<String?>? kmsKeyName, Input<Map<String, String>?>? metadata, Input<String?>? name, Input<BucketObjectRetention?>? retention, Input? source, Input<String?>? sourceMd5hash, Input<String?>? storageClass, Input<bool?>? temporaryHold})
Creates a new BucketObjectArgs. bucket The name of the containing bucket. cacheControl Cache-Control content Data as string to be uploaded. Must be defined if source is not. Note: The content field is marked as sensitive. contentDisposition Content-Disposition of the object data. contentEncoding Content-Encoding of the object data. contentLanguage Content-Language of the object data. contentType Content-Type of the object data. Defaults to "application/octet-stream" or "text/plain; charset=utf-8". contexts Contexts attached to an object, in key-value pairs. For more information about object contexts, see Object contexts overview. Structure is documented below. customerEncryption Enables object encryption with Customer-Supplied Encryption Key (CSEK). Google documentation about CSEK. deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to "DELETE". detectMd5hash Detect changes to local file or changes made outside of Terraform to the file stored on the server. MD5 hash of the data, encoded using base64. This field is not present for composite objects. For more information about using the MD5 hash, see Hashes and ETags: Best Practices. eventBasedHold 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). forceEmptyContentType When set to true, it ensure the object's Content-Type is empty. kmsKeyName The resource name of the Cloud KMS key that will be used to encrypt the object. metadata User-provided metadata, in key/value pairs. name The name of the object. If you're interpolating the name of this object, see outputName instead. retention The object retention settings for the object. The retention settings allow an object to be retained until a provided date. Structure is documented below. source A path to the data you want to upload. Must be defined sourceMd5hash User-provided md5hash to trigger replacement of object in storage bucket, Must be Base 64 MD5 hash of the object data. The usual way to set this is filemd5("file.zip"), where "file.zip" is the local filename storageClass The StorageClass of the new bucket object. temporaryHold Whether an object is under temporary hold. While this flag is set to true, the object is protected against deletion and overwrites.
const
BucketObjectArgs.fromMap(Map<String, dynamic> map)
factory

Properties

bucket → Input<String>
The name of the containing bucket.
final
cacheControl → Input<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
final
content → Input<String?>?
Data as string to be uploaded. Must be defined if source is not. Note: The content field is marked as sensitive.
final
contentDisposition → Input<String?>?
Content-Disposition of the object data.
final
contentEncoding → Input<String?>?
Content-Encoding of the object data.
final
contentLanguage → Input<String?>?
Content-Language of the object data.
final
contentType → Input<String?>?
Content-Type of the object data. Defaults to "application/octet-stream" or "text/plain; charset=utf-8".
final
contexts → Input<BucketObjectContexts?>?
Contexts attached to an object, in key-value pairs. For more information about object contexts, see Object contexts overview. Structure is documented below.
final
customerEncryption → Input<BucketObjectCustomerEncryption?>?
Enables object encryption with Customer-Supplied Encryption Key (CSEK). Google documentation about CSEK. Structure is documented below.
final
deletionPolicy → Input<String?>?
Whether Terraform will be prevented from destroying the resource. Defaults to "DELETE". When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
final
detectMd5hash → Input<String?>?
Detect changes to local file or changes made outside of Terraform to the file stored on the server. MD5 hash of the data, encoded using base64. This field is not present for composite objects. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.
final
eventBasedHold → Input<bool?>?
Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), such objects will be subject to bucket-level retention (if any).
final
forceEmptyContentType → Input<bool?>?
When set to true, it ensure the object's Content-Type is empty.
final
hashCode → int
The hash code for this object.
no setterinherited
kmsKeyName → Input<String?>?
The resource name of the Cloud KMS key that will be used to encrypt the object.
final
metadata → Input<Map<String, String>?>?
User-provided metadata, in key/value pairs.
final
name → Input<String?>?
The name of the object. If you're interpolating the name of this object, see outputName instead.
final
retention → Input<BucketObjectRetention?>?
The object retention settings for the object. The retention settings allow an object to be retained until a provided date. Structure is documented below.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
source → Input?
A path to the data you want to upload. Must be defined if content is not.
final
sourceMd5hash → Input<String?>?
User-provided md5hash to trigger replacement of object in storage bucket, Must be Base 64 MD5 hash of the object data. The usual way to set this is filemd5("file.zip"), where "file.zip" is the local filename
final
storageClass → Input<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.
final
temporaryHold → Input<bool?>?
Whether an object is under temporary hold. While this flag is set to true, the object is protected against deletion and overwrites.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited