PluginsAWSTasksKinesisPutRecords

PutRecords​Put​Records

PutRecords PutRecords

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

Send multiple records to Amazon Kinesis Data Streams.

Examples

Send multiple records as maps to Amazon Kinesis Data Streams. Check the following AWS API reference for the structure of the PutRecordsRequestEntry request payload.

yaml
id: "put_records"
type: "io.kestra.plugin.aws.kinesis.PutRecords"
accessKeyId: "<access-key>"
secretKeyId: "<secret-key>"
region: "eu-central-1"
streamName: "mystream"
records:
  - data: "user sign-in event"
    explicitHashKey: "optional hash value overriding the partition key"
    partitionKey: "user1"
  - data: "user sign-out event"
    partitionKey: "user1"

Send multiple records from an internal storage ion file to Amazon Kinesis Data Streams.

yaml
id: "put_records"
type: "io.kestra.plugin.aws.kinesis.PutRecords"
accessKeyId: "<access-key>"
secretKeyId: "<secret-key>"
region: "eu-central-1"
streamName: "mystream"
records: kestra:///myfile.ion

Properties

failOnUnsuccessfulRecords

  • Type: boolean
  • Dynamic: ❌
  • Required: ✔️
  • Default: true

Mark the task as failed when sending a record is unsuccessful.

If true, the task will fail when any record fails to be sent.

records

  • Type:
    • string
    • array
  • Dynamic: ✔️
  • Required: ✔️

List of records (i.e., list of maps) or internal storage URI of the file that defines the records to be sent to AWS Kinesis Data Streams.

A list of at least one record with a map including data and partitionKey properties (those two are required arguments). Check the PutRecordsRequestEntry API reference for a detailed description of required fields.

accessKeyId

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

Access Key Id in order to connect to AWS.

If no connection is defined, we will use the DefaultCredentialsProvider to fetch the value.

compatibilityMode

  • Type: boolean
  • Dynamic: ✔️
  • Required: ❌

endpointOverride

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The endpoint with which the SDK should communicate.

This property should normally not be used except for local development.

region

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

AWS region with which the SDK should communicate.

secretKeyId

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

Secret Key Id in order to connect to AWS.

If no connection is defined, we will use the DefaultCredentialsProvider to fetch the value.

sessionToken

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

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 connection is defined, we will use the DefaultCredentialsProvider to fetch the value.

streamArn

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The ARN of the stream to push the records.

Make sure to set either streamName or streamArn. One of those must be provided.

streamName

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The name of the stream to push the records.

Make sure to set either streamName or streamArn. One of those must be provided.

stsEndpointOverride

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The AWS STS endpoint with which the SDKClient should communicate.

stsRoleArn

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

AWS STS Role.

The Amazon Resource Name (ARN) of the role to assume. If set the task will use the StsAssumeRoleCredentialsProvider. Otherwise, the StaticCredentialsProvider will be used with the provided Access Key Id and Secret Key.

stsRoleExternalId

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

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.

stsRoleSessionDuration

  • Type: string
  • Dynamic: ❌
  • Required: ❌
  • Default: 900.000000000
  • 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.

stsRoleSessionName

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

AWS STS Session name. This property is only used when an stsRoleArn is defined.

Outputs

failedRecordsCount

  • Type: integer
  • Dynamic: ❓
  • Required: ❌
  • Default: 0

The number of failed records.

recordCount

  • Type: integer
  • Dynamic: ❓
  • Required: ❌
  • Default: 0

The total number of records sent to AWS Kinesis Data Streams.

uri

  • Type: string
  • Dynamic: ❓
  • Required: ❌
  • Format: uri

The URI of stored data

The successfully and unsuccessfully ingested records.If the ingestion was successful, the output includes the record sequence number.Otherwise, the output provides the error code and error message for troubleshooting.

Definitions

io.kestra.plugin.aws.kinesis.model.Record

Properties

data
  • Type: string
  • Dynamic: ✔️
  • Required: ✔️

Free-form data blob to put into the record.

partitionKey
  • Type: string
  • Dynamic: ✔️
  • Required: ✔️

Determines which shard in the stream the data record is assigned to.

explicitHashKey
  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The optional hash value used to determine explicitly the shard that the data record is assigned to by overriding the partition key hash.