interface IPipe 🔹

Language	Type name
.NET	Amazon.CDK.AWS.Pipes.Alpha.IPipe
Go	github.com/aws/aws-cdk-go/awscdkpipesalpha/v2#IPipe
Java	software.amazon.awscdk.services.pipes.alpha.IPipe
Python	aws_cdk.aws_pipes_alpha.IPipe
TypeScript (source)	@aws-cdk/aws-pipes-alpha » IPipe

Implemented by Pipe

Obtainable from Pipe.fromPipeName()

Interface representing a created or an imported Pipe.

Properties

Name	Type	Description
env🔹	ResourceEnvironment	The environment this resource belongs to.
node🔹	Node	The tree node.
pipeArn🔹	string	The ARN of the pipe.
pipeName🔹	string	The name of the pipe.
pipeRole🔹	IRole	The role used by the pipe.
stack🔹	Stack	The stack in which this resource is defined.

---

env🔹

Type: ResourceEnvironment

The environment this resource belongs to.

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.

---

node🔹

Type: Node

The tree node.

---

pipeArn🔹

Type: string

The ARN of the pipe.

---

pipeName🔹

Type: string

The name of the pipe.

---

pipeRole🔹

Type: IRole

The role used by the pipe.

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

---

stack🔹

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.

---

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

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).