interface IGatewayRoute

Language	Type name
.NET	Amazon.CDK.AWS.AppMesh.IGatewayRoute
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsappmesh#IGatewayRoute
Java	software.amazon.awscdk.services.appmesh.IGatewayRoute
Python	aws_cdk.aws_appmesh.IGatewayRoute
TypeScript (source)	aws-cdk-lib » aws_appmesh » IGatewayRoute

Implemented by GatewayRoute

Obtainable from GatewayRoute.fromGatewayRouteArn(), GatewayRoute.fromGatewayRouteAttributes()

Interface for which all GatewayRoute based classes MUST implement.

Properties

Name	Type	Description
env	ResourceEnvironment	The environment this resource belongs to.
gatewayRouteArn	string	The Amazon Resource Name (ARN) for the GatewayRoute.
gatewayRouteName	string	The name of the GatewayRoute.
node	Node	The tree node.
stack	Stack	The stack in which this resource is defined.
virtualGateway	IVirtualGateway	The VirtualGateway the GatewayRoute belongs to.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

gatewayRouteArn

Type: string

The Amazon Resource Name (ARN) for the GatewayRoute.

---

gatewayRouteName

Type: string

The name of the GatewayRoute.

---

node

Type: Node

The tree node.

---

stack

Type: Stack

The stack in which this resource is defined.

---

virtualGateway

Type: IVirtualGateway

The VirtualGateway the GatewayRoute belongs to.

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