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

Class BlockedEncryptionTypes

java.lang.Object
software.amazon.awssdk.services.s3.model.BlockedEncryptionTypes
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<BlockedEncryptionTypes.Builder,BlockedEncryptionTypes>
@Generated("software.amazon.awssdk:codegen") public final class BlockedEncryptionTypes extends Object implements SdkPojo, Serializable, ToCopyableBuilder<BlockedEncryptionTypes.Builder,BlockedEncryptionTypes>

A bucket-level setting for Amazon S3 general purpose buckets used to prevent the upload of new objects encrypted with the specified server-side encryption type. For example, blocking an encryption type will block PutObject, CopyObject, PostObject, multipart upload, and replication requests to the bucket for objects with the specified encryption type. However, you can continue to read and list any pre-existing objects already encrypted with the specified encryption type. For more information, see Blocking or unblocking SSE-C for a general purpose bucket.

This data type is used with the following actions:

Permissions

You must have the s3:PutEncryptionConfiguration permission to block or unblock an encryption type for a bucket.

You must have the s3:GetEncryptionConfiguration permission to view a bucket's encryption type.

See Also:

  • Method Details

    • encryptionType

      public final List<EncryptionType> encryptionType()

      The object encryption type that you want to block or unblock for an Amazon S3 general purpose bucket.

      Currently, this parameter only supports blocking or unblocking server side encryption with customer-provided keys (SSE-C). For more information about SSE-C, see Using server-side encryption with customer-provided keys (SSE-C).

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEncryptionType() method.

      Returns:
      The object encryption type that you want to block or unblock for an Amazon S3 general purpose bucket.

      Currently, this parameter only supports blocking or unblocking server side encryption with customer-provided keys (SSE-C). For more information about SSE-C, see Using server-side encryption with customer-provided keys (SSE-C).

    • hasEncryptionType

      public final boolean hasEncryptionType()
      For responses, this returns true if the service returned a value for the EncryptionType property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • encryptionTypeAsStrings

      public final List<String> encryptionTypeAsStrings()

      The object encryption type that you want to block or unblock for an Amazon S3 general purpose bucket.

      Currently, this parameter only supports blocking or unblocking server side encryption with customer-provided keys (SSE-C). For more information about SSE-C, see Using server-side encryption with customer-provided keys (SSE-C).

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEncryptionType() method.

      Returns:
      The object encryption type that you want to block or unblock for an Amazon S3 general purpose bucket.

      Currently, this parameter only supports blocking or unblocking server side encryption with customer-provided keys (SSE-C). For more information about SSE-C, see Using server-side encryption with customer-provided keys (SSE-C).

    • toBuilder

      public BlockedEncryptionTypes.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<BlockedEncryptionTypes.Builder,BlockedEncryptionTypes>

    • builder

      public static BlockedEncryptionTypes.Builder builder()

    • serializableBuilderClass

      public static Class<? extends BlockedEncryptionTypes.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)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo