interface PipeSourceDynamoDBStreamParametersProperty

Language	Type name
.NET	Amazon.CDK.AWS.Pipes.CfnPipe.PipeSourceDynamoDBStreamParametersProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awspipes#CfnPipe_PipeSourceDynamoDBStreamParametersProperty
Java	software.amazon.awscdk.services.pipes.CfnPipe.PipeSourceDynamoDBStreamParametersProperty
Python	aws_cdk.aws_pipes.CfnPipe.PipeSourceDynamoDBStreamParametersProperty
TypeScript	aws-cdk-lib » aws_pipes » CfnPipe » PipeSourceDynamoDBStreamParametersProperty

The parameters for using a DynamoDB stream as a source.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcedynamodbstreamparameters.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_pipes as pipes } from 'aws-cdk-lib';
const pipeSourceDynamoDBStreamParametersProperty: pipes.CfnPipe.PipeSourceDynamoDBStreamParametersProperty = {
  startingPosition: 'startingPosition',

  // the properties below are optional
  batchSize: 123,
  deadLetterConfig: {
    arn: 'arn',
  },
  maximumBatchingWindowInSeconds: 123,
  maximumRecordAgeInSeconds: 123,
  maximumRetryAttempts: 123,
  onPartialBatchItemFailure: 'onPartialBatchItemFailure',
  parallelizationFactor: 123,
};

Properties

Name	Type	Description
startingPosition	string	(Streams only) The position in a stream from which to start reading.
batchSize?	number	The maximum number of records to include in each batch.
deadLetterConfig?	IResolvable | DeadLetterConfigProperty	Define the target queue to send dead-letter queue events to.
maximumBatchingWindowInSeconds?	number	The maximum length of a time to wait for events.
maximumRecordAgeInSeconds?	number	Discard records older than the specified age.
maximumRetryAttempts?	number	Discard records after the specified number of retries.
onPartialBatchItemFailure?	string	Define how to handle item process failures.
parallelizationFactor?	number	The number of batches to process concurrently from each shard.

---

startingPosition

Type: string

(Streams only) The position in a stream from which to start reading.

Valid values : TRIM_HORIZON | LATEST

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcedynamodbstreamparameters.html#cfn-pipes-pipe-pipesourcedynamodbstreamparameters-startingposition

---

batchSize?

Type: number (optional)

The maximum number of records to include in each batch.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcedynamodbstreamparameters.html#cfn-pipes-pipe-pipesourcedynamodbstreamparameters-batchsize

---

deadLetterConfig?

Type: IResolvable | DeadLetterConfigProperty (optional)

Define the target queue to send dead-letter queue events to.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcedynamodbstreamparameters.html#cfn-pipes-pipe-pipesourcedynamodbstreamparameters-deadletterconfig

---

maximumBatchingWindowInSeconds?

Type: number (optional)

The maximum length of a time to wait for events.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcedynamodbstreamparameters.html#cfn-pipes-pipe-pipesourcedynamodbstreamparameters-maximumbatchingwindowinseconds

---

maximumRecordAgeInSeconds?

Type: number (optional)

Discard records older than the specified age.

The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, EventBridge never discards old records.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcedynamodbstreamparameters.html#cfn-pipes-pipe-pipesourcedynamodbstreamparameters-maximumrecordageinseconds

---

maximumRetryAttempts?

Type: number (optional)

Discard records after the specified number of retries.

The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcedynamodbstreamparameters.html#cfn-pipes-pipe-pipesourcedynamodbstreamparameters-maximumretryattempts

---

onPartialBatchItemFailure?

Type: string (optional)

Define how to handle item process failures.

AUTOMATIC_BISECT halves each batch and retry each half until all the records are processed or there is one failed message left in the batch.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcedynamodbstreamparameters.html#cfn-pipes-pipe-pipesourcedynamodbstreamparameters-onpartialbatchitemfailure

---

parallelizationFactor?

Type: number (optional)

The number of batches to process concurrently from each shard.

The default value is 1.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcedynamodbstreamparameters.html#cfn-pipes-pipe-pipesourcedynamodbstreamparameters-parallelizationfactor