ObjectCopyArgs class

The set of arguments for ObjectCopy. The set of arguments for ObjectCopy.

Constructors

ObjectCopyArgs({Input<String?>? acl, required Input<String> bucket, Input<bool?>? bucketKeyEnabled, Input<String?>? cacheControl, Input<String?>? checksumAlgorithm, Input<String?>? contentDisposition, Input<String?>? contentEncoding, Input<String?>? contentLanguage, Input<String?>? contentType, Input<String?>? copyIfMatch, Input<String?>? copyIfModifiedSince, Input<String?>? copyIfNoneMatch, Input<String?>? copyIfUnmodifiedSince, Input<String?>? customerAlgorithm, Input<String?>? customerKey, Input<String?>? customerKeyMd5, Input<String?>? expectedBucketOwner, Input<String?>? expectedSourceBucketOwner, Input<String?>? expires, Input<bool?>? forceDestroy, Input<List<ObjectCopyGrant>?>? grants, required Input<String> key, Input<String?>? kmsEncryptionContext, Input<String?>? kmsKeyId, Input<Map<String, String>?>? metadata, Input<String?>? metadataDirective, Input<String?>? objectLockLegalHoldStatus, Input<String?>? objectLockMode, Input<String?>? objectLockRetainUntilDate, Input<ObjectCopyOverrideProvider?>? overrideProvider, Input<String?>? region, Input<String?>? requestPayer, Input<String?>? serverSideEncryption, required Input<String> source, Input<String?>? sourceCustomerAlgorithm, Input<String?>? sourceCustomerKey, Input<String?>? sourceCustomerKeyMd5, Input<String?>? storageClass, Input<String?>? taggingDirective, Input<Map<String, String>?>? tags, Input<String?>? websiteRedirect})
Creates a new ObjectCopyArgs. acl Canned ACL to apply. Valid values are private, public-read, public-read-write, authenticated-read, aws-exec-read, bucket-owner-read, and bucket-owner-full-control. Conflicts with grant. bucket Name of the bucket to put the file in. bucketKeyEnabled Whether to use an S3 Bucket Key for object encryption with server-side encryption using KMS (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. 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. copyIfMatch Copies the object if its entity tag (ETag) matches the specified tag. copyIfModifiedSince Copies the object if it has been modified since the specified time, in RFC3339 format. copyIfNoneMatch Copies the object if its entity tag (ETag) is different than the specified ETag. copyIfUnmodifiedSince Copies the object if it hasn't been modified since the specified time, in RFC3339 format. customerAlgorithm Algorithm to use when encrypting the object (for example, AES256). customerKey Customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header. customerKeyMd5 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error. expectedBucketOwner Account id of the expected destination bucket owner. If the destination bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. expectedSourceBucketOwner Account id of the expected source bucket owner. If the source bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. expires Date and time at which the object is no longer cacheable, in RFC3339 format. forceDestroy 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. grants Configuration block for header grants. Documented below. Conflicts with acl. key Name of the object once it is in the bucket. kmsEncryptionContext AWS KMS Encryption Context to use for object encryption. The value is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. kmsKeyId AWS KMS Key ARN to use for object encryption. This value is a fully qualified ARN of the KMS Key. If using aws.kms.Key, use the exported arn attribute: kmsKeyId = aws_kms_key.foo.arn 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). metadataDirective Whether the metadata is copied from the source object or replaced with metadata provided in the request. Valid values are COPY and REPLACE. objectLockLegalHoldStatus Legal hold status 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 Optional. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. requestPayer Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see Downloading Objects in Requestor Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) in the Amazon S3 Developer Guide. If included, the only valid value is requester. serverSideEncryption Server-side encryption of the object in S3. Valid values are AES256 and aws:kms. source Source object for the copy operation. You specify the value in one of two formats. For objects not accessed through an access point, specify the name of the source bucket and the key of the source object, separated by a slash (/). For example, testbucket/test1.json. For objects accessed through access points, specify the ARN of the object as accessed through the access point, in the format arn:aws:s3:&lt;Region&gt;:&lt;account-id&gt;:accesspoint/&lt;access-point-name&gt;/object/&lt;key&gt;. For example, arn:aws:s3:us-west-2:9999912999:accesspoint/my-access-point/object/testbucket/test1.json. sourceCustomerAlgorithm Algorithm to use when decrypting the source object (for example, AES256). sourceCustomerKey Customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created. sourceCustomerKeyMd5 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error. storageClass Desired storage class for the object. Defaults to STANDARD. taggingDirective Whether the object tag-set is copied from the source object or replaced with tag-set provided in the request. Valid values are COPY and REPLACE. 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
ObjectCopyArgs.fromMap(Map<String, dynamic> map)
factory

Properties

acl → Input<String?>?
Canned ACL to apply. Valid values are private, public-read, public-read-write, authenticated-read, aws-exec-read, bucket-owner-read, and bucket-owner-full-control. Conflicts with grant.
final
bucket → Input<String>
Name of the bucket to put the file in.
final
bucketKeyEnabled → Input<bool?>?
Whether to use an S3 Bucket Key for object encryption with server-side encryption using KMS (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
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
copyIfMatch → Input<String?>?
Copies the object if its entity tag (ETag) matches the specified tag.
final
copyIfModifiedSince → Input<String?>?
Copies the object if it has been modified since the specified time, in RFC3339 format.
final
copyIfNoneMatch → Input<String?>?
Copies the object if its entity tag (ETag) is different than the specified ETag.
final
copyIfUnmodifiedSince → Input<String?>?
Copies the object if it hasn't been modified since the specified time, in RFC3339 format.
final
customerAlgorithm → Input<String?>?
Algorithm to use when encrypting the object (for example, AES256).
final
customerKey → Input<String?>?
Customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.
final
customerKeyMd5 → Input<String?>?
128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.
final
expectedBucketOwner → Input<String?>?
Account id of the expected destination bucket owner. If the destination bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
final
expectedSourceBucketOwner → Input<String?>?
Account id of the expected source bucket owner. If the source bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
final
expires → Input<String?>?
Date and time at which the object is no longer cacheable, in RFC3339 format.
final
forceDestroy → Input<bool?>?
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
grants → Input<List<ObjectCopyGrant>?>?
Configuration block for header grants. Documented below. Conflicts with acl.
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
kmsEncryptionContext → Input<String?>?
AWS KMS Encryption Context to use for object encryption. The value is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.
final
kmsKeyId → Input<String?>?
AWS KMS Key ARN to use for object encryption. This value is a fully qualified ARN of the KMS Key. If using aws.kms.Key, use the exported arn attribute: kmsKeyId = aws_kms_key.foo.arn
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
metadataDirective → Input<String?>?
Whether the metadata is copied from the source object or replaced with metadata provided in the request. Valid values are COPY and REPLACE.
final
objectLockLegalHoldStatus → Input<String?>?
Legal hold status 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<ObjectCopyOverrideProvider?>?
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
requestPayer → Input<String?>?
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see Downloading Objects in Requestor Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) in the Amazon S3 Developer Guide. If included, the only valid value is requester.
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 and aws:kms.
final
source → Input<String>
Source object for the copy operation. You specify the value in one of two formats. For objects not accessed through an access point, specify the name of the source bucket and the key of the source object, separated by a slash (/). For example, testbucket/test1.json. For objects accessed through access points, specify the ARN of the object as accessed through the access point, in the format arn:aws:s3:&lt;Region&gt;:&lt;account-id&gt;:accesspoint/&lt;access-point-name&gt;/object/&lt;key&gt;. For example, arn:aws:s3:us-west-2:9999912999:accesspoint/my-access-point/object/testbucket/test1.json.
final
sourceCustomerAlgorithm → Input<String?>?
Algorithm to use when decrypting the source object (for example, AES256).
final
sourceCustomerKey → Input<String?>?
Customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.
final
sourceCustomerKeyMd5 → Input<String?>?
128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.
final
storageClass → Input<String?>?
Desired storage class for the object. Defaults to STANDARD.
final
taggingDirective → Input<String?>?
Whether the object tag-set is copied from the source object or replaced with tag-set provided in the request. Valid values are COPY and REPLACE.
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