Client

appmesh

R Documentation

AWS App Mesh¶

Description¶

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 Amazon Web Services Fargate, Amazon ECS, Amazon EKS, Kubernetes on Amazon Web Services, 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.

Usage¶

appmesh(config = list(), credentials = list(), endpoint = NULL, region = NULL)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.

credentials:
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

creds:
- access_key_id: AWS access key ID
- secret_access_key: AWS secret access key
- session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax¶

svc <- appmesh(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

create_gateway_route: Creates a gateway route
create_mesh: Creates a service mesh
create_route: Creates a route that is associated with a virtual router
create_virtual_gateway: Creates a virtual gateway
create_virtual_node: Creates a virtual node within a service mesh
create_virtual_router: Creates a virtual router within a service mesh
create_virtual_service: Creates a virtual service within a service mesh
delete_gateway_route: Deletes an existing gateway route
delete_mesh: Deletes an existing service mesh
delete_route: Deletes an existing route
delete_virtual_gateway: Deletes an existing virtual gateway
delete_virtual_node: Deletes an existing virtual node
delete_virtual_router: Deletes an existing virtual router
delete_virtual_service: Deletes an existing virtual service
describe_gateway_route: Describes an existing gateway route
describe_mesh: Describes an existing service mesh
describe_route: Describes an existing route
describe_virtual_gateway: Describes an existing virtual gateway
describe_virtual_node: Describes an existing virtual node
describe_virtual_router: Describes an existing virtual router
describe_virtual_service: Describes an existing virtual service
list_gateway_routes: Returns a list of existing gateway routes that are associated to a virtual gateway
list_meshes: Returns a list of existing service meshes
list_routes: Returns a list of existing routes in a service mesh
list_tags_for_resource: List the tags for an App Mesh resource
list_virtual_gateways: Returns a list of existing virtual gateways in a service mesh
list_virtual_nodes: Returns a list of existing virtual nodes
list_virtual_routers: Returns a list of existing virtual routers in a service mesh
list_virtual_services: Returns a list of existing virtual services in a service mesh
tag_resource: Associates the specified tags to a resource with the specified resourceArn
untag_resource: Deletes specified tags from a resource
update_gateway_route: Updates an existing gateway route that is associated to a specified virtual gateway in a service mesh
update_mesh: Updates an existing service mesh
update_route: Updates an existing route for a specified service mesh and virtual router
update_virtual_gateway: Updates an existing virtual gateway in a specified service mesh
update_virtual_node: Updates an existing virtual node in a specified service mesh
update_virtual_router: Updates an existing virtual router in a specified service mesh
update_virtual_service: Updates an existing virtual service in a specified service mesh

Examples¶

## Not run: 
svc <- appmesh()
svc$create_gateway_route(
  Foo = 123
)

## End(Not run)