Use CreateLedger with an AWS SDK or CLI - AWS SDK Code Examples

There are more AWS SDK examples available in the AWS Doc SDK Examples GitHub repo.

Use CreateLedger with an AWS SDK or CLI

The following code examples show how to use CreateLedger.

CLI
AWS CLI

Example 1: To create a ledger with default properties

The following create-ledger example creates a ledger with the name myExampleLedger and the permissions mode STANDARD. The optional parameters for deletion protection and AWS KMS key are not specified, so they default to true and an AWS owned KMS key respectively.

aws qldb create-ledger \ --name myExampleLedger \ --permissions-mode STANDARD

Output:

{ "State": "CREATING", "Arn": "arn:aws:qldb:us-west-2:123456789012:ledger/myExampleLedger", "DeletionProtection": true, "CreationDateTime": 1568839243.951, "Name": "myExampleLedger", "PermissionsMode": "STANDARD" }

Example 2: To create a ledger with deletion protection disabled, a customer managed KMS key, and specified tags

The following create-ledger example creates a ledger with the name myExampleLedger2 and the permissions mode STANDARD. The deletion protection feature is disabled, the specified customer managed KMS key is used for encryption at rest, and the specified tags are attached to the resource.

aws qldb create-ledger \ --name myExampleLedger2 \ --permissions-mode STANDARD \ --no-deletion-protection \ --kms-key arn:aws:kms:us-west-2:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \ --tags IsTest=true,Domain=Test

Output:

{ "Arn": "arn:aws:qldb:us-west-2:123456789012:ledger/myExampleLedger2", "DeletionProtection": false, "CreationDateTime": 1568839543.557, "State": "CREATING", "Name": "myExampleLedger2", "PermissionsMode": "STANDARD", "KmsKeyArn": "arn:aws:kms:us-west-2:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" }

For more information, see Basic Operations for Amazon QLDB Ledgers in the Amazon QLDB Developer Guide.

  • For API details, see CreateLedger in AWS CLI Command Reference.

Rust
SDK for Rust
Note

There's more on GitHub. Find the complete example and learn how to set up and run in the AWS Code Examples Repository.

async fn make_ledger(client: &Client, ledger: &str) -> Result<(), Error> { let result = client .create_ledger() .name(ledger) .permissions_mode(PermissionsMode::AllowAll) .send() .await?; println!("ARN: {}", result.arn().unwrap()); Ok(()) }
  • For API details, see CreateLedger in AWS SDK for Rust API reference.