Package software.amazon.awssdk.services.s3.model

Class ServerSideEncryptionByDefault

  • All Implemented Interfaces:
    Serializable, SdkPojo, ToCopyableBuilder<ServerSideEncryptionByDefault.Builder,​ServerSideEncryptionByDefault>
    @Generated("software.amazon.awssdk:codegen")
public final class ServerSideEncryptionByDefault
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ServerSideEncryptionByDefault.Builder,​ServerSideEncryptionByDefault>

    Describes the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied. If you don't specify a customer managed key at configuration, Amazon S3 automatically creates an Amazon Web Services KMS key in your Amazon Web Services account the first time that you add an object encrypted with SSE-KMS to a bucket. By default, Amazon S3 uses this KMS key for SSE-KMS. For more information, see PUT Bucket encryption in the Amazon S3 API Reference.

    If you're specifying a customer managed KMS key, we recommend using a fully qualified KMS key ARN. If you use a KMS key alias instead, then KMS resolves the key within the requester’s account. This behavior can result in data that's encrypted with a KMS key that belongs to the requester, and not the bucket owner.

    See Also:
    Serialized Form

    • Method Detail

      • sseAlgorithmAsString

        public final String sseAlgorithmAsString()

        Server-side encryption algorithm to use for the default encryption.

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

        Returns:
        Server-side encryption algorithm to use for the default encryption.
        See Also:
        ServerSideEncryption

      • kmsMasterKeyID

        public final String kmsMasterKeyID()

        Amazon Web Services Key Management Service (KMS) customer Amazon Web Services KMS key ID to use for the default encryption. This parameter is allowed if and only if SSEAlgorithm is set to aws:kms or aws:kms:dsse.

        You can specify the key ID, key alias, or the Amazon Resource Name (ARN) of the KMS key.

        • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

        • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

        • Key Alias: alias/alias-name

        If you use a key ID, you can run into a LogDestination undeliverable error when creating a VPC flow log.

        If you are using encryption with cross-account or Amazon Web Services service operations you must use a fully qualified KMS key ARN. For more information, see Using encryption for cross-account operations.

        Amazon S3 only supports symmetric encryption KMS keys. For more information, see Asymmetric keys in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.

        Returns:
        Amazon Web Services Key Management Service (KMS) customer Amazon Web Services KMS key ID to use for the default encryption. This parameter is allowed if and only if SSEAlgorithm is set to aws:kms or aws:kms:dsse.

        You can specify the key ID, key alias, or the Amazon Resource Name (ARN) of the KMS key.

        • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

        • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

        • Key Alias: alias/alias-name

        If you use a key ID, you can run into a LogDestination undeliverable error when creating a VPC flow log.

        If you are using encryption with cross-account or Amazon Web Services service operations you must use a fully qualified KMS key ARN. For more information, see Using encryption for cross-account operations.

        Amazon S3 only supports symmetric encryption KMS keys. For more information, see Asymmetric keys in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • 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

      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                              Class<T> clazz)