@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSAppMeshClient extends AmazonWebServiceClient implements AWSAppMesh
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.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
static AWSAppMeshClientBuilder |
builder() |
CreateMeshResult |
createMesh(CreateMeshRequest request)
Creates a new service mesh.
|
CreateRouteResult |
createRoute(CreateRouteRequest request)
Creates a new route that is associated with a virtual router.
|
CreateVirtualNodeResult |
createVirtualNode(CreateVirtualNodeRequest request)
Creates a new virtual node within a service mesh.
|
CreateVirtualRouterResult |
createVirtualRouter(CreateVirtualRouterRequest request)
Creates a new virtual router within a service mesh.
|
DeleteMeshResult |
deleteMesh(DeleteMeshRequest request)
Deletes an existing service mesh.
|
DeleteRouteResult |
deleteRoute(DeleteRouteRequest request)
Deletes an existing route.
|
DeleteVirtualNodeResult |
deleteVirtualNode(DeleteVirtualNodeRequest request)
Deletes an existing virtual node.
|
DeleteVirtualRouterResult |
deleteVirtualRouter(DeleteVirtualRouterRequest request)
Deletes an existing virtual router.
|
DescribeMeshResult |
describeMesh(DescribeMeshRequest request)
Describes an existing service mesh.
|
DescribeRouteResult |
describeRoute(DescribeRouteRequest request)
Describes an existing route.
|
DescribeVirtualNodeResult |
describeVirtualNode(DescribeVirtualNodeRequest request)
Describes an existing virtual node.
|
DescribeVirtualRouterResult |
describeVirtualRouter(DescribeVirtualRouterRequest request)
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 request)
Returns a list of existing service meshes.
|
ListRoutesResult |
listRoutes(ListRoutesRequest request)
Returns a list of existing routes in a service mesh.
|
ListVirtualNodesResult |
listVirtualNodes(ListVirtualNodesRequest request)
Returns a list of existing virtual nodes.
|
ListVirtualRoutersResult |
listVirtualRouters(ListVirtualRoutersRequest request)
Returns a list of existing virtual routers in a service mesh.
|
UpdateRouteResult |
updateRoute(UpdateRouteRequest request)
Updates an existing route for a specified service mesh and virtual router.
|
UpdateVirtualNodeResult |
updateVirtualNode(UpdateVirtualNodeRequest request)
Updates an existing virtual node in a specified service mesh.
|
UpdateVirtualRouterResult |
updateVirtualRouter(UpdateVirtualRouterRequest request)
Updates an existing virtual router in a specified service mesh.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitshutdownpublic static AWSAppMeshClientBuilder builder()
public CreateMeshResult createMesh(CreateMeshRequest request)
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.
createMesh in interface AWSAppMeshcreateMeshRequest - 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.public CreateRouteResult createRoute(CreateRouteRequest request)
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.
createRoute in interface AWSAppMeshcreateRouteRequest - 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.public CreateVirtualNodeResult createVirtualNode(CreateVirtualNodeRequest request)
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.
createVirtualNode in interface AWSAppMeshcreateVirtualNodeRequest - 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.public CreateVirtualRouterResult createVirtualRouter(CreateVirtualRouterRequest request)
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.
createVirtualRouter in interface AWSAppMeshcreateVirtualRouterRequest - 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.public DeleteMeshResult deleteMesh(DeleteMeshRequest request)
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.
deleteMesh in interface AWSAppMeshdeleteMeshRequest - 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.public DeleteRouteResult deleteRoute(DeleteRouteRequest request)
Deletes an existing route.
deleteRoute in interface AWSAppMeshdeleteRouteRequest - 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.public DeleteVirtualNodeResult deleteVirtualNode(DeleteVirtualNodeRequest request)
Deletes an existing virtual node.
deleteVirtualNode in interface AWSAppMeshdeleteVirtualNodeRequest - 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.public DeleteVirtualRouterResult deleteVirtualRouter(DeleteVirtualRouterRequest request)
Deletes an existing virtual router.
You must delete any routes associated with the virtual router before you can delete the router itself.
deleteVirtualRouter in interface AWSAppMeshdeleteVirtualRouterRequest - 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.public DescribeMeshResult describeMesh(DescribeMeshRequest request)
Describes an existing service mesh.
describeMesh in interface AWSAppMeshdescribeMeshRequest - 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.public DescribeRouteResult describeRoute(DescribeRouteRequest request)
Describes an existing route.
describeRoute in interface AWSAppMeshdescribeRouteRequest - 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.public DescribeVirtualNodeResult describeVirtualNode(DescribeVirtualNodeRequest request)
Describes an existing virtual node.
describeVirtualNode in interface AWSAppMeshdescribeVirtualNodeRequest - 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.public DescribeVirtualRouterResult describeVirtualRouter(DescribeVirtualRouterRequest request)
Describes an existing virtual router.
describeVirtualRouter in interface AWSAppMeshdescribeVirtualRouterRequest - 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.public ListMeshesResult listMeshes(ListMeshesRequest request)
Returns a list of existing service meshes.
listMeshes in interface AWSAppMeshlistMeshesRequest - 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.public ListRoutesResult listRoutes(ListRoutesRequest request)
Returns a list of existing routes in a service mesh.
listRoutes in interface AWSAppMeshlistRoutesRequest - 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.public ListVirtualNodesResult listVirtualNodes(ListVirtualNodesRequest request)
Returns a list of existing virtual nodes.
listVirtualNodes in interface AWSAppMeshlistVirtualNodesRequest - 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.public ListVirtualRoutersResult listVirtualRouters(ListVirtualRoutersRequest request)
Returns a list of existing virtual routers in a service mesh.
listVirtualRouters in interface AWSAppMeshlistVirtualRoutersRequest - 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.public UpdateRouteResult updateRoute(UpdateRouteRequest request)
Updates an existing route for a specified service mesh and virtual router.
updateRoute in interface AWSAppMeshupdateRouteRequest - 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.public UpdateVirtualNodeResult updateVirtualNode(UpdateVirtualNodeRequest request)
Updates an existing virtual node in a specified service mesh.
updateVirtualNode in interface AWSAppMeshupdateVirtualNodeRequest - 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.public UpdateVirtualRouterResult updateVirtualRouter(UpdateVirtualRouterRequest request)
Updates an existing virtual router in a specified service mesh.
updateVirtualRouter in interface AWSAppMeshupdateVirtualRouterRequest - 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.public 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 the request.
getCachedResponseMetadata in interface AWSAppMeshrequest - The originally executed requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.