Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data KinesisStreamingSourceOptions = KinesisStreamingSourceOptions' {
- addIdleTimeBetweenReads :: Maybe Bool
- avoidEmptyBatches :: Maybe Bool
- classification :: Maybe Text
- delimiter :: Maybe Text
- describeShardInterval :: Maybe Natural
- endpointUrl :: Maybe Text
- idleTimeBetweenReadsInMs :: Maybe Natural
- maxFetchRecordsPerShard :: Maybe Natural
- maxFetchTimeInMs :: Maybe Natural
- maxRecordPerRead :: Maybe Natural
- maxRetryIntervalMs :: Maybe Natural
- numRetries :: Maybe Natural
- retryIntervalMs :: Maybe Natural
- roleArn :: Maybe Text
- roleSessionName :: Maybe Text
- startingPosition :: Maybe StartingPosition
- streamArn :: Maybe Text
- streamName :: Maybe Text
- newKinesisStreamingSourceOptions :: KinesisStreamingSourceOptions
- kinesisStreamingSourceOptions_addIdleTimeBetweenReads :: Lens' KinesisStreamingSourceOptions (Maybe Bool)
- kinesisStreamingSourceOptions_avoidEmptyBatches :: Lens' KinesisStreamingSourceOptions (Maybe Bool)
- kinesisStreamingSourceOptions_classification :: Lens' KinesisStreamingSourceOptions (Maybe Text)
- kinesisStreamingSourceOptions_delimiter :: Lens' KinesisStreamingSourceOptions (Maybe Text)
- kinesisStreamingSourceOptions_describeShardInterval :: Lens' KinesisStreamingSourceOptions (Maybe Natural)
- kinesisStreamingSourceOptions_endpointUrl :: Lens' KinesisStreamingSourceOptions (Maybe Text)
- kinesisStreamingSourceOptions_idleTimeBetweenReadsInMs :: Lens' KinesisStreamingSourceOptions (Maybe Natural)
- kinesisStreamingSourceOptions_maxFetchRecordsPerShard :: Lens' KinesisStreamingSourceOptions (Maybe Natural)
- kinesisStreamingSourceOptions_maxFetchTimeInMs :: Lens' KinesisStreamingSourceOptions (Maybe Natural)
- kinesisStreamingSourceOptions_maxRecordPerRead :: Lens' KinesisStreamingSourceOptions (Maybe Natural)
- kinesisStreamingSourceOptions_maxRetryIntervalMs :: Lens' KinesisStreamingSourceOptions (Maybe Natural)
- kinesisStreamingSourceOptions_numRetries :: Lens' KinesisStreamingSourceOptions (Maybe Natural)
- kinesisStreamingSourceOptions_retryIntervalMs :: Lens' KinesisStreamingSourceOptions (Maybe Natural)
- kinesisStreamingSourceOptions_roleArn :: Lens' KinesisStreamingSourceOptions (Maybe Text)
- kinesisStreamingSourceOptions_roleSessionName :: Lens' KinesisStreamingSourceOptions (Maybe Text)
- kinesisStreamingSourceOptions_startingPosition :: Lens' KinesisStreamingSourceOptions (Maybe StartingPosition)
- kinesisStreamingSourceOptions_streamArn :: Lens' KinesisStreamingSourceOptions (Maybe Text)
- kinesisStreamingSourceOptions_streamName :: Lens' KinesisStreamingSourceOptions (Maybe Text)
Documentation
data KinesisStreamingSourceOptions Source #
Additional options for the Amazon Kinesis streaming data source.
See: newKinesisStreamingSourceOptions
smart constructor.
KinesisStreamingSourceOptions' | |
|
Instances
newKinesisStreamingSourceOptions :: KinesisStreamingSourceOptions Source #
Create a value of KinesisStreamingSourceOptions
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:addIdleTimeBetweenReads:KinesisStreamingSourceOptions'
, kinesisStreamingSourceOptions_addIdleTimeBetweenReads
- Adds a time delay between two consecutive getRecords operations. The
default value is "False"
. This option is only configurable for Glue
version 2.0 and above.
$sel:avoidEmptyBatches:KinesisStreamingSourceOptions'
, kinesisStreamingSourceOptions_avoidEmptyBatches
- Avoids creating an empty microbatch job by checking for unread data in
the Kinesis data stream before the batch is started. The default value
is "False"
.
$sel:classification:KinesisStreamingSourceOptions'
, kinesisStreamingSourceOptions_classification
- An optional classification.
$sel:delimiter:KinesisStreamingSourceOptions'
, kinesisStreamingSourceOptions_delimiter
- Specifies the delimiter character.
$sel:describeShardInterval:KinesisStreamingSourceOptions'
, kinesisStreamingSourceOptions_describeShardInterval
- The minimum time interval between two ListShards API calls for your
script to consider resharding. The default value is 1s
.
$sel:endpointUrl:KinesisStreamingSourceOptions'
, kinesisStreamingSourceOptions_endpointUrl
- The URL of the Kinesis endpoint.
$sel:idleTimeBetweenReadsInMs:KinesisStreamingSourceOptions'
, kinesisStreamingSourceOptions_idleTimeBetweenReadsInMs
- The minimum time delay between two consecutive getRecords operations,
specified in ms. The default value is 1000
. This option is only
configurable for Glue version 2.0 and above.
$sel:maxFetchRecordsPerShard:KinesisStreamingSourceOptions'
, kinesisStreamingSourceOptions_maxFetchRecordsPerShard
- The maximum number of records to fetch per shard in the Kinesis data
stream. The default value is 100000
.
$sel:maxFetchTimeInMs:KinesisStreamingSourceOptions'
, kinesisStreamingSourceOptions_maxFetchTimeInMs
- The maximum time spent in the job executor to fetch a record from the
Kinesis data stream per shard, specified in milliseconds (ms). The
default value is 1000
.
$sel:maxRecordPerRead:KinesisStreamingSourceOptions'
, kinesisStreamingSourceOptions_maxRecordPerRead
- The maximum number of records to fetch from the Kinesis data stream in
each getRecords operation. The default value is 10000
.
$sel:maxRetryIntervalMs:KinesisStreamingSourceOptions'
, kinesisStreamingSourceOptions_maxRetryIntervalMs
- The maximum cool-off time period (specified in ms) between two retries
of a Kinesis Data Streams API call. The default value is 10000
.
$sel:numRetries:KinesisStreamingSourceOptions'
, kinesisStreamingSourceOptions_numRetries
- The maximum number of retries for Kinesis Data Streams API requests. The
default value is 3
.
$sel:retryIntervalMs:KinesisStreamingSourceOptions'
, kinesisStreamingSourceOptions_retryIntervalMs
- The cool-off time period (specified in ms) before retrying the Kinesis
Data Streams API call. The default value is 1000
.
$sel:roleArn:KinesisStreamingSourceOptions'
, kinesisStreamingSourceOptions_roleArn
- The Amazon Resource Name (ARN) of the role to assume using AWS Security
Token Service (AWS STS). This role must have permissions for describe or
read record operations for the Kinesis data stream. You must use this
parameter when accessing a data stream in a different account. Used in
conjunction with "awsSTSSessionName"
.
$sel:roleSessionName:KinesisStreamingSourceOptions'
, kinesisStreamingSourceOptions_roleSessionName
- An identifier for the session assuming the role using AWS STS. You must
use this parameter when accessing a data stream in a different account.
Used in conjunction with "awsSTSRoleARN"
.
$sel:startingPosition:KinesisStreamingSourceOptions'
, kinesisStreamingSourceOptions_startingPosition
- The starting position in the Kinesis data stream to read data from. The
possible values are "latest"
, "trim_horizon"
, or "earliest"
.
The default value is "latest"
.
$sel:streamArn:KinesisStreamingSourceOptions'
, kinesisStreamingSourceOptions_streamArn
- The Amazon Resource Name (ARN) of the Kinesis data stream.
$sel:streamName:KinesisStreamingSourceOptions'
, kinesisStreamingSourceOptions_streamName
- The name of the Kinesis data stream.
kinesisStreamingSourceOptions_addIdleTimeBetweenReads :: Lens' KinesisStreamingSourceOptions (Maybe Bool) Source #
Adds a time delay between two consecutive getRecords operations. The
default value is "False"
. This option is only configurable for Glue
version 2.0 and above.
kinesisStreamingSourceOptions_avoidEmptyBatches :: Lens' KinesisStreamingSourceOptions (Maybe Bool) Source #
Avoids creating an empty microbatch job by checking for unread data in
the Kinesis data stream before the batch is started. The default value
is "False"
.
kinesisStreamingSourceOptions_classification :: Lens' KinesisStreamingSourceOptions (Maybe Text) Source #
An optional classification.
kinesisStreamingSourceOptions_delimiter :: Lens' KinesisStreamingSourceOptions (Maybe Text) Source #
Specifies the delimiter character.
kinesisStreamingSourceOptions_describeShardInterval :: Lens' KinesisStreamingSourceOptions (Maybe Natural) Source #
The minimum time interval between two ListShards API calls for your
script to consider resharding. The default value is 1s
.
kinesisStreamingSourceOptions_endpointUrl :: Lens' KinesisStreamingSourceOptions (Maybe Text) Source #
The URL of the Kinesis endpoint.
kinesisStreamingSourceOptions_idleTimeBetweenReadsInMs :: Lens' KinesisStreamingSourceOptions (Maybe Natural) Source #
The minimum time delay between two consecutive getRecords operations,
specified in ms. The default value is 1000
. This option is only
configurable for Glue version 2.0 and above.
kinesisStreamingSourceOptions_maxFetchRecordsPerShard :: Lens' KinesisStreamingSourceOptions (Maybe Natural) Source #
The maximum number of records to fetch per shard in the Kinesis data
stream. The default value is 100000
.
kinesisStreamingSourceOptions_maxFetchTimeInMs :: Lens' KinesisStreamingSourceOptions (Maybe Natural) Source #
The maximum time spent in the job executor to fetch a record from the
Kinesis data stream per shard, specified in milliseconds (ms). The
default value is 1000
.
kinesisStreamingSourceOptions_maxRecordPerRead :: Lens' KinesisStreamingSourceOptions (Maybe Natural) Source #
The maximum number of records to fetch from the Kinesis data stream in
each getRecords operation. The default value is 10000
.
kinesisStreamingSourceOptions_maxRetryIntervalMs :: Lens' KinesisStreamingSourceOptions (Maybe Natural) Source #
The maximum cool-off time period (specified in ms) between two retries
of a Kinesis Data Streams API call. The default value is 10000
.
kinesisStreamingSourceOptions_numRetries :: Lens' KinesisStreamingSourceOptions (Maybe Natural) Source #
The maximum number of retries for Kinesis Data Streams API requests. The
default value is 3
.
kinesisStreamingSourceOptions_retryIntervalMs :: Lens' KinesisStreamingSourceOptions (Maybe Natural) Source #
The cool-off time period (specified in ms) before retrying the Kinesis
Data Streams API call. The default value is 1000
.
kinesisStreamingSourceOptions_roleArn :: Lens' KinesisStreamingSourceOptions (Maybe Text) Source #
The Amazon Resource Name (ARN) of the role to assume using AWS Security
Token Service (AWS STS). This role must have permissions for describe or
read record operations for the Kinesis data stream. You must use this
parameter when accessing a data stream in a different account. Used in
conjunction with "awsSTSSessionName"
.
kinesisStreamingSourceOptions_roleSessionName :: Lens' KinesisStreamingSourceOptions (Maybe Text) Source #
An identifier for the session assuming the role using AWS STS. You must
use this parameter when accessing a data stream in a different account.
Used in conjunction with "awsSTSRoleARN"
.
kinesisStreamingSourceOptions_startingPosition :: Lens' KinesisStreamingSourceOptions (Maybe StartingPosition) Source #
The starting position in the Kinesis data stream to read data from. The
possible values are "latest"
, "trim_horizon"
, or "earliest"
.
The default value is "latest"
.
kinesisStreamingSourceOptions_streamArn :: Lens' KinesisStreamingSourceOptions (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Kinesis data stream.
kinesisStreamingSourceOptions_streamName :: Lens' KinesisStreamingSourceOptions (Maybe Text) Source #
The name of the Kinesis data stream.