@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSAppMesh
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSAppMesh
instead.
AWS App Mesh is a service mesh based on the Envoy proxy that makes it easy to monitor and control containerized microservices. App Mesh standardizes how your microservices communicate, giving you end-to-end visibility and helping to ensure high-availability for your applications.
App Mesh gives you consistent visibility and network traffic controls for every microservice in an application. You can use App Mesh with Amazon ECS (using the Amazon EC2 launch type), Amazon EKS, and Kubernetes on AWS.
App Mesh supports containerized microservice applications that use service discovery naming for their components. To
use App Mesh, you must have a containerized application running on Amazon EC2 instances, hosted in either Amazon ECS,
Amazon EKS, or Kubernetes on AWS. For more information about service discovery on Amazon ECS, see Service Discovery in the
Amazon Elastic Container Service Developer Guide. Kubernetes kube-dns
is supported. For more
information, see DNS for Services
and Pods in the Kubernetes documentation.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
CreateMeshResult |
createMesh(CreateMeshRequest createMeshRequest)
Creates a new service mesh.
|
CreateRouteResult |
createRoute(CreateRouteRequest createRouteRequest)
Creates a new route that is associated with a virtual router.
|
CreateVirtualNodeResult |
createVirtualNode(CreateVirtualNodeRequest createVirtualNodeRequest)
Creates a new virtual node within a service mesh.
|
CreateVirtualRouterResult |
createVirtualRouter(CreateVirtualRouterRequest createVirtualRouterRequest)
Creates a new virtual router within a service mesh.
|
DeleteMeshResult |
deleteMesh(DeleteMeshRequest deleteMeshRequest)
Deletes an existing service mesh.
|
DeleteRouteResult |
deleteRoute(DeleteRouteRequest deleteRouteRequest)
Deletes an existing route.
|
DeleteVirtualNodeResult |
deleteVirtualNode(DeleteVirtualNodeRequest deleteVirtualNodeRequest)
Deletes an existing virtual node.
|
DeleteVirtualRouterResult |
deleteVirtualRouter(DeleteVirtualRouterRequest deleteVirtualRouterRequest)
Deletes an existing virtual router.
|
DescribeMeshResult |
describeMesh(DescribeMeshRequest describeMeshRequest)
Describes an existing service mesh.
|
DescribeRouteResult |
describeRoute(DescribeRouteRequest describeRouteRequest)
Describes an existing route.
|
DescribeVirtualNodeResult |
describeVirtualNode(DescribeVirtualNodeRequest describeVirtualNodeRequest)
Describes an existing virtual node.
|
DescribeVirtualRouterResult |
describeVirtualRouter(DescribeVirtualRouterRequest describeVirtualRouterRequest)
Describes an existing virtual router.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
ListMeshesResult |
listMeshes(ListMeshesRequest listMeshesRequest)
Returns a list of existing service meshes.
|
ListRoutesResult |
listRoutes(ListRoutesRequest listRoutesRequest)
Returns a list of existing routes in a service mesh.
|
ListVirtualNodesResult |
listVirtualNodes(ListVirtualNodesRequest listVirtualNodesRequest)
Returns a list of existing virtual nodes.
|
ListVirtualRoutersResult |
listVirtualRouters(ListVirtualRoutersRequest listVirtualRoutersRequest)
Returns a list of existing virtual routers in a service mesh.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
UpdateRouteResult |
updateRoute(UpdateRouteRequest updateRouteRequest)
Updates an existing route for a specified service mesh and virtual router.
|
UpdateVirtualNodeResult |
updateVirtualNode(UpdateVirtualNodeRequest updateVirtualNodeRequest)
Updates an existing virtual node in a specified service mesh.
|
UpdateVirtualRouterResult |
updateVirtualRouter(UpdateVirtualRouterRequest updateVirtualRouterRequest)
Updates an existing virtual router in a specified service mesh.
|
static final String ENDPOINT_PREFIX
CreateMeshResult createMesh(CreateMeshRequest createMeshRequest)
Creates a new service mesh. A service mesh is a logical boundary for network traffic between the services that reside within it.
After you create your service mesh, you can create virtual nodes, virtual routers, and routes to distribute traffic between the applications in your mesh.
createMeshRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.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.ForbiddenException
- You do not have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.LimitExceededException
- You have exceeded a service limit for your account. For more information, see Service Limits in
the AWS App Mesh User Guide.NotFoundException
- The specified resource does not exist. Check your request syntax and try again.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.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.CreateRouteResult createRoute(CreateRouteRequest createRouteRequest)
Creates a new route that is associated with a virtual router.
You can use the prefix
parameter in your route specification for path-based routing of requests. For
example, if your virtual router service name is my-service.local
, and you want the route to match
requests to my-service.local/metrics
, then your prefix should be /metrics
.
If your route matches a request, you can distribute traffic to one or more target virtual nodes with relative weighting.
createRouteRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.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.ForbiddenException
- You do not have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.LimitExceededException
- You have exceeded a service limit for your account. For more information, see Service Limits in
the AWS App Mesh User Guide.NotFoundException
- The specified resource does not exist. Check your request syntax and try again.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.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.CreateVirtualNodeResult createVirtualNode(CreateVirtualNodeRequest createVirtualNodeRequest)
Creates a new virtual node within a service mesh.
A virtual node acts as logical pointer to a particular task group, such as an Amazon ECS service or a Kubernetes deployment. When you create a virtual node, you must specify the DNS service discovery name for your task group.
Any inbound traffic that your virtual node expects should be specified as a listener
. Any outbound
traffic that your virtual node expects to reach should be specified as a backend
.
The response metadata for your new virtual node contains the arn
that is associated with the virtual
node. Set this value (either the full ARN or the truncated resource name, for example,
mesh/default/virtualNode/simpleapp
, as the APPMESH_VIRTUAL_NODE_NAME
environment
variable for your task group's Envoy proxy container in your task definition or pod spec. This is then mapped to
the node.id
and node.cluster
Envoy parameters.
If you require your Envoy stats or tracing to use a different name, you can override the
node.cluster
value that is set by APPMESH_VIRTUAL_NODE_NAME
with the
APPMESH_VIRTUAL_NODE_CLUSTER
environment variable.
createVirtualNodeRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.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.ForbiddenException
- You do not have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.LimitExceededException
- You have exceeded a service limit for your account. For more information, see Service Limits in
the AWS App Mesh User Guide.NotFoundException
- The specified resource does not exist. Check your request syntax and try again.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.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.CreateVirtualRouterResult createVirtualRouter(CreateVirtualRouterRequest createVirtualRouterRequest)
Creates a new virtual router within a service mesh.
Virtual routers handle traffic for one or more service names within your mesh. After you create your virtual router, create and associate routes for your virtual router that direct incoming requests to different virtual nodes.
createVirtualRouterRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.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.ForbiddenException
- You do not have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.LimitExceededException
- You have exceeded a service limit for your account. For more information, see Service Limits in
the AWS App Mesh User Guide.NotFoundException
- The specified resource does not exist. Check your request syntax and try again.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.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.DeleteMeshResult deleteMesh(DeleteMeshRequest deleteMeshRequest)
Deletes an existing service mesh.
You must delete all resources (routes, virtual routers, virtual nodes) in the service mesh before you can delete the mesh itself.
deleteMeshRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ForbiddenException
- You do not have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.NotFoundException
- The specified resource does not exist. Check your request syntax and try again.ResourceInUseException
- You cannot delete the specified resource because it is in use or required by another resource.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.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.DeleteRouteResult deleteRoute(DeleteRouteRequest deleteRouteRequest)
Deletes an existing route.
deleteRouteRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ForbiddenException
- You do not have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.NotFoundException
- The specified resource does not exist. Check your request syntax and try again.ResourceInUseException
- You cannot delete the specified resource because it is in use or required by another resource.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.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.DeleteVirtualNodeResult deleteVirtualNode(DeleteVirtualNodeRequest deleteVirtualNodeRequest)
Deletes an existing virtual node.
deleteVirtualNodeRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ForbiddenException
- You do not have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.NotFoundException
- The specified resource does not exist. Check your request syntax and try again.ResourceInUseException
- You cannot delete the specified resource because it is in use or required by another resource.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.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.DeleteVirtualRouterResult deleteVirtualRouter(DeleteVirtualRouterRequest deleteVirtualRouterRequest)
Deletes an existing virtual router.
You must delete any routes associated with the virtual router before you can delete the router itself.
deleteVirtualRouterRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ForbiddenException
- You do not have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.NotFoundException
- The specified resource does not exist. Check your request syntax and try again.ResourceInUseException
- You cannot delete the specified resource because it is in use or required by another resource.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.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.DescribeMeshResult describeMesh(DescribeMeshRequest describeMeshRequest)
Describes an existing service mesh.
describeMeshRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ForbiddenException
- You do not have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.NotFoundException
- The specified resource does not exist. Check your request syntax and try again.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.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.DescribeRouteResult describeRoute(DescribeRouteRequest describeRouteRequest)
Describes an existing route.
describeRouteRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ForbiddenException
- You do not have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.NotFoundException
- The specified resource does not exist. Check your request syntax and try again.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.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.DescribeVirtualNodeResult describeVirtualNode(DescribeVirtualNodeRequest describeVirtualNodeRequest)
Describes an existing virtual node.
describeVirtualNodeRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ForbiddenException
- You do not have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.NotFoundException
- The specified resource does not exist. Check your request syntax and try again.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.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.DescribeVirtualRouterResult describeVirtualRouter(DescribeVirtualRouterRequest describeVirtualRouterRequest)
Describes an existing virtual router.
describeVirtualRouterRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ForbiddenException
- You do not have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.NotFoundException
- The specified resource does not exist. Check your request syntax and try again.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.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.ListMeshesResult listMeshes(ListMeshesRequest listMeshesRequest)
Returns a list of existing service meshes.
listMeshesRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ForbiddenException
- You do not have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.NotFoundException
- The specified resource does not exist. Check your request syntax and try again.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.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.ListRoutesResult listRoutes(ListRoutesRequest listRoutesRequest)
Returns a list of existing routes in a service mesh.
listRoutesRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ForbiddenException
- You do not have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.NotFoundException
- The specified resource does not exist. Check your request syntax and try again.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.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.ListVirtualNodesResult listVirtualNodes(ListVirtualNodesRequest listVirtualNodesRequest)
Returns a list of existing virtual nodes.
listVirtualNodesRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ForbiddenException
- You do not have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.NotFoundException
- The specified resource does not exist. Check your request syntax and try again.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.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.ListVirtualRoutersResult listVirtualRouters(ListVirtualRoutersRequest listVirtualRoutersRequest)
Returns a list of existing virtual routers in a service mesh.
listVirtualRoutersRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ForbiddenException
- You do not have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.NotFoundException
- The specified resource does not exist. Check your request syntax and try again.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.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.UpdateRouteResult updateRoute(UpdateRouteRequest updateRouteRequest)
Updates an existing route for a specified service mesh and virtual router.
updateRouteRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.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.ForbiddenException
- You do not have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.LimitExceededException
- You have exceeded a service limit for your account. For more information, see Service Limits in
the AWS App Mesh User Guide.NotFoundException
- The specified resource does not exist. Check your request syntax and try again.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.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.UpdateVirtualNodeResult updateVirtualNode(UpdateVirtualNodeRequest updateVirtualNodeRequest)
Updates an existing virtual node in a specified service mesh.
updateVirtualNodeRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.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.ForbiddenException
- You do not have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.LimitExceededException
- You have exceeded a service limit for your account. For more information, see Service Limits in
the AWS App Mesh User Guide.NotFoundException
- The specified resource does not exist. Check your request syntax and try again.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.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.UpdateVirtualRouterResult updateVirtualRouter(UpdateVirtualRouterRequest updateVirtualRouterRequest)
Updates an existing virtual router in a specified service mesh.
updateVirtualRouterRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.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.ForbiddenException
- You do not have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.LimitExceededException
- You have exceeded a service limit for your account. For more information, see Service Limits in
the AWS App Mesh User Guide.NotFoundException
- The specified resource does not exist. Check your request syntax and try again.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.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.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request
- The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.