Class PutBucketEncryptionRequest

    • Method Detail

      • bucket

        public final 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

        Returns:
        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

      • contentMD5

        public final 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.

        Returns:
        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.

      • checksumAlgorithm

        public final 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.

        If the service returns an enum value that is not available in the current SDK version, checksumAlgorithm will return ChecksumAlgorithm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from checksumAlgorithmAsString().

        Returns:
        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.

        See Also:
        ChecksumAlgorithm
      • checksumAlgorithmAsString

        public final String checksumAlgorithmAsString()

        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.

        If the service returns an enum value that is not available in the current SDK version, checksumAlgorithm will return ChecksumAlgorithm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from checksumAlgorithmAsString().

        Returns:
        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.

        See Also:
        ChecksumAlgorithm
      • serverSideEncryptionConfiguration

        public final ServerSideEncryptionConfiguration serverSideEncryptionConfiguration()
        Returns the value of the ServerSideEncryptionConfiguration property for this object.
        Returns:
        The value of the ServerSideEncryptionConfiguration property for this object.
      • expectedBucketOwner

        public final 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.

        Returns:
        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.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object