VirtualGateway

class aws_cdk.aws_appmesh.VirtualGateway(scope, id, *, mesh, access_log=None, backend_defaults=None, listeners=None, virtual_gateway_name=None)

Bases: Resource

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:: https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_gateways.html
ExampleMetadata:: infused

Example:

# 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"
)

Parameters:

scope (Construct) –
id (str) –
mesh (IMesh) – The Mesh which the VirtualGateway belongs to.
access_log (Optional[AccessLog]) – Access Logging Configuration for the VirtualGateway. Default: - no access logging
backend_defaults (Union[BackendDefaults, Dict[str, Any], None]) – Default Configuration Virtual Node uses to communicate with Virtual Service. Default: - No Config
listeners (Optional[Sequence[VirtualGatewayListener]]) – Listeners for the VirtualGateway. Only one is supported. Default: - Single HTTP listener on port 8080
virtual_gateway_name (Optional[str]) – Name of the VirtualGateway. Default: - A name is automatically determined

Methods

add_gateway_route(id, *, route_spec, gateway_route_name=None)

Utility method to add a new GatewayRoute to the VirtualGateway.

Parameters:

id (str) –
route_spec (GatewayRouteSpec) – What protocol the route uses.
gateway_route_name (Optional[str]) – The name of the GatewayRoute. Default: - an automatically generated name

Return type:

GatewayRoute

apply_removal_policy(policy)

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 (RemovalPolicy.RETAIN).

Parameters:

policy (RemovalPolicy) –

Return type:

None

grant_stream_aggregated_resources(identity)

Grants the given entity appmesh:StreamAggregatedResources.

Parameters:

identity (IGrantable) –

Return type:

Grant

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

env

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.

mesh: The Mesh that the VirtualGateway belongs to.

node: The tree node.

stack: The stack in which this resource is defined.

virtual_gateway_arn: The Amazon Resource Name (ARN) for the VirtualGateway.

virtual_gateway_name: The name of the VirtualGateway.

Static Methods

classmethod from_virtual_gateway_arn(scope, id, virtual_gateway_arn)

Import an existing VirtualGateway given an ARN.

Parameters:

scope (Construct) –
id (str) –
virtual_gateway_arn (str) –

Return type:

IVirtualGateway

classmethod from_virtual_gateway_attributes(scope, id, *, mesh, virtual_gateway_name)

Import an existing VirtualGateway given its attributes.

Parameters:

scope (Construct) –
id (str) –
mesh (IMesh) – The Mesh that the VirtualGateway belongs to.
virtual_gateway_name (str) – The name of the VirtualGateway.

Return type:

IVirtualGateway

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

Parameters:

construct (IConstruct) –

Return type:

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:

construct (IConstruct) –

Return type:

bool