Struct aws_sdk_s3control::types::builders::S3CopyObjectOperationBuilder

#[non_exhaustive]
pub struct S3CopyObjectOperationBuilder { /* private fields */ }

A builder for S3CopyObjectOperation.

Implementations

impl S3CopyObjectOperationBuilder

pub fn target_resource(self, input: impl Into<String>) -> Self

Specifies the destination bucket Amazon Resource Name (ARN) for the batch copy operation.

• General purpose buckets - For example, to copy objects to a general purpose bucket named destinationBucket, set the TargetResource property to arn:aws:s3:::destinationBucket.

• Directory buckets - For example, to copy objects to a directory bucket named destinationBucket in the Availability Zone; identified by the AZ ID usw2-az1, set the TargetResource property to arn:aws:s3express:region:account_id:/bucket/destination_bucket_base_name--usw2-az1--x-s3.

pub fn set_target_resource(self, input: Option<String>) -> Self

Specifies the destination bucket Amazon Resource Name (ARN) for the batch copy operation.

• General purpose buckets - For example, to copy objects to a general purpose bucket named destinationBucket, set the TargetResource property to arn:aws:s3:::destinationBucket.

• Directory buckets - For example, to copy objects to a directory bucket named destinationBucket in the Availability Zone; identified by the AZ ID usw2-az1, set the TargetResource property to arn:aws:s3express:region:account_id:/bucket/destination_bucket_base_name--usw2-az1--x-s3.

pub fn get_target_resource(&self) -> &Option<String>

Specifies the destination bucket Amazon Resource Name (ARN) for the batch copy operation.

• General purpose buckets - For example, to copy objects to a general purpose bucket named destinationBucket, set the TargetResource property to arn:aws:s3:::destinationBucket.

• Directory buckets - For example, to copy objects to a directory bucket named destinationBucket in the Availability Zone; identified by the AZ ID usw2-az1, set the TargetResource property to arn:aws:s3express:region:account_id:/bucket/destination_bucket_base_name--usw2-az1--x-s3.

pub fn canned_access_control_list( self, input: S3CannedAccessControlList ) -> Self

This functionality is not supported by directory buckets.

pub fn set_canned_access_control_list( self, input: Option<S3CannedAccessControlList> ) -> Self

This functionality is not supported by directory buckets.

pub fn get_canned_access_control_list( &self ) -> &Option<S3CannedAccessControlList>

This functionality is not supported by directory buckets.

pub fn access_control_grants(self, input: S3Grant) -> Self

Appends an item to access_control_grants.

To override the contents of this collection use set_access_control_grants.

This functionality is not supported by directory buckets.

pub fn set_access_control_grants(self, input: Option<Vec<S3Grant>>) -> Self

This functionality is not supported by directory buckets.

pub fn get_access_control_grants(&self) -> &Option<Vec<S3Grant>>

This functionality is not supported by directory buckets.

pub fn metadata_directive(self, input: S3MetadataDirective) -> Self

pub fn set_metadata_directive(self, input: Option<S3MetadataDirective>) -> Self

pub fn get_metadata_directive(&self) -> &Option<S3MetadataDirective>

pub fn modified_since_constraint(self, input: DateTime) -> Self

pub fn set_modified_since_constraint(self, input: Option<DateTime>) -> Self

pub fn get_modified_since_constraint(&self) -> &Option<DateTime>

pub fn new_object_metadata(self, input: S3ObjectMetadata) -> Self

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.

pub fn set_new_object_metadata(self, input: Option<S3ObjectMetadata>) -> Self

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.

pub fn get_new_object_metadata(&self) -> &Option<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.

pub fn new_object_tagging(self, input: S3Tag) -> Self

Appends an item to new_object_tagging.

To override the contents of this collection use set_new_object_tagging.

Specifies a list of tags to add to the destination objects after they are copied. If NewObjectTagging is not specified, the tags of the source objects are copied to destination objects by default.

Directory buckets - Tags aren't supported by directory buckets. If your source objects have tags and your destination bucket is a directory bucket, specify an empty tag set in the NewObjectTagging field to prevent copying the source object tags to the directory bucket.

pub fn set_new_object_tagging(self, input: Option<Vec<S3Tag>>) -> Self

Specifies a list of tags to add to the destination objects after they are copied. If NewObjectTagging is not specified, the tags of the source objects are copied to destination objects by default.

Directory buckets - Tags aren't supported by directory buckets. If your source objects have tags and your destination bucket is a directory bucket, specify an empty tag set in the NewObjectTagging field to prevent copying the source object tags to the directory bucket.

pub fn get_new_object_tagging(&self) -> &Option<Vec<S3Tag>>

Specifies a list of tags to add to the destination objects after they are copied. If NewObjectTagging is not specified, the tags of the source objects are copied to destination objects by default.

Directory buckets - Tags aren't supported by directory buckets. If your source objects have tags and your destination bucket is a directory bucket, specify an empty tag set in the NewObjectTagging field to prevent copying the source object tags to the directory bucket.

pub fn redirect_location(self, input: impl Into<String>) -> Self

If the destination bucket is configured as a website, specifies an optional metadata property for website redirects, x-amz-website-redirect-location. Allows webpage redirects if the object copy is accessed through a website endpoint.

This functionality is not supported by directory buckets.

pub fn set_redirect_location(self, input: Option<String>) -> Self

If the destination bucket is configured as a website, specifies an optional metadata property for website redirects, x-amz-website-redirect-location. Allows webpage redirects if the object copy is accessed through a website endpoint.

This functionality is not supported by directory buckets.

pub fn get_redirect_location(&self) -> &Option<String>

If the destination bucket is configured as a website, specifies an optional metadata property for website redirects, x-amz-website-redirect-location. Allows webpage redirects if the object copy is accessed through a website endpoint.

This functionality is not supported by directory buckets.

pub fn requester_pays(self, input: bool) -> Self

This functionality is not supported by directory buckets.

pub fn set_requester_pays(self, input: Option<bool>) -> Self

This functionality is not supported by directory buckets.

pub fn get_requester_pays(&self) -> &Option<bool>

This functionality is not supported by directory buckets.

pub fn storage_class(self, input: S3StorageClass) -> Self

Specify the storage class for the destination objects in a Copy operation.

Directory buckets - This functionality is not supported by directory buckets.

pub fn set_storage_class(self, input: Option<S3StorageClass>) -> Self

Specify the storage class for the destination objects in a Copy operation.

Directory buckets - This functionality is not supported by directory buckets.

pub fn get_storage_class(&self) -> &Option<S3StorageClass>

Specify the storage class for the destination objects in a Copy operation.

Directory buckets - This functionality is not supported by directory buckets.

pub fn un_modified_since_constraint(self, input: DateTime) -> Self

pub fn set_un_modified_since_constraint(self, input: Option<DateTime>) -> Self

pub fn get_un_modified_since_constraint(&self) -> &Option<DateTime>

pub fn sse_aws_kms_key_id(self, input: impl Into<String>) -> Self

This functionality is not supported by directory buckets.

pub fn set_sse_aws_kms_key_id(self, input: Option<String>) -> Self

This functionality is not supported by directory buckets.

pub fn get_sse_aws_kms_key_id(&self) -> &Option<String>

This functionality is not supported by directory buckets.

pub fn target_key_prefix(self, input: impl Into<String>) -> Self

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.

pub fn set_target_key_prefix(self, input: Option<String>) -> Self

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.

pub fn get_target_key_prefix(&self) -> &Option<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.

pub fn object_lock_legal_hold_status( self, input: S3ObjectLockLegalHoldStatus ) -> Self

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

This functionality is not supported by directory buckets.

pub fn set_object_lock_legal_hold_status( self, input: Option<S3ObjectLockLegalHoldStatus> ) -> Self

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

This functionality is not supported by directory buckets.

pub fn get_object_lock_legal_hold_status( &self ) -> &Option<S3ObjectLockLegalHoldStatus>

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

This functionality is not supported by directory buckets.

pub fn object_lock_mode(self, input: S3ObjectLockMode) -> Self

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

This functionality is not supported by directory buckets.

pub fn set_object_lock_mode(self, input: Option<S3ObjectLockMode>) -> Self

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

This functionality is not supported by directory buckets.

pub fn get_object_lock_mode(&self) -> &Option<S3ObjectLockMode>

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

This functionality is not supported by directory buckets.

pub fn object_lock_retain_until_date(self, input: DateTime) -> Self

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

This functionality is not supported by directory buckets.

pub fn set_object_lock_retain_until_date(self, input: Option<DateTime>) -> Self

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

This functionality is not supported by directory buckets.

pub fn get_object_lock_retain_until_date(&self) -> &Option<DateTime>

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

This functionality is not supported by directory buckets.

pub fn bucket_key_enabled(self, input: bool) -> Self

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.

This functionality is not supported by directory buckets.

pub fn set_bucket_key_enabled(self, input: Option<bool>) -> Self

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.

This functionality is not supported by directory buckets.

pub fn get_bucket_key_enabled(&self) -> &Option<bool>

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.

This functionality is not supported by directory buckets.

pub fn checksum_algorithm(self, input: S3ChecksumAlgorithm) -> Self

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.

pub fn set_checksum_algorithm(self, input: Option<S3ChecksumAlgorithm>) -> Self

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.

pub fn get_checksum_algorithm(&self) -> &Option<S3ChecksumAlgorithm>

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.

pub fn build(self) -> S3CopyObjectOperation

Consumes the builder and constructs a S3CopyObjectOperation.

Trait Implementations

impl Clone for S3CopyObjectOperationBuilder

fn clone(&self) -> S3CopyObjectOperationBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for S3CopyObjectOperationBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for S3CopyObjectOperationBuilder

fn default() -> S3CopyObjectOperationBuilder

Returns the “default value” for a type.

impl PartialEq for S3CopyObjectOperationBuilder

fn eq(&self, other: &S3CopyObjectOperationBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for S3CopyObjectOperationBuilder