Package software.amazon.awscdk.services.appmesh

Class GatewayRoute

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.appmesh.GatewayRoute

All Implemented Interfaces:

IEnvironmentAware, IResource, IGatewayRoute, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-13T16:09:58.665Z")
@Stability(Stable)
public class GatewayRoute
extends Resource
implements IGatewayRoute

GatewayRoute represents a new or existing gateway route attached to a VirtualGateway 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.*;
 GatewayRouteSpec gatewayRouteSpec;
 VirtualGateway virtualGateway;
 GatewayRoute gatewayRoute = GatewayRoute.Builder.create(this, "MyGatewayRoute")
         .routeSpec(gatewayRouteSpec)
         .virtualGateway(virtualGateway)
         // the properties below are optional
         .gatewayRouteName("gatewayRouteName")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

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.services.appmesh.IGatewayRoute

IGatewayRoute.Jsii$Default, IGatewayRoute.Jsii$Proxy

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

IResource.Jsii$Default

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_INJECTION_ID	Uniquely identifies this class.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static IGatewayRoute	fromGatewayRouteArn(software.constructs.Construct scope, String id, String gatewayRouteArn)	Import an existing GatewayRoute given an ARN.
static IGatewayRoute	fromGatewayRouteAttributes(software.constructs.Construct scope, String id, GatewayRouteAttributes attrs)	Import an existing GatewayRoute given attributes.
String	getGatewayRouteArn()	The Amazon Resource Name (ARN) for the GatewayRoute.
String	getGatewayRouteName()	The name of the GatewayRoute.
IVirtualGateway	getVirtualGateway()	The VirtualGateway this GatewayRoute is a part of.

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.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

PROPERTY_INJECTION_ID

@Stability(Stable)
public static final String PROPERTY_INJECTION_ID

Uniquely identifies this class.

Constructor Details

GatewayRoute

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

GatewayRoute

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

GatewayRoute

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

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

fromGatewayRouteArn

@Stability(Stable)
@NotNull
public static IGatewayRoute fromGatewayRouteArn(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String gatewayRouteArn)

Import an existing GatewayRoute given an ARN.

Parameters:

scope - This parameter is required.

id - This parameter is required.

gatewayRouteArn - This parameter is required.

fromGatewayRouteAttributes

@Stability(Stable)
@NotNull
public static IGatewayRoute fromGatewayRouteAttributes(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 GatewayRouteAttributes attrs)

Import an existing GatewayRoute given attributes.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

getGatewayRouteArn

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

The Amazon Resource Name (ARN) for the GatewayRoute.

Specified by:

getGatewayRouteArn in interface IGatewayRoute

getGatewayRouteName

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

The name of the GatewayRoute.

Specified by:

getGatewayRouteName in interface IGatewayRoute

getVirtualGateway

@Stability(Stable)
@NotNull
public IVirtualGateway getVirtualGateway()

The VirtualGateway this GatewayRoute is a part of.

Specified by:

getVirtualGateway in interface IGatewayRoute