software.amazon.awscdk.services.appmesh

Class VirtualRouter

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.appmesh.VirtualRouter

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.587Z")
 @Stability(value=Stable)
public class VirtualRouter
extends Resource
implements IVirtualRouter

Example:

 // Example automatically generated from non-compiling source. May contain errors.
 Mesh mesh;
 VirtualRouter router = mesh.addVirtualRouter("router", VirtualRouterBaseProps.builder()
         .listeners(List.of(VirtualRouterListener.http(8080)))
         .build());
 

Nested Class Summary

Nested Classes

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

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IVirtualRouter.Jsii$Default, IVirtualRouter.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Route	addRoute(String id, RouteBaseProps props) Add a single route to the router.
static IVirtualRouter	fromVirtualRouterArn(software.constructs.Construct scope, String id, String virtualRouterArn) Import an existing VirtualRouter given an ARN.
static IVirtualRouter	fromVirtualRouterAttributes(software.constructs.Construct scope, String id, VirtualRouterAttributes attrs) Import an existing VirtualRouter given attributes.
IMesh	getMesh() The Mesh which the VirtualRouter belongs to.
String	getVirtualRouterArn() The Amazon Resource Name (ARN) for the VirtualRouter.
String	getVirtualRouterName() The name of the VirtualRouter.

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.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

VirtualRouter

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

VirtualRouter

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

VirtualRouter

@Stability(value=Stable)
public VirtualRouter(@NotNull
                                              software.constructs.Construct scope,
                                              @NotNull
                                              String id,
                                              @NotNull
                                              VirtualRouterProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromVirtualRouterArn

@Stability(value=Stable)
 @NotNull
public static IVirtualRouter fromVirtualRouterArn(@NotNull
                                                                                     software.constructs.Construct scope,
                                                                                     @NotNull
                                                                                     String id,
                                                                                     @NotNull
                                                                                     String virtualRouterArn)

Import an existing VirtualRouter given an ARN.

Parameters:

scope - This parameter is required.

id - This parameter is required.

virtualRouterArn - This parameter is required.

fromVirtualRouterAttributes

@Stability(value=Stable)
 @NotNull
public static IVirtualRouter fromVirtualRouterAttributes(@NotNull
                                                                                            software.constructs.Construct scope,
                                                                                            @NotNull
                                                                                            String id,
                                                                                            @NotNull
                                                                                            VirtualRouterAttributes attrs)

Import an existing VirtualRouter given attributes.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

addRoute

@Stability(value=Stable)
 @NotNull
public Route addRoute(@NotNull
                                                         String id,
                                                         @NotNull
                                                         RouteBaseProps props)

Add a single route to the router.

Specified by:

addRoute in interface IVirtualRouter

Parameters:

id - This parameter is required.

props - This parameter is required.

getMesh

@Stability(value=Stable)
 @NotNull
public IMesh getMesh()

The Mesh which the VirtualRouter belongs to.

Specified by:

getMesh in interface IVirtualRouter

getVirtualRouterArn

@Stability(value=Stable)
 @NotNull
public String getVirtualRouterArn()

The Amazon Resource Name (ARN) for the VirtualRouter.

Specified by:

getVirtualRouterArn in interface IVirtualRouter

getVirtualRouterName

@Stability(value=Stable)
 @NotNull
public String getVirtualRouterName()

The name of the VirtualRouter.

Specified by:

getVirtualRouterName in interface IVirtualRouter