aws-cdk-lib.aws_appmesh.IRoute

interface IRoute

LanguageType name
.NETAmazon.CDK.AWS.AppMesh.IRoute
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsappmesh#IRoute
Javasoftware.amazon.awscdk.services.appmesh.IRoute
Pythonaws_cdk.aws_appmesh.IRoute
TypeScript (source)aws-cdk-lib » aws_appmesh » IRoute

Implemented by Route

Obtainable from Route.fromRouteArn(), Route.fromRouteAttributes()

Interface for which all Route based classes MUST implement.

Properties

NameTypeDescription
envResourceEnvironmentThe environment this resource belongs to.
nodeNodeThe tree node.
routeArnstringThe Amazon Resource Name (ARN) for the route.
routeNamestringThe name of the route.
stackStackThe stack in which this resource is defined.
virtualRouterIVirtualRouterThe VirtualRouter the Route 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.


node

Type: Node

The tree node.


routeArn

Type: string

The Amazon Resource Name (ARN) for the route.


routeName

Type: string

The name of the route.


stack

Type: Stack

The stack in which this resource is defined.


virtualRouter

Type: IVirtualRouter

The VirtualRouter the Route belongs to.

Methods

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