Package software.amazon.awssdk.services.keyspaces.model

Class EncryptionSpecification

java.lang.Object

software.amazon.awssdk.services.keyspaces.model.EncryptionSpecification

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<EncryptionSpecification.Builder,EncryptionSpecification>

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

Amazon Keyspaces encrypts and decrypts the table data at rest transparently and integrates with Key Management Service for storing and managing the encryption key. You can choose one of the following KMS keys (KMS keys):

• Amazon Web Services owned key - This is the default encryption type. The key is owned by Amazon Keyspaces (no additional charge).

• Customer managed key - This key is stored in your account and is created, owned, and managed by you. You have full control over the customer managed key (KMS charges apply).

For more information about encryption at rest in Amazon Keyspaces, see Encryption at rest in the Amazon Keyspaces Developer Guide.

For more information about KMS, see KMS management service concepts in the Key Management Service Developer Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EncryptionSpecification.Builder

Method Summary

Modifier and Type	Method	Description
static EncryptionSpecification.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	kmsKeyIdentifier()	The Amazon Resource Name (ARN) of the customer managed KMS key, for example kms_key_identifier:ARN.
List<SdkField<?>>	sdkFields()
static Class<? extends EncryptionSpecification.Builder>	serializableBuilderClass()
EncryptionSpecification.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
EncryptionType	type()	The encryption option specified for the table.
String	typeAsString()	The encryption option specified for the table.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

type

public final EncryptionType type()

The encryption option specified for the table. You can choose one of the following KMS keys (KMS keys):

• type:AWS_OWNED_KMS_KEY - This key is owned by Amazon Keyspaces.

• type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your account and is created, owned, and managed by you. This option requires the kms_key_identifier of the KMS key in Amazon Resource Name (ARN) format as input.

The default is type:AWS_OWNED_KMS_KEY.

For more information, see Encryption at rest in the Amazon Keyspaces Developer Guide.

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

Returns:

The encryption option specified for the table. You can choose one of the following KMS keys (KMS keys):

• type:AWS_OWNED_KMS_KEY - This key is owned by Amazon Keyspaces.

• type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your account and is created, owned, and managed by you. This option requires the kms_key_identifier of the KMS key in Amazon Resource Name (ARN) format as input.

The default is type:AWS_OWNED_KMS_KEY.

For more information, see Encryption at rest in the Amazon Keyspaces Developer Guide.

See Also:

EncryptionType

typeAsString

public final String typeAsString()

The encryption option specified for the table. You can choose one of the following KMS keys (KMS keys):

• type:AWS_OWNED_KMS_KEY - This key is owned by Amazon Keyspaces.

• type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your account and is created, owned, and managed by you. This option requires the kms_key_identifier of the KMS key in Amazon Resource Name (ARN) format as input.

The default is type:AWS_OWNED_KMS_KEY.

For more information, see Encryption at rest in the Amazon Keyspaces Developer Guide.

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

Returns:

The encryption option specified for the table. You can choose one of the following KMS keys (KMS keys):

• type:AWS_OWNED_KMS_KEY - This key is owned by Amazon Keyspaces.

• type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your account and is created, owned, and managed by you. This option requires the kms_key_identifier of the KMS key in Amazon Resource Name (ARN) format as input.

The default is type:AWS_OWNED_KMS_KEY.

For more information, see Encryption at rest in the Amazon Keyspaces Developer Guide.

See Also:

EncryptionType

kmsKeyIdentifier

public final String kmsKeyIdentifier()

The Amazon Resource Name (ARN) of the customer managed KMS key, for example kms_key_identifier:ARN.

Returns:

The Amazon Resource Name (ARN) of the customer managed KMS key, for example kms_key_identifier:ARN.

toBuilder

public EncryptionSpecification.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EncryptionSpecification.Builder,EncryptionSpecification>

builder

public static EncryptionSpecification.Builder builder()

serializableBuilderClass

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