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

Class Pipe

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.pipes.alpha.Pipe
All Implemented Interfaces:
IResource, IPipe, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-10-31T19:13:08.133Z") @Stability(Experimental) public class Pipe extends Resource implements IPipe
(experimental) Amazon EventBridge Pipes connects sources to targets.

Pipes are intended for point-to-point integrations between supported sources and targets, with support for advanced transformations and enrichment.

Example: 

 Stream sourceStream;
 Queue targetQueue;
 KinesisSource pipeSource = KinesisSource.Builder.create(sourceStream)
         .startingPosition(KinesisStartingPosition.LATEST)
         .build();
 Pipe pipe = Pipe.Builder.create(this, "Pipe")
         .source(pipeSource)
         .target(new SomeTarget(targetQueue))
         .build();

See Also:

  • Nested Class Summary

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

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

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.constructs.IConstruct

    software.constructs.IConstruct.Jsii$Default

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

    IPipe.Jsii$Default, IPipe.Jsii$Proxy

    Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

    IResource.Jsii$Default

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Pipe(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    Pipe(software.amazon.jsii.JsiiObjectRef objRef)
     
     
    Pipe(software.constructs.Construct scope, String id, PipeProps props)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static IPipe
    fromPipeName(software.constructs.Construct scope, String id, String pipeName)
    (experimental) Creates a pipe from the name of a pipe.
    String
    getPipeArn()
    (experimental) The ARN of the pipe.
    String
    getPipeName()
    (experimental) The name of the pipe.
    IRole
    getPipeRole()
    (experimental) The role used by the pipe.

    Methods inherited from class software.amazon.awscdk.Resource

    applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

    Methods inherited from class software.constructs.Construct

    getNode, isConstruct, toString

    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, wait, wait, wait

    Methods inherited from interface software.constructs.IConstruct

    getNode

    Methods inherited from interface software.amazon.awscdk.IResource

    applyRemovalPolicy, getEnv, getStack

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Constructor Details

    • Pipe

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

    • Pipe

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

    • Pipe

      @Stability(Experimental) public Pipe(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull PipeProps props)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props - This parameter is required.

  • Method Details

    • fromPipeName

      @Stability(Experimental) @NotNull public static IPipe fromPipeName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String pipeName)
      (experimental) Creates a pipe from the name of a pipe.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      pipeName - This parameter is required.

    • getPipeArn

      @Stability(Experimental) @NotNull public String getPipeArn()
      (experimental) The ARN of the pipe.
      Specified by:
      getPipeArn in interface IPipe

    • getPipeName

      @Stability(Experimental) @NotNull public String getPipeName()
      (experimental) The name of the pipe.
      Specified by:
      getPipeName in interface IPipe

    • getPipeRole

      @Stability(Experimental) @NotNull public IRole getPipeRole()
      (experimental) The role used by the pipe.

      For imported pipes it assumes that the default role is used.

      Specified by:
      getPipeRole in interface IPipe