GatewayRouteProps

class aws_cdk.aws_appmesh.GatewayRouteProps(*, route_spec, gateway_route_name=None, virtual_gateway)

Bases: aws_cdk.aws_appmesh.GatewayRouteBaseProps

Properties to define a new GatewayRoute.

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

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

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

ExampleMetadata

fixture=_generated

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: appmesh.GatewayRouteSpec
# virtual_gateway: appmesh.VirtualGateway

gateway_route_props = appmesh.GatewayRouteProps(
    route_spec=gateway_route_spec,
    virtual_gateway=virtual_gateway,

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

Attributes

gateway_route_name

The name of the GatewayRoute.

Default
  • an automatically generated name

Return type

Optional[str]

route_spec

What protocol the route uses.

Return type

GatewayRouteSpec

virtual_gateway

The VirtualGateway this GatewayRoute is associated with.

Return type

IVirtualGateway