PluginsPlugin AwsKinesis

Consume​Consume

Consume records from an Amazon Kinesis Data Stream.

yaml
type: "io.kestra.plugin.aws.kinesis.Consume"

Consume records from a Kinesis stream using TRIM_HORIZON

yaml
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

The Kinesis stream name.

Access Key Id in order to connect to AWS.

If no credentials are defined, we will use the default credentials provider chain to fetch credentials.

Enable compatibility mode.

Use it to connect to S3 bucket with S3 compatible services that don't support the new transport client.

The endpoint with which the SDK should communicate.

This property allows you to use a different S3 compatible storage backend.

Force path style access.

Must only be used when compatibilityMode is enabled.

Default LATEST
Possible Values
AT_SEQUENCE_NUMBERAFTER_SEQUENCE_NUMBERTRIM_HORIZONLATESTAT_TIMESTAMP

The position in the stream to start reading from.

Kinesis iterator type: LATEST, TRIM_HORIZON, AT_SEQUENCE_NUMBER, AFTER_SEQUENCE_NUMBER.

Default PT30S
Format duration

Stop consumption after this duration.

Default 1000

Maximum records to consume before stopping.

Default PT1S
Format duration

How long to wait between record calls.

AWS region with which the SDK should communicate.

Secret Key Id in order to connect to AWS.

If no credentials are defined, we will use the default credentials provider chain to fetch credentials.

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.

Used if iteratorType is AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER.

The AWS STS endpoint with which the SDKClient should communicate.

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.

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.

Default PT15M
Format duration

AWS 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.

AWS STS Session name.

This property is only used when an stsRoleArn is defined.

Default 0

Number of consumed records.

SubType string

Last consumed sequence number per shard.

Format uri

Kinesis records output file.