class SqsSource
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Pipes.Sources.Alpha.SqsSource |
![]() | github.com/aws/aws-cdk-go/awscdkpipessourcesalpha/v2#SqsSource |
![]() | software.amazon.awscdk.services.pipes.sources.alpha.SqsSource |
![]() | aws_cdk.aws_pipes_sources_alpha.SqsSource |
![]() | @aws-cdk/aws-pipes-sources-alpha ยป SqsSource |
Implements
ISource
A source that reads from an SQS queue.
Example
declare const sourceQueue: sqs.Queue;
declare const dest: events.ApiDestination;
const apiTarget = new targets.ApiDestinationTarget(dest, {
inputTransformation: pipes.InputTransformation.fromObject({ body: "๐" }),
});
const pipe = new pipes.Pipe(this, 'Pipe', {
source: new SqsSource(sourceQueue),
target: apiTarget,
});
Initializer
new SqsSource(queue: IQueue, parameters?: SqsSourceParameters)
Parameters
- queue
IQueue
- parameters
Sqs
Source Parameters
Properties
Name | Type | Description |
---|---|---|
source | string | The ARN of the source resource. |
sourceArn
Type:
string
The ARN of the source resource.
Methods
Name | Description |
---|---|
bind(_pipe) | Bind the source to a pipe. |
grant | Grant the pipe role read access to the source. |
bind(_pipe)
public bind(_pipe: IPipe): SourceConfig
Parameters
- _pipe
IPipe
Returns
Bind the source to a pipe.
grantRead(grantee)
public grantRead(grantee: IRole): void
Parameters
- grantee
IRole
Grant the pipe role read access to the source.