IS3CopyObjectRequest
Interface in AWS.S3
Interface for CopyObject requests.
Ancestors
Properties
ACL
property ACL: string
The canned ACL to apply to the object.
Not supported on Amazon S3 on Outposts. Valid values: </code>(private<code>( | public-read | public-read-write | authenticated-read | aws-exec-read | bucket-owner-read | bucket-owner-full-control.
CacheControl
property CacheControl: string
Specifies the caching behaviour.
ContentDisposition
property ContentDisposition: string
Specifies presentational information for the object.
ContentEncoding
property ContentEncoding: string
Specifies what content encodings have been applied to the object.
ContentLanguage
property ContentLanguage: string
The language the content is in.
ContentType
property ContentType: string
The MIME type for the content.
CopySource
property CopySource: string
Specify the source object.
There are two formats for a copy source: - For objects not through an access point, the bucket name and object key separated by a forward slash /. For example: mybucket/sales/report.pdf refers to an object sales/report.pdf in the mybucket bucket. - For objects accessed through an access point, specify the Amazon Resource Name (ARN) in the format arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key>.
CopySourceIfMatch
property CopySourceIfMatch: string
Copies the object if the entity tag (ETag) matches the specified tag.
CopySourceIfModifiedSince
property CopySourceIfModifiedSince: TOptional<TDateTime>
Copies the object if it has been modified since the specified date and time.
CopySourceIfNoneMatch
property CopySourceIfNoneMatch: string
Copies the object if its entity tag (ETag) is different from the specified ETag.
CopySourceIfUnmodifiedSince
property CopySourceIfUnmodifiedSince: TOptional<TDateTime>
Copies the object if it hasn't been modified since the specified date and time.
CopySourceSseCustomerAlgorithm
property CopySourceSseCustomerAlgorithm: string
Specifies the algorithm to use when decrypting the source object.
CopySourceSseCustomerKey
property CopySourceSseCustomerKey: string
Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object.
CopySourceSseCustomerKeyMD5
property CopySourceSseCustomerKeyMD5: string
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.
Expires
property Expires: TOptional<TDateTime>
The date and time at which the object is no longer cacheable.
GrantFullControl
property GrantFullControl: string
Allows the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
GrantRead
property GrantRead: string
Allows the grantee read access to the object and its metadata.
GrantReadAcp
property GrantReadAcp: string
Allows the grantee read access to the objects ACL.
GrantWriteAcp
property GrantWriteAcp: string
Allows the grantee write access to the objects ACL.
MetadataDirective
property MetadataDirective: string
Specifies whether the metadata is copied from the source object or replaced with metadata in the request.
Valid values: COPY | REPLACE.
ObjectLockLegalHold
property ObjectLockLegalHold: string
Specifies whether you want to apply Legal Hold on to the copied object.
Valid values: ON | OFF.
ObjectLockMode
property ObjectLockMode: string
Valid values: GOVERNANCE | COMPLIANCE.
ObjectLockRetainUntilDate
property ObjectLockRetainUntilDate: TOptional<TDateTime>
Specifies a date and time you want the Object Lock to expire.
RequestPayer
property RequestPayer: string
Confirms that the requester knows that they will be charged for the request.
Valid values: requester.
ServerSideEncryption
property ServerSideEncryption: string
Specifies the server-side encryption algorithm to use when storing the object on Amazon S3.
Valid values: AES256 | aws:kms.
SseAwsKmsKeyId
property SseAwsKmsKeyId: string
Specifies the AWS KMS key ID to use for object encryption.
SseBucketKeyEnabled
property SseBucketKeyEnabled: TOptional<Boolean>
Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS).
SseContext
property SseContext: string
Specifies the AWS KMS Encryption Context to use for object encryption.
SseCustomerAlgorithm
property SseCustomerAlgorithm: string
Specifies the algorithm to use when encrypting the object.
SseCustomerKey
property SseCustomerKey: string
Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data.
SseCustomerKeyMD5
property SseCustomerKeyMD5: string
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.
SourceExpectedBucketOwner
property SourceExpectedBucketOwner: string
Specifies the expected account ID of the source bucket owner.
StorageClass
property StorageClass: string
Specifies the storage class to use for newly created objects.
By default Amazon S3 uses the STANDARD storage class. Valid values are: STANDARD | REDUCED_REDUNDANCY | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | GLACIER | DEEP_ARCHIVE | OUTPOSTS.
Tagging
property Tagging: string
Specifies the tag-set for the destination object.
Must be used in conjunction with TaggingDirective.
TaggingDirective
property TaggingDirective: string
Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.
Valid values: COPY | REPLACE.
WebsiteRedirectLocation
property WebsiteRedirectLocation: string
If the bucket is configured as a website, specifying this redirects requests for this object to another object in the same bucket or to an external URL.