Package software.amazon.awscdk.services.appmesh

Class Route

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.appmesh.Route

All Implemented Interfaces:

IResource, IRoute, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-09-11T18:01:11.309Z")
@Stability(Stable)
public class Route
extends Resource
implements IRoute

Route represents a new or existing route attached to a VirtualRouter and Mesh.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.appmesh.*;
 Mesh mesh;
 RouteSpec routeSpec;
 VirtualRouter virtualRouter;
 Route route = Route.Builder.create(this, "MyRoute")
         .mesh(mesh)
         .routeSpec(routeSpec)
         .virtualRouter(virtualRouter)
         // the properties below are optional
         .routeName("routeName")
         .build();
 

See Also:

• https://docs.aws.amazon.com/app-mesh/latest/userguide/routes.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Route.Builder	A fluent builder for Route.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.appmesh.IRoute

IRoute.Jsii$Default, IRoute.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Route(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Route(software.amazon.jsii.JsiiObjectRef objRef)
	Route(software.constructs.Construct scope, String id, RouteProps props)

Method Summary

Modifier and Type	Method	Description
static IRoute	fromRouteArn(software.constructs.Construct scope, String id, String routeArn)	Import an existing Route given an ARN.
static IRoute	fromRouteAttributes(software.constructs.Construct scope, String id, RouteAttributes attrs)	Import an existing Route given attributes.
String	getRouteArn()	The Amazon Resource Name (ARN) for the route.
String	getRouteName()	The name of the Route.
IVirtualRouter	getVirtualRouter()	The VirtualRouter the Route belongs to.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

Route

protected Route(software.amazon.jsii.JsiiObjectRef objRef)

Route

protected Route(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Route

@Stability(Stable)
public Route(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 RouteProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

fromRouteArn

@Stability(Stable)
@NotNull
public static IRoute fromRouteArn(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String routeArn)

Import an existing Route given an ARN.

Parameters:

scope - This parameter is required.

id - This parameter is required.

routeArn - This parameter is required.

fromRouteAttributes

@Stability(Stable)
@NotNull
public static IRoute fromRouteAttributes(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 RouteAttributes attrs)

Import an existing Route given attributes.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

getRouteArn

@Stability(Stable)
@NotNull
public String getRouteArn()

The Amazon Resource Name (ARN) for the route.

Specified by:

getRouteArn in interface IRoute

getRouteName

@Stability(Stable)
@NotNull
public String getRouteName()

The name of the Route.

Specified by:

getRouteName in interface IRoute

getVirtualRouter

@Stability(Stable)
@NotNull
public IVirtualRouter getVirtualRouter()

The VirtualRouter the Route belongs to.

Specified by:

getVirtualRouter in interface IRoute