Class EncryptionConfiguration
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<EncryptionConfiguration.Builder,EncryptionConfiguration>
Specifies the AWS Key Management Service (AWS KMS) key and encryption context used to encrypt a resource at rest. When omitted, Amazon Textract encrypts the resource using an AWS owned key.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()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 inthashCode()final booleanFor responses, this returns true if the service returned a value for the KmsEncryptionContext property.A set of key-value pairs that Amazon Textract includes as the AWS KMS encryption context when encrypting and decrypting the resource.final StringkmsKeyId()The identifier of the AWS KMS key to use for encryption.static Class<? extends EncryptionConfiguration.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
-
kmsKeyId
The identifier of the AWS KMS key to use for encryption. This can be a key ID, key ARN, alias name, or alias ARN.
- Returns:
- The identifier of the AWS KMS key to use for encryption. This can be a key ID, key ARN, alias name, or alias ARN.
-
hasKmsEncryptionContext
public final boolean hasKmsEncryptionContext()For responses, this returns true if the service returned a value for the KmsEncryptionContext 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. -
kmsEncryptionContext
A set of key-value pairs that Amazon Textract includes as the AWS KMS encryption context when encrypting and decrypting the resource.
On
UpdateProjectandUpdateBlueprint, this member is the one exception to replacing a supplied configuration whole. If you omit it, the stored encryption context is kept. To clear a custom encryption context, specify an empty map ({}).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
hasKmsEncryptionContext()method.- Returns:
- A set of key-value pairs that Amazon Textract includes as the AWS KMS encryption context when encrypting
and decrypting the resource.
On
UpdateProjectandUpdateBlueprint, this member is the one exception to replacing a supplied configuration whole. If you omit it, the stored encryption context is kept. To clear a custom encryption context, specify an empty map ({}).
-
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<EncryptionConfiguration.Builder,EncryptionConfiguration> - 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.
-