qldb_update_ledger: Updates properties on a ledger
In paws.database: 'Amazon Web Services' Database Services
View source: R/qldb_operations.R
qldb_update_ledger R Documentation
Updates properties on a ledger
Description
Updates properties on a ledger.
See https://www.paws-r-sdk.com/docs/qldb_update_ledger/ for full documentation.
Usage
qldb_update_ledger(Name, DeletionProtection = NULL, KmsKey = NULL)
Arguments
Name
[required] The name of the ledger.
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
update_ledger operation to set this parameter to
false.
KmsKey
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.
paws.database documentation built on Sept. 12, 2023, 1:21 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
View source: R/qldb_operations.R
| qldb_update_ledger | R Documentation |
Updates properties on a ledger
Description
Updates properties on a ledger.
See https://www.paws-r-sdk.com/docs/qldb_update_ledger/ for full documentation.
Usage
qldb_update_ledger(Name, DeletionProtection = NULL, KmsKey = NULL)
Arguments
Name |
[required] The name of the ledger. |
DeletionProtection |
Specifies whether the ledger is protected from being deleted by any
user. If not defined during ledger creation, this feature is enabled
( If deletion protection is enabled, you must first disable it before you
can delete the ledger. You can disable it by calling the
|
KmsKey |
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:
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 For example:
For more information, see Key identifiers (KeyId) in the Key Management Service Developer Guide. |
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.