SqsSource

class aws_cdk.aws_pipes_sources_alpha.SqsSource(queue, *, batch_size=None, maximum_batching_window=None)

Bases: object

(experimental) A source that reads from an SQS queue.

Stability:: experimental
ExampleMetadata:: infused

Example:

# source_queue: sqs.Queue
# dest: events.ApiDestination


api_target = targets.ApiDestinationTarget(dest,
    input_transformation=pipes.InputTransformation.from_object({"body": "👀"})
)

pipe = pipes.Pipe(self, "Pipe",
    source=SqsSource(source_queue),
    target=api_target
)

Parameters:

queue (IQueue)
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

Methods

bind(_pipe)

(experimental) Bind the source to a pipe.

Parameters:: _pipe (IPipe)
Stability:: experimental
Return type:: SourceConfig

grant_read(grantee)

(experimental) Grant the pipe role read access to the source.

Parameters:: grantee (IRole)
Stability:: experimental
Return type:: None

Attributes

source_arn

(experimental) The ARN of the source resource.

Stability:: experimental