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

Class SqsSource

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.pipes.sources.alpha.SqsSource
All Implemented Interfaces:
ISource, software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-12-17T21:37:41.821Z") @Stability(Experimental) public class SqsSource extends software.amazon.jsii.JsiiObject implements ISource
(experimental) A source that reads from an SQS queue.

Example: 

 Queue sourceQueue;
 ApiDestination dest;
 ApiDestinationTarget apiTarget = ApiDestinationTarget.Builder.create(dest)
         .inputTransformation(InputTransformation.fromObject(Map.of("body", "👀")))
         .build();
 Pipe pipe = Pipe.Builder.create(this, "Pipe")
         .source(new SqsSource(sourceQueue))
         .target(apiTarget)
         .build();

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    SqsSource.Builder
    (experimental) A fluent builder for SqsSource.

    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, ISource.Jsii$Proxy

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
     
    SqsSource(IQueue queue)
     
     
    SqsSource(IQueue queue, SqsSourceParameters parameters)
     
    protected
    SqsSource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    SqsSource(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    SourceConfig
    bind(IPipe _pipe)
    (experimental) Bind the source to a pipe.
    String
    getSourceArn()
    (experimental) The ARN of the source resource.
    void
    grantRead(IRole grantee)
    (experimental) Grant the pipe role read access to the source.

    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

    • SqsSource

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

    • SqsSource

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

    • SqsSource

      @Stability(Experimental) public SqsSource(@NotNull IQueue queue, @Nullable SqsSourceParameters parameters)
      Parameters:
      queue - This parameter is required.
      parameters -

    • SqsSource

      @Stability(Experimental) public SqsSource(@NotNull IQueue queue)
      Parameters:
      queue - This parameter is required.

  • Method Details

    • bind

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

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

    • grantRead

      @Stability(Experimental) public 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