SqsSourceParameters

class aws_cdk.aws_pipes_sources_alpha.SqsSourceParameters(*, batch_size=None, maximum_batching_window=None)

Bases: object

(experimental) Parameters for the SQS source.

Parameters:

  • batch_size (Union[int, float, None]) – (experimental) The maximum number of records to include in each batch. Default: 10

  • maximum_batching_window (Optional[Duration]) – (experimental) The maximum length of a time to wait for events. Default: 1

Stability:

experimental

ExampleMetadata:

infused

Example:

# source_queue: sqs.Queue
# target_queue: sqs.Queue


pipe_source = sources.SqsSource(source_queue,
    batch_size=10,
    maximum_batching_window=cdk.Duration.seconds(10)
)

pipe = pipes.Pipe(self, "Pipe",
    source=pipe_source,
    target=SqsTarget(target_queue)
)

Attributes

batch_size

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

Default:

10

See:

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

Stability:

experimental

maximum_batching_window

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

Default:

1

See:

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

Stability:

experimental