| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.QLDB.StreamJournalToKinesis
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.
Synopsis
- data StreamJournalToKinesis = StreamJournalToKinesis' {}
- newStreamJournalToKinesis :: Text -> Text -> UTCTime -> KinesisConfiguration -> Text -> StreamJournalToKinesis
- streamJournalToKinesis_exclusiveEndTime :: Lens' StreamJournalToKinesis (Maybe UTCTime)
- streamJournalToKinesis_tags :: Lens' StreamJournalToKinesis (Maybe (HashMap Text Text))
- streamJournalToKinesis_ledgerName :: Lens' StreamJournalToKinesis Text
- streamJournalToKinesis_roleArn :: Lens' StreamJournalToKinesis Text
- streamJournalToKinesis_inclusiveStartTime :: Lens' StreamJournalToKinesis UTCTime
- streamJournalToKinesis_kinesisConfiguration :: Lens' StreamJournalToKinesis KinesisConfiguration
- streamJournalToKinesis_streamName :: Lens' StreamJournalToKinesis Text
- data StreamJournalToKinesisResponse = StreamJournalToKinesisResponse' {
- streamId :: Maybe Text
- httpStatus :: Int
- newStreamJournalToKinesisResponse :: Int -> StreamJournalToKinesisResponse
- streamJournalToKinesisResponse_streamId :: Lens' StreamJournalToKinesisResponse (Maybe Text)
- streamJournalToKinesisResponse_httpStatus :: Lens' StreamJournalToKinesisResponse Int
Creating a Request
data StreamJournalToKinesis Source #
See: newStreamJournalToKinesis smart constructor.
Constructors
| StreamJournalToKinesis' | |
Fields
| |
Instances
newStreamJournalToKinesis Source #
Arguments
| :: Text | |
| -> Text | |
| -> UTCTime | |
| -> KinesisConfiguration | |
| -> Text | |
| -> StreamJournalToKinesis |
Create a value of StreamJournalToKinesis with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:exclusiveEndTime:StreamJournalToKinesis', streamJournalToKinesis_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.
$sel:tags:StreamJournalToKinesis', streamJournalToKinesis_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.
$sel:ledgerName:StreamJournalToKinesis', streamJournalToKinesis_ledgerName - The name of the ledger.
$sel:roleArn:StreamJournalToKinesis', streamJournalToKinesis_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.
$sel:inclusiveStartTime:StreamJournalToKinesis', streamJournalToKinesis_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.
$sel:kinesisConfiguration:StreamJournalToKinesis', streamJournalToKinesis_kinesisConfiguration - The configuration settings of the Kinesis Data Streams destination for
your stream request.
$sel:streamName:StreamJournalToKinesis', streamJournalToKinesis_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.
Request Lenses
streamJournalToKinesis_exclusiveEndTime :: Lens' StreamJournalToKinesis (Maybe UTCTime) Source #
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.
streamJournalToKinesis_tags :: Lens' StreamJournalToKinesis (Maybe (HashMap Text Text)) Source #
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.
streamJournalToKinesis_ledgerName :: Lens' StreamJournalToKinesis Text Source #
The name of the ledger.
streamJournalToKinesis_roleArn :: Lens' StreamJournalToKinesis Text Source #
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.
streamJournalToKinesis_inclusiveStartTime :: Lens' StreamJournalToKinesis UTCTime Source #
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.
streamJournalToKinesis_kinesisConfiguration :: Lens' StreamJournalToKinesis KinesisConfiguration Source #
The configuration settings of the Kinesis Data Streams destination for your stream request.
streamJournalToKinesis_streamName :: Lens' StreamJournalToKinesis Text Source #
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.
Destructuring the Response
data StreamJournalToKinesisResponse Source #
See: newStreamJournalToKinesisResponse smart constructor.
Constructors
| StreamJournalToKinesisResponse' | |
Fields
| |
Instances
newStreamJournalToKinesisResponse Source #
Create a value of StreamJournalToKinesisResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:streamId:StreamJournalToKinesisResponse', streamJournalToKinesisResponse_streamId - The UUID (represented in Base62-encoded text) that QLDB assigns to each
QLDB journal stream.
$sel:httpStatus:StreamJournalToKinesisResponse', streamJournalToKinesisResponse_httpStatus - The response's http status code.
Response Lenses
streamJournalToKinesisResponse_streamId :: Lens' StreamJournalToKinesisResponse (Maybe Text) Source #
The UUID (represented in Base62-encoded text) that QLDB assigns to each QLDB journal stream.
streamJournalToKinesisResponse_httpStatus :: Lens' StreamJournalToKinesisResponse Int Source #
The response's http status code.