Class EncryptionSettings

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

A structure that contains the encryption configuration for the policy store and child resources.

This data type is used as a request parameter in the CreatePolicyStore operation.

See Also:

  • Method Details

    • kmsEncryptionSettings

      public final KmsEncryptionSettings kmsEncryptionSettings()

      The KMS encryption settings for this policy store to encrypt data with. It will contain the customer-managed KMS key, and a user-defined encryption context.

      Returns:
      The KMS encryption settings for this policy store to encrypt data with. It will contain the customer-managed KMS key, and a user-defined encryption context.

    • defaultValue

      public final Unit defaultValue()

      Use AWS owned encryption keys for encrypting policy store data.

      Returns:
      Use AWS owned encryption keys for encrypting policy store data.

    • toBuilder

      public EncryptionSettings.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<EncryptionSettings.Builder,EncryptionSettings>
      Returns:
      a builder for type T

    • builder

      public static EncryptionSettings.Builder builder()

    • serializableBuilderClass

      public static Class<? extends EncryptionSettings.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)

    • fromKmsEncryptionSettings

      public static EncryptionSettings fromKmsEncryptionSettings(KmsEncryptionSettings kmsEncryptionSettings)
      Create an instance of this class with kmsEncryptionSettings() initialized to the given value.

      The KMS encryption settings for this policy store to encrypt data with. It will contain the customer-managed KMS key, and a user-defined encryption context.

      Parameters:
      kmsEncryptionSettings - The KMS encryption settings for this policy store to encrypt data with. It will contain the customer-managed KMS key, and a user-defined encryption context.

    • fromKmsEncryptionSettings

      public static EncryptionSettings fromKmsEncryptionSettings(Consumer<KmsEncryptionSettings.Builder> kmsEncryptionSettings)
      Create an instance of this class with kmsEncryptionSettings() initialized to the given value.

      The KMS encryption settings for this policy store to encrypt data with. It will contain the customer-managed KMS key, and a user-defined encryption context.

      Parameters:
      kmsEncryptionSettings - The KMS encryption settings for this policy store to encrypt data with. It will contain the customer-managed KMS key, and a user-defined encryption context.

    • fromDefaultValue

      public static EncryptionSettings fromDefaultValue(Unit defaultValue)
      Create an instance of this class with defaultValue() initialized to the given value.

      Use AWS owned encryption keys for encrypting policy store data.

      Parameters:
      defaultValue - Use AWS owned encryption keys for encrypting policy store data.

    • fromDefaultValue

      public static EncryptionSettings fromDefaultValue(Consumer<Unit.Builder> defaultValue)
      Create an instance of this class with defaultValue() initialized to the given value.

      Use AWS owned encryption keys for encrypting policy store data.

      Parameters:
      defaultValue - Use AWS owned encryption keys for encrypting policy store data.

    • type

      public EncryptionSettings.Type type()
      Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be EncryptionSettings.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be EncryptionSettings.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

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