Amazon QLDB · JSON Structure

Amazon Qldb S3Export Configuration Structure

The Amazon Simple Storage Service (Amazon S3) bucket location in which a journal export job writes the journal contents.

Type: object Properties: 3 Required: 3
BlockchainDatabaseLedger

S3ExportConfiguration is a JSON Structure definition published by Amazon QLDB, describing 3 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

Bucket Prefix EncryptionConfiguration

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-s3export-configuration-structure.json",
  "name": "S3ExportConfiguration",
  "description": "The Amazon Simple Storage Service (Amazon S3) bucket location in which a journal export job writes the journal contents.",
  "type": "object",
  "properties": {
    "Bucket": {
      "allOf": [
        {
          "$ref": "#/components/schemas/S3Bucket"
        },
        {
          "description": "<p>The Amazon S3 bucket name in which a journal export job writes the journal contents.</p> <p>The bucket name must comply with the Amazon S3 bucket naming conventions. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html\">Bucket Restrictions and Limitations</a> in the <i>Amazon S3 Developer Guide</i>.</p>"
        }
      ]
    },
    "Prefix": {
      "allOf": [
        {
          "$ref": "#/components/schemas/S3Prefix"
        },
        {
          "description": "<p>The prefix for the Amazon S3 bucket in which a journal export job writes the journal contents.</p> <p>The prefix must comply with Amazon S3 key naming rules and restrictions. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html\">Object Key and Metadata</a> in the <i>Amazon S3 Developer Guide</i>.</p> <p>The following are examples of valid <code>Prefix</code> values:</p> <ul> <li> <p> <code>JournalExports-ForMyLedger/Testing/</code> </p> </li> <li> <p> <code>JournalExports</code> </p> </li> <li> <p> <code>My:Tests/</code> </p> </li> </ul>"
        }
      ]
    },
    "EncryptionConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/S3EncryptionConfiguration"
        },
        {
          "description": "The encryption settings that are used by a journal export job to write data in an Amazon S3 bucket."
        }
      ]
    }
  },
  "required": [
    "Bucket",
    "Prefix",
    "EncryptionConfiguration"
  ]
}