Class ServerSideEncryptionByDefault

java.lang.Object
software.amazon.awssdk.services.s3.model.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. For more information, see PutBucketEncryption.

  • General purpose buckets - If you don't specify a customer managed key at configuration, Amazon S3 automatically creates an Amazon Web Services KMS key (aws/s3) 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.

  • Directory buckets - Your SSE-KMS configuration can only support 1 customer managed key per directory bucket's lifetime. The Amazon Web Services managed key (aws/s3) isn't supported.

  • Directory buckets - For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS.

See Also:

  • Method Details

    • sseAlgorithm

      public final ServerSideEncryption sseAlgorithm()

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

      For directory buckets, there are only two supported values for server-side encryption: AES256 and aws:kms.

      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.

      For directory buckets, there are only two supported values for server-side encryption: AES256 and aws:kms.

      See Also:

    • sseAlgorithmAsString

      public final String sseAlgorithmAsString()

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

      For directory buckets, there are only two supported values for server-side encryption: AES256 and aws:kms.

      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.

      For directory buckets, there are only two supported values for server-side encryption: AES256 and aws:kms.

      See Also:

    • kmsMasterKeyID

      public final String kmsMasterKeyID()

      Amazon Web Services Key Management Service (KMS) customer managed key ID to use for the default encryption.

      • General purpose buckets - This parameter is allowed if and only if SSEAlgorithm is set to aws:kms or aws:kms:dsse.

      • Directory buckets - This parameter is allowed if and only if SSEAlgorithm is set to aws:kms.

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

      • General purpose buckets - 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. Also, if you use a key ID, you can run into a LogDestination undeliverable error when creating a VPC flow log.

      • Directory buckets - When you specify an KMS customer managed key for encryption in your directory bucket, only use the key ID or key ARN. The key alias format of the KMS key isn't supported.

      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 managed key ID to use for the default encryption.

      • General purpose buckets - This parameter is allowed if and only if SSEAlgorithm is set to aws:kms or aws:kms:dsse.

      • Directory buckets - This parameter is allowed if and only if SSEAlgorithm is set to aws:kms.

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

      • General purpose buckets - 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. Also, if you use a key ID, you can run into a LogDestination undeliverable error when creating a VPC flow log.

      • Directory buckets - When you specify an KMS customer managed key for encryption in your directory bucket, only use the key ID or key ARN. The key alias format of the KMS key isn't supported.

      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.

    • toBuilder

      public ServerSideEncryptionByDefault.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ServerSideEncryptionByDefault.Builder,ServerSideEncryptionByDefault>
      Returns:
      a builder for type T

    • builder

      public static ServerSideEncryptionByDefault.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ServerSideEncryptionByDefault.Builder> serializableBuilderClass()

    • hashCode

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

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.