software.amazon.awscdk.services.appmesh

Class VirtualGateway

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.appmesh.VirtualGateway

All Implemented Interfaces:

IConstruct, IDependable, IResource, IVirtualGateway

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-09T19:16:43.006Z")
public class VirtualGateway
extends Resource
implements IVirtualGateway

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.

Example:

 // A Virtual Node with a gRPC listener with a connection pool set
 Mesh mesh;
 VirtualNode node = VirtualNode.Builder.create(this, "node")
         .mesh(mesh)
         // DNS service discovery can optionally specify the DNS response type as either LOAD_BALANCER or ENDPOINTS.
         // LOAD_BALANCER means that the DNS resolver returns a loadbalanced set of endpoints,
         // whereas ENDPOINTS means that the DNS resolver is returning all the endpoints.
         // By default, the response type is assumed to be LOAD_BALANCER
         .serviceDiscovery(ServiceDiscovery.dns("node", DnsResponseType.ENDPOINTS))
         .listeners(List.of(VirtualNodeListener.http(HttpVirtualNodeListenerOptions.builder()
                 .port(80)
                 .connectionPool(HttpConnectionPool.builder()
                         .maxConnections(100)
                         .maxPendingRequests(10)
                         .build())
                 .build())))
         .build();
 // A Virtual Gateway with a gRPC listener with a connection pool set
 VirtualGateway gateway = VirtualGateway.Builder.create(this, "gateway")
         .mesh(mesh)
         .listeners(List.of(VirtualGatewayListener.grpc(GrpcGatewayListenerOptions.builder()
                 .port(8080)
                 .connectionPool(GrpcConnectionPool.builder()
                         .maxRequests(10)
                         .build())
                 .build())))
         .virtualGatewayName("gateway")
         .build();
 

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 A fluent builder for VirtualGateway.

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
protected	VirtualGateway(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	VirtualGateway(software.amazon.jsii.JsiiObjectRef objRef)
	VirtualGateway(software.constructs.Construct scope, java.lang.String id, VirtualGatewayProps props)

Method Summary

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

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

VirtualGateway

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

VirtualGateway

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

VirtualGateway

public VirtualGateway(software.constructs.Construct scope,
                      java.lang.String id,
                      VirtualGatewayProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromVirtualGatewayArn

public static IVirtualGateway fromVirtualGatewayArn(software.constructs.Construct scope,
                                                    java.lang.String id,
                                                    java.lang.String virtualGatewayArn)

Import an existing VirtualGateway given an ARN.

Parameters:

scope - This parameter is required.

id - This parameter is required.

virtualGatewayArn - This parameter is required.

fromVirtualGatewayAttributes

public static IVirtualGateway fromVirtualGatewayAttributes(software.constructs.Construct scope,
                                                           java.lang.String id,
                                                           VirtualGatewayAttributes attrs)

Import an existing VirtualGateway given its attributes.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

addGatewayRoute

public GatewayRoute addGatewayRoute(java.lang.String id,
                                    GatewayRouteBaseProps props)

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.

grantStreamAggregatedResources

public Grant grantStreamAggregatedResources(IGrantable identity)

Grants the given entity `appmesh:StreamAggregatedResources`.

Specified by:

grantStreamAggregatedResources in interface IVirtualGateway

Parameters:

identity - This parameter is required.

getListeners

protected java.util.List<VirtualGatewayListenerConfig> getListeners()

getMesh

public IMesh getMesh()

The Mesh that the VirtualGateway belongs to.

Specified by:

getMesh in interface IVirtualGateway

getVirtualGatewayArn

public java.lang.String getVirtualGatewayArn()

The Amazon Resource Name (ARN) for the VirtualGateway.

Specified by:

getVirtualGatewayArn in interface IVirtualGateway

getVirtualGatewayName

public java.lang.String getVirtualGatewayName()

The name of the VirtualGateway.

Specified by:

getVirtualGatewayName in interface IVirtualGateway