class SourceWithDeadLetterTarget
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Pipes.Alpha.SourceWithDeadLetterTarget |
![]() | github.com/aws/aws-cdk-go/awscdkpipesalpha/v2#SourceWithDeadLetterTarget |
![]() | software.amazon.awscdk.services.pipes.alpha.SourceWithDeadLetterTarget |
![]() | aws_cdk.aws_pipes_alpha.SourceWithDeadLetterTarget |
![]() | @aws-cdk/aws-pipes-alpha ยป SourceWithDeadLetterTarget |
Implements
ISource
Implemented by
Dynamo
, Kinesis
Sources that support a dead-letter target.
Initializer
new SourceWithDeadLetterTarget(sourceArn: string, deadLetterTarget?: IQueue | ITopic)
Parameters
Properties
Name | Type | Description |
---|---|---|
source | string | The ARN of the source resource. |
dead | 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. |
grant | Grants the pipe role permission to publish to the dead-letter target. |
grant | Grant the pipe role read access to the source. |
protected get | Retrieves the ARN from the dead-letter SQS queue or SNS topic. |
static is | Determines if the source is an instance of SourceWithDeadLetterTarget. |
bind(pipe)
public bind(pipe: IPipe): SourceConfig
Parameters
- pipe
IPipe
Returns
Bind the source to a pipe.
grantPush(grantee, deadLetterTarget?)
public grantPush(grantee: IRole, deadLetterTarget?: IQueue | ITopic): void
Parameters
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
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.