String streamId
The UUID (Base62-encoded text) of the canceled QLDB journal stream.
String name
The name of the ledger that you want to create. The name must be unique among all of the ledgers in your Amazon Web Services account in the current Region.
Naming constraints for ledger names are defined in Quotas in Amazon QLDB in the Amazon QLDB Developer Guide.
Map<K,V> tags
The key-value pairs to add as tags to the ledger that you want to create. Tag keys are case sensitive. Tag values are case sensitive and can be null.
String permissionsMode
The permissions mode to assign to the ledger that you want to create. This parameter can have one of the following values:
ALLOW_ALL: A legacy permissions mode that enables access control with API-level granularity for
ledgers.
This mode allows users who have the SendCommand API permission for this ledger to run all PartiQL
commands (hence, ALLOW_ALL) on any tables in the specified ledger. This mode disregards any
table-level or command-level IAM permissions policies that you create for the ledger.
STANDARD: (Recommended) A permissions mode that enables access control with finer granularity
for ledgers, tables, and PartiQL commands.
By default, this mode denies all user requests to run any PartiQL commands on any tables in this ledger. To allow
PartiQL commands to run, you must create IAM permissions policies for specific table resources and PartiQL
actions, in addition to the SendCommand API permission for the ledger. For information, see Getting started
with the standard permissions mode in the Amazon QLDB Developer Guide.
We strongly recommend using the STANDARD permissions mode to maximize the security of your ledger
data.
Boolean 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 UpdateLedger operation to set this parameter to false.
String 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: By default, use an Amazon Web Services owned KMS key.
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.
String name
The name of the ledger.
String arn
The Amazon Resource Name (ARN) for the ledger.
String state
The current status of the ledger.
Date creationDateTime
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.)
String permissionsMode
The permissions mode of the ledger that you created.
Boolean 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 UpdateLedger operation to set this parameter to false.
String kmsKeyArn
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.
String name
The name of the ledger that you want to delete.
JournalKinesisStreamDescription stream
Information about the QLDB journal stream returned by a DescribeJournalS3Export request.
JournalS3ExportDescription exportDescription
Information about the journal export job returned by a DescribeJournalS3Export request.
String name
The name of the ledger that you want to describe.
String name
The name of the ledger.
String arn
The Amazon Resource Name (ARN) for the ledger.
String state
The current status of the ledger.
Date creationDateTime
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.)
String permissionsMode
The permissions mode of the ledger.
Boolean 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 UpdateLedger operation to set this parameter to false.
LedgerEncryptionDescription encryptionDescription
Information about the encryption of data at rest in the ledger. This includes the current status, the KMS key, and when the key became inaccessible (in the case of an error).
String name
The name of the ledger.
Date inclusiveStartTime
The inclusive start date and time for the range of journal contents to export.
The InclusiveStartTime must be in ISO 8601 date and time format and in Universal
Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z.
The InclusiveStartTime must be before ExclusiveEndTime.
If you provide an InclusiveStartTime that is before the ledger's CreationDateTime,
Amazon QLDB defaults it to the ledger's CreationDateTime.
Date exclusiveEndTime
The exclusive end date and time for the range of journal contents to export.
The ExclusiveEndTime must be in ISO 8601 date and time format and in Universal
Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z.
The ExclusiveEndTime must be less than or equal to the current UTC date and time.
S3ExportConfiguration s3ExportConfiguration
The configuration settings of the Amazon S3 bucket destination for your export request.
String roleArn
The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal export job to do the following:
Write objects into your Amazon S3 bucket.
(Optional) Use your customer managed key in Key Management Service (KMS) for server-side encryption of your exported data.
To pass a role to QLDB when requesting a journal export, you must have permissions to perform the
iam:PassRole action on the IAM role resource. This is required for all journal export requests.
String outputFormat
The output format of your exported journal data. A journal export job can write the data objects in either the text or binary representation of Amazon Ion format, or in JSON Lines text format.
Default: ION_TEXT
In JSON Lines format, each journal block in an exported data object is a valid JSON object that is delimited by a newline. You can use this format to directly integrate JSON exports with analytics tools such as Amazon Athena and Glue because these services can parse newline-delimited JSON automatically.
String exportId
The UUID (represented in Base62-encoded text) that QLDB assigns to each journal export job.
To describe your export request and check the status of the job, you can use ExportId to call
DescribeJournalS3Export.
String name
The name of the ledger.
ValueHolder blockAddress
The location of the block that you want to request. An address is an Amazon Ion structure that has two fields:
strandId and sequenceNo.
For example: {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14}.
ValueHolder digestTipAddress
The latest block location covered by the digest for which to request a proof. An address is an Amazon Ion
structure that has two fields: strandId and sequenceNo.
For example: {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49}.
ValueHolder block
The block data object in Amazon Ion format.
ValueHolder proof
The proof object in Amazon Ion format returned by a GetBlock request. A proof contains the list of
hash values required to recalculate the specified digest using a Merkle tree, starting with the specified block.
String name
The name of the ledger.
ByteBuffer digest
The 256-bit hash value representing the digest returned by a GetDigest request.
ValueHolder digestTipAddress
The latest block location covered by the digest that you requested. An address is an Amazon Ion structure that
has two fields: strandId and sequenceNo.
String name
The name of the ledger.
ValueHolder blockAddress
The block location of the document revision to be verified. An address is an Amazon Ion structure that has two
fields: strandId and sequenceNo.
For example: {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14}.
String documentId
The UUID (represented in Base62-encoded text) of the document to be verified.
ValueHolder digestTipAddress
The latest block location covered by the digest for which to request a proof. An address is an Amazon Ion
structure that has two fields: strandId and sequenceNo.
For example: {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49}.
ValueHolder proof
The proof object in Amazon Ion format returned by a GetRevision request. A proof contains the list
of hash values that are required to recalculate the specified digest using a Merkle tree, starting with the
specified document revision.
ValueHolder revision
The document revision data object in Amazon Ion format.
String parameterName
The name of the invalid parameter.
String ledgerName
The name of the ledger.
Date creationTime
The date and time, in epoch time format, when the QLDB journal stream was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)
Date inclusiveStartTime
The inclusive start date and time from which to start streaming journal data.
Date exclusiveEndTime
The exclusive date and time that specifies when the stream ends. If this parameter is undefined, the stream runs indefinitely until you cancel it.
String roleArn
The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal stream to write data records to a Kinesis Data Streams resource.
String streamId
The UUID (represented in Base62-encoded text) of the QLDB journal stream.
String arn
The Amazon Resource Name (ARN) of the QLDB journal stream.
String status
The current state of the QLDB journal stream.
KinesisConfiguration kinesisConfiguration
The configuration settings of the Amazon Kinesis Data Streams destination for a QLDB journal stream.
String errorCause
The error message that describes the reason that a stream has a status of IMPAIRED or
FAILED. This is not applicable to streams that have other status values.
String streamName
The user-defined name of the QLDB journal stream.
String ledgerName
The name of the ledger.
String exportId
The UUID (represented in Base62-encoded text) of the journal export job.
Date exportCreationTime
The date and time, in epoch time format, when the export job was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)
String status
The current state of the journal export job.
Date inclusiveStartTime
The inclusive start date and time for the range of journal contents that was specified in the original export request.
Date exclusiveEndTime
The exclusive end date and time for the range of journal contents that was specified in the original export request.
S3ExportConfiguration s3ExportConfiguration
String roleArn
The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal export job to do the following:
Write objects into your Amazon Simple Storage Service (Amazon S3) bucket.
(Optional) Use your customer managed key in Key Management Service (KMS) for server-side encryption of your exported data.
String outputFormat
The output format of the exported journal data.
String streamArn
The Amazon Resource Name (ARN) of the Kinesis Data Streams resource.
Boolean aggregationEnabled
Enables QLDB to publish multiple data records in a single Kinesis Data Streams record, increasing the number of records sent per API call.
Default: True
Record aggregation has important implications for processing records and requires de-aggregation in your stream consumer. To learn more, see KPL Key Concepts and Consumer De-aggregation in the Amazon Kinesis Data Streams Developer Guide.
String kmsKeyArn
The Amazon Resource Name (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.
String encryptionStatus
The current state of encryption at rest for the ledger. This can be one of the following values:
ENABLED: Encryption is fully enabled using the specified key.
UPDATING: The ledger is actively processing the specified key change.
Key changes in QLDB are asynchronous. The ledger is fully accessible without any performance impact while the key change is being processed. The amount of time it takes to update a key varies depending on the ledger size.
KMS_KEY_INACCESSIBLE: The specified customer managed KMS key is not accessible, and the ledger is
impaired. Either the key was disabled or deleted, or the grants on the key were revoked. When a ledger is
impaired, it is not accessible and does not accept any read or write requests.
An impaired ledger automatically returns to an active state after you restore the grants on the key, or re-enable the key that was disabled. However, deleting a customer managed KMS key is irreversible. After a key is deleted, you can no longer access the ledgers that are protected with that key, and the data becomes unrecoverable permanently.
Date inaccessibleKmsKeyDateTime
The date and time, in epoch time format, when the KMS key first became inaccessible, in the case of an error. (Epoch time format is the number of seconds that have elapsed since 12:00:00 AM January 1, 1970 UTC.)
This parameter is undefined if the KMS key is accessible.
String resourceType
The type of resource.
String ledgerName
The name of the ledger.
Integer maxResults
The maximum number of results to return in a single ListJournalKinesisStreamsForLedger request. (The
actual number of results returned might be fewer.)
String nextToken
A pagination token, indicating that you want to retrieve the next page of results. If you received a value for
NextToken in the response from a previous ListJournalKinesisStreamsForLedger call, you
should use that value as input here.
List<E> streams
The QLDB journal streams that are currently associated with the given ledger.
String nextToken
If NextToken is empty, the last page of results has been processed and there are no more results to
be retrieved.
If NextToken is not empty, more results are available. To retrieve the next page of results,
use the value of NextToken in a subsequent ListJournalKinesisStreamsForLedger call.
String name
The name of the ledger.
Integer maxResults
The maximum number of results to return in a single ListJournalS3ExportsForLedger request. (The
actual number of results returned might be fewer.)
String nextToken
A pagination token, indicating that you want to retrieve the next page of results. If you received a value for
NextToken in the response from a previous ListJournalS3ExportsForLedger call, then you
should use that value as input here.
List<E> journalS3Exports
The journal export jobs that are currently associated with the specified ledger.
String nextToken
If NextToken is empty, then the last page of results has been processed and there are no more
results to be retrieved.
If NextToken is not empty, then there are more results available. To retrieve the next page
of results, use the value of NextToken in a subsequent ListJournalS3ExportsForLedger
call.
Integer maxResults
The maximum number of results to return in a single ListJournalS3Exports request. (The actual number
of results returned might be fewer.)
String nextToken
A pagination token, indicating that you want to retrieve the next page of results. If you received a value for
NextToken in the response from a previous ListJournalS3Exports call, then you should
use that value as input here.
List<E> journalS3Exports
The journal export jobs for all ledgers that are associated with the current Amazon Web Services account and Region.
String nextToken
If NextToken is empty, then the last page of results has been processed and there are no more
results to be retrieved.
If NextToken is not empty, then there are more results available. To retrieve the next page
of results, use the value of NextToken in a subsequent ListJournalS3Exports call.
Integer maxResults
The maximum number of results to return in a single ListLedgers request. (The actual number of
results returned might be fewer.)
String nextToken
A pagination token, indicating that you want to retrieve the next page of results. If you received a value for
NextToken in the response from a previous ListLedgers call, then you should use that
value as input here.
List<E> ledgers
The ledgers that are associated with the current Amazon Web Services account and Region.
String nextToken
A pagination token, indicating whether there are more results available:
If NextToken is empty, then the last page of results has been processed and there are no more
results to be retrieved.
If NextToken is not empty, then there are more results available. To retrieve the next page
of results, use the value of NextToken in a subsequent ListLedgers call.
String resourceArn
The Amazon Resource Name (ARN) for which to list the tags. For example:
arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger
String objectEncryptionType
The Amazon S3 object encryption type.
To learn more about server-side encryption options in Amazon S3, see Protecting Data Using Server-Side Encryption in the Amazon S3 Developer Guide.
String kmsKeyArn
The Amazon Resource Name (ARN) of a symmetric encryption key in Key Management Service (KMS). Amazon S3 does not support asymmetric KMS keys.
You must provide a KmsKeyArn if you specify SSE_KMS as the
ObjectEncryptionType.
KmsKeyArn is not required if you specify SSE_S3 as the
ObjectEncryptionType.
String bucket
The Amazon S3 bucket name in which a journal export job writes the journal contents.
The bucket name must comply with the Amazon S3 bucket naming conventions. For more information, see Bucket Restrictions and Limitations in the Amazon S3 Developer Guide.
String prefix
The prefix for the Amazon S3 bucket in which a journal export job writes the journal contents.
The prefix must comply with Amazon S3 key naming rules and restrictions. For more information, see Object Key and Metadata in the Amazon S3 Developer Guide.
The following are examples of valid Prefix values:
JournalExports-ForMyLedger/Testing/
JournalExports
My:Tests/
S3EncryptionConfiguration encryptionConfiguration
The encryption settings that are used by a journal export job to write data in an Amazon S3 bucket.
String ledgerName
The name of the ledger.
String roleArn
The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal stream to write data records to a Kinesis Data Streams resource.
To pass a role to QLDB when requesting a journal stream, you must have permissions to perform the
iam:PassRole action on the IAM role resource. This is required for all journal stream requests.
Map<K,V> tags
The key-value pairs to add as tags to the stream that you want to create. Tag keys are case sensitive. Tag values are case sensitive and can be null.
Date inclusiveStartTime
The inclusive start date and time from which to start streaming journal data. This parameter must be in
ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example:
2019-06-13T21:36:34Z.
The InclusiveStartTime cannot be in the future and must be before ExclusiveEndTime.
If you provide an InclusiveStartTime that is before the ledger's CreationDateTime, QLDB
effectively defaults it to the ledger's CreationDateTime.
Date exclusiveEndTime
The exclusive date and time that specifies when the stream ends. If you don't define this parameter, the stream runs indefinitely until you cancel it.
The ExclusiveEndTime must be in ISO 8601 date and time format and in Universal
Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z.
KinesisConfiguration kinesisConfiguration
The configuration settings of the Kinesis Data Streams destination for your stream request.
String streamName
The name that you want to assign to the QLDB journal stream. User-defined names can help identify and indicate the purpose of a stream.
Your stream name must be unique among other active streams for a given ledger. Stream names have the same naming constraints as ledger names, as defined in Quotas in Amazon QLDB in the Amazon QLDB Developer Guide.
String streamId
The UUID (represented in Base62-encoded text) that QLDB assigns to each QLDB journal stream.
String resourceArn
The Amazon Resource Name (ARN) to which you want to add the tags. For example:
arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger
Map<K,V> tags
The key-value pairs to add as tags to the specified QLDB resource. Tag keys are case sensitive. If you specify a key that already exists for the resource, your request fails and returns an error. Tag values are case sensitive and can be null.
String name
The name of the ledger.
String permissionsMode
The permissions mode to assign to the ledger. This parameter can have one of the following values:
ALLOW_ALL: A legacy permissions mode that enables access control with API-level granularity for
ledgers.
This mode allows users who have the SendCommand API permission for this ledger to run all PartiQL
commands (hence, ALLOW_ALL) on any tables in the specified ledger. This mode disregards any
table-level or command-level IAM permissions policies that you create for the ledger.
STANDARD: (Recommended) A permissions mode that enables access control with finer granularity
for ledgers, tables, and PartiQL commands.
By default, this mode denies all user requests to run any PartiQL commands on any tables in this ledger. To allow
PartiQL commands to run, you must create IAM permissions policies for specific table resources and PartiQL
actions, in addition to the SendCommand API permission for the ledger. For information, see Getting started
with the standard permissions mode in the Amazon QLDB Developer Guide.
We strongly recommend using the STANDARD permissions mode to maximize the security of your ledger
data.
String name
The name of the ledger.
Boolean 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 UpdateLedger operation to set this parameter to false.
String 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.
String name
The name of the ledger.
String arn
The Amazon Resource Name (ARN) for the ledger.
String state
The current status of the ledger.
Date creationDateTime
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.)
Boolean 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 UpdateLedger operation to set this parameter to false.
LedgerEncryptionDescription encryptionDescription
Information about the encryption of data at rest in the ledger. This includes the current status, the KMS key, and when the key became inaccessible (in the case of an error).
String ionText
An Amazon Ion plaintext value contained in a ValueHolder structure.
Copyright © 2023. All rights reserved.