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

Interface ISource

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
ISource.Jsii$Default
All Known Implementing Classes:
ISource.Jsii$Proxy, SqsSource
@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)", date="2024-05-08T21:35:15.952Z") @Stability(Experimental) public interface ISource extends software.amazon.jsii.JsiiSerializable
(experimental) Source interface.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    ISource.Jsii$Default
    Internal default implementation for ISource.
    static final class 
    ISource.Jsii$Proxy
    A proxy class which represents a concrete javascript instance of this type.

  • 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 interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Method Details

    • getSourceArn

      @Stability(Experimental) @NotNull String getSourceArn()
      (experimental) The ARN of the source resource.

    • bind

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

      Parameters:
      pipe - This parameter is required.

    • grantRead

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

      Parameters:
      grantee - This parameter is required.