You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::S3::Types::CopyObjectRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CopyObjectRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  acl: "private", # accepts private, public-read, public-read-write, authenticated-read, aws-exec-read, bucket-owner-read, bucket-owner-full-control
  bucket: "BucketName", # required
  cache_control: "CacheControl",
  content_disposition: "ContentDisposition",
  content_encoding: "ContentEncoding",
  content_language: "ContentLanguage",
  content_type: "ContentType",
  copy_source: "CopySource", # required
  copy_source_if_match: "CopySourceIfMatch",
  copy_source_if_modified_since: Time.now,
  copy_source_if_none_match: "CopySourceIfNoneMatch",
  copy_source_if_unmodified_since: Time.now,
  expires: Time.now,
  grant_full_control: "GrantFullControl",
  grant_read: "GrantRead",
  grant_read_acp: "GrantReadACP",
  grant_write_acp: "GrantWriteACP",
  key: "ObjectKey", # required
  metadata: {
    "MetadataKey" => "MetadataValue",
  },
  metadata_directive: "COPY", # accepts COPY, REPLACE
  tagging_directive: "COPY", # accepts COPY, REPLACE
  server_side_encryption: "AES256", # accepts AES256, aws:kms
  storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA
  website_redirect_location: "WebsiteRedirectLocation",
  sse_customer_algorithm: "SSECustomerAlgorithm",
  sse_customer_key: "SSECustomerKey",
  sse_customer_key_md5: "SSECustomerKeyMD5",
  ssekms_key_id: "SSEKMSKeyId",
  copy_source_sse_customer_algorithm: "CopySourceSSECustomerAlgorithm",
  copy_source_sse_customer_key: "CopySourceSSECustomerKey",
  copy_source_sse_customer_key_md5: "CopySourceSSECustomerKeyMD5",
  request_payer: "requester", # accepts requester
  tagging: "TaggingHeader",
  use_accelerate_endpoint: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#aclString

The canned ACL to apply to the object.

Possible values:

  • private
  • public-read
  • public-read-write
  • authenticated-read
  • aws-exec-read
  • bucket-owner-read
  • bucket-owner-full-control

Returns:

  • (String)

    The canned ACL to apply to the object.

#bucketString

Returns:

  • (String)

#cache_controlString

Specifies caching behavior along the request/reply chain.

Returns:

  • (String)

    Specifies caching behavior along the request/reply chain.

#content_dispositionString

Specifies presentational information for the object.

Returns:

  • (String)

    Specifies presentational information for the object.

#content_encodingString

Specifies what content encodings 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.

Returns:

  • (String)

    Specifies what content encodings 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.

#content_languageString

The language the content is in.

Returns:

  • (String)

    The language the content is in.

#content_typeString

A standard MIME type describing the format of the object data.

Returns:

  • (String)

    A standard MIME type describing the format of the object data.

#copy_sourceString

The name of the source bucket and key name of the source object, separated by a slash (/). Must be URL-encoded.

Returns:

  • (String)

    The name of the source bucket and key name of the source object, separated by a slash (/).

#copy_source_if_matchString

Copies the object if its entity tag (ETag) matches the specified tag.

Returns:

  • (String)

    Copies the object if its entity tag (ETag) matches the specified tag.

#copy_source_if_modified_sinceTime

Copies the object if it has been modified since the specified time.

Returns:

  • (Time)

    Copies the object if it has been modified since the specified time.

#copy_source_if_none_matchString

Copies the object if its entity tag (ETag) is different than the specified ETag.

Returns:

  • (String)

    Copies the object if its entity tag (ETag) is different than the specified ETag.

#copy_source_if_unmodified_sinceTime

Copies the object if it hasn\'t been modified since the specified time.

Returns:

  • (Time)

    Copies the object if it hasn\'t been modified since the specified time.

#copy_source_sse_customer_algorithmString

Specifies the algorithm to use when decrypting the source object (e.g., AES256).

Returns:

  • (String)

    Specifies the algorithm to use when decrypting the source object (e.g., AES256).

#copy_source_sse_customer_keyString

Specifies the 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.

Returns:

  • (String)

    Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object.

#copy_source_sse_customer_key_md5String

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.

Returns:

  • (String)

    Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.

#expiresTime

The date and time at which the object is no longer cacheable.

Returns:

  • (Time)

    The date and time at which the object is no longer cacheable.

#grant_full_controlString

Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

Returns:

  • (String)

    Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

#grant_readString

Allows grantee to read the object data and its metadata.

Returns:

  • (String)

    Allows grantee to read the object data and its metadata.

#grant_read_acpString

Allows grantee to read the object ACL.

Returns:

  • (String)

    Allows grantee to read the object ACL.

#grant_write_acpString

Allows grantee to write the ACL for the applicable object.

Returns:

  • (String)

    Allows grantee to write the ACL for the applicable object.

#keyString

Returns:

  • (String)

#metadataHash<String,String>

A map of metadata to store with the object in S3.

Returns:

  • (Hash<String,String>)

    A map of metadata to store with the object in S3.

#metadata_directiveString

Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.

Possible values:

  • COPY
  • REPLACE

Returns:

  • (String)

    Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.

#request_payerString

Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

Possible values:

  • requester

Returns:

  • (String)

    Confirms that the requester knows that she or he will be charged for the request.

#server_side_encryptionString

The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).

Possible values:

  • AES256
  • aws:kms

Returns:

  • (String)

    The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).

#sse_customer_algorithmString

Specifies the algorithm to use to when encrypting the object (e.g., AES256).

Returns:

  • (String)

    Specifies the algorithm to use to when encrypting the object (e.g., AES256).

#sse_customer_keyString

Specifies the 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 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.

Returns:

  • (String)

    Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data.

#sse_customer_key_md5String

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.

Returns:

  • (String)

    Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.

#ssekms_key_idString

Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version

Returns:

  • (String)

    Specifies the AWS KMS key ID to use for object encryption.

#storage_classString

The type of storage to use for the object. Defaults to \'STANDARD\'.

Possible values:

  • STANDARD
  • REDUCED_REDUNDANCY
  • STANDARD_IA

Returns:

  • (String)

    The type of storage to use for the object.

#taggingString

The tag-set for the object destination object this value must be used in conjunction with the TaggingDirective. The tag-set must be encoded as URL Query parameters

Returns:

  • (String)

    The tag-set for the object destination object this value must be used in conjunction with the TaggingDirective.

#tagging_directiveString

Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.

Possible values:

  • COPY
  • REPLACE

Returns:

  • (String)

    Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.

#use_accelerate_endpointBoolean

When true, the "https://BUCKETNAME.s3-accelerate.amazonaws.com" endpoint will be used.

Returns:

#website_redirect_locationString

If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.

Returns:

  • (String)

    If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL.