VirtualGateway

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

Bases: aws_cdk.core.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

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 (Optional[BackendDefaults]) – 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.DELETE), 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.

Return type

ResourceEnvironment

mesh

The Mesh that the VirtualGateway belongs to.

Return type

IMesh

node

The construct tree node associated with this construct.

Return type

ConstructNode

stack

The stack in which this resource is defined.

Return type

Stack

virtual_gateway_arn

The Amazon Resource Name (ARN) for the VirtualGateway.

Return type

str

virtual_gateway_name

The name of the VirtualGateway.

Return type

str

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)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters

construct (IConstruct) –

Return type

bool