Package software.amazon.awscdk.services.pipes

Interface CfnPipe.PipeSourceKinesisStreamParametersProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPipe.PipeSourceKinesisStreamParametersProperty.Jsii$Proxy

Enclosing class:

CfnPipe

@Stability(Stable)
public static interface CfnPipe.PipeSourceKinesisStreamParametersProperty
extends software.amazon.jsii.JsiiSerializable

The parameters for using a Kinesis stream as a source.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.pipes.*;
 PipeSourceKinesisStreamParametersProperty pipeSourceKinesisStreamParametersProperty = PipeSourceKinesisStreamParametersProperty.builder()
         .startingPosition("startingPosition")
         // the properties below are optional
         .batchSize(123)
         .deadLetterConfig(DeadLetterConfigProperty.builder()
                 .arn("arn")
                 .build())
         .maximumBatchingWindowInSeconds(123)
         .maximumRecordAgeInSeconds(123)
         .maximumRetryAttempts(123)
         .onPartialBatchItemFailure("onPartialBatchItemFailure")
         .parallelizationFactor(123)
         .startingPositionTimestamp("startingPositionTimestamp")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcekinesisstreamparameters.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPipe.PipeSourceKinesisStreamParametersProperty.Builder	A builder for CfnPipe.PipeSourceKinesisStreamParametersProperty
static final class	CfnPipe.PipeSourceKinesisStreamParametersProperty.Jsii$Proxy	An implementation for CfnPipe.PipeSourceKinesisStreamParametersProperty

Method Summary

Modifier and Type	Method	Description
static CfnPipe.PipeSourceKinesisStreamParametersProperty.Builder	builder()
default Number	getBatchSize()	The maximum number of records to include in each batch.
default Object	getDeadLetterConfig()	Define the target queue to send dead-letter queue events to.
default Number	getMaximumBatchingWindowInSeconds()	The maximum length of a time to wait for events.
default Number	getMaximumRecordAgeInSeconds()	Discard records older than the specified age.
default Number	getMaximumRetryAttempts()	Discard records after the specified number of retries.
default String	getOnPartialBatchItemFailure()	Define how to handle item process failures.
default Number	getParallelizationFactor()	The number of batches to process concurrently from each shard.
String	getStartingPosition()	The position in a stream from which to start reading.
default String	getStartingPositionTimestamp()	With StartingPosition set to AT_TIMESTAMP , the time from which to start reading, in Unix time seconds.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getStartingPosition

@Stability(Stable)
@NotNull
String getStartingPosition()

The position in a stream from which to start reading.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcekinesisstreamparameters.html#cfn-pipes-pipe-pipesourcekinesisstreamparameters-startingposition

getBatchSize

@Stability(Stable)
@Nullable
default Number getBatchSize()

The maximum number of records to include in each batch.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcekinesisstreamparameters.html#cfn-pipes-pipe-pipesourcekinesisstreamparameters-batchsize

getDeadLetterConfig

@Stability(Stable)
@Nullable
default Object getDeadLetterConfig()

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-pipesourcekinesisstreamparameters.html#cfn-pipes-pipe-pipesourcekinesisstreamparameters-deadletterconfig

getMaximumBatchingWindowInSeconds

@Stability(Stable)
@Nullable
default Number getMaximumBatchingWindowInSeconds()

The maximum length of a time to wait for events.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcekinesisstreamparameters.html#cfn-pipes-pipe-pipesourcekinesisstreamparameters-maximumbatchingwindowinseconds

getMaximumRecordAgeInSeconds

@Stability(Stable)
@Nullable
default Number getMaximumRecordAgeInSeconds()

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-pipesourcekinesisstreamparameters.html#cfn-pipes-pipe-pipesourcekinesisstreamparameters-maximumrecordageinseconds

getMaximumRetryAttempts

@Stability(Stable)
@Nullable
default Number getMaximumRetryAttempts()

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-pipesourcekinesisstreamparameters.html#cfn-pipes-pipe-pipesourcekinesisstreamparameters-maximumretryattempts

getOnPartialBatchItemFailure

@Stability(Stable)
@Nullable
default String getOnPartialBatchItemFailure()

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-pipesourcekinesisstreamparameters.html#cfn-pipes-pipe-pipesourcekinesisstreamparameters-onpartialbatchitemfailure

getParallelizationFactor

@Stability(Stable)
@Nullable
default Number getParallelizationFactor()

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-pipesourcekinesisstreamparameters.html#cfn-pipes-pipe-pipesourcekinesisstreamparameters-parallelizationfactor

getStartingPositionTimestamp

@Stability(Stable)
@Nullable
default String getStartingPositionTimestamp()

With StartingPosition set to AT_TIMESTAMP , the time from which to start reading, in Unix time seconds.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcekinesisstreamparameters.html#cfn-pipes-pipe-pipesourcekinesisstreamparameters-startingpositiontimestamp

builder

@Stability(Stable)
static CfnPipe.PipeSourceKinesisStreamParametersProperty.Builder builder()

Returns:

a CfnPipe.PipeSourceKinesisStreamParametersProperty.Builder of CfnPipe.PipeSourceKinesisStreamParametersProperty