Interface S3CopyObjectOperation.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<S3CopyObjectOperation.Builder,
,S3CopyObjectOperation> SdkBuilder<S3CopyObjectOperation.Builder,
,S3CopyObjectOperation> SdkPojo
- Enclosing class:
S3CopyObjectOperation
-
Method Summary
Modifier and TypeMethodDescriptionaccessControlGrants
(Collection<S3Grant> accessControlGrants) accessControlGrants
(Consumer<S3Grant.Builder>... accessControlGrants) accessControlGrants
(S3Grant... accessControlGrants) bucketKeyEnabled
(Boolean bucketKeyEnabled) Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Amazon Web Services KMS (SSE-KMS).cannedAccessControlList
(String cannedAccessControlList) cannedAccessControlList
(S3CannedAccessControlList cannedAccessControlList) checksumAlgorithm
(String checksumAlgorithm) Indicates the algorithm that you want Amazon S3 to use to create the checksum.checksumAlgorithm
(S3ChecksumAlgorithm checksumAlgorithm) Indicates the algorithm that you want Amazon S3 to use to create the checksum.metadataDirective
(String metadataDirective) metadataDirective
(S3MetadataDirective metadataDirective) modifiedSinceConstraint
(Instant modifiedSinceConstraint) default S3CopyObjectOperation.Builder
newObjectMetadata
(Consumer<S3ObjectMetadata.Builder> newObjectMetadata) If you don't provide this parameter, Amazon S3 copies all the metadata from the original objects.newObjectMetadata
(S3ObjectMetadata newObjectMetadata) If you don't provide this parameter, Amazon S3 copies all the metadata from the original objects.newObjectTagging
(Collection<S3Tag> newObjectTagging) Specifies a list of tags to add to the destination objects after they are copied.newObjectTagging
(Consumer<S3Tag.Builder>... newObjectTagging) Specifies a list of tags to add to the destination objects after they are copied.newObjectTagging
(S3Tag... newObjectTagging) Specifies a list of tags to add to the destination objects after they are copied.objectLockLegalHoldStatus
(String objectLockLegalHoldStatus) The legal hold status to be applied to all objects in the Batch Operations job.objectLockLegalHoldStatus
(S3ObjectLockLegalHoldStatus objectLockLegalHoldStatus) The legal hold status to be applied to all objects in the Batch Operations job.objectLockMode
(String objectLockMode) The retention mode to be applied to all objects in the Batch Operations job.objectLockMode
(S3ObjectLockMode objectLockMode) The retention mode to be applied to all objects in the Batch Operations job.objectLockRetainUntilDate
(Instant objectLockRetainUntilDate) The date when the applied object retention configuration expires on all objects in the Batch Operations job.redirectLocation
(String redirectLocation) If the destination bucket is configured as a website, specifies an optional metadata property for website redirects,x-amz-website-redirect-location
.requesterPays
(Boolean requesterPays) sseAwsKmsKeyId
(String sseAwsKmsKeyId) storageClass
(String storageClass) Specify the storage class for the destination objects in aCopy
operation.storageClass
(S3StorageClass storageClass) Specify the storage class for the destination objects in aCopy
operation.targetKeyPrefix
(String targetKeyPrefix) Specifies the folder prefix that you want the objects to be copied into.targetResource
(String targetResource) Specifies the destination bucket Amazon Resource Name (ARN) for the batch copy operation.unModifiedSinceConstraint
(Instant unModifiedSinceConstraint) Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
targetResource
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 theTargetResource
property toarn:aws:s3:::destinationBucket
. -
Directory buckets - For example, to copy objects to a directory bucket named
destinationBucket
in the Availability Zone; identified by the AZ IDusw2-az2
, set theTargetResource
property toarn:aws:s3express:region:account_id:/bucket/destination_bucket_base_name--usw2-az2--x-s3
.
- Parameters:
targetResource
- 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 theTargetResource
property toarn:aws:s3:::destinationBucket
. -
Directory buckets - For example, to copy objects to a directory bucket named
destinationBucket
in the Availability Zone; identified by the AZ IDusw2-az2
, set theTargetResource
property toarn:aws:s3express:region:account_id:/bucket/destination_bucket_base_name--usw2-az2--x-s3
.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
cannedAccessControlList
This functionality is not supported by directory buckets.
- Parameters:
cannedAccessControlList
-This functionality is not supported by directory buckets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
cannedAccessControlList
S3CopyObjectOperation.Builder cannedAccessControlList(S3CannedAccessControlList cannedAccessControlList) This functionality is not supported by directory buckets.
- Parameters:
cannedAccessControlList
-This functionality is not supported by directory buckets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
accessControlGrants
This functionality is not supported by directory buckets.
- Parameters:
accessControlGrants
-This functionality is not supported by directory buckets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
accessControlGrants
This functionality is not supported by directory buckets.
- Parameters:
accessControlGrants
-This functionality is not supported by directory buckets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
accessControlGrants
This functionality is not supported by directory buckets.
S3Grant.Builder
avoiding the need to create one manually viaS3Grant.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toaccessControlGrants(List<S3Grant>)
.- Parameters:
accessControlGrants
- a consumer that will call methods onS3Grant.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
metadataDirective
- Parameters:
metadataDirective
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
metadataDirective
- Parameters:
metadataDirective
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
modifiedSinceConstraint
- Parameters:
modifiedSinceConstraint
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
newObjectMetadata
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.
- Parameters:
newObjectMetadata
- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
newObjectMetadata
default S3CopyObjectOperation.Builder newObjectMetadata(Consumer<S3ObjectMetadata.Builder> newObjectMetadata) 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.
This is a convenience method that creates an instance of theS3ObjectMetadata.Builder
avoiding the need to create one manually viaS3ObjectMetadata.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tonewObjectMetadata(S3ObjectMetadata)
.- Parameters:
newObjectMetadata
- a consumer that will call methods onS3ObjectMetadata.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
newObjectTagging
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.- Parameters:
newObjectTagging
- Specifies a list of tags to add to the destination objects after they are copied. IfNewObjectTagging
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
newObjectTagging
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.- Parameters:
newObjectTagging
- Specifies a list of tags to add to the destination objects after they are copied. IfNewObjectTagging
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
newObjectTagging
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.S3Tag.Builder
avoiding the need to create one manually viaS3Tag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tonewObjectTagging(List<S3Tag>)
.- Parameters:
newObjectTagging
- a consumer that will call methods onS3Tag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
redirectLocation
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.
- Parameters:
redirectLocation
- 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
requesterPays
This functionality is not supported by directory buckets.
- Parameters:
requesterPays
-This functionality is not supported by directory buckets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
storageClass
Specify the storage class for the destination objects in a
Copy
operation.Directory buckets - This functionality is not supported by directory buckets.
- Parameters:
storageClass
- Specify the storage class for the destination objects in aCopy
operation.Directory buckets - This functionality is not supported by directory buckets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
storageClass
Specify the storage class for the destination objects in a
Copy
operation.Directory buckets - This functionality is not supported by directory buckets.
- Parameters:
storageClass
- Specify the storage class for the destination objects in aCopy
operation.Directory buckets - This functionality is not supported by directory buckets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
unModifiedSinceConstraint
- Parameters:
unModifiedSinceConstraint
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sseAwsKmsKeyId
This functionality is not supported by directory buckets.
- Parameters:
sseAwsKmsKeyId
-This functionality is not supported by directory buckets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
targetKeyPrefix
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 theTargetKeyPrefix
property toFolder1
.- Parameters:
targetKeyPrefix
- Specifies the folder prefix that you want the objects to be copied into. For example, to copy objects into a folder namedFolder1
in the destination bucket, set theTargetKeyPrefix
property toFolder1
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
objectLockLegalHoldStatus
The legal hold status to be applied to all objects in the Batch Operations job.
This functionality is not supported by directory buckets.
- Parameters:
objectLockLegalHoldStatus
- The legal hold status to be applied to all objects in the Batch Operations job.This functionality is not supported by directory buckets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
objectLockLegalHoldStatus
S3CopyObjectOperation.Builder objectLockLegalHoldStatus(S3ObjectLockLegalHoldStatus objectLockLegalHoldStatus) The legal hold status to be applied to all objects in the Batch Operations job.
This functionality is not supported by directory buckets.
- Parameters:
objectLockLegalHoldStatus
- The legal hold status to be applied to all objects in the Batch Operations job.This functionality is not supported by directory buckets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
objectLockMode
The retention mode to be applied to all objects in the Batch Operations job.
This functionality is not supported by directory buckets.
- Parameters:
objectLockMode
- The retention mode to be applied to all objects in the Batch Operations job.This functionality is not supported by directory buckets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
objectLockMode
The retention mode to be applied to all objects in the Batch Operations job.
This functionality is not supported by directory buckets.
- Parameters:
objectLockMode
- The retention mode to be applied to all objects in the Batch Operations job.This functionality is not supported by directory buckets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
objectLockRetainUntilDate
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.
- Parameters:
objectLockRetainUntilDate
- 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
bucketKeyEnabled
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.
- Parameters:
bucketKeyEnabled
- 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 totrue
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
checksumAlgorithm
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.
- Parameters:
checksumAlgorithm
- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
checksumAlgorithm
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.
- Parameters:
checksumAlgorithm
- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-