Consume
Consume records from an Amazon Kinesis Data Stream.
Consume records from an Amazon Kinesis Data Stream.
Consume records from an Amazon Kinesis Data Stream.
type: "io.kestra.plugin.aws.kinesis.Consume"Examples
Consume records from a Kinesis stream using TRIM_HORIZON
id: kinesis_consume
namespace: company.team
tasks:
- id: consume
type: io.kestra.plugin.aws.kinesis.Consume
accessKeyId: "{{ secret('AWS_ACCESS_KEY_ID') }}"
secretKeyId: "{{ secret('AWS_SECRET_KEY_ID') }}"
region: "eu-central-1"
streamName: "stream"
iteratorType: TRIM_HORIZON
pollDuration: PT5S
maxRecords: 100
Properties
streamName*Requiredstring
The Kinesis stream name.
accessKeyIdstring
Access Key Id in order to connect to AWS.
compatibilityModebooleanstring
Enable compatibility mode.
Use it to connect to S3 bucket with S3 compatible services that don't support the new transport client.
endpointOverridestring
The endpoint with which the SDK should communicate.
This property allows you to use a different S3 compatible storage backend.
forcePathStylebooleanstring
Force path style access.
Must only be used when compatibilityMode is enabled.
iteratorTypestring
LATESTAT_SEQUENCE_NUMBERAFTER_SEQUENCE_NUMBERTRIM_HORIZONLATESTAT_TIMESTAMPThe position in the stream to start reading from.
Kinesis iterator type: LATEST, TRIM_HORIZON, AT_SEQUENCE_NUMBER, AFTER_SEQUENCE_NUMBER.
maxDurationstring
PT30SdurationStop consumption after this duration.
maxRecordsintegerstring
1000Maximum records to consume before stopping.
pollDurationstring
PT1SdurationHow long to wait between record calls.
regionstring
AWS region with which the SDK should communicate.
secretKeyIdstring
Secret Key Id in order to connect to AWS.
sessionTokenstring
AWS session token, retrieved from an AWS token service, used for authenticating that this user has received temporary permissions to access a given resource.
If no credentials are defined, we will use the default credentials provider chain to fetch credentials.
startingSequenceNumberstring
Used if iteratorType is AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER.
stsEndpointOverridestring
The AWS STS endpoint with which the SDKClient should communicate.
stsRoleArnstring
AWS STS Role.
The Amazon Resource Name (ARN) of the role to assume. If set the task will use the StsAssumeRoleCredentialsProvider. If no credentials are defined, we will use the default credentials provider chain to fetch credentials.
stsRoleExternalIdstring
AWS STS External Id.
A unique identifier that might be required when you assume a role in another account. This property is only used when an stsRoleArn is defined.
stsRoleSessionDurationstring
PT15MdurationAWS STS Session duration.
The duration of the role session (default: 15 minutes, i.e., PT15M). This property is only used when an stsRoleArn is defined.
stsRoleSessionNamestring
AWS STS Session name.
This property is only used when an stsRoleArn is defined.
Outputs
countinteger
0Number of consumed records.
lastSequencePerShardobject
Last consumed sequence number per shard.
uristring
uriKinesis records output file.
