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

Interface SqsSourceParameters

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

SqsSourceParameters.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-17T14:41:05.407Z")
@Stability(Experimental)
public interface SqsSourceParameters
extends software.amazon.jsii.JsiiSerializable

(experimental) Parameters for the SQS source.

Example:

 Queue sourceQueue;
 Queue targetQueue;
 SqsSource pipeSource = SqsSource.Builder.create(sourceQueue)
         .batchSize(10)
         .maximumBatchingWindow(Duration.seconds(10))
         .build();
 Pipe pipe = Pipe.Builder.create(this, "Pipe")
         .source(pipeSource)
         .target(new SqsTarget(targetQueue))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static SqsSourceParameters.Builder	builder()
default Number	getBatchSize()	(experimental) The maximum number of records to include in each batch.
default Duration	getMaximumBatchingWindow()	(experimental) The maximum length of a time to wait for events.

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: 10

See Also:

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

getMaximumBatchingWindow

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

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

Default: 1

See Also:

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

builder

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

Returns:

a SqsSourceParameters.Builder of SqsSourceParameters