Class: Aws::AppMesh::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::AppMesh::Client
- Includes:
- ClientStubs
- Defined in:
- lib/aws-sdk-appmesh/client.rb
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#create_mesh(params = {}) ⇒ Types::CreateMeshOutput
Creates a service mesh.
-
#create_route(params = {}) ⇒ Types::CreateRouteOutput
Creates a route that is associated with a virtual router.
-
#create_virtual_node(params = {}) ⇒ Types::CreateVirtualNodeOutput
Creates a virtual node within a service mesh.
-
#create_virtual_router(params = {}) ⇒ Types::CreateVirtualRouterOutput
Creates a virtual router within a service mesh.
-
#create_virtual_service(params = {}) ⇒ Types::CreateVirtualServiceOutput
Creates a virtual service within a service mesh.
-
#delete_mesh(params = {}) ⇒ Types::DeleteMeshOutput
Deletes an existing service mesh.
-
#delete_route(params = {}) ⇒ Types::DeleteRouteOutput
Deletes an existing route.
-
#delete_virtual_node(params = {}) ⇒ Types::DeleteVirtualNodeOutput
Deletes an existing virtual node.
-
#delete_virtual_router(params = {}) ⇒ Types::DeleteVirtualRouterOutput
Deletes an existing virtual router.
-
#delete_virtual_service(params = {}) ⇒ Types::DeleteVirtualServiceOutput
Deletes an existing virtual service.
-
#describe_mesh(params = {}) ⇒ Types::DescribeMeshOutput
Describes an existing service mesh.
-
#describe_route(params = {}) ⇒ Types::DescribeRouteOutput
Describes an existing route.
-
#describe_virtual_node(params = {}) ⇒ Types::DescribeVirtualNodeOutput
Describes an existing virtual node.
-
#describe_virtual_router(params = {}) ⇒ Types::DescribeVirtualRouterOutput
Describes an existing virtual router.
-
#describe_virtual_service(params = {}) ⇒ Types::DescribeVirtualServiceOutput
Describes an existing virtual service.
-
#list_meshes(params = {}) ⇒ Types::ListMeshesOutput
Returns a list of existing service meshes.
-
#list_routes(params = {}) ⇒ Types::ListRoutesOutput
Returns a list of existing routes in a service mesh.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
List the tags for an App Mesh resource.
-
#list_virtual_nodes(params = {}) ⇒ Types::ListVirtualNodesOutput
Returns a list of existing virtual nodes.
-
#list_virtual_routers(params = {}) ⇒ Types::ListVirtualRoutersOutput
Returns a list of existing virtual routers in a service mesh.
-
#list_virtual_services(params = {}) ⇒ Types::ListVirtualServicesOutput
Returns a list of existing virtual services in a service mesh.
-
#tag_resource(params = {}) ⇒ Struct
Associates the specified tags to a resource with the specified ‘resourceArn`.
-
#untag_resource(params = {}) ⇒ Struct
Deletes specified tags from a resource.
-
#update_mesh(params = {}) ⇒ Types::UpdateMeshOutput
Updates an existing service mesh.
-
#update_route(params = {}) ⇒ Types::UpdateRouteOutput
Updates an existing route for a specified service mesh and virtual router.
-
#update_virtual_node(params = {}) ⇒ Types::UpdateVirtualNodeOutput
Updates an existing virtual node in a specified service mesh.
-
#update_virtual_router(params = {}) ⇒ Types::UpdateVirtualRouterOutput
Updates an existing virtual router in a specified service mesh.
-
#update_virtual_service(params = {}) ⇒ Types::UpdateVirtualServiceOutput
Updates an existing virtual service in a specified service mesh.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
251 252 253 |
# File 'lib/aws-sdk-appmesh/client.rb', line 251 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
2486 2487 2488 |
# File 'lib/aws-sdk-appmesh/client.rb', line 2486 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
2489 2490 2491 |
# File 'lib/aws-sdk-appmesh/client.rb', line 2489 def errors_module Errors end |
Instance Method Details
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 |
# File 'lib/aws-sdk-appmesh/client.rb', line 2464 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-appmesh' context[:gem_version] = '1.18.0' Seahorse::Client::Request.new(handlers, context) end |
#create_mesh(params = {}) ⇒ Types::CreateMeshOutput
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.
322 323 324 325 |
# File 'lib/aws-sdk-appmesh/client.rb', line 322 def create_mesh(params = {}, = {}) req = build_request(:create_mesh, params) req.send_request() end |
#create_route(params = {}) ⇒ Types::CreateRouteOutput
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.
603 604 605 606 |
# File 'lib/aws-sdk-appmesh/client.rb', line 603 def create_route(params = {}, = {}) req = build_request(:create_route, params) req.send_request() end |
#create_virtual_node(params = {}) ⇒ Types::CreateVirtualNodeOutput
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.
<note markdown=“1”> 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.
</note>
759 760 761 762 |
# File 'lib/aws-sdk-appmesh/client.rb', line 759 def create_virtual_node(params = {}, = {}) req = build_request(:create_virtual_node, params) req.send_request() end |
#create_virtual_router(params = {}) ⇒ Types::CreateVirtualRouterOutput
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.
844 845 846 847 |
# File 'lib/aws-sdk-appmesh/client.rb', line 844 def create_virtual_router(params = {}, = {}) req = build_request(:create_virtual_router, params) req.send_request() end |
#create_virtual_service(params = {}) ⇒ Types::CreateVirtualServiceOutput
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.
927 928 929 930 |
# File 'lib/aws-sdk-appmesh/client.rb', line 927 def create_virtual_service(params = {}, = {}) req = build_request(:create_virtual_service, params) req.send_request() end |
#delete_mesh(params = {}) ⇒ Types::DeleteMeshOutput
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.
966 967 968 969 |
# File 'lib/aws-sdk-appmesh/client.rb', line 966 def delete_mesh(params = {}, = {}) req = build_request(:delete_mesh, params) req.send_request() end |
#delete_route(params = {}) ⇒ Types::DeleteRouteOutput
Deletes an existing route.
1081 1082 1083 1084 |
# File 'lib/aws-sdk-appmesh/client.rb', line 1081 def delete_route(params = {}, = {}) req = build_request(:delete_route, params) req.send_request() end |
#delete_virtual_node(params = {}) ⇒ Types::DeleteVirtualNodeOutput
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.
1142 1143 1144 1145 |
# File 'lib/aws-sdk-appmesh/client.rb', line 1142 def delete_virtual_node(params = {}, = {}) req = build_request(:delete_virtual_node, params) req.send_request() end |
#delete_virtual_router(params = {}) ⇒ Types::DeleteVirtualRouterOutput
Deletes an existing virtual router.
You must delete any routes associated with the virtual router before you can delete the router itself.
1187 1188 1189 1190 |
# File 'lib/aws-sdk-appmesh/client.rb', line 1187 def delete_virtual_router(params = {}, = {}) req = build_request(:delete_virtual_router, params) req.send_request() end |
#delete_virtual_service(params = {}) ⇒ Types::DeleteVirtualServiceOutput
Deletes an existing virtual service.
1228 1229 1230 1231 |
# File 'lib/aws-sdk-appmesh/client.rb', line 1228 def delete_virtual_service(params = {}, = {}) req = build_request(:delete_virtual_service, params) req.send_request() end |
#describe_mesh(params = {}) ⇒ Types::DescribeMeshOutput
Describes an existing service mesh.
1263 1264 1265 1266 |
# File 'lib/aws-sdk-appmesh/client.rb', line 1263 def describe_mesh(params = {}, = {}) req = build_request(:describe_mesh, params) req.send_request() end |
#describe_route(params = {}) ⇒ Types::DescribeRouteOutput
Describes an existing route.
1378 1379 1380 1381 |
# File 'lib/aws-sdk-appmesh/client.rb', line 1378 def describe_route(params = {}, = {}) req = build_request(:describe_route, params) req.send_request() end |
#describe_virtual_node(params = {}) ⇒ Types::DescribeVirtualNodeOutput
Describes an existing virtual node.
1436 1437 1438 1439 |
# File 'lib/aws-sdk-appmesh/client.rb', line 1436 def describe_virtual_node(params = {}, = {}) req = build_request(:describe_virtual_node, params) req.send_request() end |
#describe_virtual_router(params = {}) ⇒ Types::DescribeVirtualRouterOutput
Describes an existing virtual router.
1478 1479 1480 1481 |
# File 'lib/aws-sdk-appmesh/client.rb', line 1478 def describe_virtual_router(params = {}, = {}) req = build_request(:describe_virtual_router, params) req.send_request() end |
#describe_virtual_service(params = {}) ⇒ Types::DescribeVirtualServiceOutput
Describes an existing virtual service.
1519 1520 1521 1522 |
# File 'lib/aws-sdk-appmesh/client.rb', line 1519 def describe_virtual_service(params = {}, = {}) req = build_request(:describe_virtual_service, params) req.send_request() end |
#list_meshes(params = {}) ⇒ Types::ListMeshesOutput
Returns a list of existing service meshes.
1571 1572 1573 1574 |
# File 'lib/aws-sdk-appmesh/client.rb', line 1571 def list_meshes(params = {}, = {}) req = build_request(:list_meshes, params) req.send_request() end |
#list_routes(params = {}) ⇒ Types::ListRoutesOutput
Returns a list of existing routes in a service mesh.
1627 1628 1629 1630 |
# File 'lib/aws-sdk-appmesh/client.rb', line 1627 def list_routes(params = {}, = {}) req = build_request(:list_routes, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
List the tags for an App Mesh resource.
1678 1679 1680 1681 |
# File 'lib/aws-sdk-appmesh/client.rb', line 1678 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_virtual_nodes(params = {}) ⇒ Types::ListVirtualNodesOutput
Returns a list of existing virtual nodes.
1729 1730 1731 1732 |
# File 'lib/aws-sdk-appmesh/client.rb', line 1729 def list_virtual_nodes(params = {}, = {}) req = build_request(:list_virtual_nodes, params) req.send_request() end |
#list_virtual_routers(params = {}) ⇒ Types::ListVirtualRoutersOutput
Returns a list of existing virtual routers in a service mesh.
1780 1781 1782 1783 |
# File 'lib/aws-sdk-appmesh/client.rb', line 1780 def list_virtual_routers(params = {}, = {}) req = build_request(:list_virtual_routers, params) req.send_request() end |
#list_virtual_services(params = {}) ⇒ Types::ListVirtualServicesOutput
Returns a list of existing virtual services in a service mesh.
1831 1832 1833 1834 |
# File 'lib/aws-sdk-appmesh/client.rb', line 1831 def list_virtual_services(params = {}, = {}) req = build_request(:list_virtual_services, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
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.
1867 1868 1869 1870 |
# File 'lib/aws-sdk-appmesh/client.rb', line 1867 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Deletes specified tags from a resource.
1893 1894 1895 1896 |
# File 'lib/aws-sdk-appmesh/client.rb', line 1893 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_mesh(params = {}) ⇒ Types::UpdateMeshOutput
Updates an existing service mesh.
1945 1946 1947 1948 |
# File 'lib/aws-sdk-appmesh/client.rb', line 1945 def update_mesh(params = {}, = {}) req = build_request(:update_mesh, params) req.send_request() end |
#update_route(params = {}) ⇒ Types::UpdateRouteOutput
Updates an existing route for a specified service mesh and virtual router.
2207 2208 2209 2210 |
# File 'lib/aws-sdk-appmesh/client.rb', line 2207 def update_route(params = {}, = {}) req = build_request(:update_route, params) req.send_request() end |
#update_virtual_node(params = {}) ⇒ Types::UpdateVirtualNodeOutput
Updates an existing virtual node in a specified service mesh.
2326 2327 2328 2329 |
# File 'lib/aws-sdk-appmesh/client.rb', line 2326 def update_virtual_node(params = {}, = {}) req = build_request(:update_virtual_node, params) req.send_request() end |
#update_virtual_router(params = {}) ⇒ Types::UpdateVirtualRouterOutput
Updates an existing virtual router in a specified service mesh.
2391 2392 2393 2394 |
# File 'lib/aws-sdk-appmesh/client.rb', line 2391 def update_virtual_router(params = {}, = {}) req = build_request(:update_virtual_router, params) req.send_request() end |
#update_virtual_service(params = {}) ⇒ Types::UpdateVirtualServiceOutput
Updates an existing virtual service in a specified service mesh.
2455 2456 2457 2458 |
# File 'lib/aws-sdk-appmesh/client.rb', line 2455 def update_virtual_service(params = {}, = {}) req = build_request(:update_virtual_service, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
2479 2480 2481 |
# File 'lib/aws-sdk-appmesh/client.rb', line 2479 def waiter_names [] end |