Amazon QLDB · JSON Structure

Amazon Qldb Create Ledger Response Structure

CreateLedgerResponse schema from Amazon QLDB API

Type: object Properties: 7
BlockchainDatabaseLedger

CreateLedgerResponse is a JSON Structure definition published by Amazon QLDB, describing 7 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

Name Arn State CreationDateTime PermissionsMode DeletionProtection KmsKeyArn

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-qldb/refs/heads/main/json-structure/amazon-qldb-create-ledger-response-structure.json",
  "name": "CreateLedgerResponse",
  "description": "CreateLedgerResponse schema from Amazon QLDB API",
  "type": "object",
  "properties": {
    "Name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LedgerName"
        },
        {
          "description": "The name of the ledger."
        }
      ]
    },
    "Arn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Arn"
        },
        {
          "description": "The Amazon Resource Name (ARN) for the ledger."
        }
      ]
    },
    "State": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LedgerState"
        },
        {
          "description": "The current status of the ledger."
        }
      ]
    },
    "CreationDateTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "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.)"
        }
      ]
    },
    "PermissionsMode": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PermissionsMode"
        },
        {
          "description": "The permissions mode of the ledger that you created."
        }
      ]
    },
    "DeletionProtection": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DeletionProtection"
        },
        {
          "description": "<p>The flag that prevents a ledger from being deleted by any user. If not provided on ledger creation, this feature is enabled (<code>true</code>) by default.</p> <p>If deletion protection is enabled, you must first disable it before you can delete the ledger. You can disable it by calling the <code>UpdateLedger</code> operation to set the flag to <code>false</code>.</p>"
        }
      ]
    },
    "KmsKeyArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Arn"
        },
        {
          "description": "The 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."
        }
      ]
    }
  }
}