AWS::AppMesh::GatewayRoute - AWS CloudFormation

AWS::AppMesh::GatewayRoute

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.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "Type" : "AWS::AppMesh::GatewayRoute", "Properties" : { "GatewayRouteName" : String, "MeshName" : String, "MeshOwner" : String, "Spec" : GatewayRouteSpec, "Tags" : [ Tag, ... ], "VirtualGatewayName" : String } }

YAML

Type: AWS::AppMesh::GatewayRoute Properties: GatewayRouteName: String MeshName: String MeshOwner: String Spec: GatewayRouteSpec Tags: - Tag VirtualGatewayName: String

Properties

GatewayRouteName

The name of the gateway route.

Required: No

Type: String

Minimum: 1

Maximum: 255

Update requires: Replacement

MeshName

The name of the service mesh that the resource resides in.

Required: Yes

Type: String

Minimum: 1

Maximum: 255

Update requires: Replacement

MeshOwner

The 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.

Required: No

Type: String

Minimum: 12

Maximum: 12

Update requires: Replacement

Spec

The specifications of the gateway route.

Required: Yes

Type: GatewayRouteSpec

Update requires: No interruption

Tags

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.

Required: No

Type: List of Tag

Maximum: 50

Update requires: No interruption

VirtualGatewayName

The virtual gateway that the gateway route is associated with.

Required: Yes

Type: String

Minimum: 1

Maximum: 255

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the resource ARN. For example:

{ "Ref": "myGatewayRoute" }

When you pass the logical ID of an AWS::AppMesh::GatewayRoute resource to the intrinsic Ref function, the function returns the gateway route ARN, such as arn:aws:appmesh:us-east-1:555555555555:gatewayRoute/myGatewayRoute .

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

The full Amazon Resource Name (ARN) for the gateway route.

GatewayRouteName

The name of the gateway route.

MeshName

The name of the service mesh that the gateway route resides in.

MeshOwner

The 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.

ResourceOwner

The IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with Shared Meshes.

Uid

The unique identifier for the gateway route.

VirtualGatewayName

The name of the virtual gateway that the gateway route is associated with.

See also