Experimental

@aws-cdk/aws-pipes-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

Pipe L2 construct

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.

Stability: Experimental
Source: lib/pipe.ts

Example

declare const sourceQueue: sqs.Queue;
declare const dest: events.ApiDestination;

const apiTarget = new targets.ApiDestinationTarget(dest, {
  inputTransformation: pipes.InputTransformation.fromObject({ body: "👀" }),
});

const pipe = new pipes.Pipe(this, 'Pipe', {
    source: new SqsSource(sourceQueue),
    target: apiTarget,
});

python

# source_queue: sqs.Queue
# dest: events.ApiDestination


api_target = targets.ApiDestinationTarget(dest,
    input_transformation=pipes.InputTransformation.from_object({"body": "👀"})
)

pipe = pipes.Pipe(self, "Pipe",
    source=SqsSource(source_queue),
    target=api_target
)

java

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();

csharp

// Install: dotnet add package Amazon.CDK.AWS.Pipes.Alpha
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
});

// Install: go get github.com/aws/aws-cdk-go/awscdkpipesalpha/v2
var sourceQueue Queue
var dest ApiDestination


apiTarget := targets.NewApiDestinationTarget(dest, &ApiDestinationTargetParameters{
	InputTransformation: pipes.InputTransformation_FromObject(map[string]interface{}{
		"body": jsii.String("👀"),
	}),
})

pipe := pipes.NewPipe(this, jsii.String("Pipe"), &PipeProps{
	Source: awscdkpipessourcesalpha.NewSqsSource(sourceQueue),
	Target: apiTarget,
})

Initializer

new Pipe(scope: Construct, id: string, props: PipeProps)

python

Pipe(scope: Construct, id: str, props: PipeProps)

java

new Pipe(Construct scope, String id, PipeProps props)

csharp

new Pipe(Construct scope, string id, PipeProps props)

NewPipe(Scope Construct, Id *string, Props PipeProps)

Construct Props

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#

A description of the pipe displayed in the AWS console.

Default: no description

desiredStateoptionalDesiredStatedesired_stateoptionalDesiredStatedesiredStateoptionalDesiredStateDesiredStateoptionalDesiredStateDesiredStateoptionalDesiredState= DesiredState.RUNNING#

The desired state of the pipe.

If the state is set to STOPPED, the pipe will not process events.

enrichmentoptionalIEnrichmentenrichmentoptionalIEnrichmentenrichmentoptionalIEnrichmentEnrichmentoptionalIEnrichmentEnrichmentoptionalIEnrichment#

Enrichment step to enhance the data from the source before sending it to the target.

Default: no enrichment

filteroptionalIFilterfilteroptionalIFilterfilteroptionalIFilterFilteroptionalIFilterFilteroptionalIFilter#

The filter pattern for the pipe source.

Default: no filter

kmsKeyoptionalIKeykms_keyoptionalIKeykmsKeyoptionalIKeyKmsKeyoptionalIKeyKmsKeyoptionalIKey#

The AWS KMS customer managed key to encrypt pipe data.

Default: undefined - AWS managed key is used

logDestinationsoptionalILogDestination[]log_destinationsoptionaltyping.List[ILogDestination]logDestinationsoptionalList<ILogDestination>LogDestinationsoptionalILogDestination[]LogDestinationsoptional*[]ILogDestination#

Destinations for the logs.

Default: no logs

logIncludeExecutionDataoptionalIncludeExecutionData[]log_include_execution_dataoptionaltyping.List[IncludeExecutionData]logIncludeExecutionDataoptionalList<IncludeExecutionData>LogIncludeExecutionDataoptionalIncludeExecutionData[]LogIncludeExecutionDataoptional*[]IncludeExecutionData= none#

Whether the execution data (specifically, the `payload` , `awsRequest` , and `awsResponse` fields) is included in the log messages for this pipe.

notes

This applies to all log destinations for the pipe.

For more information, see Including execution data in logs and the message schema in the Amazon EventBridge User Guide .

logLeveloptionalLogLevellog_leveloptionalLogLevellogLeveloptionalLogLevelLogLeveloptionalLogLevelLogLeveloptionalLogLevel= LogLevel.ERROR#

The level of logging detail to include.

This applies to all log destinations for the pipe.

pipeNameoptionalstringpipe_nameoptionalstrpipeNameoptionalStringPipeNameoptionalstringPipeNameoptional*string#

Name of the pipe in the AWS console.

Default: automatically generated name

roleoptionalIRoleroleoptionalIRoleroleoptionalIRoleRoleoptionalIRoleRoleoptionalIRole#

The role used by the pipe which has permissions to read from the source and write to the target.

Default: a new role will be created.

If an enriched target is used, the role also have permissions to call the enriched target. If no role is provided, a role will be created.

sourceISourcesourceISourcesourceISourceSourceISourceSourceISourcerequired#

The source of the pipe.

tagsoptional{ [key: string]: string }tagsoptionaltyping.Mapping[str, str]tagsoptionalMap<String, String>TagsoptionalIDictionary<string, string>Tagsoptional*map[string]*string#

The list of key-value pairs to associate with the pipe.

Default: no tags

targetITargettargetITargettargetITargetTargetITargetTargetITargetrequired#

The target of the pipe.

Properties

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#

The environment this resource belongs to.

notes

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#

The tree node.

pipeArnstringpipe_arnstrpipeArnStringPipeArnstringPipeArn*stringrequired#

The ARN of the pipe.

pipeNamestringpipe_namestrpipeNameStringPipeNamestringPipeName*stringrequired#

The name of the pipe.

pipeRoleIRolepipe_roleIRolepipeRoleIRolePipeRoleIRolePipeRoleIRolerequired#

The role used by the pipe.

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

PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#

Uniquely identifies this class.

stackStackstackStackstackStackStackStackStackStackrequired#

The stack in which this resource is defined.

Methods

applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#

Override the cross-stack reference strength for this resource.

notes · 1 parameter

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters

strengthstrengthstrengthstrengthStrength — - The reference strength to use for this resource.

applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#

Apply the given removal policy to this resource.

notes

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

fromPipeName(scope: Construct, id: string, pipeName: string): IPipe@staticmethod def from_pipe_name(scope: Construct, id: str, pipe_name: str) -> IPipepublic static IPipe fromPipeName(Construct scope, String id, String pipeName)public static IPipe FromPipeName(Construct scope, string id, string pipeName)func FromPipeName(Scope Construct, Id *string, PipeName *string) IPipestatic#

Creates a pipe from the name of a pipe.

isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#

Checks if `x` is a construct.

notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#

Returns true if the construct was created by CDK, and false otherwise.

isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#

Check whether the given construct is a Resource.

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#

Returns a string representation of this construct.

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Pipe L2 construct ​

Example ​

Initializer ​

Construct Props ​

Properties ​

Methods ​

Pipe L2 construct

Example

Initializer

Construct Props

Properties

Methods