com.amazonaws.services.qldb.model

Class LedgerEncryptionDescription

java.lang.Object

com.amazonaws.services.qldb.model.LedgerEncryptionDescription

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class LedgerEncryptionDescription
extends Object
implements Serializable, Cloneable, StructuredPojo

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
LedgerEncryptionDescription()

Method Summary

Modifier and Type	Method and Description
LedgerEncryptionDescription	clone()
boolean	equals(Object obj)
String	getEncryptionStatus() The current state of encryption at rest for the ledger.
Date	getInaccessibleKmsKeyDateTime() The date and time, in epoch time format, when the KMS key first became inaccessible, in the case of an error.
String	getKmsKeyArn() The Amazon Resource Name (ARN) of the customer managed KMS key that the ledger uses for encryption at rest.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setEncryptionStatus(String encryptionStatus) The current state of encryption at rest for the ledger.
void	setInaccessibleKmsKeyDateTime(Date inaccessibleKmsKeyDateTime) The date and time, in epoch time format, when the KMS key first became inaccessible, in the case of an error.
void	setKmsKeyArn(String kmsKeyArn) The Amazon Resource Name (ARN) of the customer managed KMS key that the ledger uses for encryption at rest.
String	toString() Returns a string representation of this object.
LedgerEncryptionDescription	withEncryptionStatus(EncryptionStatus encryptionStatus) The current state of encryption at rest for the ledger.
LedgerEncryptionDescription	withEncryptionStatus(String encryptionStatus) The current state of encryption at rest for the ledger.
LedgerEncryptionDescription	withInaccessibleKmsKeyDateTime(Date inaccessibleKmsKeyDateTime) The date and time, in epoch time format, when the KMS key first became inaccessible, in the case of an error.
LedgerEncryptionDescription	withKmsKeyArn(String kmsKeyArn) The Amazon Resource Name (ARN) of the customer managed KMS key that the ledger uses for encryption at rest.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

LedgerEncryptionDescription

public LedgerEncryptionDescription()

Method Detail

setKmsKeyArn

public void setKmsKeyArn(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.

Parameters:

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.

getKmsKeyArn

public String getKmsKeyArn()

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.

withKmsKeyArn

public LedgerEncryptionDescription withKmsKeyArn(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setEncryptionStatus

public void setEncryptionStatus(String 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.

Parameters:

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.

See Also:

EncryptionStatus

getEncryptionStatus

public String getEncryptionStatus()

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.

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

withEncryptionStatus

public LedgerEncryptionDescription withEncryptionStatus(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EncryptionStatus

withEncryptionStatus

public LedgerEncryptionDescription withEncryptionStatus(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EncryptionStatus

setInaccessibleKmsKeyDateTime

public void setInaccessibleKmsKeyDateTime(Date 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.

Parameters:

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.

getInaccessibleKmsKeyDateTime

public Date getInaccessibleKmsKeyDateTime()

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.

withInaccessibleKmsKeyDateTime

public LedgerEncryptionDescription withInaccessibleKmsKeyDateTime(Date 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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public LedgerEncryptionDescription clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.