AWS::AppMesh::VirtualService
Creates a virtual service within a service mesh.
A virtual service is an abstraction of a real service that is provided by a virtual node
directly or indirectly by means of a virtual router. Dependent services call your virtual
service by its virtualServiceName
, and those requests are routed to the
virtual node or virtual router that is specified as the provider for the virtual
service.
For more information about virtual services, see Virtual services.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::AppMesh::VirtualService", "Properties" : { "MeshName" :
String
, "MeshOwner" :String
, "Spec" :VirtualServiceSpec
, "Tags" :[ Tag, ... ]
, "VirtualServiceName" :String
} }
YAML
Type: AWS::AppMesh::VirtualService Properties: MeshName:
String
MeshOwner:String
Spec:VirtualServiceSpec
Tags:- Tag
VirtualServiceName:String
Properties
MeshName
-
The name of the service mesh to create the virtual service in.
Required: Yes
Type: String
Minimum:
1
Maximum:
255
Update requires: Replacement
MeshOwner
-
The Amazon IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes.
Required: No
Type: String
Minimum:
12
Maximum:
12
Update requires: Replacement
Spec
-
The virtual service specification to apply.
Required: Yes
Type: VirtualServiceSpec
Update requires: No interruption
-
Optional metadata that you can apply to the virtual service 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
VirtualServiceName
-
The name to use for the virtual service.
Required: Yes
Type: String
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": "myVirtualService" }
When you pass the logical ID of an AWS::AppMesh::VirtualService
resource to
the intrinsic Ref function, the function returns the virtual service ARN, such as
arn:aws:appmesh:us-east-1:555555555555:virtualService/myVirtualService
.
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 service.
MeshName
-
The name of the service mesh that the virtual service resides in.
MeshOwner
-
The Amazon 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 Amazon 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 service.
VirtualServiceName
-
The name of the virtual service.
See also
-
Virtual Services in the Amazon App Mesh User Guide .
-
CreateVirtualService in the Amazon App Mesh API Reference .