Package software.amazon.awscdk.services.pipes.alpha

Class SourceWithDeadLetterTarget

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.pipes.alpha.SourceWithDeadLetterTarget
All Implemented Interfaces:
ISource, software.amazon.jsii.JsiiSerializable
Direct Known Subclasses:
StreamSource
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-13T16:10:18.587Z") @Stability(Experimental) public abstract class SourceWithDeadLetterTarget extends software.amazon.jsii.JsiiObject implements ISource
(experimental) Sources that support a dead-letter target.

  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.amazon.awscdk.services.pipes.alpha.ISource

    ISource.Jsii$Default

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    SourceWithDeadLetterTarget(String sourceArn)
     
    protected
    SourceWithDeadLetterTarget(String sourceArn, Object deadLetterTarget)
     
    protected
    SourceWithDeadLetterTarget(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    SourceWithDeadLetterTarget(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract SourceConfig
    bind(IPipe pipe)
    (experimental) Bind the source to a pipe.
    Object
    getDeadLetterTarget()
    (experimental) The dead-letter SQS queue or SNS topic.
    protected String
    getDeadLetterTargetArn()
    (experimental) Retrieves the ARN from the dead-letter SQS queue or SNS topic.
    protected String
    getDeadLetterTargetArn(Object deadLetterTarget)
    (experimental) Retrieves the ARN from the dead-letter SQS queue or SNS topic.
    String
    getSourceArn()
    (experimental) The ARN of the source resource.
    void
    grantPush(IRole grantee)
    (experimental) Grants the pipe role permission to publish to the dead-letter target.
    void
    grantPush(IRole grantee, Object deadLetterTarget)
    (experimental) Grants the pipe role permission to publish to the dead-letter target.
    abstract void
    grantRead(IRole grantee)
    (experimental) Grant the pipe role read access to the source.
    static Boolean
    isSourceWithDeadLetterTarget(ISource source)
    (experimental) Determines if the source is an instance of SourceWithDeadLetterTarget.

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Constructor Details

    • SourceWithDeadLetterTarget

      protected SourceWithDeadLetterTarget(software.amazon.jsii.JsiiObjectRef objRef)

    • SourceWithDeadLetterTarget

      protected SourceWithDeadLetterTarget(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • SourceWithDeadLetterTarget

      @Stability(Experimental) protected SourceWithDeadLetterTarget(@NotNull String sourceArn, @Nullable Object deadLetterTarget)
      Parameters:
      sourceArn - The ARN of the source resource. This parameter is required.
      deadLetterTarget - Takes union: either IQueue or ITopic.

    • SourceWithDeadLetterTarget

      @Stability(Experimental) protected SourceWithDeadLetterTarget(@NotNull String sourceArn)
      Parameters:
      sourceArn - The ARN of the source resource. This parameter is required.

  • Method Details

    • isSourceWithDeadLetterTarget

      @Stability(Experimental) @NotNull public static Boolean isSourceWithDeadLetterTarget(@NotNull ISource source)
      (experimental) Determines if the source is an instance of SourceWithDeadLetterTarget.

      Parameters:
      source - This parameter is required.

    • bind

      @Stability(Experimental) @NotNull public abstract SourceConfig bind(@NotNull IPipe pipe)
      (experimental) Bind the source to a pipe.

      Specified by:
      bind in interface ISource
      Parameters:
      pipe - This parameter is required.

    • getDeadLetterTargetArn

      @Stability(Experimental) @Nullable protected String getDeadLetterTargetArn(@Nullable Object deadLetterTarget)
      (experimental) Retrieves the ARN from the dead-letter SQS queue or SNS topic.

      Parameters:
      deadLetterTarget - Takes union: either IQueue or ITopic.

    • getDeadLetterTargetArn

      @Stability(Experimental) @Nullable protected String getDeadLetterTargetArn()
      (experimental) Retrieves the ARN from the dead-letter SQS queue or SNS topic.

    • grantPush

      @Stability(Experimental) public void grantPush(@NotNull IRole grantee, @Nullable Object deadLetterTarget)
      (experimental) Grants the pipe role permission to publish to the dead-letter target.

      Parameters:
      grantee - This parameter is required.
      deadLetterTarget - Takes union: either IQueue or ITopic.

    • grantPush

      @Stability(Experimental) public void grantPush(@NotNull IRole grantee)
      (experimental) Grants the pipe role permission to publish to the dead-letter target.

      Parameters:
      grantee - This parameter is required.

    • grantRead

      @Stability(Experimental) public abstract void grantRead(@NotNull IRole grantee)
      (experimental) Grant the pipe role read access to the source.

      Specified by:
      grantRead in interface ISource
      Parameters:
      grantee - This parameter is required.

    • getSourceArn

      @Stability(Experimental) @NotNull public String getSourceArn()
      (experimental) The ARN of the source resource.
      Specified by:
      getSourceArn in interface ISource

    • getDeadLetterTarget

      @Stability(Experimental) @Nullable public Object getDeadLetterTarget()
      (experimental) The dead-letter SQS queue or SNS topic.

      Returns union: either IQueue or ITopic