ObjectCopyState class
Input properties used for looking up and filtering ObjectCopy resources.
Constructors
-
ObjectCopyState({Input<
String?> ? acl, Input<String?> ? arn, Input<String?> ? bucket, Input<bool?> ? bucketKeyEnabled, Input<String?> ? cacheControl, Input<String?> ? checksumAlgorithm, Input<String?> ? checksumCrc32, Input<String?> ? checksumCrc32c, Input<String?> ? checksumCrc64nvme, Input<String?> ? checksumSha1, Input<String?> ? checksumSha256, 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?> ? etag, Input<String?> ? expectedBucketOwner, Input<String?> ? expectedSourceBucketOwner, Input<String?> ? expiration, Input<String?> ? expires, Input<bool?> ? forceDestroy, Input<List< ? grants, Input<ObjectCopyGrant> ?>String?> ? key, Input<String?> ? kmsEncryptionContext, Input<String?> ? kmsKeyId, Input<String?> ? lastModified, Input<Map< ? metadata, Input<String, String> ?>String?> ? metadataDirective, Input<String?> ? objectLockLegalHoldStatus, Input<String?> ? objectLockMode, Input<String?> ? objectLockRetainUntilDate, Input<ObjectCopyOverrideProvider?> ? overrideProvider, Input<String?> ? region, Input<bool?> ? requestCharged, Input<String?> ? requestPayer, Input<String?> ? serverSideEncryption, Input<String?> ? source, Input<String?> ? sourceCustomerAlgorithm, Input<String?> ? sourceCustomerKey, Input<String?> ? sourceCustomerKeyMd5, Input<String?> ? sourceVersionId, Input<String?> ? storageClass, Input<String?> ? taggingDirective, Input<Map< ? tags, Input<String, String> ?>Map< ? tagsAll, Input<String, String> ?>String?> ? versionId, Input<String?> ? websiteRedirect}) -
Creates a new ObjectCopyState.
acl Canned ACL to apply. Valid values are
private,public-read,public-read-write,authenticated-read,aws-exec-read,bucket-owner-read, andbucket-owner-full-control. Conflicts withgrant.arnARN of the object.bucketName of the bucket to put the file in.bucketKeyEnabledWhether to use an S3 Bucket Key for object encryption with server-side encryption using KMS (SSE-KMS).cacheControlCaching behavior along the request/reply chain. Read w3c cacheControl for further details.checksumAlgorithmAlgorithm 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 thekms:Decryptaction. Valid values:CRC32,CRC32C,CRC64NVMESHA1,SHA256.checksumCrc32Base64-encoded, 32-bit CRC32 checksum of the object.checksumCrc32cBase64-encoded, 32-bit CRC32C checksum of the object.checksumCrc64nvmeBase64-encoded, 64-bit CRC64NVME checksum of the object.checksumSha1Base64-encoded, 160-bit SHA-1 digest of the object.checksumSha256Base64-encoded, 256-bit SHA-256 digest of the object.contentDispositionPresentational information for the object. Read w3c contentDisposition for further information.contentEncodingContent 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.contentLanguageLanguage the content is in e.g., en-US or en-GB.contentTypeStandard MIME type describing the format of the object data, e.g.,application/octet-stream. All Valid MIME Types are valid for this input.copyIfMatchCopies the object if its entity tag (ETag) matches the specified tag.copyIfModifiedSinceCopies the object if it has been modified since the specified time, in RFC3339 format.copyIfNoneMatchCopies the object if its entity tag (ETag) is different than the specified ETag.copyIfUnmodifiedSinceCopies the object if it hasn't been modified since the specified time, in RFC3339 format.customerAlgorithmAlgorithm to use when encrypting the object (for example, AES256).customerKeyCustomer-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.customerKeyMd5128-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.etagETag generated for the object (an MD5 sum of the object content). For plaintext objects or objects encrypted with an AWS-managed key, the hash is an MD5 digest of the object data. For objects encrypted with a KMS key or objects created by either the Multipart Upload or Part Copy operation, the hash is not an MD5 digest, regardless of the method of encryption. More information on possible values can be found on Common Response Headers.expectedBucketOwnerAccount 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.expectedSourceBucketOwnerAccount 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.expirationIf the object expiration is configured, this attribute will be set.expiresDate and time at which the object is no longer cacheable, in RFC3339 format.forceDestroyAllow the object to be deleted by removing any legal hold on any object version. Default isfalse. This value should be set totrueonly if the bucket has S3 object lock enabled.grantsConfiguration block for header grants. Documented below. Conflicts withacl.keyName of the object once it is in the bucket.kmsEncryptionContextAWS 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.kmsKeyIdAWS KMS Key ARN to use for object encryption. This value is a fully qualified ARN of the KMS Key. If usingaws.kms.Key, use the exportedarnattribute:kmsKeyId = aws_kms_key.foo.arnlastModifiedReturns the date that the object was last modified, in RFC3339 format.metadataMap of keys/values to provision metadata (will be automatically prefixed byx-amz-meta-, note that only lowercase label are currently supported by the AWS Go API).metadataDirectiveWhether the metadata is copied from the source object or replaced with metadata provided in the request. Valid values areCOPYandREPLACE. objectLockLegalHoldStatus Legal hold status to apply to the specified object. Valid values areONandOFF.objectLockModeObject lock retention mode that you want to apply to this object. Valid values areGOVERNANCEandCOMPLIANCE.objectLockRetainUntilDateDate and time, in RFC3339 format, when this object's object lock will expire.overrideProviderOptional.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.requestChargedIf present, indicates that the requester was successfully charged for the request.requestPayerConfirms 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 isrequester.serverSideEncryptionServer-side encryption of the object in S3. Valid values areAES256andaws:kms.sourceSource 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 formatarn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key>. For example,arn:aws:s3:us-west-2:9999912999:accesspoint/my-access-point/object/testbucket/test1.json.sourceCustomerAlgorithmAlgorithm to use when decrypting the source object (for example, AES256).sourceCustomerKeyCustomer-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.sourceCustomerKeyMd5128-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.sourceVersionIdVersion of the copied object in the source bucket.storageClassDesired storage class for the object. Defaults toSTANDARD.taggingDirectiveWhether the object tag-set is copied from the source object or replaced with tag-set provided in the request. Valid values areCOPYandREPLACE.tagsMap of tags to assign to the object. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.tagsAllMap of tags assigned to the resource, including those inherited from the providerdefaultTagsconfiguration block.versionIdVersion ID of the newly created copy.websiteRedirectTarget URL for website redirect.const -
ObjectCopyState.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, andbucket-owner-full-control. Conflicts withgrant.final -
arn
→ Input<
String?> ? -
ARN of the object.
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:Decryptaction. Valid values:CRC32,CRC32C,CRC64NVMESHA1,SHA256.final -
checksumCrc32
→ Input<
String?> ? -
Base64-encoded, 32-bit CRC32 checksum of the object.
final
-
checksumCrc32c
→ Input<
String?> ? -
Base64-encoded, 32-bit CRC32C checksum of the object.
final
-
checksumCrc64nvme
→ Input<
String?> ? -
Base64-encoded, 64-bit CRC64NVME checksum of the object.
final
-
checksumSha1
→ Input<
String?> ? -
Base64-encoded, 160-bit SHA-1 digest of the object.
final
-
checksumSha256
→ Input<
String?> ? -
Base64-encoded, 256-bit SHA-256 digest of the object.
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
-
etag
→ Input<
String?> ? -
ETag generated for the object (an MD5 sum of the object content). For plaintext objects or objects encrypted with an AWS-managed key, the hash is an MD5 digest of the object data. For objects encrypted with a KMS key or objects created by either the Multipart Upload or Part Copy operation, the hash is not an MD5 digest, regardless of the method of encryption. More information on possible values can be found on Common Response Headers.
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
-
expiration
→ Input<
String?> ? -
If the object expiration is configured, this attribute will be set.
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 totrueonly 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 exportedarnattribute:kmsKeyId = aws_kms_key.foo.arnfinal -
lastModified
→ Input<
String?> ? -
Returns the date that the object was last modified, in RFC3339 format.
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
COPYandREPLACE.final -
objectLockLegalHoldStatus
→ Input<
String?> ? -
Legal hold status to apply to the specified object. Valid values are
ONandOFF.final -
objectLockMode
→ Input<
String?> ? -
Object lock retention mode that you want to apply to this object. Valid values are
GOVERNANCEandCOMPLIANCE.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
-
requestCharged
→ Input<
bool?> ? -
If present, indicates that the requester was successfully charged for the request.
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
AES256andaws: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 formatarn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key>. 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
-
sourceVersionId
→ Input<
String?> ? -
Version of the copied object in the source bucket.
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
COPYandREPLACE.final -
Map of tags to assign to the object. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.final -
versionId
→ Input<
String?> ? -
Version ID of the newly created copy.
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