Class CustomerManagedEncryption

java.lang.Object
software.amazon.awssdk.services.polly.model.CustomerManagedEncryption
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CustomerManagedEncryption.Builder,CustomerManagedEncryption>

@Generated("software.amazon.awssdk:codegen") public final class CustomerManagedEncryption extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CustomerManagedEncryption.Builder,CustomerManagedEncryption>

The customer managed key that encrypts your custom voice. If you don't specify a key, Amazon Polly encrypts the voice with an Amazon Web Services owned key.

See Also:
  • Method Details

    • kmsKeyArn

      public final String kmsKeyArn()

      The Amazon Resource Name (ARN) of the key. The key must be a symmetric encryption key in the same Amazon Web Services Region as the voice. To create the voice, you need kms:DescribeKey, kms:GenerateDataKey, and kms:Decrypt permissions on the key. To synthesize speech with the voice, you need kms:Decrypt permission on the key.

      Returns:
      The Amazon Resource Name (ARN) of the key. The key must be a symmetric encryption key in the same Amazon Web Services Region as the voice. To create the voice, you need kms:DescribeKey, kms:GenerateDataKey, and kms:Decrypt permissions on the key. To synthesize speech with the voice, you need kms:Decrypt permission on the key.
    • hasEncryptionContext

      public final boolean hasEncryptionContext()
      For responses, this returns true if the service returned a value for the EncryptionContext 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.
    • encryptionContext

      public final Map<String,String> encryptionContext()

      The key-value pairs that Amazon Polly includes as the encryption context when it encrypts or decrypts the voice with the key. You can use these pairs in key policy conditions. Don't use keys that start with aws:, which are reserved.

      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 hasEncryptionContext() method.

      Returns:
      The key-value pairs that Amazon Polly includes as the encryption context when it encrypts or decrypts the voice with the key. You can use these pairs in key policy conditions. Don't use keys that start with aws:, which are reserved.
    • 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<CustomerManagedEncryption.Builder,CustomerManagedEncryption>
      Returns:
      a builder for type T
    • builder

      public static CustomerManagedEncryption.Builder builder()
    • serializableBuilderClass

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