- class aws_cdk.aws_appmesh.VirtualGateway(scope, id, *, mesh, access_log=None, backend_defaults=None, listeners=None, virtual_gateway_name=None)
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.
# A Virtual Node with a gRPC listener with a connection pool set # mesh: appmesh.Mesh node = appmesh.VirtualNode(self, "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 service_discovery=appmesh.ServiceDiscovery.dns("node", appmesh.DnsResponseType.ENDPOINTS), listeners=[appmesh.VirtualNodeListener.http( port=80, connection_pool=appmesh.HttpConnectionPool( max_connections=100, max_pending_requests=10 ) )] ) # A Virtual Gateway with a gRPC listener with a connection pool set gateway = appmesh.VirtualGateway(self, "gateway", mesh=mesh, listeners=[appmesh.VirtualGatewayListener.grpc( port=8080, connection_pool=appmesh.GrpcConnectionPool( max_requests=10 ) )], virtual_gateway_name="gateway" )
IMesh) – The Mesh which the VirtualGateway belongs to.
AccessLog]) – Access Logging Configuration for the VirtualGateway. Default: - no access logging
None]) – Default Configuration Virtual Node uses to communicate with Virtual Service. Default: - No Config
VirtualGatewayListener]]) – Listeners for the VirtualGateway. Only one is supported. Default: - Single HTTP listener on port 8080
str]) – Name of the VirtualGateway. Default: - A name is automatically determined
- add_gateway_route(id, *, route_spec, gateway_route_name=None)
Utility method to add a new GatewayRoute to the VirtualGateway.
Apply the given removal policy to this resource.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (
- Return type:
Grants the given entity
Returns a string representation of this construct.
- Return type:
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
The Mesh that the VirtualGateway belongs to.
The construct tree node associated with this construct.
The stack in which this resource is defined.
The Amazon Resource Name (ARN) for the VirtualGateway.
The name of the VirtualGateway.
- classmethod from_virtual_gateway_arn(scope, id, virtual_gateway_arn)
Import an existing VirtualGateway given an ARN.
- classmethod from_virtual_gateway_attributes(scope, id, *, mesh, virtual_gateway_name)
Import an existing VirtualGateway given its attributes.
- classmethod is_construct(x)
Return whether the given object is a Construct.
- Return type: