qldb_stream_journal_to_kinesis: Creates a journal stream for a given Amazon QLDB ledger
In paws.database: 'Amazon Web Services' Database Services

qldb_stream_journal_to_kinesis

R Documentation

Creates a journal stream for a given Amazon QLDB ledger

Description

Creates a journal stream for a given Amazon QLDB ledger. The stream captures every document revision that is committed to the ledger's journal and delivers the data to a specified Amazon Kinesis Data Streams resource.

See https://www.paws-r-sdk.com/docs/qldb_stream_journal_to_kinesis/ for full documentation.

Usage

qldb_stream_journal_to_kinesis(
  LedgerName,
  RoleArn,
  Tags = NULL,
  InclusiveStartTime,
  ExclusiveEndTime = NULL,
  KinesisConfiguration,
  StreamName
)

Arguments

`LedgerName`	[required] The name of the ledger.
`RoleArn`	[required] 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.
`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.
`InclusiveStartTime`	[required] 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`.
`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`	[required] The configuration settings of the Kinesis Data Streams destination for your stream request.
`StreamName`	[required] 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.