Interface PutBucketEncryptionRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<PutBucketEncryptionRequest.Builder,PutBucketEncryptionRequest>, S3Request.Builder, SdkBuilder<PutBucketEncryptionRequest.Builder,PutBucketEncryptionRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
PutBucketEncryptionRequest
public static interface PutBucketEncryptionRequest.Builder extends S3Request.Builder, SdkPojo, CopyableBuilder<PutBucketEncryptionRequest.Builder,PutBucketEncryptionRequest>

  • Method Details

    • bucket

      PutBucketEncryptionRequest.Builder bucket(String bucket)

      Specifies default encryption for a bucket using server-side encryption with different key options.

      Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must also follow the format bucket_base_name--az_id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide

      Parameters:
      bucket - Specifies default encryption for a bucket using server-side encryption with different key options.

      Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must also follow the format bucket_base_name--az_id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide

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

    • contentMD5

      PutBucketEncryptionRequest.Builder contentMD5(String contentMD5)

      The base64-encoded 128-bit MD5 digest of the server-side encryption configuration.

      For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

      This functionality is not supported for directory buckets.

      Parameters:
      contentMD5 - The base64-encoded 128-bit MD5 digest of the server-side encryption configuration.

      For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

      This functionality is not supported for directory buckets.

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

    • checksumAlgorithm

      PutBucketEncryptionRequest.Builder checksumAlgorithm(String checksumAlgorithm)

      Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

      If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

      For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default checksum algorithm that's used for performance.

      Parameters:
      checksumAlgorithm - Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

      If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

      For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default checksum algorithm that's used for performance.

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

    • checksumAlgorithm

      PutBucketEncryptionRequest.Builder checksumAlgorithm(ChecksumAlgorithm checksumAlgorithm)

      Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

      If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

      For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default checksum algorithm that's used for performance.

      Parameters:
      checksumAlgorithm - Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

      If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

      For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default checksum algorithm that's used for performance.

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

    • serverSideEncryptionConfiguration

      PutBucketEncryptionRequest.Builder serverSideEncryptionConfiguration(ServerSideEncryptionConfiguration serverSideEncryptionConfiguration)
      Sets the value of the ServerSideEncryptionConfiguration property for this object.
      Parameters:
      serverSideEncryptionConfiguration - The new value for the ServerSideEncryptionConfiguration property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serverSideEncryptionConfiguration

      default PutBucketEncryptionRequest.Builder serverSideEncryptionConfiguration(Consumer<ServerSideEncryptionConfiguration.Builder> serverSideEncryptionConfiguration)
      Sets the value of the ServerSideEncryptionConfiguration property for this object. This is a convenience method that creates an instance of the ServerSideEncryptionConfiguration.Builder avoiding the need to create one manually via ServerSideEncryptionConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to serverSideEncryptionConfiguration(ServerSideEncryptionConfiguration).

      Parameters:
      serverSideEncryptionConfiguration - a consumer that will call methods on ServerSideEncryptionConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • expectedBucketOwner

      PutBucketEncryptionRequest.Builder expectedBucketOwner(String expectedBucketOwner)

      The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

      For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code 501 Not Implemented.

      Parameters:
      expectedBucketOwner - The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

      For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code 501 Not Implemented.

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

    • overrideConfiguration

      PutBucketEncryptionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      PutBucketEncryptionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.