Package software.amazon.awssdk.services.s3control.model

Interface S3CopyObjectOperation.Builder

    • Method Detail

      • targetResource

        S3CopyObjectOperation.Builder targetResource​(String 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 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-az2, set the TargetResource property to arn: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 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-az2 , set the TargetResource property to arn: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.

      • accessControlGrants

        S3CopyObjectOperation.Builder accessControlGrants​(Collection<S3Grant> 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

        S3CopyObjectOperation.Builder accessControlGrants​(S3Grant... 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

        S3CopyObjectOperation.Builder accessControlGrants​(Consumer<S3Grant.Builder>... accessControlGrants)

        This functionality is not supported by directory buckets.

        This is a convenience method that creates an instance of the S3Grant.Builder avoiding the need to create one manually via S3Grant.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #accessControlGrants(List).

        Parameters:
        accessControlGrants - a consumer that will call methods on S3Grant.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #accessControlGrants(java.util.Collection)

      • modifiedSinceConstraint

        S3CopyObjectOperation.Builder modifiedSinceConstraint​(Instant modifiedSinceConstraint)

        Parameters:
        modifiedSinceConstraint -
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • newObjectMetadata

        S3CopyObjectOperation.Builder newObjectMetadata​(S3ObjectMetadata 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.

      • newObjectTagging

        S3CopyObjectOperation.Builder newObjectTagging​(Collection<S3Tag> 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. 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • newObjectTagging

        S3CopyObjectOperation.Builder newObjectTagging​(S3Tag... 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. 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • newObjectTagging

        S3CopyObjectOperation.Builder newObjectTagging​(Consumer<S3Tag.Builder>... 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.

        This is a convenience method that creates an instance of the S3Tag.Builder avoiding the need to create one manually via S3Tag.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #newObjectTagging(List).

        Parameters:
        newObjectTagging - a consumer that will call methods on S3Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #newObjectTagging(java.util.Collection)

      • redirectLocation

        S3CopyObjectOperation.Builder 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. 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

        S3CopyObjectOperation.Builder requesterPays​(Boolean 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

        S3CopyObjectOperation.Builder storageClass​(String 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 a Copy 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:
        S3StorageClass, S3StorageClass

      • storageClass

        S3CopyObjectOperation.Builder storageClass​(S3StorageClass 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 a Copy 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:
        S3StorageClass, S3StorageClass

      • unModifiedSinceConstraint

        S3CopyObjectOperation.Builder unModifiedSinceConstraint​(Instant unModifiedSinceConstraint)

        Parameters:
        unModifiedSinceConstraint -
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sseAwsKmsKeyId

        S3CopyObjectOperation.Builder sseAwsKmsKeyId​(String 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

        S3CopyObjectOperation.Builder targetKeyPrefix​(String 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 the TargetKeyPrefix property to Folder1.

        Parameters:
        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 the TargetKeyPrefix property to Folder1.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • objectLockLegalHoldStatus

        S3CopyObjectOperation.Builder objectLockLegalHoldStatus​(String 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:
        S3ObjectLockLegalHoldStatus, S3ObjectLockLegalHoldStatus

      • 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:
        S3ObjectLockLegalHoldStatus, S3ObjectLockLegalHoldStatus

      • objectLockMode

        S3CopyObjectOperation.Builder objectLockMode​(String 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:
        S3ObjectLockMode, S3ObjectLockMode

      • objectLockMode

        S3CopyObjectOperation.Builder objectLockMode​(S3ObjectLockMode 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:
        S3ObjectLockMode, S3ObjectLockMode

      • objectLockRetainUntilDate

        S3CopyObjectOperation.Builder objectLockRetainUntilDate​(Instant 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

        S3CopyObjectOperation.Builder 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). 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 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.