Package software.amazon.awssdk.services.cognitoidentityprovider.model

Class KeyConfigurationType

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

Specifies the key configuration for a user pool. Contains settings for encryption keys used to secure user pool data.

See Also:

  • Method Details

    • keyType

      public final EncryptionKeyType keyType()

      The type of encryption key used for the user pool.

      AWS_OWNED_KEY

      A key owned by Amazon Web Services in Key Management Service.

      CUSTOMER_MANAGED_KEY

      A key managed by the customer in Key Management Service. You must use a multi-region key to enable multi-region replication for a user pool.

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

      Returns:
      The type of encryption key used for the user pool.

      AWS_OWNED_KEY

      A key owned by Amazon Web Services in Key Management Service.

      CUSTOMER_MANAGED_KEY

      A key managed by the customer in Key Management Service. You must use a multi-region key to enable multi-region replication for a user pool.

      See Also:

    • keyTypeAsString

      public final String keyTypeAsString()

      The type of encryption key used for the user pool.

      AWS_OWNED_KEY

      A key owned by Amazon Web Services in Key Management Service.

      CUSTOMER_MANAGED_KEY

      A key managed by the customer in Key Management Service. You must use a multi-region key to enable multi-region replication for a user pool.

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

      Returns:
      The type of encryption key used for the user pool.

      AWS_OWNED_KEY

      A key owned by Amazon Web Services in Key Management Service.

      CUSTOMER_MANAGED_KEY

      A key managed by the customer in Key Management Service. You must use a multi-region key to enable multi-region replication for a user pool.

      See Also:

    • kmsKeyArn

      public final String kmsKeyArn()

      The Amazon Resource Name (ARN) of the KMS key used for encryption. If not specified, Amazon Web Services managed keys are used.

      Returns:
      The Amazon Resource Name (ARN) of the KMS key used for encryption. If not specified, Amazon Web Services managed keys are used.

    • toBuilder

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

    • builder

      public static KeyConfigurationType.Builder builder()

    • serializableBuilderClass

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