Class CustomerManagedEncryption
- All Implemented Interfaces:
Serializable,SdkPojo,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:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()The key-value pairs that Amazon Polly includes as the encryption context when it encrypts or decrypts the voice with the key.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) final booleanFor responses, this returns true if the service returned a value for the EncryptionContext property.final inthashCode()final StringThe Amazon Resource Name (ARN) of the key.static Class<? extends CustomerManagedEncryption.Builder> Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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, andkms:Decryptpermissions on the key. To synthesize speech with the voice, you needkms:Decryptpermission 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, andkms:Decryptpermissions on the key. To synthesize speech with the voice, you needkms:Decryptpermission 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 theisEmpty()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
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:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<CustomerManagedEncryption.Builder,CustomerManagedEncryption> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-