software.amazon.awssdk.services.qldb.model

Class LedgerEncryptionDescription

java.lang.Object

software.amazon.awssdk.services.qldb.model.LedgerEncryptionDescription

All Implemented Interfaces:

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

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

Information about the encryption of data at rest in an Amazon QLDB ledger. This includes the current status, the key in Key Management Service (KMS), and when the key became inaccessible (in the case of an error).

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LedgerEncryptionDescription.Builder

Method Summary

Modifier and Type	Method and Description
static LedgerEncryptionDescription.Builder	builder()
EncryptionStatus	encryptionStatus() The current state of encryption at rest for the ledger.
String	encryptionStatusAsString() The current state of encryption at rest for the ledger.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	inaccessibleKmsKeyDateTime() The date and time, in epoch time format, when the KMS key first became inaccessible, in the case of an error.
String	kmsKeyArn() The Amazon Resource Name (ARN) of the customer managed KMS key that the ledger uses for encryption at rest.
List<SdkField<?>>	sdkFields()
static Class<? extends LedgerEncryptionDescription.Builder>	serializableBuilderClass()
LedgerEncryptionDescription.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

kmsKeyArn

public final String kmsKeyArn()

The Amazon Resource Name (ARN) of the customer managed KMS key that the ledger uses for encryption at rest. If this parameter is undefined, the ledger uses an Amazon Web Services owned KMS key for encryption.

Returns:

The Amazon Resource Name (ARN) of the customer managed KMS key that the ledger uses for encryption at rest. If this parameter is undefined, the ledger uses an Amazon Web Services owned KMS key for encryption.

encryptionStatus

public final EncryptionStatus encryptionStatus()

The current state of encryption at rest for the ledger. This can be one of the following values:

• ENABLED: Encryption is fully enabled using the specified key.

• UPDATING: The ledger is actively processing the specified key change.

  Key changes in QLDB are asynchronous. The ledger is fully accessible without any performance impact while the key change is being processed. The amount of time it takes to update a key varies depending on the ledger size.

• KMS_KEY_INACCESSIBLE: The specified customer managed KMS key is not accessible, and the ledger is impaired. Either the key was disabled or deleted, or the grants on the key were revoked. When a ledger is impaired, it is not accessible and does not accept any read or write requests.

  An impaired ledger automatically returns to an active state after you restore the grants on the key, or re-enable the key that was disabled. However, deleting a customer managed KMS key is irreversible. After a key is deleted, you can no longer access the ledgers that are protected with that key, and the data becomes unrecoverable permanently.

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

Returns:

The current state of encryption at rest for the ledger. This can be one of the following values:

• ENABLED: Encryption is fully enabled using the specified key.

• UPDATING: The ledger is actively processing the specified key change.

  Key changes in QLDB are asynchronous. The ledger is fully accessible without any performance impact while the key change is being processed. The amount of time it takes to update a key varies depending on the ledger size.

• KMS_KEY_INACCESSIBLE: The specified customer managed KMS key is not accessible, and the ledger is impaired. Either the key was disabled or deleted, or the grants on the key were revoked. When a ledger is impaired, it is not accessible and does not accept any read or write requests.

  An impaired ledger automatically returns to an active state after you restore the grants on the key, or re-enable the key that was disabled. However, deleting a customer managed KMS key is irreversible. After a key is deleted, you can no longer access the ledgers that are protected with that key, and the data becomes unrecoverable permanently.

See Also:

EncryptionStatus

encryptionStatusAsString

public final String encryptionStatusAsString()

The current state of encryption at rest for the ledger. This can be one of the following values:

• ENABLED: Encryption is fully enabled using the specified key.

• UPDATING: The ledger is actively processing the specified key change.

  Key changes in QLDB are asynchronous. The ledger is fully accessible without any performance impact while the key change is being processed. The amount of time it takes to update a key varies depending on the ledger size.

• KMS_KEY_INACCESSIBLE: The specified customer managed KMS key is not accessible, and the ledger is impaired. Either the key was disabled or deleted, or the grants on the key were revoked. When a ledger is impaired, it is not accessible and does not accept any read or write requests.

  An impaired ledger automatically returns to an active state after you restore the grants on the key, or re-enable the key that was disabled. However, deleting a customer managed KMS key is irreversible. After a key is deleted, you can no longer access the ledgers that are protected with that key, and the data becomes unrecoverable permanently.

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

Returns:

The current state of encryption at rest for the ledger. This can be one of the following values:

• ENABLED: Encryption is fully enabled using the specified key.

• UPDATING: The ledger is actively processing the specified key change.

  Key changes in QLDB are asynchronous. The ledger is fully accessible without any performance impact while the key change is being processed. The amount of time it takes to update a key varies depending on the ledger size.

• KMS_KEY_INACCESSIBLE: The specified customer managed KMS key is not accessible, and the ledger is impaired. Either the key was disabled or deleted, or the grants on the key were revoked. When a ledger is impaired, it is not accessible and does not accept any read or write requests.

  An impaired ledger automatically returns to an active state after you restore the grants on the key, or re-enable the key that was disabled. However, deleting a customer managed KMS key is irreversible. After a key is deleted, you can no longer access the ledgers that are protected with that key, and the data becomes unrecoverable permanently.

See Also:

EncryptionStatus

inaccessibleKmsKeyDateTime

public final Instant inaccessibleKmsKeyDateTime()

The date and time, in epoch time format, when the KMS key first became inaccessible, in the case of an error. (Epoch time format is the number of seconds that have elapsed since 12:00:00 AM January 1, 1970 UTC.)

This parameter is undefined if the KMS key is accessible.

Returns:

The date and time, in epoch time format, when the KMS key first became inaccessible, in the case of an error. (Epoch time format is the number of seconds that have elapsed since 12:00:00 AM January 1, 1970 UTC.)

This parameter is undefined if the KMS key is accessible.

toBuilder

public LedgerEncryptionDescription.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<LedgerEncryptionDescription.Builder,LedgerEncryptionDescription>

builder

public static LedgerEncryptionDescription.Builder builder()

serializableBuilderClass

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