Struct bonsaidb::keystorage::s3::aws_sdk_s3::operation::copy_object::builders::CopyObjectInputBuilder
pub struct CopyObjectInputBuilder { /* private fields */ }
Expand description
A builder for CopyObjectInput
.
Implementations§
§impl CopyObjectInputBuilder
impl CopyObjectInputBuilder
pub fn acl(self, input: ObjectCannedAcl) -> CopyObjectInputBuilder
pub fn acl(self, input: ObjectCannedAcl) -> CopyObjectInputBuilder
The canned ACL to apply to the object.
This action is not supported by Amazon S3 on Outposts.
pub fn set_acl(self, input: Option<ObjectCannedAcl>) -> CopyObjectInputBuilder
pub fn set_acl(self, input: Option<ObjectCannedAcl>) -> CopyObjectInputBuilder
The canned ACL to apply to the object.
This action is not supported by Amazon S3 on Outposts.
pub fn get_acl(&self) -> &Option<ObjectCannedAcl>
pub fn get_acl(&self) -> &Option<ObjectCannedAcl>
The canned ACL to apply to the object.
This action is not supported by Amazon S3 on Outposts.
pub fn bucket(self, input: impl Into<String>) -> CopyObjectInputBuilder
pub fn bucket(self, input: impl Into<String>) -> CopyObjectInputBuilder
The name of the destination bucket.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.
pub fn set_bucket(self, input: Option<String>) -> CopyObjectInputBuilder
pub fn set_bucket(self, input: Option<String>) -> CopyObjectInputBuilder
The name of the destination bucket.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.
pub fn get_bucket(&self) -> &Option<String>
pub fn get_bucket(&self) -> &Option<String>
The name of the destination bucket.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.
pub fn cache_control(self, input: impl Into<String>) -> CopyObjectInputBuilder
pub fn cache_control(self, input: impl Into<String>) -> CopyObjectInputBuilder
Specifies caching behavior along the request/reply chain.
pub fn set_cache_control(self, input: Option<String>) -> CopyObjectInputBuilder
pub fn set_cache_control(self, input: Option<String>) -> CopyObjectInputBuilder
Specifies caching behavior along the request/reply chain.
pub fn get_cache_control(&self) -> &Option<String>
pub fn get_cache_control(&self) -> &Option<String>
Specifies caching behavior along the request/reply chain.
pub fn checksum_algorithm(
self,
input: ChecksumAlgorithm
) -> CopyObjectInputBuilder
pub fn checksum_algorithm( self, input: ChecksumAlgorithm ) -> CopyObjectInputBuilder
Indicates the algorithm you want Amazon S3 to use to create the checksum for the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
pub fn set_checksum_algorithm(
self,
input: Option<ChecksumAlgorithm>
) -> CopyObjectInputBuilder
pub fn set_checksum_algorithm( self, input: Option<ChecksumAlgorithm> ) -> CopyObjectInputBuilder
Indicates the algorithm you want Amazon S3 to use to create the checksum for the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
pub fn get_checksum_algorithm(&self) -> &Option<ChecksumAlgorithm>
pub fn get_checksum_algorithm(&self) -> &Option<ChecksumAlgorithm>
Indicates the algorithm you want Amazon S3 to use to create the checksum for the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
pub fn content_disposition(
self,
input: impl Into<String>
) -> CopyObjectInputBuilder
pub fn content_disposition( self, input: impl Into<String> ) -> CopyObjectInputBuilder
Specifies presentational information for the object.
pub fn set_content_disposition(
self,
input: Option<String>
) -> CopyObjectInputBuilder
pub fn set_content_disposition( self, input: Option<String> ) -> CopyObjectInputBuilder
Specifies presentational information for the object.
pub fn get_content_disposition(&self) -> &Option<String>
pub fn get_content_disposition(&self) -> &Option<String>
Specifies presentational information for the object.
pub fn content_encoding(
self,
input: impl Into<String>
) -> CopyObjectInputBuilder
pub fn content_encoding( self, input: impl Into<String> ) -> CopyObjectInputBuilder
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.
pub fn set_content_encoding(
self,
input: Option<String>
) -> CopyObjectInputBuilder
pub fn set_content_encoding( self, input: Option<String> ) -> CopyObjectInputBuilder
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.
pub fn get_content_encoding(&self) -> &Option<String>
pub fn get_content_encoding(&self) -> &Option<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.
pub fn content_language(
self,
input: impl Into<String>
) -> CopyObjectInputBuilder
pub fn content_language( self, input: impl Into<String> ) -> CopyObjectInputBuilder
The language the content is in.
pub fn set_content_language(
self,
input: Option<String>
) -> CopyObjectInputBuilder
pub fn set_content_language( self, input: Option<String> ) -> CopyObjectInputBuilder
The language the content is in.
pub fn get_content_language(&self) -> &Option<String>
pub fn get_content_language(&self) -> &Option<String>
The language the content is in.
pub fn content_type(self, input: impl Into<String>) -> CopyObjectInputBuilder
pub fn content_type(self, input: impl Into<String>) -> CopyObjectInputBuilder
A standard MIME type describing the format of the object data.
pub fn set_content_type(self, input: Option<String>) -> CopyObjectInputBuilder
pub fn set_content_type(self, input: Option<String>) -> CopyObjectInputBuilder
A standard MIME type describing the format of the object data.
pub fn get_content_type(&self) -> &Option<String>
pub fn get_content_type(&self) -> &Option<String>
A standard MIME type describing the format of the object data.
pub fn copy_source(self, input: impl Into<String>) -> CopyObjectInputBuilder
pub fn copy_source(self, input: impl Into<String>) -> CopyObjectInputBuilder
Specifies the source object for the copy operation. You specify the value in one of two formats, depending on whether you want to access the source object through an access point:
-
For objects not accessed through an access point, specify the name of the source bucket and the key of the source object, separated by a slash (/). For example, to copy the object
reports/january.pdf
from the bucketawsexamplebucket
, useawsexamplebucket/reports/january.pdf
. The value must be URL-encoded. -
For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format
arn:aws:s3:
. For example, to copy the object: :accesspoint/ /object/ reports/january.pdf
through access pointmy-access-point
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf
. The value must be URL encoded.Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same Amazon Web Services Region.
Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format
arn:aws:s3-outposts:
. For example, to copy the object: :outpost/ /object/ reports/january.pdf
through outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf
. The value must be URL-encoded.
To copy a specific version of an object, append ?versionId=
to the value (for example, awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893
). If you don't specify a version ID, Amazon S3 copies the latest version of the source object.
pub fn set_copy_source(self, input: Option<String>) -> CopyObjectInputBuilder
pub fn set_copy_source(self, input: Option<String>) -> CopyObjectInputBuilder
Specifies the source object for the copy operation. You specify the value in one of two formats, depending on whether you want to access the source object through an access point:
-
For objects not accessed through an access point, specify the name of the source bucket and the key of the source object, separated by a slash (/). For example, to copy the object
reports/january.pdf
from the bucketawsexamplebucket
, useawsexamplebucket/reports/january.pdf
. The value must be URL-encoded. -
For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format
arn:aws:s3:
. For example, to copy the object: :accesspoint/ /object/ reports/january.pdf
through access pointmy-access-point
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf
. The value must be URL encoded.Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same Amazon Web Services Region.
Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format
arn:aws:s3-outposts:
. For example, to copy the object: :outpost/ /object/ reports/january.pdf
through outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf
. The value must be URL-encoded.
To copy a specific version of an object, append ?versionId=
to the value (for example, awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893
). If you don't specify a version ID, Amazon S3 copies the latest version of the source object.
pub fn get_copy_source(&self) -> &Option<String>
pub fn get_copy_source(&self) -> &Option<String>
Specifies the source object for the copy operation. You specify the value in one of two formats, depending on whether you want to access the source object through an access point:
-
For objects not accessed through an access point, specify the name of the source bucket and the key of the source object, separated by a slash (/). For example, to copy the object
reports/january.pdf
from the bucketawsexamplebucket
, useawsexamplebucket/reports/january.pdf
. The value must be URL-encoded. -
For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format
arn:aws:s3:
. For example, to copy the object: :accesspoint/ /object/ reports/january.pdf
through access pointmy-access-point
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf
. The value must be URL encoded.Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same Amazon Web Services Region.
Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format
arn:aws:s3-outposts:
. For example, to copy the object: :outpost/ /object/ reports/january.pdf
through outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf
. The value must be URL-encoded.
To copy a specific version of an object, append ?versionId=
to the value (for example, awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893
). If you don't specify a version ID, Amazon S3 copies the latest version of the source object.
pub fn copy_source_if_match(
self,
input: impl Into<String>
) -> CopyObjectInputBuilder
pub fn copy_source_if_match( self, input: impl Into<String> ) -> CopyObjectInputBuilder
Copies the object if its entity tag (ETag) matches the specified tag.
pub fn set_copy_source_if_match(
self,
input: Option<String>
) -> CopyObjectInputBuilder
pub fn set_copy_source_if_match( self, input: Option<String> ) -> CopyObjectInputBuilder
Copies the object if its entity tag (ETag) matches the specified tag.
pub fn get_copy_source_if_match(&self) -> &Option<String>
pub fn get_copy_source_if_match(&self) -> &Option<String>
Copies the object if its entity tag (ETag) matches the specified tag.
pub fn copy_source_if_modified_since(
self,
input: DateTime
) -> CopyObjectInputBuilder
pub fn copy_source_if_modified_since( self, input: DateTime ) -> CopyObjectInputBuilder
Copies the object if it has been modified since the specified time.
pub fn set_copy_source_if_modified_since(
self,
input: Option<DateTime>
) -> CopyObjectInputBuilder
pub fn set_copy_source_if_modified_since( self, input: Option<DateTime> ) -> CopyObjectInputBuilder
Copies the object if it has been modified since the specified time.
pub fn get_copy_source_if_modified_since(&self) -> &Option<DateTime>
pub fn get_copy_source_if_modified_since(&self) -> &Option<DateTime>
Copies the object if it has been modified since the specified time.
pub fn copy_source_if_none_match(
self,
input: impl Into<String>
) -> CopyObjectInputBuilder
pub fn copy_source_if_none_match( self, input: impl Into<String> ) -> CopyObjectInputBuilder
Copies the object if its entity tag (ETag) is different than the specified ETag.
pub fn set_copy_source_if_none_match(
self,
input: Option<String>
) -> CopyObjectInputBuilder
pub fn set_copy_source_if_none_match( self, input: Option<String> ) -> CopyObjectInputBuilder
Copies the object if its entity tag (ETag) is different than the specified ETag.
pub fn get_copy_source_if_none_match(&self) -> &Option<String>
pub fn get_copy_source_if_none_match(&self) -> &Option<String>
Copies the object if its entity tag (ETag) is different than the specified ETag.
pub fn copy_source_if_unmodified_since(
self,
input: DateTime
) -> CopyObjectInputBuilder
pub fn copy_source_if_unmodified_since( self, input: DateTime ) -> CopyObjectInputBuilder
Copies the object if it hasn't been modified since the specified time.
pub fn set_copy_source_if_unmodified_since(
self,
input: Option<DateTime>
) -> CopyObjectInputBuilder
pub fn set_copy_source_if_unmodified_since( self, input: Option<DateTime> ) -> CopyObjectInputBuilder
Copies the object if it hasn't been modified since the specified time.
pub fn get_copy_source_if_unmodified_since(&self) -> &Option<DateTime>
pub fn get_copy_source_if_unmodified_since(&self) -> &Option<DateTime>
Copies the object if it hasn't been modified since the specified time.
pub fn expires(self, input: DateTime) -> CopyObjectInputBuilder
pub fn expires(self, input: DateTime) -> CopyObjectInputBuilder
The date and time at which the object is no longer cacheable.
pub fn set_expires(self, input: Option<DateTime>) -> CopyObjectInputBuilder
pub fn set_expires(self, input: Option<DateTime>) -> CopyObjectInputBuilder
The date and time at which the object is no longer cacheable.
pub fn get_expires(&self) -> &Option<DateTime>
pub fn get_expires(&self) -> &Option<DateTime>
The date and time at which the object is no longer cacheable.
pub fn grant_full_control(
self,
input: impl Into<String>
) -> CopyObjectInputBuilder
pub fn grant_full_control( self, input: impl Into<String> ) -> CopyObjectInputBuilder
Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
This action is not supported by Amazon S3 on Outposts.
pub fn set_grant_full_control(
self,
input: Option<String>
) -> CopyObjectInputBuilder
pub fn set_grant_full_control( self, input: Option<String> ) -> CopyObjectInputBuilder
Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
This action is not supported by Amazon S3 on Outposts.
pub fn get_grant_full_control(&self) -> &Option<String>
pub fn get_grant_full_control(&self) -> &Option<String>
Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
This action is not supported by Amazon S3 on Outposts.
pub fn grant_read(self, input: impl Into<String>) -> CopyObjectInputBuilder
pub fn grant_read(self, input: impl Into<String>) -> CopyObjectInputBuilder
Allows grantee to read the object data and its metadata.
This action is not supported by Amazon S3 on Outposts.
pub fn set_grant_read(self, input: Option<String>) -> CopyObjectInputBuilder
pub fn set_grant_read(self, input: Option<String>) -> CopyObjectInputBuilder
Allows grantee to read the object data and its metadata.
This action is not supported by Amazon S3 on Outposts.
pub fn get_grant_read(&self) -> &Option<String>
pub fn get_grant_read(&self) -> &Option<String>
Allows grantee to read the object data and its metadata.
This action is not supported by Amazon S3 on Outposts.
pub fn grant_read_acp(self, input: impl Into<String>) -> CopyObjectInputBuilder
pub fn grant_read_acp(self, input: impl Into<String>) -> CopyObjectInputBuilder
Allows grantee to read the object ACL.
This action is not supported by Amazon S3 on Outposts.
pub fn set_grant_read_acp(self, input: Option<String>) -> CopyObjectInputBuilder
pub fn set_grant_read_acp(self, input: Option<String>) -> CopyObjectInputBuilder
Allows grantee to read the object ACL.
This action is not supported by Amazon S3 on Outposts.
pub fn get_grant_read_acp(&self) -> &Option<String>
pub fn get_grant_read_acp(&self) -> &Option<String>
Allows grantee to read the object ACL.
This action is not supported by Amazon S3 on Outposts.
pub fn grant_write_acp(self, input: impl Into<String>) -> CopyObjectInputBuilder
pub fn grant_write_acp(self, input: impl Into<String>) -> CopyObjectInputBuilder
Allows grantee to write the ACL for the applicable object.
This action is not supported by Amazon S3 on Outposts.
pub fn set_grant_write_acp(
self,
input: Option<String>
) -> CopyObjectInputBuilder
pub fn set_grant_write_acp( self, input: Option<String> ) -> CopyObjectInputBuilder
Allows grantee to write the ACL for the applicable object.
This action is not supported by Amazon S3 on Outposts.
pub fn get_grant_write_acp(&self) -> &Option<String>
pub fn get_grant_write_acp(&self) -> &Option<String>
Allows grantee to write the ACL for the applicable object.
This action is not supported by Amazon S3 on Outposts.
pub fn key(self, input: impl Into<String>) -> CopyObjectInputBuilder
pub fn key(self, input: impl Into<String>) -> CopyObjectInputBuilder
The key of the destination object.
pub fn set_key(self, input: Option<String>) -> CopyObjectInputBuilder
pub fn set_key(self, input: Option<String>) -> CopyObjectInputBuilder
The key of the destination object.
pub fn metadata(
self,
k: impl Into<String>,
v: impl Into<String>
) -> CopyObjectInputBuilder
pub fn metadata( self, k: impl Into<String>, v: impl Into<String> ) -> CopyObjectInputBuilder
Adds a key-value pair to metadata
.
To override the contents of this collection use set_metadata
.
A map of metadata to store with the object in S3.
pub fn set_metadata(
self,
input: Option<HashMap<String, String, RandomState>>
) -> CopyObjectInputBuilder
pub fn set_metadata( self, input: Option<HashMap<String, String, RandomState>> ) -> CopyObjectInputBuilder
A map of metadata to store with the object in S3.
pub fn get_metadata(&self) -> &Option<HashMap<String, String, RandomState>>
pub fn get_metadata(&self) -> &Option<HashMap<String, String, RandomState>>
A map of metadata to store with the object in S3.
pub fn metadata_directive(
self,
input: MetadataDirective
) -> CopyObjectInputBuilder
pub fn metadata_directive( self, input: MetadataDirective ) -> CopyObjectInputBuilder
Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.
pub fn set_metadata_directive(
self,
input: Option<MetadataDirective>
) -> CopyObjectInputBuilder
pub fn set_metadata_directive( self, input: Option<MetadataDirective> ) -> CopyObjectInputBuilder
Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.
pub fn get_metadata_directive(&self) -> &Option<MetadataDirective>
pub fn get_metadata_directive(&self) -> &Option<MetadataDirective>
Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.
pub fn tagging_directive(
self,
input: TaggingDirective
) -> CopyObjectInputBuilder
pub fn tagging_directive( self, input: TaggingDirective ) -> CopyObjectInputBuilder
Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.
pub fn set_tagging_directive(
self,
input: Option<TaggingDirective>
) -> CopyObjectInputBuilder
pub fn set_tagging_directive( self, input: Option<TaggingDirective> ) -> CopyObjectInputBuilder
Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.
pub fn get_tagging_directive(&self) -> &Option<TaggingDirective>
pub fn get_tagging_directive(&self) -> &Option<TaggingDirective>
Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.
pub fn server_side_encryption(
self,
input: ServerSideEncryption
) -> CopyObjectInputBuilder
pub fn server_side_encryption( self, input: ServerSideEncryption ) -> CopyObjectInputBuilder
The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256
, aws:kms
, aws:kms:dsse
).
pub fn set_server_side_encryption(
self,
input: Option<ServerSideEncryption>
) -> CopyObjectInputBuilder
pub fn set_server_side_encryption( self, input: Option<ServerSideEncryption> ) -> CopyObjectInputBuilder
The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256
, aws:kms
, aws:kms:dsse
).
pub fn get_server_side_encryption(&self) -> &Option<ServerSideEncryption>
pub fn get_server_side_encryption(&self) -> &Option<ServerSideEncryption>
The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256
, aws:kms
, aws:kms:dsse
).
pub fn storage_class(self, input: StorageClass) -> CopyObjectInputBuilder
pub fn storage_class(self, input: StorageClass) -> CopyObjectInputBuilder
If the x-amz-storage-class
header is not used, the copied object will be stored in the STANDARD Storage Class by default. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.
pub fn set_storage_class(
self,
input: Option<StorageClass>
) -> CopyObjectInputBuilder
pub fn set_storage_class( self, input: Option<StorageClass> ) -> CopyObjectInputBuilder
If the x-amz-storage-class
header is not used, the copied object will be stored in the STANDARD Storage Class by default. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.
pub fn get_storage_class(&self) -> &Option<StorageClass>
pub fn get_storage_class(&self) -> &Option<StorageClass>
If the x-amz-storage-class
header is not used, the copied object will be stored in the STANDARD Storage Class by default. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.
pub fn website_redirect_location(
self,
input: impl Into<String>
) -> CopyObjectInputBuilder
pub fn website_redirect_location( self, input: impl Into<String> ) -> CopyObjectInputBuilder
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. This value is unique to each object and is not copied when using the x-amz-metadata-directive
header. Instead, you may opt to provide this header in combination with the directive.
pub fn set_website_redirect_location(
self,
input: Option<String>
) -> CopyObjectInputBuilder
pub fn set_website_redirect_location( self, input: Option<String> ) -> CopyObjectInputBuilder
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. This value is unique to each object and is not copied when using the x-amz-metadata-directive
header. Instead, you may opt to provide this header in combination with the directive.
pub fn get_website_redirect_location(&self) -> &Option<String>
pub fn get_website_redirect_location(&self) -> &Option<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. Amazon S3 stores the value of this header in the object metadata. This value is unique to each object and is not copied when using the x-amz-metadata-directive
header. Instead, you may opt to provide this header in combination with the directive.
pub fn sse_customer_algorithm(
self,
input: impl Into<String>
) -> CopyObjectInputBuilder
pub fn sse_customer_algorithm( self, input: impl Into<String> ) -> CopyObjectInputBuilder
Specifies the algorithm to use to when encrypting the object (for example, AES256).
pub fn set_sse_customer_algorithm(
self,
input: Option<String>
) -> CopyObjectInputBuilder
pub fn set_sse_customer_algorithm( self, input: Option<String> ) -> CopyObjectInputBuilder
Specifies the algorithm to use to when encrypting the object (for example, AES256).
pub fn get_sse_customer_algorithm(&self) -> &Option<String>
pub fn get_sse_customer_algorithm(&self) -> &Option<String>
Specifies the algorithm to use to when encrypting the object (for example, AES256).
pub fn sse_customer_key(
self,
input: impl Into<String>
) -> CopyObjectInputBuilder
pub fn sse_customer_key( self, input: impl Into<String> ) -> CopyObjectInputBuilder
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 S3 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.
pub fn set_sse_customer_key(
self,
input: Option<String>
) -> CopyObjectInputBuilder
pub fn set_sse_customer_key( self, input: Option<String> ) -> CopyObjectInputBuilder
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 S3 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.
pub fn get_sse_customer_key(&self) -> &Option<String>
pub fn get_sse_customer_key(&self) -> &Option<String>
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 S3 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.
pub fn sse_customer_key_md5(
self,
input: impl Into<String>
) -> CopyObjectInputBuilder
pub fn sse_customer_key_md5( self, input: impl Into<String> ) -> CopyObjectInputBuilder
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 that the encryption key was transmitted without error.
pub fn set_sse_customer_key_md5(
self,
input: Option<String>
) -> CopyObjectInputBuilder
pub fn set_sse_customer_key_md5( self, input: Option<String> ) -> CopyObjectInputBuilder
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 that the encryption key was transmitted without error.
pub fn get_sse_customer_key_md5(&self) -> &Option<String>
pub fn get_sse_customer_key_md5(&self) -> &Option<String>
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 that the encryption key was transmitted without error.
pub fn ssekms_key_id(self, input: impl Into<String>) -> CopyObjectInputBuilder
pub fn ssekms_key_id(self, input: impl Into<String>) -> CopyObjectInputBuilder
Specifies the KMS ID (Key ID, Key ARN, or Key Alias) to use for object encryption. All GET and PUT requests for an object protected by KMS will fail if they're not made via SSL or using SigV4. For information about configuring any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 User Guide.
pub fn set_ssekms_key_id(self, input: Option<String>) -> CopyObjectInputBuilder
pub fn set_ssekms_key_id(self, input: Option<String>) -> CopyObjectInputBuilder
Specifies the KMS ID (Key ID, Key ARN, or Key Alias) to use for object encryption. All GET and PUT requests for an object protected by KMS will fail if they're not made via SSL or using SigV4. For information about configuring any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 User Guide.
pub fn get_ssekms_key_id(&self) -> &Option<String>
pub fn get_ssekms_key_id(&self) -> &Option<String>
Specifies the KMS ID (Key ID, Key ARN, or Key Alias) to use for object encryption. All GET and PUT requests for an object protected by KMS will fail if they're not made via SSL or using SigV4. For information about configuring any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 User Guide.
pub fn ssekms_encryption_context(
self,
input: impl Into<String>
) -> CopyObjectInputBuilder
pub fn ssekms_encryption_context( self, input: impl Into<String> ) -> CopyObjectInputBuilder
Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.
pub fn set_ssekms_encryption_context(
self,
input: Option<String>
) -> CopyObjectInputBuilder
pub fn set_ssekms_encryption_context( self, input: Option<String> ) -> CopyObjectInputBuilder
Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.
pub fn get_ssekms_encryption_context(&self) -> &Option<String>
pub fn get_ssekms_encryption_context(&self) -> &Option<String>
Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.
pub fn bucket_key_enabled(self, input: bool) -> CopyObjectInputBuilder
pub fn bucket_key_enabled(self, input: bool) -> CopyObjectInputBuilder
Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Key Management Service (KMS) keys (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 a COPY action doesn’t affect bucket-level settings for S3 Bucket Key.
pub fn set_bucket_key_enabled(
self,
input: Option<bool>
) -> CopyObjectInputBuilder
pub fn set_bucket_key_enabled( self, input: Option<bool> ) -> CopyObjectInputBuilder
Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Key Management Service (KMS) keys (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 a COPY action doesn’t affect bucket-level settings for S3 Bucket Key.
pub fn get_bucket_key_enabled(&self) -> &Option<bool>
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 Key Management Service (KMS) keys (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 a COPY action doesn’t affect bucket-level settings for S3 Bucket Key.
pub fn copy_source_sse_customer_algorithm(
self,
input: impl Into<String>
) -> CopyObjectInputBuilder
pub fn copy_source_sse_customer_algorithm( self, input: impl Into<String> ) -> CopyObjectInputBuilder
Specifies the algorithm to use when decrypting the source object (for example, AES256).
pub fn set_copy_source_sse_customer_algorithm(
self,
input: Option<String>
) -> CopyObjectInputBuilder
pub fn set_copy_source_sse_customer_algorithm( self, input: Option<String> ) -> CopyObjectInputBuilder
Specifies the algorithm to use when decrypting the source object (for example, AES256).
pub fn get_copy_source_sse_customer_algorithm(&self) -> &Option<String>
pub fn get_copy_source_sse_customer_algorithm(&self) -> &Option<String>
Specifies the algorithm to use when decrypting the source object (for example, AES256).
pub fn copy_source_sse_customer_key(
self,
input: impl Into<String>
) -> CopyObjectInputBuilder
pub fn copy_source_sse_customer_key( self, input: impl Into<String> ) -> CopyObjectInputBuilder
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.
pub fn set_copy_source_sse_customer_key(
self,
input: Option<String>
) -> CopyObjectInputBuilder
pub fn set_copy_source_sse_customer_key( self, input: Option<String> ) -> CopyObjectInputBuilder
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.
pub fn get_copy_source_sse_customer_key(&self) -> &Option<String>
pub fn get_copy_source_sse_customer_key(&self) -> &Option<String>
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.
pub fn copy_source_sse_customer_key_md5(
self,
input: impl Into<String>
) -> CopyObjectInputBuilder
pub fn copy_source_sse_customer_key_md5( self, input: impl Into<String> ) -> CopyObjectInputBuilder
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 that the encryption key was transmitted without error.
pub fn set_copy_source_sse_customer_key_md5(
self,
input: Option<String>
) -> CopyObjectInputBuilder
pub fn set_copy_source_sse_customer_key_md5( self, input: Option<String> ) -> CopyObjectInputBuilder
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 that the encryption key was transmitted without error.
pub fn get_copy_source_sse_customer_key_md5(&self) -> &Option<String>
pub fn get_copy_source_sse_customer_key_md5(&self) -> &Option<String>
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 that the encryption key was transmitted without error.
pub fn request_payer(self, input: RequestPayer) -> CopyObjectInputBuilder
pub fn request_payer(self, input: RequestPayer) -> CopyObjectInputBuilder
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination Amazon S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.
pub fn set_request_payer(
self,
input: Option<RequestPayer>
) -> CopyObjectInputBuilder
pub fn set_request_payer( self, input: Option<RequestPayer> ) -> CopyObjectInputBuilder
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination Amazon S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.
pub fn get_request_payer(&self) -> &Option<RequestPayer>
pub fn get_request_payer(&self) -> &Option<RequestPayer>
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination Amazon S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.
pub fn tagging(self, input: impl Into<String>) -> CopyObjectInputBuilder
pub fn tagging(self, input: impl Into<String>) -> CopyObjectInputBuilder
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.
pub fn set_tagging(self, input: Option<String>) -> CopyObjectInputBuilder
pub fn set_tagging(self, input: Option<String>) -> CopyObjectInputBuilder
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.
pub fn get_tagging(&self) -> &Option<String>
pub fn get_tagging(&self) -> &Option<String>
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.
pub fn object_lock_mode(self, input: ObjectLockMode) -> CopyObjectInputBuilder
pub fn object_lock_mode(self, input: ObjectLockMode) -> CopyObjectInputBuilder
The Object Lock mode that you want to apply to the copied object.
pub fn set_object_lock_mode(
self,
input: Option<ObjectLockMode>
) -> CopyObjectInputBuilder
pub fn set_object_lock_mode( self, input: Option<ObjectLockMode> ) -> CopyObjectInputBuilder
The Object Lock mode that you want to apply to the copied object.
pub fn get_object_lock_mode(&self) -> &Option<ObjectLockMode>
pub fn get_object_lock_mode(&self) -> &Option<ObjectLockMode>
The Object Lock mode that you want to apply to the copied object.
pub fn object_lock_retain_until_date(
self,
input: DateTime
) -> CopyObjectInputBuilder
pub fn object_lock_retain_until_date( self, input: DateTime ) -> CopyObjectInputBuilder
The date and time when you want the copied object's Object Lock to expire.
pub fn set_object_lock_retain_until_date(
self,
input: Option<DateTime>
) -> CopyObjectInputBuilder
pub fn set_object_lock_retain_until_date( self, input: Option<DateTime> ) -> CopyObjectInputBuilder
The date and time when you want the copied object's Object Lock to expire.
pub fn get_object_lock_retain_until_date(&self) -> &Option<DateTime>
pub fn get_object_lock_retain_until_date(&self) -> &Option<DateTime>
The date and time when you want the copied object's Object Lock to expire.
pub fn object_lock_legal_hold_status(
self,
input: ObjectLockLegalHoldStatus
) -> CopyObjectInputBuilder
pub fn object_lock_legal_hold_status( self, input: ObjectLockLegalHoldStatus ) -> CopyObjectInputBuilder
Specifies whether you want to apply a legal hold to the copied object.
pub fn set_object_lock_legal_hold_status(
self,
input: Option<ObjectLockLegalHoldStatus>
) -> CopyObjectInputBuilder
pub fn set_object_lock_legal_hold_status( self, input: Option<ObjectLockLegalHoldStatus> ) -> CopyObjectInputBuilder
Specifies whether you want to apply a legal hold to the copied object.
pub fn get_object_lock_legal_hold_status(
&self
) -> &Option<ObjectLockLegalHoldStatus>
pub fn get_object_lock_legal_hold_status( &self ) -> &Option<ObjectLockLegalHoldStatus>
Specifies whether you want to apply a legal hold to the copied object.
pub fn expected_bucket_owner(
self,
input: impl Into<String>
) -> CopyObjectInputBuilder
pub fn expected_bucket_owner( self, input: impl Into<String> ) -> CopyObjectInputBuilder
The account ID of the expected destination bucket owner. If the destination bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden
(access denied).
pub fn set_expected_bucket_owner(
self,
input: Option<String>
) -> CopyObjectInputBuilder
pub fn set_expected_bucket_owner( self, input: Option<String> ) -> CopyObjectInputBuilder
The account ID of the expected destination bucket owner. If the destination bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden
(access denied).
pub fn get_expected_bucket_owner(&self) -> &Option<String>
pub fn get_expected_bucket_owner(&self) -> &Option<String>
The account ID of the expected destination bucket owner. If the destination bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden
(access denied).
pub fn expected_source_bucket_owner(
self,
input: impl Into<String>
) -> CopyObjectInputBuilder
pub fn expected_source_bucket_owner( self, input: impl Into<String> ) -> CopyObjectInputBuilder
The account ID of the expected source bucket owner. If the source bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden
(access denied).
pub fn set_expected_source_bucket_owner(
self,
input: Option<String>
) -> CopyObjectInputBuilder
pub fn set_expected_source_bucket_owner( self, input: Option<String> ) -> CopyObjectInputBuilder
The account ID of the expected source bucket owner. If the source bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden
(access denied).
pub fn get_expected_source_bucket_owner(&self) -> &Option<String>
pub fn get_expected_source_bucket_owner(&self) -> &Option<String>
The account ID of the expected source bucket owner. If the source bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden
(access denied).
pub fn build(self) -> Result<CopyObjectInput, BuildError>
pub fn build(self) -> Result<CopyObjectInput, BuildError>
Consumes the builder and constructs a CopyObjectInput
.
§impl CopyObjectInputBuilder
impl CopyObjectInputBuilder
pub async fn send_with(
self,
client: &Client
) -> impl Future<Output = Result<CopyObjectOutput, SdkError<CopyObjectError, Response<SdkBody>>>>
pub async fn send_with( self, client: &Client ) -> impl Future<Output = Result<CopyObjectOutput, SdkError<CopyObjectError, Response<SdkBody>>>>
Sends a request with this input using the given client.
Trait Implementations§
§impl Clone for CopyObjectInputBuilder
impl Clone for CopyObjectInputBuilder
§fn clone(&self) -> CopyObjectInputBuilder
fn clone(&self) -> CopyObjectInputBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more§impl Debug for CopyObjectInputBuilder
impl Debug for CopyObjectInputBuilder
§impl Default for CopyObjectInputBuilder
impl Default for CopyObjectInputBuilder
§fn default() -> CopyObjectInputBuilder
fn default() -> CopyObjectInputBuilder
§impl PartialEq<CopyObjectInputBuilder> for CopyObjectInputBuilder
impl PartialEq<CopyObjectInputBuilder> for CopyObjectInputBuilder
§fn eq(&self, other: &CopyObjectInputBuilder) -> bool
fn eq(&self, other: &CopyObjectInputBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.