software.amazon.awscdk.services.appmesh

Class VirtualGateway

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.appmesh.VirtualGateway

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.26.0 (build 7d76e02)",
           date="2021-03-25T11:29:25.718Z")
 @Stability(value=Experimental)
public class VirtualGateway
extends Resource
implements IVirtualGateway

(experimental) VirtualGateway represents a newly defined App Mesh Virtual Gateway.

A virtual gateway allows resources that are outside of your mesh to communicate to resources that are inside of your mesh.

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VirtualGateway.Builder (experimental) A fluent builder for VirtualGateway.

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.IVirtualGateway

IVirtualGateway.Jsii$Default, IVirtualGateway.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
GatewayRoute	addGatewayRoute(String id, GatewayRouteBaseProps props) (experimental) Utility method to add a new GatewayRoute to the VirtualGateway.
static IVirtualGateway	fromVirtualGatewayArn(software.constructs.Construct scope, String id, String virtualGatewayArn) (experimental) Import an existing VirtualGateway given an ARN.
static IVirtualGateway	fromVirtualGatewayAttributes(software.constructs.Construct scope, String id, VirtualGatewayAttributes attrs) (experimental) Import an existing VirtualGateway given its attributes.
protected List<VirtualGatewayListenerConfig>	getListeners()
IMesh	getMesh() (experimental) The Mesh that the VirtualGateway belongs to.
String	getVirtualGatewayArn() (experimental) The Amazon Resource Name (ARN) for the VirtualGateway.
String	getVirtualGatewayName() (experimental) The name of the VirtualGateway.

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 software.constructs.Construct

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.core.IResource

getEnv, getStack

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

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

VirtualGateway

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

VirtualGateway

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

VirtualGateway

@Stability(value=Experimental)
public VirtualGateway(@NotNull
                                                     software.constructs.Construct scope,
                                                     @NotNull
                                                     String id,
                                                     @NotNull
                                                     VirtualGatewayProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromVirtualGatewayArn

@Stability(value=Experimental)
 @NotNull
public static IVirtualGateway fromVirtualGatewayArn(@NotNull
                                                                                             software.constructs.Construct scope,
                                                                                             @NotNull
                                                                                             String id,
                                                                                             @NotNull
                                                                                             String virtualGatewayArn)

(experimental) Import an existing VirtualGateway given an ARN.

Parameters:

scope - This parameter is required.

id - This parameter is required.

virtualGatewayArn - This parameter is required.

fromVirtualGatewayAttributes

@Stability(value=Experimental)
 @NotNull
public static IVirtualGateway fromVirtualGatewayAttributes(@NotNull
                                                                                                    software.constructs.Construct scope,
                                                                                                    @NotNull
                                                                                                    String id,
                                                                                                    @NotNull
                                                                                                    VirtualGatewayAttributes attrs)

(experimental) Import an existing VirtualGateway given its attributes.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

addGatewayRoute

@Stability(value=Experimental)
 @NotNull
public GatewayRoute addGatewayRoute(@NotNull
                                                                             String id,
                                                                             @NotNull
                                                                             GatewayRouteBaseProps props)

(experimental) Utility method to add a new GatewayRoute to the VirtualGateway.

Specified by:

addGatewayRoute in interface IVirtualGateway

Parameters:

id - This parameter is required.

props - This parameter is required.

getListeners

@Stability(value=Experimental)
 @NotNull
protected List<VirtualGatewayListenerConfig> getListeners()

getMesh

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

(experimental) The Mesh that the VirtualGateway belongs to.

Specified by:

getMesh in interface IVirtualGateway

getVirtualGatewayArn

@Stability(value=Experimental)
 @NotNull
public String getVirtualGatewayArn()

(experimental) The Amazon Resource Name (ARN) for the VirtualGateway.

Specified by:

getVirtualGatewayArn in interface IVirtualGateway

getVirtualGatewayName

@Stability(value=Experimental)
 @NotNull
public String getVirtualGatewayName()

(experimental) The name of the VirtualGateway.

Specified by:

getVirtualGatewayName in interface IVirtualGateway