IVirtualGateway

class aws_cdk.aws_appmesh.IVirtualGateway(*args, **kwds)

Bases: IResource, Protocol

Interface which all Virtual Gateway based classes must implement.

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

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 which the VirtualGateway belongs to.

node

The construct tree node for this construct.

stack

The stack in which this resource is defined.

virtual_gateway_arn

The Amazon Resource Name (ARN) for the VirtualGateway.

Attribute

true

virtual_gateway_name

Name of the VirtualGateway.

Attribute

true