@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSAppMesh extends Object implements AWSAppMesh
AWSAppMesh
. Convenient method forms pass through to the corresponding overload
that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
CreateMeshResult |
createMesh(CreateMeshRequest request)
Creates a service mesh.
|
CreateRouteResult |
createRoute(CreateRouteRequest request)
Creates a route that is associated with a virtual router.
|
CreateVirtualNodeResult |
createVirtualNode(CreateVirtualNodeRequest request)
Creates a virtual node within a service mesh.
|
CreateVirtualRouterResult |
createVirtualRouter(CreateVirtualRouterRequest request)
Creates a virtual router within a service mesh.
|
CreateVirtualServiceResult |
createVirtualService(CreateVirtualServiceRequest request)
Creates a virtual service 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.
|
DeleteVirtualServiceResult |
deleteVirtualService(DeleteVirtualServiceRequest request)
Deletes an existing virtual service.
|
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.
|
DescribeVirtualServiceResult |
describeVirtualService(DescribeVirtualServiceRequest request)
Describes an existing virtual service.
|
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.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
List the tags for an App Mesh resource.
|
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.
|
ListVirtualServicesResult |
listVirtualServices(ListVirtualServicesRequest request)
Returns a list of existing virtual services in a service mesh.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Associates the specified tags to a resource with the specified
resourceArn . |
UntagResourceResult |
untagResource(UntagResourceRequest request)
Deletes specified tags from a resource.
|
UpdateMeshResult |
updateMesh(UpdateMeshRequest request)
Updates an existing 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.
|
UpdateVirtualServiceResult |
updateVirtualService(UpdateVirtualServiceRequest request)
Updates an existing virtual service in a specified service mesh.
|
public CreateMeshResult createMesh(CreateMeshRequest request)
AWSAppMesh
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.
createMesh
in interface AWSAppMesh
public CreateRouteResult createRoute(CreateRouteRequest request)
AWSAppMesh
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.
createRoute
in interface AWSAppMesh
public CreateVirtualNodeResult createVirtualNode(CreateVirtualNodeRequest request)
AWSAppMesh
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 must specify the DNS service discovery hostname 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 AWSAppMesh
public CreateVirtualRouterResult createVirtualRouter(CreateVirtualRouterRequest request)
AWSAppMesh
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.
createVirtualRouter
in interface AWSAppMesh
public CreateVirtualServiceResult createVirtualService(CreateVirtualServiceRequest request)
AWSAppMesh
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.
createVirtualService
in interface AWSAppMesh
public DeleteMeshResult deleteMesh(DeleteMeshRequest request)
AWSAppMesh
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.
deleteMesh
in interface AWSAppMesh
public DeleteRouteResult deleteRoute(DeleteRouteRequest request)
AWSAppMesh
Deletes an existing route.
deleteRoute
in interface AWSAppMesh
public DeleteVirtualNodeResult deleteVirtualNode(DeleteVirtualNodeRequest request)
AWSAppMesh
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.
deleteVirtualNode
in interface AWSAppMesh
public DeleteVirtualRouterResult deleteVirtualRouter(DeleteVirtualRouterRequest request)
AWSAppMesh
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 AWSAppMesh
public DeleteVirtualServiceResult deleteVirtualService(DeleteVirtualServiceRequest request)
AWSAppMesh
Deletes an existing virtual service.
deleteVirtualService
in interface AWSAppMesh
public DescribeMeshResult describeMesh(DescribeMeshRequest request)
AWSAppMesh
Describes an existing service mesh.
describeMesh
in interface AWSAppMesh
public DescribeRouteResult describeRoute(DescribeRouteRequest request)
AWSAppMesh
Describes an existing route.
describeRoute
in interface AWSAppMesh
public DescribeVirtualNodeResult describeVirtualNode(DescribeVirtualNodeRequest request)
AWSAppMesh
Describes an existing virtual node.
describeVirtualNode
in interface AWSAppMesh
public DescribeVirtualRouterResult describeVirtualRouter(DescribeVirtualRouterRequest request)
AWSAppMesh
Describes an existing virtual router.
describeVirtualRouter
in interface AWSAppMesh
public DescribeVirtualServiceResult describeVirtualService(DescribeVirtualServiceRequest request)
AWSAppMesh
Describes an existing virtual service.
describeVirtualService
in interface AWSAppMesh
public ListMeshesResult listMeshes(ListMeshesRequest request)
AWSAppMesh
Returns a list of existing service meshes.
listMeshes
in interface AWSAppMesh
public ListRoutesResult listRoutes(ListRoutesRequest request)
AWSAppMesh
Returns a list of existing routes in a service mesh.
listRoutes
in interface AWSAppMesh
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AWSAppMesh
List the tags for an App Mesh resource.
listTagsForResource
in interface AWSAppMesh
public ListVirtualNodesResult listVirtualNodes(ListVirtualNodesRequest request)
AWSAppMesh
Returns a list of existing virtual nodes.
listVirtualNodes
in interface AWSAppMesh
public ListVirtualRoutersResult listVirtualRouters(ListVirtualRoutersRequest request)
AWSAppMesh
Returns a list of existing virtual routers in a service mesh.
listVirtualRouters
in interface AWSAppMesh
public ListVirtualServicesResult listVirtualServices(ListVirtualServicesRequest request)
AWSAppMesh
Returns a list of existing virtual services in a service mesh.
listVirtualServices
in interface AWSAppMesh
public TagResourceResult tagResource(TagResourceRequest request)
AWSAppMesh
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.
tagResource
in interface AWSAppMesh
public UntagResourceResult untagResource(UntagResourceRequest request)
AWSAppMesh
Deletes specified tags from a resource.
untagResource
in interface AWSAppMesh
public UpdateMeshResult updateMesh(UpdateMeshRequest request)
AWSAppMesh
Updates an existing service mesh.
updateMesh
in interface AWSAppMesh
public UpdateRouteResult updateRoute(UpdateRouteRequest request)
AWSAppMesh
Updates an existing route for a specified service mesh and virtual router.
updateRoute
in interface AWSAppMesh
public UpdateVirtualNodeResult updateVirtualNode(UpdateVirtualNodeRequest request)
AWSAppMesh
Updates an existing virtual node in a specified service mesh.
updateVirtualNode
in interface AWSAppMesh
public UpdateVirtualRouterResult updateVirtualRouter(UpdateVirtualRouterRequest request)
AWSAppMesh
Updates an existing virtual router in a specified service mesh.
updateVirtualRouter
in interface AWSAppMesh
public UpdateVirtualServiceResult updateVirtualService(UpdateVirtualServiceRequest request)
AWSAppMesh
Updates an existing virtual service in a specified service mesh.
updateVirtualService
in interface AWSAppMesh
public void shutdown()
AWSAppMesh
shutdown
in interface AWSAppMesh
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSAppMesh
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.
getCachedResponseMetadata
in interface AWSAppMesh
request
- The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.