Class: Aws::S3Control::Types::S3CopyObjectOperation
- Inherits:
-
Struct
- Object
- Struct
- Aws::S3Control::Types::S3CopyObjectOperation
- Defined in:
- gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb
Overview
Contains the configuration parameters for a PUT Copy object operation.
S3 Batch Operations passes every object to the underlying CopyObject
API operation. For more information about the parameters for this
operation, see CopyObject.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#access_control_grants ⇒ Array<Types::S3Grant>
-
#bucket_key_enabled ⇒ Boolean
Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Amazon Web Services KMS (SSE-KMS).
-
#canned_access_control_list ⇒ String
-
#checksum_algorithm ⇒ String
Indicates the algorithm that you want Amazon S3 to use to create the checksum.
-
#metadata_directive ⇒ String
-
#modified_since_constraint ⇒ Time
-
#new_object_metadata ⇒ Types::S3ObjectMetadata
If you don't provide this parameter, Amazon S3 copies all the metadata from the original objects.
-
#new_object_tagging ⇒ Array<Types::S3Tag>
-
#object_lock_legal_hold_status ⇒ 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.
-
#object_lock_retain_until_date ⇒ 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
. -
#requester_pays ⇒ Boolean
-
#sse_aws_kms_key_id ⇒ String
-
#storage_class ⇒ String
-
#target_key_prefix ⇒ String
Specifies the folder prefix that you want the objects to be copied into.
-
#target_resource ⇒ String
Specifies the destination bucket Amazon Resource Name (ARN) for the batch copy operation.
-
#un_modified_since_constraint ⇒ Time
Instance Attribute Details
#access_control_grants ⇒ Array<Types::S3Grant>
5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 5166 class S3CopyObjectOperation < Struct.new( :target_resource, :canned_access_control_list, :access_control_grants, :metadata_directive, :modified_since_constraint, :new_object_metadata, :new_object_tagging, :redirect_location, :requester_pays, :storage_class, :un_modified_since_constraint, :sse_aws_kms_key_id, :target_key_prefix, :object_lock_legal_hold_status, :object_lock_mode, :object_lock_retain_until_date, :bucket_key_enabled, :checksum_algorithm) SENSITIVE = [] include Aws::Structure end |
#bucket_key_enabled ⇒ Boolean
Specifies whether Amazon S3 should use an S3 Bucket Key for object
encryption with server-side encryption using Amazon Web Services KMS
(SSE-KMS). Setting this header to true
causes Amazon S3 to use an
S3 Bucket Key for object encryption with SSE-KMS.
Specifying this header with an object action doesn’t affect bucket-level settings for S3 Bucket Key.
5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 5166 class S3CopyObjectOperation < Struct.new( :target_resource, :canned_access_control_list, :access_control_grants, :metadata_directive, :modified_since_constraint, :new_object_metadata, :new_object_tagging, :redirect_location, :requester_pays, :storage_class, :un_modified_since_constraint, :sse_aws_kms_key_id, :target_key_prefix, :object_lock_legal_hold_status, :object_lock_mode, :object_lock_retain_until_date, :bucket_key_enabled, :checksum_algorithm) SENSITIVE = [] include Aws::Structure end |
#canned_access_control_list ⇒ String
5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 5166 class S3CopyObjectOperation < Struct.new( :target_resource, :canned_access_control_list, :access_control_grants, :metadata_directive, :modified_since_constraint, :new_object_metadata, :new_object_tagging, :redirect_location, :requester_pays, :storage_class, :un_modified_since_constraint, :sse_aws_kms_key_id, :target_key_prefix, :object_lock_legal_hold_status, :object_lock_mode, :object_lock_retain_until_date, :bucket_key_enabled, :checksum_algorithm) SENSITIVE = [] include Aws::Structure end |
#checksum_algorithm ⇒ String
Indicates the algorithm that you want Amazon S3 to use to create the checksum. For more information, see Checking object integrity in the Amazon S3 User Guide.
5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 5166 class S3CopyObjectOperation < Struct.new( :target_resource, :canned_access_control_list, :access_control_grants, :metadata_directive, :modified_since_constraint, :new_object_metadata, :new_object_tagging, :redirect_location, :requester_pays, :storage_class, :un_modified_since_constraint, :sse_aws_kms_key_id, :target_key_prefix, :object_lock_legal_hold_status, :object_lock_mode, :object_lock_retain_until_date, :bucket_key_enabled, :checksum_algorithm) SENSITIVE = [] include Aws::Structure end |
#metadata_directive ⇒ String
5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 5166 class S3CopyObjectOperation < Struct.new( :target_resource, :canned_access_control_list, :access_control_grants, :metadata_directive, :modified_since_constraint, :new_object_metadata, :new_object_tagging, :redirect_location, :requester_pays, :storage_class, :un_modified_since_constraint, :sse_aws_kms_key_id, :target_key_prefix, :object_lock_legal_hold_status, :object_lock_mode, :object_lock_retain_until_date, :bucket_key_enabled, :checksum_algorithm) SENSITIVE = [] include Aws::Structure end |
#modified_since_constraint ⇒ Time
5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 5166 class S3CopyObjectOperation < Struct.new( :target_resource, :canned_access_control_list, :access_control_grants, :metadata_directive, :modified_since_constraint, :new_object_metadata, :new_object_tagging, :redirect_location, :requester_pays, :storage_class, :un_modified_since_constraint, :sse_aws_kms_key_id, :target_key_prefix, :object_lock_legal_hold_status, :object_lock_mode, :object_lock_retain_until_date, :bucket_key_enabled, :checksum_algorithm) SENSITIVE = [] include Aws::Structure end |
#new_object_metadata ⇒ Types::S3ObjectMetadata
If you don't provide this parameter, Amazon S3 copies all the metadata from the original objects. If you specify an empty set, the new objects will have no tags. Otherwise, Amazon S3 assigns the supplied tags to the new objects.
5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 5166 class S3CopyObjectOperation < Struct.new( :target_resource, :canned_access_control_list, :access_control_grants, :metadata_directive, :modified_since_constraint, :new_object_metadata, :new_object_tagging, :redirect_location, :requester_pays, :storage_class, :un_modified_since_constraint, :sse_aws_kms_key_id, :target_key_prefix, :object_lock_legal_hold_status, :object_lock_mode, :object_lock_retain_until_date, :bucket_key_enabled, :checksum_algorithm) SENSITIVE = [] include Aws::Structure end |
#new_object_tagging ⇒ Array<Types::S3Tag>
5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 5166 class S3CopyObjectOperation < Struct.new( :target_resource, :canned_access_control_list, :access_control_grants, :metadata_directive, :modified_since_constraint, :new_object_metadata, :new_object_tagging, :redirect_location, :requester_pays, :storage_class, :un_modified_since_constraint, :sse_aws_kms_key_id, :target_key_prefix, :object_lock_legal_hold_status, :object_lock_mode, :object_lock_retain_until_date, :bucket_key_enabled, :checksum_algorithm) SENSITIVE = [] include Aws::Structure end |
#object_lock_legal_hold_status ⇒ String
The legal hold status to be applied to all objects in the Batch Operations job.
5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 5166 class S3CopyObjectOperation < Struct.new( :target_resource, :canned_access_control_list, :access_control_grants, :metadata_directive, :modified_since_constraint, :new_object_metadata, :new_object_tagging, :redirect_location, :requester_pays, :storage_class, :un_modified_since_constraint, :sse_aws_kms_key_id, :target_key_prefix, :object_lock_legal_hold_status, :object_lock_mode, :object_lock_retain_until_date, :bucket_key_enabled, :checksum_algorithm) SENSITIVE = [] include Aws::Structure end |
#object_lock_mode ⇒ String
The retention mode to be applied to all objects in the Batch Operations job.
5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 5166 class S3CopyObjectOperation < Struct.new( :target_resource, :canned_access_control_list, :access_control_grants, :metadata_directive, :modified_since_constraint, :new_object_metadata, :new_object_tagging, :redirect_location, :requester_pays, :storage_class, :un_modified_since_constraint, :sse_aws_kms_key_id, :target_key_prefix, :object_lock_legal_hold_status, :object_lock_mode, :object_lock_retain_until_date, :bucket_key_enabled, :checksum_algorithm) SENSITIVE = [] include Aws::Structure end |
#object_lock_retain_until_date ⇒ Time
The date when the applied object retention configuration expires on all objects in the Batch Operations job.
5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 5166 class S3CopyObjectOperation < Struct.new( :target_resource, :canned_access_control_list, :access_control_grants, :metadata_directive, :modified_since_constraint, :new_object_metadata, :new_object_tagging, :redirect_location, :requester_pays, :storage_class, :un_modified_since_constraint, :sse_aws_kms_key_id, :target_key_prefix, :object_lock_legal_hold_status, :object_lock_mode, :object_lock_retain_until_date, :bucket_key_enabled, :checksum_algorithm) SENSITIVE = [] include Aws::Structure end |
#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.
5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 5166 class S3CopyObjectOperation < Struct.new( :target_resource, :canned_access_control_list, :access_control_grants, :metadata_directive, :modified_since_constraint, :new_object_metadata, :new_object_tagging, :redirect_location, :requester_pays, :storage_class, :un_modified_since_constraint, :sse_aws_kms_key_id, :target_key_prefix, :object_lock_legal_hold_status, :object_lock_mode, :object_lock_retain_until_date, :bucket_key_enabled, :checksum_algorithm) SENSITIVE = [] include Aws::Structure end |
#requester_pays ⇒ Boolean
5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 5166 class S3CopyObjectOperation < Struct.new( :target_resource, :canned_access_control_list, :access_control_grants, :metadata_directive, :modified_since_constraint, :new_object_metadata, :new_object_tagging, :redirect_location, :requester_pays, :storage_class, :un_modified_since_constraint, :sse_aws_kms_key_id, :target_key_prefix, :object_lock_legal_hold_status, :object_lock_mode, :object_lock_retain_until_date, :bucket_key_enabled, :checksum_algorithm) SENSITIVE = [] include Aws::Structure end |
#sse_aws_kms_key_id ⇒ String
5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 5166 class S3CopyObjectOperation < Struct.new( :target_resource, :canned_access_control_list, :access_control_grants, :metadata_directive, :modified_since_constraint, :new_object_metadata, :new_object_tagging, :redirect_location, :requester_pays, :storage_class, :un_modified_since_constraint, :sse_aws_kms_key_id, :target_key_prefix, :object_lock_legal_hold_status, :object_lock_mode, :object_lock_retain_until_date, :bucket_key_enabled, :checksum_algorithm) SENSITIVE = [] include Aws::Structure end |
#storage_class ⇒ String
5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 5166 class S3CopyObjectOperation < Struct.new( :target_resource, :canned_access_control_list, :access_control_grants, :metadata_directive, :modified_since_constraint, :new_object_metadata, :new_object_tagging, :redirect_location, :requester_pays, :storage_class, :un_modified_since_constraint, :sse_aws_kms_key_id, :target_key_prefix, :object_lock_legal_hold_status, :object_lock_mode, :object_lock_retain_until_date, :bucket_key_enabled, :checksum_algorithm) SENSITIVE = [] include Aws::Structure end |
#target_key_prefix ⇒ String
Specifies the folder prefix that you want the objects to be copied
into. For example, to copy objects into a folder named Folder1
in
the destination bucket, set the TargetKeyPrefix
property to
Folder1
.
5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 5166 class S3CopyObjectOperation < Struct.new( :target_resource, :canned_access_control_list, :access_control_grants, :metadata_directive, :modified_since_constraint, :new_object_metadata, :new_object_tagging, :redirect_location, :requester_pays, :storage_class, :un_modified_since_constraint, :sse_aws_kms_key_id, :target_key_prefix, :object_lock_legal_hold_status, :object_lock_mode, :object_lock_retain_until_date, :bucket_key_enabled, :checksum_algorithm) SENSITIVE = [] include Aws::Structure end |
#target_resource ⇒ String
Specifies the destination bucket Amazon Resource Name (ARN) for the
batch copy operation. For example, to copy objects to a bucket named
destinationBucket
, set the TargetResource
property to
arn:aws:s3:::destinationBucket
.
5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 5166 class S3CopyObjectOperation < Struct.new( :target_resource, :canned_access_control_list, :access_control_grants, :metadata_directive, :modified_since_constraint, :new_object_metadata, :new_object_tagging, :redirect_location, :requester_pays, :storage_class, :un_modified_since_constraint, :sse_aws_kms_key_id, :target_key_prefix, :object_lock_legal_hold_status, :object_lock_mode, :object_lock_retain_until_date, :bucket_key_enabled, :checksum_algorithm) SENSITIVE = [] include Aws::Structure end |
#un_modified_since_constraint ⇒ Time
5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 5166 class S3CopyObjectOperation < Struct.new( :target_resource, :canned_access_control_list, :access_control_grants, :metadata_directive, :modified_since_constraint, :new_object_metadata, :new_object_tagging, :redirect_location, :requester_pays, :storage_class, :un_modified_since_constraint, :sse_aws_kms_key_id, :target_key_prefix, :object_lock_legal_hold_status, :object_lock_mode, :object_lock_retain_until_date, :bucket_key_enabled, :checksum_algorithm) SENSITIVE = [] include Aws::Structure end |