Class Pipe

(experimental) Amazon EventBridge Pipes connects sources to targets.

Inheritance
object
Resource
Pipe
Implements
IConstruct
IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.Pipes.Alpha
Assembly: Amazon.CDK.AWS.Pipes.Alpha.dll
Syntax (csharp)
public class Pipe : Resource, IPipe, IResource, IConstruct, IDependable, IEnvironmentAware
Syntax (vb)
Public Class Pipe Inherits Resource Implements IPipe, IResource, IConstruct, IDependable, IEnvironmentAware
Remarks

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

Stability: Experimental

See: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html

ExampleMetadata: infused

Examples
Queue sourceQueue;
             ApiDestination dest;


             var apiTarget = new ApiDestinationTarget(dest, new ApiDestinationTargetParameters {
                 InputTransformation = InputTransformation.FromObject(new Dictionary<string, object> { { "body", "👀" } })
             });

             var pipe = new Pipe(this, "Pipe", new PipeProps {
                 Source = new SqsSource(sourceQueue),
                 Target = apiTarget
             });

Synopsis

Constructors

Pipe(Construct, string, IPipeProps)

(experimental) Amazon EventBridge Pipes connects sources to targets.

Properties

PROPERTY_INJECTION_ID

(experimental) Uniquely identifies this class.
PipeArn

(experimental) The ARN of the pipe.
PipeName

(experimental) The name of the pipe.
PipeRole

(experimental) The role used by the pipe.

Methods

FromPipeName(Construct, string, string)

(experimental) Creates a pipe from the name of a pipe.

Constructors

Pipe(Construct, string, IPipeProps)

(experimental) Amazon EventBridge Pipes connects sources to targets.

public Pipe(Construct scope, string id, IPipeProps props)
Parameters
scope Construct
id string
props IPipeProps
Remarks

Stability: Experimental

Properties

PROPERTY_INJECTION_ID

(experimental) Uniquely identifies this class.

public static string PROPERTY_INJECTION_ID { get; }
Property Value

string

Remarks

Stability: Experimental

PipeArn

(experimental) The ARN of the pipe.

public virtual string PipeArn { get; }
Property Value

string

Remarks

Stability: Experimental

PipeName

(experimental) The name of the pipe.

public virtual string PipeName { get; }
Property Value

string

Remarks

Stability: Experimental

PipeRole

(experimental) The role used by the pipe.

public virtual IRole PipeRole { get; }
Property Value

IRole

Remarks

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

Stability: Experimental

Methods

FromPipeName(Construct, string, string)

(experimental) Creates a pipe from the name of a pipe.

public static IPipe FromPipeName(Construct scope, string id, string pipeName)
Parameters
scope Construct
id string
pipeName string
Returns

IPipe

Remarks

Stability: Experimental

Implements

Constructs.IConstruct
Constructs.IDependable