GatewayRoute¶

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

Bases: aws_cdk.core.Resource

(experimental) 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

Stability

experimental

Parameters

scope (Construct) –
id (str) –
virtual_gateway (IVirtualGateway) – (experimental) The VirtualGateway this GatewayRoute is associated with.
route_spec (GatewayRouteSpec) – (experimental) What protocol the route uses.
gateway_route_name (Optional[str]) – (experimental) The name of the GatewayRoute. Default: - an automatically generated name

Stability

experimental

Methods

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¶

(experimental) The Amazon Resource Name (ARN) for the GatewayRoute.

Stability: experimental
Return type: str

gateway_route_name¶

(experimental) The name of the GatewayRoute.

Stability: experimental
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¶

(experimental) The VirtualGateway this GatewayRoute is a part of.

Stability: experimental
Return type: IVirtualGateway

Static Methods

classmethod from_gateway_route_arn(scope, id, gateway_route_arn)¶

(experimental) Import an existing GatewayRoute given an ARN.

Parameters

scope (Construct) –
id (str) –
gateway_route_arn (str) –

Stability

experimental

Return type

IGatewayRoute

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

(experimental) Import an existing GatewayRoute given attributes.

Parameters

scope (Construct) –
id (str) –
gateway_route_name (str) – (experimental) The name of the GatewayRoute.
virtual_gateway (IVirtualGateway) – (experimental) The VirtualGateway this GatewayRoute is associated with.

Stability

experimental

Return type

IGatewayRoute

classmethod is_construct(x)¶

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool