CreateMesh
Creates a service mesh.
A service mesh is a logical boundary for network traffic between services that are represented by resources within the mesh. After you create your service mesh, you can create virtual services, virtual nodes, virtual routers, and routes to distribute traffic between the applications in your mesh.
For more information about service meshes, see Service meshes.
Request Syntax
PUT /v20190125/meshes HTTP/1.1
Content-type: application/json
{
"clientToken": "string
",
"meshName": "string
",
"spec": {
"egressFilter": {
"type": "string
"
},
"serviceDiscovery": {
"ipPreference": "string
"
}
},
"tags": [
{
"key": "string
",
"value": "string
"
}
]
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- clientToken
-
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
Type: String
Required: No
- meshName
-
The name to use for the service mesh.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes
- spec
-
The service mesh specification to apply.
Type: MeshSpec object
Required: No
-
Optional metadata that you can apply to the service mesh 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.
Type: Array of TagRef objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"meshName": "string",
"metadata": {
"arn": "string",
"createdAt": number,
"lastUpdatedAt": number,
"meshOwner": "string",
"resourceOwner": "string",
"uid": "string",
"version": number
},
"spec": {
"egressFilter": {
"type": "string"
},
"serviceDiscovery": {
"ipPreference": "string"
}
},
"status": {
"status": "string"
}
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- meshName
-
The name of the service mesh.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
- metadata
-
The associated metadata for the service mesh.
Type: ResourceMetadata object
- spec
-
The associated specification for the service mesh.
Type: MeshSpec object
- status
-
The status of the service mesh.
Type: MeshStatus object
Errors
- BadRequestException
-
The request syntax was malformed. Check your request syntax and try again.
HTTP Status Code: 400
- ConflictException
-
The request contains a client token that was used for a previous update resource call with different specifications. Try the request again with a new client token.
HTTP Status Code: 409
- ForbiddenException
-
You don't have permissions to perform this action.
HTTP Status Code: 403
- InternalServerErrorException
-
The request processing has failed because of an unknown error, exception, or failure.
HTTP Status Code: 500
- LimitExceededException
-
You have exceeded a service limit for your account. For more information, see Service Limits in the Amazon App Mesh User Guide.
HTTP Status Code: 400
- NotFoundException
-
The specified resource doesn't exist. Check your request syntax and try again.
HTTP Status Code: 404
- ServiceUnavailableException
-
The request has failed due to a temporary failure of the service.
HTTP Status Code: 503
- TooManyRequestsException
-
The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best results, use an increasing or variable sleep interval between requests.
HTTP Status Code: 429
Examples
In the following example or examples, the Authorization header contents
(AUTHPARAMS
) must be replaced with an Amazon Signature Version 4
signature. For more information about creating these signatures, see Signature
Version 4 Signing Process in the
Amazon General
Reference.
You need to learn how to sign HTTP requests only if you intend to manually
create them. When you use the Amazon Command Line Interface (Amazon CLI)
Example
The following example creates a service mesh named
ecs-mesh
.
Sample Request
PUT /v20190125/meshes HTTP/1.1
Host: appmesh.us-east-1.amazonaws.com
Accept-Encoding: identity
User-Agent: aws-cli/1.16.56 Python/3.7.0 Darwin/17.7.0 botocore/1.12.46
X-Amz-Date: 20190227T192324Z
Authorization: AUTHPARAMS
{
"meshName": "ecs-mesh",
"clientToken": "34a20934-da3a-43a0-9d1b-390308a7393b"
}
Sample Response
HTTP/1.1 200 OK
x-amzn-requestid: 5c2f774d-da0b-40f3-80c5-d8711eb15dce
content-type: application/json
content-length: 245
date: Wed, 27 Feb 2019 19:23:24 GMT
x-envoy-upstream-service-time: 76
server: envoy
Connection: keep-alive
{
"meshName": "ecs-mesh",
"metadata": {
"arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/ecs-mesh",
"createdAt": 1.551295405298E9,
"lastUpdatedAt": 1.551295405298E9,
"uid": "2d29a11c-f2dd-44a6-b620-33661cfdfe97",
"version": 1
},
"status": {
"status": "ACTIVE"
}
}
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: