GatewayRoute

class aws_cdk.aws_appmesh.GatewayRoute(scope, id, *, virtual_gateway, gateway_route_name=None, route_spec)

Bases: aws_cdk.core.Resource

GatewayRoute represents a new or existing gateway route attached to a VirtualGateway and Mesh.

See

https://docs.aws.amazon.com/app-mesh/latest/userguide/gateway-routes.html

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_appmesh as appmesh

# gateway_route_spec is of type GatewayRouteSpec
# virtual_gateway is of type VirtualGateway

gateway_route = appmesh.GatewayRoute(self, "MyGatewayRoute",
    route_spec=gateway_route_spec,
    virtual_gateway=virtual_gateway,

    # the properties below are optional
    gateway_route_name="gatewayRouteName"
)
Parameters

  • scope (Construct) –

  • id (str) –

  • virtual_gateway (IVirtualGateway) – The VirtualGateway this GatewayRoute is associated with.

  • gateway_route_name (Optional[str]) – The name of the GatewayRoute. Default: - an automatically generated name

  • route_spec (GatewayRouteSpec) – What protocol the route uses.

Methods

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

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

gateway_route_arn

The Amazon Resource Name (ARN) for the GatewayRoute.

Return type

str

gateway_route_name

The name of the GatewayRoute.

Return type

str

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

The VirtualGateway this GatewayRoute is a part of.

Return type

IVirtualGateway

Static Methods

classmethod from_gateway_route_arn(scope, id, gateway_route_arn)

Import an existing GatewayRoute given an ARN.

Parameters

  • scope (Construct) –

  • id (str) –

  • gateway_route_arn (str) –

Return type

IGatewayRoute

classmethod from_gateway_route_attributes(scope, id, *, gateway_route_name, virtual_gateway)

Import an existing GatewayRoute given attributes.

Parameters

  • scope (Construct) –

  • id (str) –

  • gateway_route_name (str) – The name of the GatewayRoute.

  • virtual_gateway (IVirtualGateway) – The VirtualGateway this GatewayRoute is associated with.

Return type

IGatewayRoute

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