Package software.amazon.awssdk.services.qldb.model

Interface DescribeLedgerResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<DescribeLedgerResponse.Builder,DescribeLedgerResponse>, QldbResponse.Builder, SdkBuilder<DescribeLedgerResponse.Builder,DescribeLedgerResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
DescribeLedgerResponse
public static interface DescribeLedgerResponse.Builder extends QldbResponse.Builder, SdkPojo, CopyableBuilder<DescribeLedgerResponse.Builder,DescribeLedgerResponse>

  • Method Details

    • name

      DescribeLedgerResponse.Builder name(String name)

      The name of the ledger.

      Parameters:
      name - The name of the ledger.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • arn

      DescribeLedgerResponse.Builder arn(String arn)

      The Amazon Resource Name (ARN) for the ledger.

      Parameters:
      arn - The Amazon Resource Name (ARN) for the ledger.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • state

      DescribeLedgerResponse.Builder state(String state)

      The current status of the ledger.

      Parameters:
      state - The current status of the ledger.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • state

      DescribeLedgerResponse.Builder state(LedgerState state)

      The current status of the ledger.

      Parameters:
      state - The current status of the ledger.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • creationDateTime

      DescribeLedgerResponse.Builder creationDateTime(Instant creationDateTime)

      The date and time, in epoch time format, when the ledger was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)

      Parameters:
      creationDateTime - The date and time, in epoch time format, when the ledger was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • permissionsMode

      DescribeLedgerResponse.Builder permissionsMode(String permissionsMode)

      The permissions mode of the ledger.

      Parameters:
      permissionsMode - The permissions mode of the ledger.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • permissionsMode

      DescribeLedgerResponse.Builder permissionsMode(PermissionsMode permissionsMode)

      The permissions mode of the ledger.

      Parameters:
      permissionsMode - The permissions mode of the ledger.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • deletionProtection

      DescribeLedgerResponse.Builder deletionProtection(Boolean deletionProtection)

      Specifies whether the ledger is protected from being deleted by any user. If not defined during ledger creation, this feature is enabled (true) by default.

      If deletion protection is enabled, you must first disable it before you can delete the ledger. You can disable it by calling the UpdateLedger operation to set this parameter to false.

      Parameters:
      deletionProtection - Specifies whether the ledger is protected from being deleted by any user. If not defined during ledger creation, this feature is enabled (true) by default.

      If deletion protection is enabled, you must first disable it before you can delete the ledger. You can disable it by calling the UpdateLedger operation to set this parameter to false.

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

    • encryptionDescription

      DescribeLedgerResponse.Builder encryptionDescription(LedgerEncryptionDescription encryptionDescription)

      Information about the encryption of data at rest in the ledger. This includes the current status, the KMS key, and when the key became inaccessible (in the case of an error). If this parameter is undefined, the ledger uses an Amazon Web Services owned KMS key for encryption.

      Parameters:
      encryptionDescription - Information about the encryption of data at rest in the ledger. This includes the current status, the KMS key, and when the key became inaccessible (in the case of an error). 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.

    • encryptionDescription

      default DescribeLedgerResponse.Builder encryptionDescription(Consumer<LedgerEncryptionDescription.Builder> encryptionDescription)

      Information about the encryption of data at rest in the ledger. This includes the current status, the KMS key, and when the key became inaccessible (in the case of an error). If this parameter is undefined, the ledger uses an Amazon Web Services owned KMS key for encryption.

      This is a convenience method that creates an instance of the LedgerEncryptionDescription.Builder avoiding the need to create one manually via LedgerEncryptionDescription.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to encryptionDescription(LedgerEncryptionDescription).

      Parameters:
      encryptionDescription - a consumer that will call methods on LedgerEncryptionDescription.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: