class SourceWithDeadLetterTarget 🔹

Language	Type name
.NET	Amazon.CDK.AWS.Pipes.Alpha.SourceWithDeadLetterTarget
Go	github.com/aws/aws-cdk-go/awscdkpipesalpha/v2#SourceWithDeadLetterTarget
Java	software.amazon.awscdk.services.pipes.alpha.SourceWithDeadLetterTarget
Python	aws_cdk.aws_pipes_alpha.SourceWithDeadLetterTarget
TypeScript (source)	@aws-cdk/aws-pipes-alpha » SourceWithDeadLetterTarget

Implements ISource

Implemented by DynamoDBSource, KinesisSource

Sources that support a dead-letter target.

Initializer

new SourceWithDeadLetterTarget(sourceArn: string, deadLetterTarget?: IQueue | ITopic)

Parameters

• sourceArn string — The ARN of the source resource.
• deadLetterTarget IQueue | ITopic

Properties

Name	Type	Description
sourceArn🔹	string	The ARN of the source resource.
deadLetterTarget?🔹	IQueue | ITopic	The dead-letter SQS queue or SNS topic.

---

sourceArn🔹

Type: string

The ARN of the source resource.

---

deadLetterTarget?🔹

Type: IQueue | ITopic (optional)

The dead-letter SQS queue or SNS topic.

Methods

Name	Description
bind(pipe)🔹	Bind the source to a pipe.
grantPush(grantee, deadLetterTarget?)🔹	Grants the pipe role permission to publish to the dead-letter target.
grantRead(grantee)🔹	Grant the pipe role read access to the source.
protected getDeadLetterTargetArn(deadLetterTarget?)🔹	Retrieves the ARN from the dead-letter SQS queue or SNS topic.
static isSourceWithDeadLetterTarget(source)🔹	Determines if the source is an instance of SourceWithDeadLetterTarget.

---

bind(pipe)🔹

public bind(pipe: IPipe): SourceConfig

Parameters

• pipe IPipe

Returns

• SourceConfig

Bind the source to a pipe.

---

grantPush(grantee, deadLetterTarget?)🔹

public grantPush(grantee: IRole, deadLetterTarget?: IQueue | ITopic): void

Parameters

• grantee IRole
• deadLetterTarget IQueue | ITopic

Grants the pipe role permission to publish to the dead-letter target.

---

grantRead(grantee)🔹

public grantRead(grantee: IRole): void

Parameters

• grantee IRole

Grant the pipe role read access to the source.

---

protected getDeadLetterTargetArn(deadLetterTarget?)🔹

protected getDeadLetterTargetArn(deadLetterTarget?: IQueue | ITopic): string

Parameters

• deadLetterTarget IQueue | ITopic

Returns

• string

Retrieves the ARN from the dead-letter SQS queue or SNS topic.

---

static isSourceWithDeadLetterTarget(source)🔹

public static isSourceWithDeadLetterTarget(source: ISource): boolean

Parameters

• source ISource

Returns

• boolean

Determines if the source is an instance of SourceWithDeadLetterTarget.