Class: Aws::QLDB::Types::UpdateLedgerRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-qldb/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#deletion_protection ⇒ Boolean

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:

  • (Boolean) 


1582
1583
1584
1585
1586
1587
1588
 
# File 'lib/aws-sdk-qldb/types.rb', line 1582

class UpdateLedgerRequest < Struct.new(
  :name,
  :deletion_protection,
  :kms_key)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key ⇒ String

The key in Key Management Service (KMS) to use for encryption of data at rest in the ledger. For more information, see [Encryption at rest] in the *Amazon QLDB Developer Guide*.

Use one of the following options to specify this parameter:

  • ‘AWS_OWNED_KMS_KEY`: Use an KMS key that is owned and managed by Amazon Web Services on your behalf.

  • Undefined: Make no changes to the KMS key of the ledger.

  • **A valid symmetric customer managed KMS key**: Use the specified symmetric encryption KMS key in your account that you create, own, and manage.

    Amazon QLDB does not support asymmetric keys. For more information, see [Using symmetric and asymmetric keys] in the *Key Management Service Developer Guide*.

To specify a customer managed KMS key, you can use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with ‘“alias/”`. To specify a key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

  • Key ID: ‘1234abcd-12ab-34cd-56ef-1234567890ab`

  • Key ARN: ‘arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`

  • Alias name: ‘alias/ExampleAlias`

  • Alias ARN: ‘arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`

For more information, see [Key identifiers (KeyId)] in the *Key Management Service Developer Guide*.

[1]: docs.aws.amazon.com/qldb/latest/developerguide/encryption-at-rest.html [2]: docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html [3]: docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id

Returns:

  • (String) 


1582
1583
1584
1585
1586
1587
1588
 
# File 'lib/aws-sdk-qldb/types.rb', line 1582

class UpdateLedgerRequest < Struct.new(
  :name,
  :deletion_protection,
  :kms_key)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the ledger.

Returns:

  • (String) 


1582
1583
1584
1585
1586
1587
1588
 
# File 'lib/aws-sdk-qldb/types.rb', line 1582

class UpdateLedgerRequest < Struct.new(
  :name,
  :deletion_protection,
  :kms_key)
  SENSITIVE = []
  include Aws::Structure
end