@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSAppMeshAsync extends AWSAppMesh
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSAppMeshAsync
instead.
AWS App Mesh is a service mesh based on the Envoy proxy that makes it easy to monitor and control 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 AWS Fargate, Amazon ECS, Amazon EKS, Kubernetes on AWS, and Amazon EC2.
App Mesh supports microservice applications that use service discovery naming for their components. For more
information about service discovery on Amazon ECS, see Service Discovery in the
Amazon Elastic Container Service Developer Guide. Kubernetes kube-dns
and coredns
are supported. For more information, see DNS for Services and Pods in the
Kubernetes documentation.
ENDPOINT_PREFIX
createMesh, createRoute, createVirtualNode, createVirtualRouter, createVirtualService, deleteMesh, deleteRoute, deleteVirtualNode, deleteVirtualRouter, deleteVirtualService, describeMesh, describeRoute, describeVirtualNode, describeVirtualRouter, describeVirtualService, getCachedResponseMetadata, listMeshes, listRoutes, listTagsForResource, listVirtualNodes, listVirtualRouters, listVirtualServices, shutdown, tagResource, untagResource, updateMesh, updateRoute, updateVirtualNode, updateVirtualRouter, updateVirtualService
Future<CreateMeshResult> createMeshAsync(CreateMeshRequest createMeshRequest)
Creates a 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 services, virtual nodes, virtual routers, and routes to distribute traffic between the applications in your mesh.
createMeshRequest
- Future<CreateMeshResult> createMeshAsync(CreateMeshRequest createMeshRequest, AsyncHandler<CreateMeshRequest,CreateMeshResult> asyncHandler)
Creates a 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 services, virtual nodes, virtual routers, and routes to distribute traffic between the applications in your mesh.
createMeshRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateRouteResult> createRouteAsync(CreateRouteRequest createRouteRequest)
Creates a 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 service name is my-service.local
and you want the route to match requests
to my-service.local/metrics
, 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
- Future<CreateRouteResult> createRouteAsync(CreateRouteRequest createRouteRequest, AsyncHandler<CreateRouteRequest,CreateRouteResult> asyncHandler)
Creates a 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 service name is my-service.local
and you want the route to match requests
to my-service.local/metrics
, 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
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateVirtualNodeResult> createVirtualNodeAsync(CreateVirtualNodeRequest createVirtualNodeRequest)
Creates a virtual node within a service mesh.
A virtual node acts as a logical pointer to a particular task group, such as an Amazon ECS service or a Kubernetes deployment. When you create a virtual node, you can specify the service discovery information 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
- Future<CreateVirtualNodeResult> createVirtualNodeAsync(CreateVirtualNodeRequest createVirtualNodeRequest, AsyncHandler<CreateVirtualNodeRequest,CreateVirtualNodeResult> asyncHandler)
Creates a virtual node within a service mesh.
A virtual node acts as a logical pointer to a particular task group, such as an Amazon ECS service or a Kubernetes deployment. When you create a virtual node, you can specify the service discovery information 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
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateVirtualRouterResult> createVirtualRouterAsync(CreateVirtualRouterRequest createVirtualRouterRequest)
Creates a virtual router within a service mesh.
Any inbound traffic that your virtual router expects should be specified as a listener
.
Virtual routers handle traffic for one or more virtual services 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
- Future<CreateVirtualRouterResult> createVirtualRouterAsync(CreateVirtualRouterRequest createVirtualRouterRequest, AsyncHandler<CreateVirtualRouterRequest,CreateVirtualRouterResult> asyncHandler)
Creates a virtual router within a service mesh.
Any inbound traffic that your virtual router expects should be specified as a listener
.
Virtual routers handle traffic for one or more virtual services 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
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateVirtualServiceResult> createVirtualServiceAsync(CreateVirtualServiceRequest createVirtualServiceRequest)
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.
createVirtualServiceRequest
- Future<CreateVirtualServiceResult> createVirtualServiceAsync(CreateVirtualServiceRequest createVirtualServiceRequest, AsyncHandler<CreateVirtualServiceRequest,CreateVirtualServiceResult> asyncHandler)
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.
createVirtualServiceRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteMeshResult> deleteMeshAsync(DeleteMeshRequest deleteMeshRequest)
Deletes an existing service mesh.
You must delete all resources (virtual services, routes, virtual routers, and virtual nodes) in the service mesh before you can delete the mesh itself.
deleteMeshRequest
- Future<DeleteMeshResult> deleteMeshAsync(DeleteMeshRequest deleteMeshRequest, AsyncHandler<DeleteMeshRequest,DeleteMeshResult> asyncHandler)
Deletes an existing service mesh.
You must delete all resources (virtual services, routes, virtual routers, and virtual nodes) in the service mesh before you can delete the mesh itself.
deleteMeshRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteRouteResult> deleteRouteAsync(DeleteRouteRequest deleteRouteRequest)
Deletes an existing route.
deleteRouteRequest
- Future<DeleteRouteResult> deleteRouteAsync(DeleteRouteRequest deleteRouteRequest, AsyncHandler<DeleteRouteRequest,DeleteRouteResult> asyncHandler)
Deletes an existing route.
deleteRouteRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteVirtualNodeResult> deleteVirtualNodeAsync(DeleteVirtualNodeRequest deleteVirtualNodeRequest)
Deletes an existing virtual node.
You must delete any virtual services that list a virtual node as a service provider before you can delete the virtual node itself.
deleteVirtualNodeRequest
- Future<DeleteVirtualNodeResult> deleteVirtualNodeAsync(DeleteVirtualNodeRequest deleteVirtualNodeRequest, AsyncHandler<DeleteVirtualNodeRequest,DeleteVirtualNodeResult> asyncHandler)
Deletes an existing virtual node.
You must delete any virtual services that list a virtual node as a service provider before you can delete the virtual node itself.
deleteVirtualNodeRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteVirtualRouterResult> deleteVirtualRouterAsync(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
- Future<DeleteVirtualRouterResult> deleteVirtualRouterAsync(DeleteVirtualRouterRequest deleteVirtualRouterRequest, AsyncHandler<DeleteVirtualRouterRequest,DeleteVirtualRouterResult> asyncHandler)
Deletes an existing virtual router.
You must delete any routes associated with the virtual router before you can delete the router itself.
deleteVirtualRouterRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteVirtualServiceResult> deleteVirtualServiceAsync(DeleteVirtualServiceRequest deleteVirtualServiceRequest)
Deletes an existing virtual service.
deleteVirtualServiceRequest
- Future<DeleteVirtualServiceResult> deleteVirtualServiceAsync(DeleteVirtualServiceRequest deleteVirtualServiceRequest, AsyncHandler<DeleteVirtualServiceRequest,DeleteVirtualServiceResult> asyncHandler)
Deletes an existing virtual service.
deleteVirtualServiceRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeMeshResult> describeMeshAsync(DescribeMeshRequest describeMeshRequest)
Describes an existing service mesh.
describeMeshRequest
- Future<DescribeMeshResult> describeMeshAsync(DescribeMeshRequest describeMeshRequest, AsyncHandler<DescribeMeshRequest,DescribeMeshResult> asyncHandler)
Describes an existing service mesh.
describeMeshRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeRouteResult> describeRouteAsync(DescribeRouteRequest describeRouteRequest)
Describes an existing route.
describeRouteRequest
- Future<DescribeRouteResult> describeRouteAsync(DescribeRouteRequest describeRouteRequest, AsyncHandler<DescribeRouteRequest,DescribeRouteResult> asyncHandler)
Describes an existing route.
describeRouteRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeVirtualNodeResult> describeVirtualNodeAsync(DescribeVirtualNodeRequest describeVirtualNodeRequest)
Describes an existing virtual node.
describeVirtualNodeRequest
- Future<DescribeVirtualNodeResult> describeVirtualNodeAsync(DescribeVirtualNodeRequest describeVirtualNodeRequest, AsyncHandler<DescribeVirtualNodeRequest,DescribeVirtualNodeResult> asyncHandler)
Describes an existing virtual node.
describeVirtualNodeRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeVirtualRouterResult> describeVirtualRouterAsync(DescribeVirtualRouterRequest describeVirtualRouterRequest)
Describes an existing virtual router.
describeVirtualRouterRequest
- Future<DescribeVirtualRouterResult> describeVirtualRouterAsync(DescribeVirtualRouterRequest describeVirtualRouterRequest, AsyncHandler<DescribeVirtualRouterRequest,DescribeVirtualRouterResult> asyncHandler)
Describes an existing virtual router.
describeVirtualRouterRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeVirtualServiceResult> describeVirtualServiceAsync(DescribeVirtualServiceRequest describeVirtualServiceRequest)
Describes an existing virtual service.
describeVirtualServiceRequest
- Future<DescribeVirtualServiceResult> describeVirtualServiceAsync(DescribeVirtualServiceRequest describeVirtualServiceRequest, AsyncHandler<DescribeVirtualServiceRequest,DescribeVirtualServiceResult> asyncHandler)
Describes an existing virtual service.
describeVirtualServiceRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListMeshesResult> listMeshesAsync(ListMeshesRequest listMeshesRequest)
Returns a list of existing service meshes.
listMeshesRequest
- Future<ListMeshesResult> listMeshesAsync(ListMeshesRequest listMeshesRequest, AsyncHandler<ListMeshesRequest,ListMeshesResult> asyncHandler)
Returns a list of existing service meshes.
listMeshesRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListRoutesResult> listRoutesAsync(ListRoutesRequest listRoutesRequest)
Returns a list of existing routes in a service mesh.
listRoutesRequest
- Future<ListRoutesResult> listRoutesAsync(ListRoutesRequest listRoutesRequest, AsyncHandler<ListRoutesRequest,ListRoutesResult> asyncHandler)
Returns a list of existing routes in a service mesh.
listRoutesRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
List the tags for an App Mesh resource.
listTagsForResourceRequest
- Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
List the tags for an App Mesh resource.
listTagsForResourceRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListVirtualNodesResult> listVirtualNodesAsync(ListVirtualNodesRequest listVirtualNodesRequest)
Returns a list of existing virtual nodes.
listVirtualNodesRequest
- Future<ListVirtualNodesResult> listVirtualNodesAsync(ListVirtualNodesRequest listVirtualNodesRequest, AsyncHandler<ListVirtualNodesRequest,ListVirtualNodesResult> asyncHandler)
Returns a list of existing virtual nodes.
listVirtualNodesRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListVirtualRoutersResult> listVirtualRoutersAsync(ListVirtualRoutersRequest listVirtualRoutersRequest)
Returns a list of existing virtual routers in a service mesh.
listVirtualRoutersRequest
- Future<ListVirtualRoutersResult> listVirtualRoutersAsync(ListVirtualRoutersRequest listVirtualRoutersRequest, AsyncHandler<ListVirtualRoutersRequest,ListVirtualRoutersResult> asyncHandler)
Returns a list of existing virtual routers in a service mesh.
listVirtualRoutersRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListVirtualServicesResult> listVirtualServicesAsync(ListVirtualServicesRequest listVirtualServicesRequest)
Returns a list of existing virtual services in a service mesh.
listVirtualServicesRequest
- Future<ListVirtualServicesResult> listVirtualServicesAsync(ListVirtualServicesRequest listVirtualServicesRequest, AsyncHandler<ListVirtualServicesRequest,ListVirtualServicesResult> asyncHandler)
Returns a list of existing virtual services in a service mesh.
listVirtualServicesRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)
Associates the specified tags to a resource with the specified resourceArn
. If existing tags on a
resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags
associated with that resource are also deleted.
tagResourceRequest
- Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Associates the specified tags to a resource with the specified resourceArn
. If existing tags on a
resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags
associated with that resource are also deleted.
tagResourceRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
Deletes specified tags from a resource.
untagResourceRequest
- Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Deletes specified tags from a resource.
untagResourceRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateMeshResult> updateMeshAsync(UpdateMeshRequest updateMeshRequest)
Updates an existing service mesh.
updateMeshRequest
- Future<UpdateMeshResult> updateMeshAsync(UpdateMeshRequest updateMeshRequest, AsyncHandler<UpdateMeshRequest,UpdateMeshResult> asyncHandler)
Updates an existing service mesh.
updateMeshRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateRouteResult> updateRouteAsync(UpdateRouteRequest updateRouteRequest)
Updates an existing route for a specified service mesh and virtual router.
updateRouteRequest
- Future<UpdateRouteResult> updateRouteAsync(UpdateRouteRequest updateRouteRequest, AsyncHandler<UpdateRouteRequest,UpdateRouteResult> asyncHandler)
Updates an existing route for a specified service mesh and virtual router.
updateRouteRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateVirtualNodeResult> updateVirtualNodeAsync(UpdateVirtualNodeRequest updateVirtualNodeRequest)
Updates an existing virtual node in a specified service mesh.
updateVirtualNodeRequest
- Future<UpdateVirtualNodeResult> updateVirtualNodeAsync(UpdateVirtualNodeRequest updateVirtualNodeRequest, AsyncHandler<UpdateVirtualNodeRequest,UpdateVirtualNodeResult> asyncHandler)
Updates an existing virtual node in a specified service mesh.
updateVirtualNodeRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateVirtualRouterResult> updateVirtualRouterAsync(UpdateVirtualRouterRequest updateVirtualRouterRequest)
Updates an existing virtual router in a specified service mesh.
updateVirtualRouterRequest
- Future<UpdateVirtualRouterResult> updateVirtualRouterAsync(UpdateVirtualRouterRequest updateVirtualRouterRequest, AsyncHandler<UpdateVirtualRouterRequest,UpdateVirtualRouterResult> asyncHandler)
Updates an existing virtual router in a specified service mesh.
updateVirtualRouterRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateVirtualServiceResult> updateVirtualServiceAsync(UpdateVirtualServiceRequest updateVirtualServiceRequest)
Updates an existing virtual service in a specified service mesh.
updateVirtualServiceRequest
- Future<UpdateVirtualServiceResult> updateVirtualServiceAsync(UpdateVirtualServiceRequest updateVirtualServiceRequest, AsyncHandler<UpdateVirtualServiceRequest,UpdateVirtualServiceResult> asyncHandler)
Updates an existing virtual service in a specified service mesh.
updateVirtualServiceRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.