Package software.amazon.awscdk.services.pipes.sources.alpha

Interface StreamSourceParameters

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

DynamoDBSourceParameters, KinesisSourceParameters

All Known Implementing Classes:

DynamoDBSourceParameters.Jsii$Proxy, KinesisSourceParameters.Jsii$Proxy, StreamSourceParameters.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:11.935Z")
@Stability(Experimental)
public interface StreamSourceParameters
extends software.amazon.jsii.JsiiSerializable

(experimental) Base parameters for streaming sources.

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.sources.alpha.*;
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.sqs.*;
 Queue queue;
 StreamSourceParameters streamSourceParameters = StreamSourceParameters.builder()
         .batchSize(123)
         .deadLetterTarget(queue)
         .maximumBatchingWindow(Duration.minutes(30))
         .maximumRecordAge(Duration.minutes(30))
         .maximumRetryAttempts(123)
         .onPartialBatchItemFailure(OnPartialBatchItemFailure.AUTOMATIC_BISECT)
         .parallelizationFactor(123)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static StreamSourceParameters.Builder	builder()
default Number	getBatchSize()	(experimental) The maximum number of records to include in each batch.
default Object	getDeadLetterTarget()	(experimental) Define the target to send dead-letter queue events to.
default Duration	getMaximumBatchingWindow()	(experimental) The maximum length of a time to wait for events.
default Duration	getMaximumRecordAge()	(experimental) Discard records older than the specified age.
default Number	getMaximumRetryAttempts()	(experimental) Discard records after the specified number of retries.
default OnPartialBatchItemFailure	getOnPartialBatchItemFailure()	(experimental) Define how to handle item process failures.
default Number	getParallelizationFactor()	(experimental) The number of batches to process concurrently from each shard.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBatchSize

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

(experimental) The maximum number of records to include in each batch.

Default: 1

See Also:

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

getDeadLetterTarget

@Stability(Experimental)
@Nullable
default Object getDeadLetterTarget()

(experimental) Define the target to send dead-letter queue events to.

The dead-letter queue stores any events that are not successfully delivered to a Pipes target after all retry attempts are exhausted. You can then resolve the issue that caused the failed invocations and replay the events at a later time. In some cases, such as when access is denied to a resource, events are sent directly to the dead-letter queue and are not retried.

Default: - no dead-letter queue or topic

See Also:

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

getMaximumBatchingWindow

@Stability(Experimental)
@Nullable
default Duration getMaximumBatchingWindow()

(experimental) The maximum length of a time to wait for events.

Default: - the events will be handled immediately

See Also:

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

getMaximumRecordAge

@Stability(Experimental)
@Nullable
default Duration getMaximumRecordAge()

(experimental) 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.

Default: -1 - EventBridge won't discard old records

See Also:

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

getMaximumRetryAttempts

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

(experimental) 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.

Default: -1 - EventBridge will retry failed records until the record expires in the event source

See Also:

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

getOnPartialBatchItemFailure

@Stability(Experimental)
@Nullable
default OnPartialBatchItemFailure getOnPartialBatchItemFailure()

(experimental) Define how to handle item process failures.

invalid @link

OnPartialBatchItemFailure.AUTOMATIC_BISECT

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

Default: off - EventBridge will retry the entire batch

See Also:

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

getParallelizationFactor

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

(experimental) The number of batches to process concurrently from each shard.

Default: 1

See Also:

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

builder

@Stability(Experimental)
static StreamSourceParameters.Builder builder()

Returns:

a StreamSourceParameters.Builder of StreamSourceParameters