AWS::AppMesh::GatewayRouteCfnGatewayRoute
Creates a gateway route. A gateway route is attached to a virtual gateway and routes traffic to an existing virtual service. If a route matches a request, it can distribute traffic to a target virtual service. For more information about gateway routes, see [Gateway routes](https://docs.aws.amazon.com/app-mesh/latest/userguide/gateway-routes.html) .
Import
import { CfnGatewayRoute } from 'aws-cdk-lib/aws-appmesh';Or use the module namespace:
import * as appmesh from 'aws-cdk-lib/aws-appmesh';
// appmesh.CfnGatewayRouteProperties
Configuration passed to the constructor as CfnGatewayRouteProps.
meshNameRequiredstringThe name of the service mesh that the resource resides in.
specRequiredIResolvable | GatewayRouteSpecPropertyThe specifications of the gateway route.
virtualGatewayNameRequiredstringThe virtual gateway that the gateway route is associated with.
gatewayRouteNameOptionalstringThe name of the gateway route.
meshOwnerOptionalstringThe AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see [Working with shared meshes](https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) .
tagsOptionalCfnTag[]Optional metadata that you can apply to the gateway route to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
CloudFormation Resource
This L1 construct maps directly to the following CloudFormation resource type.
Learn AWS the Practical Way
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterQuick Facts
aws-appmeshAWS::AppMesh::GatewayRoute