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

Class: Aws::S3Control::Types::S3CopyObjectOperation

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

Overview

Note:

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

{
  target_resource: "S3BucketArnString",
  canned_access_control_list: "private", # accepts private, public-read, public-read-write, aws-exec-read, authenticated-read, bucket-owner-read, bucket-owner-full-control
  access_control_grants: [
    {
      grantee: {
        type_identifier: "id", # accepts id, emailAddress, uri
        identifier: "NonEmptyMaxLength1024String",
        display_name: "NonEmptyMaxLength1024String",
      },
      permission: "FULL_CONTROL", # accepts FULL_CONTROL, READ, WRITE, READ_ACP, WRITE_ACP
    },
  ],
  metadata_directive: "COPY", # accepts COPY, REPLACE
  modified_since_constraint: Time.now,
  new_object_metadata: {
    cache_control: "NonEmptyMaxLength1024String",
    content_disposition: "NonEmptyMaxLength1024String",
    content_encoding: "NonEmptyMaxLength1024String",
    content_language: "NonEmptyMaxLength1024String",
    user_metadata: {
      "NonEmptyMaxLength1024String" => "MaxLength1024String",
    },
    content_length: 1,
    content_md5: "NonEmptyMaxLength1024String",
    content_type: "NonEmptyMaxLength1024String",
    http_expires_date: Time.now,
    requester_charged: false,
    sse_algorithm: "AES256", # accepts AES256, KMS
  },
  new_object_tagging: [
    {
      key: "TagKeyString", # required
      value: "TagValueString", # required
    },
  ],
  redirect_location: "NonEmptyMaxLength2048String",
  requester_pays: false,
  storage_class: "STANDARD", # accepts STANDARD, STANDARD_IA, ONEZONE_IA, GLACIER, INTELLIGENT_TIERING, DEEP_ARCHIVE
  un_modified_since_constraint: Time.now,
  sse_aws_kms_key_id: "KmsKeyArnString",
  target_key_prefix: "NonEmptyMaxLength1024String",
  object_lock_legal_hold_status: "OFF", # accepts OFF, ON
  object_lock_mode: "COMPLIANCE", # accepts COMPLIANCE, GOVERNANCE
  object_lock_retain_until_date: Time.now,
}

Contains the configuration parameters for a PUT Copy object operation. S3 Batch Operations passes each value through to the underlying PUT Copy object API. For more information about the parameters for this operation, see PUT Object - Copy.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#access_control_grants ⇒ Array<Types::S3Grant>

Returns:

#canned_access_control_list ⇒ String

Possible values:

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

Returns:

  • (String)

#metadata_directive ⇒ String

Possible values:

  • COPY
  • REPLACE

Returns:

  • (String)

#modified_since_constraint ⇒ Time

Returns:

  • (Time)

#new_object_metadata ⇒ Types::S3ObjectMetadata

Returns:

#new_object_tagging ⇒ Array<Types::S3Tag>

Returns:

#object_lock_legal_hold_status ⇒ String

The legal hold status to be applied to all objects in the Batch Operations job.

Possible values:

  • OFF
  • ON

Returns:

  • (String) —

    The legal hold status to be applied to all objects in the Batch Operations job.

#object_lock_mode ⇒ String

The retention mode to be applied to all objects in the Batch Operations job.

Possible values:

  • COMPLIANCE
  • GOVERNANCE

Returns:

  • (String) —

    The retention mode to be applied to all objects in the Batch Operations job.

#object_lock_retain_until_date ⇒ Time

The date when the applied object retention configuration expires on all objects in the Batch Operations job.

Returns:

  • (Time) —

    The date when the applied object retention configuration expires on all objects in the Batch Operations job.

#redirect_location ⇒ String

Specifies an optional metadata property for website redirects, x-amz-website-redirect-location. Allows webpage redirects if the object is accessed through a website endpoint.

Returns:

  • (String) —

    Specifies an optional metadata property for website redirects, x-amz-website-redirect-location.

#requester_pays ⇒ Boolean

Returns:

  • (Boolean)

#sse_aws_kms_key_id ⇒ String

Returns:

  • (String)

#storage_class ⇒ String

Possible values:

  • STANDARD
  • STANDARD_IA
  • ONEZONE_IA
  • GLACIER
  • INTELLIGENT_TIERING
  • DEEP_ARCHIVE

Returns:

  • (String)

#target_key_prefix ⇒ String

Specifies the folder prefix into which you would like the objects to be copied. For example, to copy objects into a folder named \"Folder1\" in the destination bucket, set the TargetKeyPrefix to \"Folder1/\".

Returns:

  • (String) —

    Specifies the folder prefix into which you would like the objects to be copied.

#target_resource ⇒ String

Specifies the destination bucket ARN for the batch copy operation. For example, to copy objects to a bucket named \"destinationBucket\", set the TargetResource to \"arn:aws:s3:::destinationBucket\".

Returns:

  • (String) —

    Specifies the destination bucket ARN for the batch copy operation.

#un_modified_since_constraint ⇒ Time

Returns:

  • (Time)