@aws-cdk/aws-pipes-alpha.SourceWithDeadLetterTarget

Experimental

@aws-cdk/aws-pipes-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

SourceWithDeadLetterTarget Class

Sources that support a dead-letter target.

SourceWithDeadLetterTarget

implements

• ISource

superclass of

• DynamoDBSource,
• KinesisSource,
• StreamSource

Stability

Experimental

Source

lib/source.ts

Initializer

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

SourceWithDeadLetterTarget(source_arn: str, dead_letter_target: typing.Optional[typing.Union[IQueue, ITopic]] = None)

new SourceWithDeadLetterTarget(String sourceArn, IQueue deadLetterTarget)

new SourceWithDeadLetterTarget(string sourceArn, IQueue? deadLetterTarget = null)

NewSourceWithDeadLetterTarget(SourceArn *string, DeadLetterTarget interface{})

Properties

deadLetterTarget?may be undefinedIQueue | ITopicdead_letter_target?may be undefinedtyping.Union[IQueue, ITopic]deadLetterTarget?may be undefinedIQueueDeadLetterTarget?may be undefinedIQueueDeadLetterTarget?may be undefinedinterface{}#

The dead-letter SQS queue or SNS topic.

sourceArnstringsource_arnstrsourceArnStringSourceArnstringSourceArn*string#

The ARN of the source resource.

Methods

bind(pipe: IPipe): SourceConfigdef bind(self, pipe: IPipe) -> SourceConfigpublic SourceConfig bind(IPipe pipe)public SourceConfig Bind(IPipe pipe)func Bind(Pipe IPipe) SourceConfig#

Bind the source to a pipe.

grantPush(grantee: IRole, deadLetterTarget?: IQueue | ITopic): voiddef grant_push(self, grantee: IRole, dead_letter_target: typing.Optional[typing.Union[IQueue, ITopic]] = None) -> Nonepublic void grantPush(IRole grantee, IQueue deadLetterTarget)public void GrantPush(IRole grantee, IQueue? deadLetterTarget = null)func GrantPush(Grantee IRole, DeadLetterTarget interface{})#

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

[disable-awslint:no-grants]

grantRead(grantee: IRole): voiddef grant_read(self, grantee: IRole) -> Nonepublic void grantRead(IRole grantee)public void GrantRead(IRole grantee)func GrantRead(Grantee IRole)#

Grant the pipe role read access to the source.

isSourceWithDeadLetterTarget(source: ISource): boolean@staticmethod def is_source_with_dead_letter_target(source: ISource) -> boolpublic static Boolean isSourceWithDeadLetterTarget(ISource source)public static bool IsSourceWithDeadLetterTarget(ISource source)func IsSourceWithDeadLetterTarget(Source ISource) *boolstatic#

Determines if the source is an instance of SourceWithDeadLetterTarget.