AWS::AppMesh::VirtualGateway - AWS CloudFormation
SyntaxPropertiesReturn valuesSee also

AWS::AppMesh::VirtualGateway

Creates a virtual gateway.

A virtual gateway allows resources outside your mesh to communicate to resources that are inside your mesh. The virtual gateway represents an Envoy proxy running in an Amazon ECS task, in a Kubernetes service, or on an Amazon EC2 instance. Unlike a virtual node, which represents an Envoy running with an application, a virtual gateway represents Envoy deployed by itself.

For more information about virtual gateways, see Virtual gateways.

Syntax

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

JSON

{
  "Type" : "AWS::AppMesh::VirtualGateway",
  "Properties" : {
      "MeshName" : String,
      "MeshOwner" : String,
      "Spec" : VirtualGatewaySpec,
      "Tags" : [ Tag, ... ],
      "VirtualGatewayName" : String
    }
}

YAML

Type: AWS::AppMesh::VirtualGateway
Properties:
  MeshName: String
  MeshOwner: String
  Spec: 
    VirtualGatewaySpec
  Tags: 
    - Tag
  VirtualGatewayName: String

Properties

MeshName

The name of the service mesh that the virtual gateway 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 virtual gateway.

Required: Yes

Type: VirtualGatewaySpec

Update requires: No interruption

Tags

Optional metadata that you can apply to the virtual gateway 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: Array of Tag

Minimum: 0

Maximum: 50

Update requires: No interruption

VirtualGatewayName

The name of the virtual gateway.

Required: No

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": "myVirtualGateway" }

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

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 virtual gateway.

MeshName

The name of the service mesh that the virtual gateway 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 AWS 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 virtual gateway.

VirtualGatewayName

The name of the virtual gateway.

See also