BucketObjectv2Args class

The set of arguments for BucketObjectv2. The set of arguments for BucketObjectv2.

Constructors

BucketObjectv2Args({Input<String?>? acl, required Input bucket, Input<bool?>? bucketKeyEnabled, Input<String?>? cacheControl, Input<String?>? checksumAlgorithm, Input<String?>? content, Input<String?>? contentBase64, Input<String?>? contentDisposition, Input<String?>? contentEncoding, Input<String?>? contentLanguage, Input<String?>? contentType, Input<String?>? etag, Input<bool?>? forceDestroy, Input<String?>? key, Input<String?>? kmsKeyId, Input<Map<String, String>?>? metadata, Input<String?>? objectLockLegalHoldStatus, Input<String?>? objectLockMode, Input<String?>? objectLockRetainUntilDate, Input<BucketObjectv2OverrideProvider?>? overrideProvider, Input<String?>? region, Input<String?>? serverSideEncryption, Input? source, Input<String?>? sourceHash, Input<String?>? storageClass, Input<Map<String, String>?>? tags, Input<String?>? websiteRedirect})
Creates a new BucketObjectv2Args. acl Canned ACL to apply. Valid values are private, public-read, public-read-write, aws-exec-read, authenticated-read, bucket-owner-read, and bucket-owner-full-control. bucket Name of the bucket to put the file in. Alternatively, an S3 access point ARN can be specified. bucketKeyEnabled Whether or not to use Amazon S3 Bucket Keys for SSE-KMS. cacheControl Caching behavior along the request/reply chain Read w3c cacheControl for further details. checksumAlgorithm Algorithm used to create the checksum for the object. If a value is specified and the object is encrypted with KMS, you must have permission to use the kms:Decrypt action. Valid values: CRC32, CRC32C, CRC64NVME, SHA1, SHA256. content Literal string value to use as the object content, which will be uploaded as UTF-8-encoded text. contentBase64 Base64-encoded data that will be decoded and uploaded as raw bytes for the object content. This allows safely uploading non-UTF8 binary data, but is recommended only for small content such as the result of the gzipbase64 function with small text strings. For larger objects, use source to stream the content from a disk file. contentDisposition Presentational information for the object. Read w3c contentDisposition for further information. contentEncoding Content encodings that have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. Read w3c content encoding for further information. contentLanguage Language the content is in e.g., en-US or en-GB. contentType Standard MIME type describing the format of the object data, e.g., application/octet-stream. All Valid MIME Types are valid for this input. etag Triggers updates when the value changes. This attribute is not compatible with KMS encryption, kmsKeyId or serverSideEncryption = "aws:kms", also if an object is larger than 16 MB, the AWS Management Console will upload or copy that object as a Multipart Upload, and therefore the ETag will not be an MD5 digest (see sourceHash instead). forceDestroy Whether to allow the object to be deleted by removing any legal hold on any object version. Default is false. This value should be set to true only if the bucket has S3 object lock enabled. key Name of the object once it is in the bucket. kmsKeyId ARN of the KMS Key to use for object encryption. If the S3 Bucket has server-side encryption enabled, that value will automatically be used. If referencing the aws.kms.Key resource, use the arn attribute. If referencing the aws.kms.Alias data source or resource, use the targetKeyArn attribute. The provider will only perform drift detection if a configuration value is provided. metadata Map of keys/values to provision metadata (will be automatically prefixed by x-amz-meta-, note that only lowercase label are currently supported by the AWS Go API). objectLockLegalHoldStatus Legal hold status that you want to apply to the specified object. Valid values are ON and OFF. objectLockMode Object lock retention mode that you want to apply to this object. Valid values are GOVERNANCE and COMPLIANCE. objectLockRetainUntilDate Date and time, in RFC3339 format, when this object's object lock will expire. overrideProvider Override provider-level configuration options. See overrideProvider Block below for more details. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. serverSideEncryption Server-side encryption of the object in S3. Valid values are "AES256", "aws:kms", "aws:kms:dsse", and "aws:fsx". source Path to a file that will be read and uploaded as raw bytes for the object content. sourceHash Triggers updates like etag but useful to address etag encryption limitations. (The value is only stored in state and not saved by AWS.) storageClass Storage Class for the object. Defaults to "STANDARD". tags Map of tags to assign to the object. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. websiteRedirect Target URL for website redirect.
const
BucketObjectv2Args.fromMap(Map<String, dynamic> map)
factory

Properties

acl → Input<String?>?
Canned ACL to apply. Valid values are private, public-read, public-read-write, aws-exec-read, authenticated-read, bucket-owner-read, and bucket-owner-full-control.
final
bucket → Input
Name of the bucket to put the file in. Alternatively, an S3 access point ARN can be specified.
final
bucketKeyEnabled → Input<bool?>?
Whether or not to use Amazon S3 Bucket Keys for SSE-KMS.
final
cacheControl → Input<String?>?
Caching behavior along the request/reply chain Read w3c cacheControl for further details.
final
checksumAlgorithm → Input<String?>?
Algorithm used to create the checksum for the object. If a value is specified and the object is encrypted with KMS, you must have permission to use the kms:Decrypt action. Valid values: CRC32, CRC32C, CRC64NVME, SHA1, SHA256.
final
content → Input<String?>?
Literal string value to use as the object content, which will be uploaded as UTF-8-encoded text.
final
contentBase64 → Input<String?>?
Base64-encoded data that will be decoded and uploaded as raw bytes for the object content. This allows safely uploading non-UTF8 binary data, but is recommended only for small content such as the result of the gzipbase64 function with small text strings. For larger objects, use source to stream the content from a disk file.
final
contentDisposition → Input<String?>?
Presentational information for the object. Read w3c contentDisposition for further information.
final
contentEncoding → Input<String?>?
Content encodings that have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. Read w3c content encoding for further information.
final
contentLanguage → Input<String?>?
Language the content is in e.g., en-US or en-GB.
final
contentType → Input<String?>?
Standard MIME type describing the format of the object data, e.g., application/octet-stream. All Valid MIME Types are valid for this input.
final
etag → Input<String?>?
Triggers updates when the value changes. This attribute is not compatible with KMS encryption, kmsKeyId or serverSideEncryption = "aws:kms", also if an object is larger than 16 MB, the AWS Management Console will upload or copy that object as a Multipart Upload, and therefore the ETag will not be an MD5 digest (see sourceHash instead).
final
forceDestroy → Input<bool?>?
Whether to allow the object to be deleted by removing any legal hold on any object version. Default is false. This value should be set to true only if the bucket has S3 object lock enabled.
final
hashCode → int
The hash code for this object.
no setterinherited
key → Input<String?>?
Name of the object once it is in the bucket.
final
kmsKeyId → Input<String?>?
ARN of the KMS Key to use for object encryption. If the S3 Bucket has server-side encryption enabled, that value will automatically be used. If referencing the aws.kms.Key resource, use the arn attribute. If referencing the aws.kms.Alias data source or resource, use the targetKeyArn attribute. The provider will only perform drift detection if a configuration value is provided.
final
metadata → Input<Map<String, String>?>?
Map of keys/values to provision metadata (will be automatically prefixed by x-amz-meta-, note that only lowercase label are currently supported by the AWS Go API).
final
objectLockLegalHoldStatus → Input<String?>?
Legal hold status that you want to apply to the specified object. Valid values are ON and OFF.
final
objectLockMode → Input<String?>?
Object lock retention mode that you want to apply to this object. Valid values are GOVERNANCE and COMPLIANCE.
final
objectLockRetainUntilDate → Input<String?>?
Date and time, in RFC3339 format, when this object's object lock will expire.
final
overrideProvider → Input<BucketObjectv2OverrideProvider?>?
Override provider-level configuration options. See overrideProvider Block below for more details.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
serverSideEncryption → Input<String?>?
Server-side encryption of the object in S3. Valid values are "AES256", "aws:kms", "aws:kms:dsse", and "aws:fsx".
final
source → Input?
Path to a file that will be read and uploaded as raw bytes for the object content.
final
sourceHash → Input<String?>?
Triggers updates like etag but useful to address etag encryption limitations. (The value is only stored in state and not saved by AWS.)
final
storageClass → Input<String?>?
Storage Class for the object. Defaults to "STANDARD".
final
tags → Input<Map<String, String>?>?
Map of tags to assign to the object. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
websiteRedirect → Input<String?>?
Target URL for website redirect.
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