software.amazon.awscdk.services.appmesh

Class GatewayRoute

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.appmesh.GatewayRoute

All Implemented Interfaces:

IConstruct, IDependable, IResource, IGatewayRoute

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:48.555Z")
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 and Description
static class	GatewayRoute.Builder A fluent builder for GatewayRoute.

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

IGatewayRoute.Jsii$Default, IGatewayRoute.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class software.amazon.awscdk.core.Resource

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

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

GatewayRoute

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

GatewayRoute

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

GatewayRoute

public GatewayRoute(software.constructs.Construct scope,
                    java.lang.String id,
                    GatewayRouteProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromGatewayRouteArn

public static IGatewayRoute fromGatewayRouteArn(software.constructs.Construct scope,
                                                java.lang.String id,
                                                java.lang.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

public static IGatewayRoute fromGatewayRouteAttributes(software.constructs.Construct scope,
                                                       java.lang.String id,
                                                       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

public java.lang.String getGatewayRouteArn()

The Amazon Resource Name (ARN) for the GatewayRoute.

Specified by:

getGatewayRouteArn in interface IGatewayRoute

getGatewayRouteName

public java.lang.String getGatewayRouteName()

The name of the GatewayRoute.

Specified by:

getGatewayRouteName in interface IGatewayRoute

getVirtualGateway

public IVirtualGateway getVirtualGateway()

The VirtualGateway this GatewayRoute is a part of.

Specified by:

getVirtualGateway in interface IGatewayRoute