• Home
• aws.sdk.kotlin
• qldb-jvm
• 1.3.52
• source code
• LedgerEncryptionDescription.kt

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

commonMain.aws.sdk.kotlin.services.qldb.model.LedgerEncryptionDescription.kt Maven / Gradle / Ivy

// Code generated by smithy-kotlin-codegen. DO NOT EDIT!

package aws.sdk.kotlin.services.qldb.model

import aws.smithy.kotlin.runtime.SdkDsl
import aws.smithy.kotlin.runtime.time.Instant

/**
 * 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](https://docs.aws.amazon.com/qldb/latest/developerguide/encryption-at-rest.html) in the *Amazon QLDB Developer Guide*.
 */
public class LedgerEncryptionDescription private constructor(builder: Builder) {
    /**
     * 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.
     */
    public val encryptionStatus: aws.sdk.kotlin.services.qldb.model.EncryptionStatus = requireNotNull(builder.encryptionStatus) { "A non-null value must be provided for encryptionStatus" }
    /**
     * 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.
     */
    public val inaccessibleKmsKeyDateTime: aws.smithy.kotlin.runtime.time.Instant? = builder.inaccessibleKmsKeyDateTime
    /**
     * 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. It will display `AWS_OWNED_KMS_KEY` when updating the ledger's encryption configuration to the Amazon Web Services owned KMS key.
     */
    public val kmsKeyArn: kotlin.String = requireNotNull(builder.kmsKeyArn) { "A non-null value must be provided for kmsKeyArn" }

    public companion object {
        public operator fun invoke(block: Builder.() -> kotlin.Unit): aws.sdk.kotlin.services.qldb.model.LedgerEncryptionDescription = Builder().apply(block).build()
    }

    override fun toString(): kotlin.String = buildString {
        append("LedgerEncryptionDescription(")
        append("encryptionStatus=$encryptionStatus,")
        append("inaccessibleKmsKeyDateTime=$inaccessibleKmsKeyDateTime,")
        append("kmsKeyArn=$kmsKeyArn")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = encryptionStatus.hashCode()
        result = 31 * result + (inaccessibleKmsKeyDateTime?.hashCode() ?: 0)
        result = 31 * result + (kmsKeyArn.hashCode())
        return result
    }

    override fun equals(other: kotlin.Any?): kotlin.Boolean {
        if (this === other) return true
        if (other == null || this::class != other::class) return false

        other as LedgerEncryptionDescription

        if (encryptionStatus != other.encryptionStatus) return false
        if (inaccessibleKmsKeyDateTime != other.inaccessibleKmsKeyDateTime) return false
        if (kmsKeyArn != other.kmsKeyArn) return false

        return true
    }

    public inline fun copy(block: Builder.() -> kotlin.Unit = {}): aws.sdk.kotlin.services.qldb.model.LedgerEncryptionDescription = Builder(this).apply(block).build()

    @SdkDsl
    public class Builder {
        /**
         * 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.
         */
        public var encryptionStatus: aws.sdk.kotlin.services.qldb.model.EncryptionStatus? = null
        /**
         * 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.
         */
        public var inaccessibleKmsKeyDateTime: aws.smithy.kotlin.runtime.time.Instant? = null
        /**
         * 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. It will display `AWS_OWNED_KMS_KEY` when updating the ledger's encryption configuration to the Amazon Web Services owned KMS key.
         */
        public var kmsKeyArn: kotlin.String? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.qldb.model.LedgerEncryptionDescription) : this() {
            this.encryptionStatus = x.encryptionStatus
            this.inaccessibleKmsKeyDateTime = x.inaccessibleKmsKeyDateTime
            this.kmsKeyArn = x.kmsKeyArn
        }

        @PublishedApi
        internal fun build(): aws.sdk.kotlin.services.qldb.model.LedgerEncryptionDescription = LedgerEncryptionDescription(this)

        internal fun correctErrors(): Builder {
            if (encryptionStatus == null) encryptionStatus = EncryptionStatus.SdkUnknown("no value provided")
            if (kmsKeyArn == null) kmsKeyArn = ""
            return this
        }
    }
}