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

• .identifier ⇒ Object readonly private

API Operations

• #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

• .errors_module ⇒ Object private

Instance Method Summary

• #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.

Parameters:

• options (Hash)

Options Hash (options):

• :credentials (required, Aws::CredentialProvider) —

  Your AWS credentials. This can be an instance of any one of the following classes:

  • ‘Aws::Credentials` - Used for configuring static, non-refreshing credentials.

  • ‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.

  • ‘Aws::SharedCredentials` - Used for loading credentials from a shared file, such as `~/.aws/config`.

  • ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.

  When ‘:credentials` are not configured directly, the following locations will be searched for credentials:

  • ‘Aws.config`

  • The ‘:access_key_id`, `:secret_access_key`, and `:session_token` options.

  • ENV, ENV

  • ‘~/.aws/credentials`

  • ‘~/.aws/config`

  • EC2 IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentails` to enable retries and extended timeouts.

• :region (required, String) —

  The AWS region to connect to. The configured ‘:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is search for in the following locations:

  • ‘Aws.config`

  • ‘ENV`

  • ‘ENV`

  • ‘ENV`

  • ‘~/.aws/credentials`

  • ‘~/.aws/config`

• :access_key_id (String)
• :active_endpoint_cache (Boolean) — default: false —

  When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.

• :client_side_monitoring (Boolean) — default: false —

  When ‘true`, client-side metrics will be collected for all API requests from this client.

• :client_side_monitoring_client_id (String) — default: "" —

  Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

• :client_side_monitoring_host (String) — default: "127.0.0.1" —

  Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

• :client_side_monitoring_port (Integer) — default: 31000 —

  Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

• :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

  Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

• :convert_params (Boolean) — default: true —

  When ‘true`, an attempt is made to coerce request parameters into the required types.

• :disable_host_prefix_injection (Boolean) — default: false —

  Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

• :endpoint (String) —

  The client endpoint is normally constructed from the ‘:region` option. You should only configure an `:endpoint` when connecting to test endpoints. This should be avalid HTTP(S) URI.

• :endpoint_cache_max_entries (Integer) — default: 1000 —

  Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

• :endpoint_cache_max_threads (Integer) — default: 10 —

  Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

• :endpoint_cache_poll_interval (Integer) — default: 60 —

  When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

• :endpoint_discovery (Boolean) — default: false —

  When set to ‘true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.

• :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

  The log formatter.

• :log_level (Symbol) — default: :info —

  The log level to send messages to the ‘:logger` at.

• :logger (Logger) —

  The Logger instance to send log messages to. If this option is not set, logging will be disabled.

• :profile (String) — default: "default" —

  Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, ‘default’ is used.

• :retry_base_delay (Float) — default: 0.3 —

  The base delay in seconds used by the default backoff function.

• :retry_jitter (Symbol) — default: :none —

  A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.

  @see www.awsarchitectureblog.com/2015/03/backoff.html

• :retry_limit (Integer) — default: 3 —

  The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors and auth errors from expired credentials.

• :retry_max_delay (Integer) — default: 0 —

  The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.

• :secret_access_key (String)
• :session_token (String)
• :stub_responses (Boolean) — default: false —

  Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

  ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

• :validate_params (Boolean) — default: true —

  When ‘true`, request parameters are validated before sending the request.

• :http_proxy (URI::HTTP, String) —

  A proxy to send requests through. Formatted like ‘proxy.com:123’.

• :http_open_timeout (Float) — default: 15 —

  The number of seconds to wait when opening a HTTP session before rasing a ‘Timeout::Error`.

• :http_read_timeout (Integer) — default: 60 —

  The default number of seconds to wait for response data. This value can safely be set per-request on the session yeidled by #session_for.

• :http_idle_timeout (Float) — default: 5 —

  The number of seconds a connection is allowed to sit idble before it is considered stale. Stale connections are closed and removed from the pool before making a request.

• :http_continue_timeout (Float) — default: 1 —

  The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has “Expect” header set to “100-continue”. Defaults to ‘nil` which disables this behaviour. This value can safely be set per request on the session yeidled by #session_for.

• :http_wire_trace (Boolean) — default: false —

  When ‘true`, HTTP debug output will be sent to the `:logger`.

• :ssl_verify_peer (Boolean) — default: true —

  When ‘true`, SSL peer certificates are verified when establishing a connection.

• :ssl_ca_bundle (String) —

  Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

• :ssl_ca_directory (String) —

  Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

# 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.

# 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.

# 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.

Parameters:

• params ({}) (defaults to: {})

# 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.

Examples:

Request syntax with placeholder values

resp = client.create_mesh({
  client_token: "String",
  mesh_name: "ResourceName", # required
  spec: {
    egress_filter: {
      type: "ALLOW_ALL", # required, accepts ALLOW_ALL, DROP_ALL
    },
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
})

Response structure

resp.mesh.mesh_name #=> String
resp.mesh.metadata.arn #=> String
resp.mesh.metadata.created_at #=> Time
resp.mesh.metadata.last_updated_at #=> Time
resp.mesh.metadata.uid #=> String
resp.mesh.metadata.version #=> Integer
resp.mesh.spec.egress_filter.type #=> String, one of "ALLOW_ALL", "DROP_ALL"
resp.mesh.status.status #=> String, one of "ACTIVE", "DELETED", "INACTIVE"

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :client_token (String) —

  Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

  **A suitable default value is auto-generated.** You should normally not need to pass this option.**

• :mesh_name (required, String) —

  The name to use for the service mesh.

• :spec (Types::MeshSpec) —

  The service mesh specification to apply.

• :tags (Array<Types::TagRef>) —

  Optional metadata that you can apply to the service mesh to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

Returns:

• (Types::CreateMeshOutput) —

  Returns a response object which responds to the following methods:

  • #mesh => Types::MeshData

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-appmesh/client.rb', line 322

def create_mesh(params = {}, options = {})
  req = build_request(:create_mesh, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values

resp = client.create_route({
  client_token: "String",
  mesh_name: "ResourceName", # required
  route_name: "ResourceName", # required
  spec: { # required
    grpc_route: {
      action: { # required
        weighted_targets: [ # required
          {
            virtual_node: "ResourceName", # required
            weight: 1, # required
          },
        ],
      },
      match: { # required
        metadata: [
          {
            invert: false,
            match: {
              exact: "HeaderMatch",
              prefix: "HeaderMatch",
              range: {
                end: 1, # required
                start: 1, # required
              },
              regex: "HeaderMatch",
              suffix: "HeaderMatch",
            },
            name: "HeaderName", # required
          },
        ],
        method_name: "MethodName",
        service_name: "ServiceName",
      },
      retry_policy: {
        grpc_retry_events: ["cancelled"], # accepts cancelled, deadline-exceeded, internal, resource-exhausted, unavailable
        http_retry_events: ["HttpRetryPolicyEvent"],
        max_retries: 1, # required
        per_retry_timeout: { # required
          unit: "ms", # accepts ms, s
          value: 1,
        },
        tcp_retry_events: ["connection-error"], # accepts connection-error
      },
    },
    http2_route: {
      action: { # required
        weighted_targets: [ # required
          {
            virtual_node: "ResourceName", # required
            weight: 1, # required
          },
        ],
      },
      match: { # required
        headers: [
          {
            invert: false,
            match: {
              exact: "HeaderMatch",
              prefix: "HeaderMatch",
              range: {
                end: 1, # required
                start: 1, # required
              },
              regex: "HeaderMatch",
              suffix: "HeaderMatch",
            },
            name: "HeaderName", # required
          },
        ],
        method: "CONNECT", # accepts CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, TRACE
        prefix: "String", # required
        scheme: "http", # accepts http, https
      },
      retry_policy: {
        http_retry_events: ["HttpRetryPolicyEvent"],
        max_retries: 1, # required
        per_retry_timeout: { # required
          unit: "ms", # accepts ms, s
          value: 1,
        },
        tcp_retry_events: ["connection-error"], # accepts connection-error
      },
    },
    http_route: {
      action: { # required
        weighted_targets: [ # required
          {
            virtual_node: "ResourceName", # required
            weight: 1, # required
          },
        ],
      },
      match: { # required
        headers: [
          {
            invert: false,
            match: {
              exact: "HeaderMatch",
              prefix: "HeaderMatch",
              range: {
                end: 1, # required
                start: 1, # required
              },
              regex: "HeaderMatch",
              suffix: "HeaderMatch",
            },
            name: "HeaderName", # required
          },
        ],
        method: "CONNECT", # accepts CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, TRACE
        prefix: "String", # required
        scheme: "http", # accepts http, https
      },
      retry_policy: {
        http_retry_events: ["HttpRetryPolicyEvent"],
        max_retries: 1, # required
        per_retry_timeout: { # required
          unit: "ms", # accepts ms, s
          value: 1,
        },
        tcp_retry_events: ["connection-error"], # accepts connection-error
      },
    },
    priority: 1,
    tcp_route: {
      action: { # required
        weighted_targets: [ # required
          {
            virtual_node: "ResourceName", # required
            weight: 1, # required
          },
        ],
      },
    },
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
  virtual_router_name: "ResourceName", # required
})

Response structure

resp.route.mesh_name #=> String
resp.route.metadata.arn #=> String
resp.route.metadata.created_at #=> Time
resp.route.metadata.last_updated_at #=> Time
resp.route.metadata.uid #=> String
resp.route.metadata.version #=> Integer
resp.route.route_name #=> String
resp.route.spec.grpc_route.action.weighted_targets #=> Array
resp.route.spec.grpc_route.action.weighted_targets[0].virtual_node #=> String
resp.route.spec.grpc_route.action.weighted_targets[0].weight #=> Integer
resp.route.spec.grpc_route.match.metadata #=> Array
resp.route.spec.grpc_route.match.metadata[0].invert #=> Boolean
resp.route.spec.grpc_route.match.metadata[0].match.exact #=> String
resp.route.spec.grpc_route.match.metadata[0].match.prefix #=> String
resp.route.spec.grpc_route.match.metadata[0].match.range.end #=> Integer
resp.route.spec.grpc_route.match.metadata[0].match.range.start #=> Integer
resp.route.spec.grpc_route.match.metadata[0].match.regex #=> String
resp.route.spec.grpc_route.match.metadata[0].match.suffix #=> String
resp.route.spec.grpc_route.match.metadata[0].name #=> String
resp.route.spec.grpc_route.match.method_name #=> String
resp.route.spec.grpc_route.match.service_name #=> String
resp.route.spec.grpc_route.retry_policy.grpc_retry_events #=> Array
resp.route.spec.grpc_route.retry_policy.grpc_retry_events[0] #=> String, one of "cancelled", "deadline-exceeded", "internal", "resource-exhausted", "unavailable"
resp.route.spec.grpc_route.retry_policy.http_retry_events #=> Array
resp.route.spec.grpc_route.retry_policy.http_retry_events[0] #=> String
resp.route.spec.grpc_route.retry_policy.max_retries #=> Integer
resp.route.spec.grpc_route.retry_policy.per_retry_timeout.unit #=> String, one of "ms", "s"
resp.route.spec.grpc_route.retry_policy.per_retry_timeout.value #=> Integer
resp.route.spec.grpc_route.retry_policy.tcp_retry_events #=> Array
resp.route.spec.grpc_route.retry_policy.tcp_retry_events[0] #=> String, one of "connection-error"
resp.route.spec.http2_route.action.weighted_targets #=> Array
resp.route.spec.http2_route.action.weighted_targets[0].virtual_node #=> String
resp.route.spec.http2_route.action.weighted_targets[0].weight #=> Integer
resp.route.spec.http2_route.match.headers #=> Array
resp.route.spec.http2_route.match.headers[0].invert #=> Boolean
resp.route.spec.http2_route.match.headers[0].match.exact #=> String
resp.route.spec.http2_route.match.headers[0].match.prefix #=> String
resp.route.spec.http2_route.match.headers[0].match.range.end #=> Integer
resp.route.spec.http2_route.match.headers[0].match.range.start #=> Integer
resp.route.spec.http2_route.match.headers[0].match.regex #=> String
resp.route.spec.http2_route.match.headers[0].match.suffix #=> String
resp.route.spec.http2_route.match.headers[0].name #=> String
resp.route.spec.http2_route.match.method #=> String, one of "CONNECT", "DELETE", "GET", "HEAD", "OPTIONS", "PATCH", "POST", "PUT", "TRACE"
resp.route.spec.http2_route.match.prefix #=> String
resp.route.spec.http2_route.match.scheme #=> String, one of "http", "https"
resp.route.spec.http2_route.retry_policy.http_retry_events #=> Array
resp.route.spec.http2_route.retry_policy.http_retry_events[0] #=> String
resp.route.spec.http2_route.retry_policy.max_retries #=> Integer
resp.route.spec.http2_route.retry_policy.per_retry_timeout.unit #=> String, one of "ms", "s"
resp.route.spec.http2_route.retry_policy.per_retry_timeout.value #=> Integer
resp.route.spec.http2_route.retry_policy.tcp_retry_events #=> Array
resp.route.spec.http2_route.retry_policy.tcp_retry_events[0] #=> String, one of "connection-error"
resp.route.spec.http_route.action.weighted_targets #=> Array
resp.route.spec.http_route.action.weighted_targets[0].virtual_node #=> String
resp.route.spec.http_route.action.weighted_targets[0].weight #=> Integer
resp.route.spec.http_route.match.headers #=> Array
resp.route.spec.http_route.match.headers[0].invert #=> Boolean
resp.route.spec.http_route.match.headers[0].match.exact #=> String
resp.route.spec.http_route.match.headers[0].match.prefix #=> String
resp.route.spec.http_route.match.headers[0].match.range.end #=> Integer
resp.route.spec.http_route.match.headers[0].match.range.start #=> Integer
resp.route.spec.http_route.match.headers[0].match.regex #=> String
resp.route.spec.http_route.match.headers[0].match.suffix #=> String
resp.route.spec.http_route.match.headers[0].name #=> String
resp.route.spec.http_route.match.method #=> String, one of "CONNECT", "DELETE", "GET", "HEAD", "OPTIONS", "PATCH", "POST", "PUT", "TRACE"
resp.route.spec.http_route.match.prefix #=> String
resp.route.spec.http_route.match.scheme #=> String, one of "http", "https"
resp.route.spec.http_route.retry_policy.http_retry_events #=> Array
resp.route.spec.http_route.retry_policy.http_retry_events[0] #=> String
resp.route.spec.http_route.retry_policy.max_retries #=> Integer
resp.route.spec.http_route.retry_policy.per_retry_timeout.unit #=> String, one of "ms", "s"
resp.route.spec.http_route.retry_policy.per_retry_timeout.value #=> Integer
resp.route.spec.http_route.retry_policy.tcp_retry_events #=> Array
resp.route.spec.http_route.retry_policy.tcp_retry_events[0] #=> String, one of "connection-error"
resp.route.spec.priority #=> Integer
resp.route.spec.tcp_route.action.weighted_targets #=> Array
resp.route.spec.tcp_route.action.weighted_targets[0].virtual_node #=> String
resp.route.spec.tcp_route.action.weighted_targets[0].weight #=> Integer
resp.route.status.status #=> String, one of "ACTIVE", "DELETED", "INACTIVE"
resp.route.virtual_router_name #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :client_token (String) —

  Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

  **A suitable default value is auto-generated.** You should normally not need to pass this option.**

• :mesh_name (required, String) —

  The name of the service mesh to create the route in.

• :route_name (required, String) —

  The name to use for the route.

• :spec (required, Types::RouteSpec) —

  The route specification to apply.

• :tags (Array<Types::TagRef>) —

  Optional metadata that you can apply to the route to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

• :virtual_router_name (required, String) —

  The name of the virtual router in which to create the route.

Returns:

• (Types::CreateRouteOutput) —

  Returns a response object which responds to the following methods:

  • #route => Types::RouteData

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-appmesh/client.rb', line 603

def create_route(params = {}, options = {})
  req = build_request(:create_route, params)
  req.send_request(options)
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>

Examples:

Request syntax with placeholder values

resp = client.create_virtual_node({
  client_token: "String",
  mesh_name: "ResourceName", # required
  spec: { # required
    backends: [
      {
        virtual_service: {
          virtual_service_name: "ServiceName", # required
        },
      },
    ],
    listeners: [
      {
        health_check: {
          healthy_threshold: 1, # required
          interval_millis: 1, # required
          path: "String",
          port: 1,
          protocol: "grpc", # required, accepts grpc, http, http2, tcp
          timeout_millis: 1, # required
          unhealthy_threshold: 1, # required
        },
        port_mapping: { # required
          port: 1, # required
          protocol: "grpc", # required, accepts grpc, http, http2, tcp
        },
      },
    ],
    logging: {
      access_log: {
        file: {
          path: "FilePath", # required
        },
      },
    },
    service_discovery: {
      aws_cloud_map: {
        attributes: [
          {
            key: "AwsCloudMapInstanceAttributeKey", # required
            value: "AwsCloudMapInstanceAttributeValue", # required
          },
        ],
        namespace_name: "AwsCloudMapName", # required
        service_name: "AwsCloudMapName", # required
      },
      dns: {
        hostname: "Hostname", # required
      },
    },
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
  virtual_node_name: "ResourceName", # required
})

Response structure

resp.virtual_node.mesh_name #=> String
resp.virtual_node.metadata.arn #=> String
resp.virtual_node.metadata.created_at #=> Time
resp.virtual_node.metadata.last_updated_at #=> Time
resp.virtual_node.metadata.uid #=> String
resp.virtual_node.metadata.version #=> Integer
resp.virtual_node.spec.backends #=> Array
resp.virtual_node.spec.backends[0].virtual_service.virtual_service_name #=> String
resp.virtual_node.spec.listeners #=> Array
resp.virtual_node.spec.listeners[0].health_check.healthy_threshold #=> Integer
resp.virtual_node.spec.listeners[0].health_check.interval_millis #=> Integer
resp.virtual_node.spec.listeners[0].health_check.path #=> String
resp.virtual_node.spec.listeners[0].health_check.port #=> Integer
resp.virtual_node.spec.listeners[0].health_check.protocol #=> String, one of "grpc", "http", "http2", "tcp"
resp.virtual_node.spec.listeners[0].health_check.timeout_millis #=> Integer
resp.virtual_node.spec.listeners[0].health_check.unhealthy_threshold #=> Integer
resp.virtual_node.spec.listeners[0].port_mapping.port #=> Integer
resp.virtual_node.spec.listeners[0].port_mapping.protocol #=> String, one of "grpc", "http", "http2", "tcp"
resp.virtual_node.spec.logging.access_log.file.path #=> String
resp.virtual_node.spec.service_discovery.aws_cloud_map.attributes #=> Array
resp.virtual_node.spec.service_discovery.aws_cloud_map.attributes[0].key #=> String
resp.virtual_node.spec.service_discovery.aws_cloud_map.attributes[0].value #=> String
resp.virtual_node.spec.service_discovery.aws_cloud_map.namespace_name #=> String
resp.virtual_node.spec.service_discovery.aws_cloud_map.service_name #=> String
resp.virtual_node.spec.service_discovery.dns.hostname #=> String
resp.virtual_node.status.status #=> String, one of "ACTIVE", "DELETED", "INACTIVE"
resp.virtual_node.virtual_node_name #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :client_token (String) —

  Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

  **A suitable default value is auto-generated.** You should normally not need to pass this option.**

• :mesh_name (required, String) —

  The name of the service mesh to create the virtual node in.

• :spec (required, Types::VirtualNodeSpec) —

  The virtual node specification to apply.

• :tags (Array<Types::TagRef>) —

  Optional metadata that you can apply to the virtual node to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

• :virtual_node_name (required, String) —

  The name to use for the virtual node.

Returns:

• (Types::CreateVirtualNodeOutput) —

  Returns a response object which responds to the following methods:

  • #virtual_node => Types::VirtualNodeData

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-appmesh/client.rb', line 759

def create_virtual_node(params = {}, options = {})
  req = build_request(:create_virtual_node, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values

resp = client.create_virtual_router({
  client_token: "String",
  mesh_name: "ResourceName", # required
  spec: { # required
    listeners: [
      {
        port_mapping: { # required
          port: 1, # required
          protocol: "grpc", # required, accepts grpc, http, http2, tcp
        },
      },
    ],
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
  virtual_router_name: "ResourceName", # required
})

Response structure

resp.virtual_router.mesh_name #=> String
resp.virtual_router.metadata.arn #=> String
resp.virtual_router.metadata.created_at #=> Time
resp.virtual_router.metadata.last_updated_at #=> Time
resp.virtual_router.metadata.uid #=> String
resp.virtual_router.metadata.version #=> Integer
resp.virtual_router.spec.listeners #=> Array
resp.virtual_router.spec.listeners[0].port_mapping.port #=> Integer
resp.virtual_router.spec.listeners[0].port_mapping.protocol #=> String, one of "grpc", "http", "http2", "tcp"
resp.virtual_router.status.status #=> String, one of "ACTIVE", "DELETED", "INACTIVE"
resp.virtual_router.virtual_router_name #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :client_token (String) —

  Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

  **A suitable default value is auto-generated.** You should normally not need to pass this option.**

• :mesh_name (required, String) —

  The name of the service mesh to create the virtual router in.

• :spec (required, Types::VirtualRouterSpec) —

  The virtual router specification to apply.

• :tags (Array<Types::TagRef>) —

  Optional metadata that you can apply to the virtual router to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

• :virtual_router_name (required, String) —

  The name to use for the virtual router.

Returns:

• (Types::CreateVirtualRouterOutput) —

  Returns a response object which responds to the following methods:

  • #virtual_router => Types::VirtualRouterData

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-appmesh/client.rb', line 844

def create_virtual_router(params = {}, options = {})
  req = build_request(:create_virtual_router, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values

resp = client.create_virtual_service({
  client_token: "String",
  mesh_name: "ResourceName", # required
  spec: { # required
    provider: {
      virtual_node: {
        virtual_node_name: "ResourceName", # required
      },
      virtual_router: {
        virtual_router_name: "ResourceName", # required
      },
    },
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
  virtual_service_name: "ServiceName", # required
})

Response structure

resp.virtual_service.mesh_name #=> String
resp.virtual_service.metadata.arn #=> String
resp.virtual_service.metadata.created_at #=> Time
resp.virtual_service.metadata.last_updated_at #=> Time
resp.virtual_service.metadata.uid #=> String
resp.virtual_service.metadata.version #=> Integer
resp.virtual_service.spec.provider.virtual_node.virtual_node_name #=> String
resp.virtual_service.spec.provider.virtual_router.virtual_router_name #=> String
resp.virtual_service.status.status #=> String, one of "ACTIVE", "DELETED", "INACTIVE"
resp.virtual_service.virtual_service_name #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :client_token (String) —

  Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

  **A suitable default value is auto-generated.** You should normally not need to pass this option.**

• :mesh_name (required, String) —

  The name of the service mesh to create the virtual service in.

• :spec (required, Types::VirtualServiceSpec) —

  The virtual service specification to apply.

• :tags (Array<Types::TagRef>) —

  Optional metadata that you can apply to the virtual service to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

• :virtual_service_name (required, String) —

  The name to use for the virtual service.

Returns:

• (Types::CreateVirtualServiceOutput) —

  Returns a response object which responds to the following methods:

  • #virtual_service => Types::VirtualServiceData

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-appmesh/client.rb', line 927

def create_virtual_service(params = {}, options = {})
  req = build_request(:create_virtual_service, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values

resp = client.delete_mesh({
  mesh_name: "ResourceName", # required
})

Response structure

resp.mesh.mesh_name #=> String
resp.mesh.metadata.arn #=> String
resp.mesh.metadata.created_at #=> Time
resp.mesh.metadata.last_updated_at #=> Time
resp.mesh.metadata.uid #=> String
resp.mesh.metadata.version #=> Integer
resp.mesh.spec.egress_filter.type #=> String, one of "ALLOW_ALL", "DROP_ALL"
resp.mesh.status.status #=> String, one of "ACTIVE", "DELETED", "INACTIVE"

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :mesh_name (required, String) —

  The name of the service mesh to delete.

Returns:

• (Types::DeleteMeshOutput) —

  Returns a response object which responds to the following methods:

  • #mesh => Types::MeshData

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-appmesh/client.rb', line 966

def delete_mesh(params = {}, options = {})
  req = build_request(:delete_mesh, params)
  req.send_request(options)
end

#delete_route(params = {}) ⇒ Types::DeleteRouteOutput

Deletes an existing route.

Examples:

Request syntax with placeholder values

resp = client.delete_route({
  mesh_name: "ResourceName", # required
  route_name: "ResourceName", # required
  virtual_router_name: "ResourceName", # required
})

Response structure

resp.route.mesh_name #=> String
resp.route.metadata.arn #=> String
resp.route.metadata.created_at #=> Time
resp.route.metadata.last_updated_at #=> Time
resp.route.metadata.uid #=> String
resp.route.metadata.version #=> Integer
resp.route.route_name #=> String
resp.route.spec.grpc_route.action.weighted_targets #=> Array
resp.route.spec.grpc_route.action.weighted_targets[0].virtual_node #=> String
resp.route.spec.grpc_route.action.weighted_targets[0].weight #=> Integer
resp.route.spec.grpc_route.match.metadata #=> Array
resp.route.spec.grpc_route.match.metadata[0].invert #=> Boolean
resp.route.spec.grpc_route.match.metadata[0].match.exact #=> String
resp.route.spec.grpc_route.match.metadata[0].match.prefix #=> String
resp.route.spec.grpc_route.match.metadata[0].match.range.end #=> Integer
resp.route.spec.grpc_route.match.metadata[0].match.range.start #=> Integer
resp.route.spec.grpc_route.match.metadata[0].match.regex #=> String
resp.route.spec.grpc_route.match.metadata[0].match.suffix #=> String
resp.route.spec.grpc_route.match.metadata[0].name #=> String
resp.route.spec.grpc_route.match.method_name #=> String
resp.route.spec.grpc_route.match.service_name #=> String
resp.route.spec.grpc_route.retry_policy.grpc_retry_events #=> Array
resp.route.spec.grpc_route.retry_policy.grpc_retry_events[0] #=> String, one of "cancelled", "deadline-exceeded", "internal", "resource-exhausted", "unavailable"
resp.route.spec.grpc_route.retry_policy.http_retry_events #=> Array
resp.route.spec.grpc_route.retry_policy.http_retry_events[0] #=> String
resp.route.spec.grpc_route.retry_policy.max_retries #=> Integer
resp.route.spec.grpc_route.retry_policy.per_retry_timeout.unit #=> String, one of "ms", "s"
resp.route.spec.grpc_route.retry_policy.per_retry_timeout.value #=> Integer
resp.route.spec.grpc_route.retry_policy.tcp_retry_events #=> Array
resp.route.spec.grpc_route.retry_policy.tcp_retry_events[0] #=> String, one of "connection-error"
resp.route.spec.http2_route.action.weighted_targets #=> Array
resp.route.spec.http2_route.action.weighted_targets[0].virtual_node #=> String
resp.route.spec.http2_route.action.weighted_targets[0].weight #=> Integer
resp.route.spec.http2_route.match.headers #=> Array
resp.route.spec.http2_route.match.headers[0].invert #=> Boolean
resp.route.spec.http2_route.match.headers[0].match.exact #=> String
resp.route.spec.http2_route.match.headers[0].match.prefix #=> String
resp.route.spec.http2_route.match.headers[0].match.range.end #=> Integer
resp.route.spec.http2_route.match.headers[0].match.range.start #=> Integer
resp.route.spec.http2_route.match.headers[0].match.regex #=> String
resp.route.spec.http2_route.match.headers[0].match.suffix #=> String
resp.route.spec.http2_route.match.headers[0].name #=> String
resp.route.spec.http2_route.match.method #=> String, one of "CONNECT", "DELETE", "GET", "HEAD", "OPTIONS", "PATCH", "POST", "PUT", "TRACE"
resp.route.spec.http2_route.match.prefix #=> String
resp.route.spec.http2_route.match.scheme #=> String, one of "http", "https"
resp.route.spec.http2_route.retry_policy.http_retry_events #=> Array
resp.route.spec.http2_route.retry_policy.http_retry_events[0] #=> String
resp.route.spec.http2_route.retry_policy.max_retries #=> Integer
resp.route.spec.http2_route.retry_policy.per_retry_timeout.unit #=> String, one of "ms", "s"
resp.route.spec.http2_route.retry_policy.per_retry_timeout.value #=> Integer
resp.route.spec.http2_route.retry_policy.tcp_retry_events #=> Array
resp.route.spec.http2_route.retry_policy.tcp_retry_events[0] #=> String, one of "connection-error"
resp.route.spec.http_route.action.weighted_targets #=> Array
resp.route.spec.http_route.action.weighted_targets[0].virtual_node #=> String
resp.route.spec.http_route.action.weighted_targets[0].weight #=> Integer
resp.route.spec.http_route.match.headers #=> Array
resp.route.spec.http_route.match.headers[0].invert #=> Boolean
resp.route.spec.http_route.match.headers[0].match.exact #=> String
resp.route.spec.http_route.match.headers[0].match.prefix #=> String
resp.route.spec.http_route.match.headers[0].match.range.end #=> Integer
resp.route.spec.http_route.match.headers[0].match.range.start #=> Integer
resp.route.spec.http_route.match.headers[0].match.regex #=> String
resp.route.spec.http_route.match.headers[0].match.suffix #=> String
resp.route.spec.http_route.match.headers[0].name #=> String
resp.route.spec.http_route.match.method #=> String, one of "CONNECT", "DELETE", "GET", "HEAD", "OPTIONS", "PATCH", "POST", "PUT", "TRACE"
resp.route.spec.http_route.match.prefix #=> String
resp.route.spec.http_route.match.scheme #=> String, one of "http", "https"
resp.route.spec.http_route.retry_policy.http_retry_events #=> Array
resp.route.spec.http_route.retry_policy.http_retry_events[0] #=> String
resp.route.spec.http_route.retry_policy.max_retries #=> Integer
resp.route.spec.http_route.retry_policy.per_retry_timeout.unit #=> String, one of "ms", "s"
resp.route.spec.http_route.retry_policy.per_retry_timeout.value #=> Integer
resp.route.spec.http_route.retry_policy.tcp_retry_events #=> Array
resp.route.spec.http_route.retry_policy.tcp_retry_events[0] #=> String, one of "connection-error"
resp.route.spec.priority #=> Integer
resp.route.spec.tcp_route.action.weighted_targets #=> Array
resp.route.spec.tcp_route.action.weighted_targets[0].virtual_node #=> String
resp.route.spec.tcp_route.action.weighted_targets[0].weight #=> Integer
resp.route.status.status #=> String, one of "ACTIVE", "DELETED", "INACTIVE"
resp.route.virtual_router_name #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :mesh_name (required, String) —

  The name of the service mesh to delete the route in.

• :route_name (required, String) —

  The name of the route to delete.

• :virtual_router_name (required, String) —

  The name of the virtual router to delete the route in.

Returns:

• (Types::DeleteRouteOutput) —

  Returns a response object which responds to the following methods:

  • #route => Types::RouteData

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-appmesh/client.rb', line 1081

def delete_route(params = {}, options = {})
  req = build_request(:delete_route, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values

resp = client.delete_virtual_node({
  mesh_name: "ResourceName", # required
  virtual_node_name: "ResourceName", # required
})

Response structure

resp.virtual_node.mesh_name #=> String
resp.virtual_node.metadata.arn #=> String
resp.virtual_node.metadata.created_at #=> Time
resp.virtual_node.metadata.last_updated_at #=> Time
resp.virtual_node.metadata.uid #=> String
resp.virtual_node.metadata.version #=> Integer
resp.virtual_node.spec.backends #=> Array
resp.virtual_node.spec.backends[0].virtual_service.virtual_service_name #=> String
resp.virtual_node.spec.listeners #=> Array
resp.virtual_node.spec.listeners[0].health_check.healthy_threshold #=> Integer
resp.virtual_node.spec.listeners[0].health_check.interval_millis #=> Integer
resp.virtual_node.spec.listeners[0].health_check.path #=> String
resp.virtual_node.spec.listeners[0].health_check.port #=> Integer
resp.virtual_node.spec.listeners[0].health_check.protocol #=> String, one of "grpc", "http", "http2", "tcp"
resp.virtual_node.spec.listeners[0].health_check.timeout_millis #=> Integer
resp.virtual_node.spec.listeners[0].health_check.unhealthy_threshold #=> Integer
resp.virtual_node.spec.listeners[0].port_mapping.port #=> Integer
resp.virtual_node.spec.listeners[0].port_mapping.protocol #=> String, one of "grpc", "http", "http2", "tcp"
resp.virtual_node.spec.logging.access_log.file.path #=> String
resp.virtual_node.spec.service_discovery.aws_cloud_map.attributes #=> Array
resp.virtual_node.spec.service_discovery.aws_cloud_map.attributes[0].key #=> String
resp.virtual_node.spec.service_discovery.aws_cloud_map.attributes[0].value #=> String
resp.virtual_node.spec.service_discovery.aws_cloud_map.namespace_name #=> String
resp.virtual_node.spec.service_discovery.aws_cloud_map.service_name #=> String
resp.virtual_node.spec.service_discovery.dns.hostname #=> String
resp.virtual_node.status.status #=> String, one of "ACTIVE", "DELETED", "INACTIVE"
resp.virtual_node.virtual_node_name #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :mesh_name (required, String) —

  The name of the service mesh to delete the virtual node in.

• :virtual_node_name (required, String) —

  The name of the virtual node to delete.

Returns:

• (Types::DeleteVirtualNodeOutput) —

  Returns a response object which responds to the following methods:

  • #virtual_node => Types::VirtualNodeData

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-appmesh/client.rb', line 1142

def delete_virtual_node(params = {}, options = {})
  req = build_request(:delete_virtual_node, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values

resp = client.delete_virtual_router({
  mesh_name: "ResourceName", # required
  virtual_router_name: "ResourceName", # required
})

Response structure

resp.virtual_router.mesh_name #=> String
resp.virtual_router.metadata.arn #=> String
resp.virtual_router.metadata.created_at #=> Time
resp.virtual_router.metadata.last_updated_at #=> Time
resp.virtual_router.metadata.uid #=> String
resp.virtual_router.metadata.version #=> Integer
resp.virtual_router.spec.listeners #=> Array
resp.virtual_router.spec.listeners[0].port_mapping.port #=> Integer
resp.virtual_router.spec.listeners[0].port_mapping.protocol #=> String, one of "grpc", "http", "http2", "tcp"
resp.virtual_router.status.status #=> String, one of "ACTIVE", "DELETED", "INACTIVE"
resp.virtual_router.virtual_router_name #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :mesh_name (required, String) —

  The name of the service mesh to delete the virtual router in.

• :virtual_router_name (required, String) —

  The name of the virtual router to delete.

Returns:

• (Types::DeleteVirtualRouterOutput) —

  Returns a response object which responds to the following methods:

  • #virtual_router => Types::VirtualRouterData

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-appmesh/client.rb', line 1187

def delete_virtual_router(params = {}, options = {})
  req = build_request(:delete_virtual_router, params)
  req.send_request(options)
end

#delete_virtual_service(params = {}) ⇒ Types::DeleteVirtualServiceOutput

Deletes an existing virtual service.

Examples:

Request syntax with placeholder values

resp = client.delete_virtual_service({
  mesh_name: "ResourceName", # required
  virtual_service_name: "ServiceName", # required
})

Response structure

resp.virtual_service.mesh_name #=> String
resp.virtual_service.metadata.arn #=> String
resp.virtual_service.metadata.created_at #=> Time
resp.virtual_service.metadata.last_updated_at #=> Time
resp.virtual_service.metadata.uid #=> String
resp.virtual_service.metadata.version #=> Integer
resp.virtual_service.spec.provider.virtual_node.virtual_node_name #=> String
resp.virtual_service.spec.provider.virtual_router.virtual_router_name #=> String
resp.virtual_service.status.status #=> String, one of "ACTIVE", "DELETED", "INACTIVE"
resp.virtual_service.virtual_service_name #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :mesh_name (required, String) —

  The name of the service mesh to delete the virtual service in.

• :virtual_service_name (required, String) —

  The name of the virtual service to delete.

Returns:

• (Types::DeleteVirtualServiceOutput) —

  Returns a response object which responds to the following methods:

  • #virtual_service => Types::VirtualServiceData

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-appmesh/client.rb', line 1228

def delete_virtual_service(params = {}, options = {})
  req = build_request(:delete_virtual_service, params)
  req.send_request(options)
end

#describe_mesh(params = {}) ⇒ Types::DescribeMeshOutput

Describes an existing service mesh.

Examples:

Request syntax with placeholder values

resp = client.describe_mesh({
  mesh_name: "ResourceName", # required
})

Response structure

resp.mesh.mesh_name #=> String
resp.mesh.metadata.arn #=> String
resp.mesh.metadata.created_at #=> Time
resp.mesh.metadata.last_updated_at #=> Time
resp.mesh.metadata.uid #=> String
resp.mesh.metadata.version #=> Integer
resp.mesh.spec.egress_filter.type #=> String, one of "ALLOW_ALL", "DROP_ALL"
resp.mesh.status.status #=> String, one of "ACTIVE", "DELETED", "INACTIVE"

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :mesh_name (required, String) —

  The name of the service mesh to describe.

Returns:

• (Types::DescribeMeshOutput) —

  Returns a response object which responds to the following methods:

  • #mesh => Types::MeshData

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-appmesh/client.rb', line 1263

def describe_mesh(params = {}, options = {})
  req = build_request(:describe_mesh, params)
  req.send_request(options)
end

#describe_route(params = {}) ⇒ Types::DescribeRouteOutput

Describes an existing route.

Examples:

Request syntax with placeholder values

resp = client.describe_route({
  mesh_name: "ResourceName", # required
  route_name: "ResourceName", # required
  virtual_router_name: "ResourceName", # required
})

Response structure

resp.route.mesh_name #=> String
resp.route.metadata.arn #=> String
resp.route.metadata.created_at #=> Time
resp.route.metadata.last_updated_at #=> Time
resp.route.metadata.uid #=> String
resp.route.metadata.version #=> Integer
resp.route.route_name #=> String
resp.route.spec.grpc_route.action.weighted_targets #=> Array
resp.route.spec.grpc_route.action.weighted_targets[0].virtual_node #=> String
resp.route.spec.grpc_route.action.weighted_targets[0].weight #=> Integer
resp.route.spec.grpc_route.match.metadata #=> Array
resp.route.spec.grpc_route.match.metadata[0].invert #=> Boolean
resp.route.spec.grpc_route.match.metadata[0].match.exact #=> String
resp.route.spec.grpc_route.match.metadata[0].match.prefix #=> String
resp.route.spec.grpc_route.match.metadata[0].match.range.end #=> Integer
resp.route.spec.grpc_route.match.metadata[0].match.range.start #=> Integer
resp.route.spec.grpc_route.match.metadata[0].match.regex #=> String
resp.route.spec.grpc_route.match.metadata[0].match.suffix #=> String
resp.route.spec.grpc_route.match.metadata[0].name #=> String
resp.route.spec.grpc_route.match.method_name #=> String
resp.route.spec.grpc_route.match.service_name #=> String
resp.route.spec.grpc_route.retry_policy.grpc_retry_events #=> Array
resp.route.spec.grpc_route.retry_policy.grpc_retry_events[0] #=> String, one of "cancelled", "deadline-exceeded", "internal", "resource-exhausted", "unavailable"
resp.route.spec.grpc_route.retry_policy.http_retry_events #=> Array
resp.route.spec.grpc_route.retry_policy.http_retry_events[0] #=> String
resp.route.spec.grpc_route.retry_policy.max_retries #=> Integer
resp.route.spec.grpc_route.retry_policy.per_retry_timeout.unit #=> String, one of "ms", "s"
resp.route.spec.grpc_route.retry_policy.per_retry_timeout.value #=> Integer
resp.route.spec.grpc_route.retry_policy.tcp_retry_events #=> Array
resp.route.spec.grpc_route.retry_policy.tcp_retry_events[0] #=> String, one of "connection-error"
resp.route.spec.http2_route.action.weighted_targets #=> Array
resp.route.spec.http2_route.action.weighted_targets[0].virtual_node #=> String
resp.route.spec.http2_route.action.weighted_targets[0].weight #=> Integer
resp.route.spec.http2_route.match.headers #=> Array
resp.route.spec.http2_route.match.headers[0].invert #=> Boolean
resp.route.spec.http2_route.match.headers[0].match.exact #=> String
resp.route.spec.http2_route.match.headers[0].match.prefix #=> String
resp.route.spec.http2_route.match.headers[0].match.range.end #=> Integer
resp.route.spec.http2_route.match.headers[0].match.range.start #=> Integer
resp.route.spec.http2_route.match.headers[0].match.regex #=> String
resp.route.spec.http2_route.match.headers[0].match.suffix #=> String
resp.route.spec.http2_route.match.headers[0].name #=> String
resp.route.spec.http2_route.match.method #=> String, one of "CONNECT", "DELETE", "GET", "HEAD", "OPTIONS", "PATCH", "POST", "PUT", "TRACE"
resp.route.spec.http2_route.match.prefix #=> String
resp.route.spec.http2_route.match.scheme #=> String, one of "http", "https"
resp.route.spec.http2_route.retry_policy.http_retry_events #=> Array
resp.route.spec.http2_route.retry_policy.http_retry_events[0] #=> String
resp.route.spec.http2_route.retry_policy.max_retries #=> Integer
resp.route.spec.http2_route.retry_policy.per_retry_timeout.unit #=> String, one of "ms", "s"
resp.route.spec.http2_route.retry_policy.per_retry_timeout.value #=> Integer
resp.route.spec.http2_route.retry_policy.tcp_retry_events #=> Array
resp.route.spec.http2_route.retry_policy.tcp_retry_events[0] #=> String, one of "connection-error"
resp.route.spec.http_route.action.weighted_targets #=> Array
resp.route.spec.http_route.action.weighted_targets[0].virtual_node #=> String
resp.route.spec.http_route.action.weighted_targets[0].weight #=> Integer
resp.route.spec.http_route.match.headers #=> Array
resp.route.spec.http_route.match.headers[0].invert #=> Boolean
resp.route.spec.http_route.match.headers[0].match.exact #=> String
resp.route.spec.http_route.match.headers[0].match.prefix #=> String
resp.route.spec.http_route.match.headers[0].match.range.end #=> Integer
resp.route.spec.http_route.match.headers[0].match.range.start #=> Integer
resp.route.spec.http_route.match.headers[0].match.regex #=> String
resp.route.spec.http_route.match.headers[0].match.suffix #=> String
resp.route.spec.http_route.match.headers[0].name #=> String
resp.route.spec.http_route.match.method #=> String, one of "CONNECT", "DELETE", "GET", "HEAD", "OPTIONS", "PATCH", "POST", "PUT", "TRACE"
resp.route.spec.http_route.match.prefix #=> String
resp.route.spec.http_route.match.scheme #=> String, one of "http", "https"
resp.route.spec.http_route.retry_policy.http_retry_events #=> Array
resp.route.spec.http_route.retry_policy.http_retry_events[0] #=> String
resp.route.spec.http_route.retry_policy.max_retries #=> Integer
resp.route.spec.http_route.retry_policy.per_retry_timeout.unit #=> String, one of "ms", "s"
resp.route.spec.http_route.retry_policy.per_retry_timeout.value #=> Integer
resp.route.spec.http_route.retry_policy.tcp_retry_events #=> Array
resp.route.spec.http_route.retry_policy.tcp_retry_events[0] #=> String, one of "connection-error"
resp.route.spec.priority #=> Integer
resp.route.spec.tcp_route.action.weighted_targets #=> Array
resp.route.spec.tcp_route.action.weighted_targets[0].virtual_node #=> String
resp.route.spec.tcp_route.action.weighted_targets[0].weight #=> Integer
resp.route.status.status #=> String, one of "ACTIVE", "DELETED", "INACTIVE"
resp.route.virtual_router_name #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :mesh_name (required, String) —

  The name of the service mesh that the route resides in.

• :route_name (required, String) —

  The name of the route to describe.

• :virtual_router_name (required, String) —

  The name of the virtual router that the route is associated with.

Returns:

• (Types::DescribeRouteOutput) —

  Returns a response object which responds to the following methods:

  • #route => Types::RouteData

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-appmesh/client.rb', line 1378

def describe_route(params = {}, options = {})
  req = build_request(:describe_route, params)
  req.send_request(options)
end

#describe_virtual_node(params = {}) ⇒ Types::DescribeVirtualNodeOutput

Describes an existing virtual node.

Examples:

Request syntax with placeholder values

resp = client.describe_virtual_node({
  mesh_name: "ResourceName", # required
  virtual_node_name: "ResourceName", # required
})

Response structure

resp.virtual_node.mesh_name #=> String
resp.virtual_node.metadata.arn #=> String
resp.virtual_node.metadata.created_at #=> Time
resp.virtual_node.metadata.last_updated_at #=> Time
resp.virtual_node.metadata.uid #=> String
resp.virtual_node.metadata.version #=> Integer
resp.virtual_node.spec.backends #=> Array
resp.virtual_node.spec.backends[0].virtual_service.virtual_service_name #=> String
resp.virtual_node.spec.listeners #=> Array
resp.virtual_node.spec.listeners[0].health_check.healthy_threshold #=> Integer
resp.virtual_node.spec.listeners[0].health_check.interval_millis #=> Integer
resp.virtual_node.spec.listeners[0].health_check.path #=> String
resp.virtual_node.spec.listeners[0].health_check.port #=> Integer
resp.virtual_node.spec.listeners[0].health_check.protocol #=> String, one of "grpc", "http", "http2", "tcp"
resp.virtual_node.spec.listeners[0].health_check.timeout_millis #=> Integer
resp.virtual_node.spec.listeners[0].health_check.unhealthy_threshold #=> Integer
resp.virtual_node.spec.listeners[0].port_mapping.port #=> Integer
resp.virtual_node.spec.listeners[0].port_mapping.protocol #=> String, one of "grpc", "http", "http2", "tcp"
resp.virtual_node.spec.logging.access_log.file.path #=> String
resp.virtual_node.spec.service_discovery.aws_cloud_map.attributes #=> Array
resp.virtual_node.spec.service_discovery.aws_cloud_map.attributes[0].key #=> String
resp.virtual_node.spec.service_discovery.aws_cloud_map.attributes[0].value #=> String
resp.virtual_node.spec.service_discovery.aws_cloud_map.namespace_name #=> String
resp.virtual_node.spec.service_discovery.aws_cloud_map.service_name #=> String
resp.virtual_node.spec.service_discovery.dns.hostname #=> String
resp.virtual_node.status.status #=> String, one of "ACTIVE", "DELETED", "INACTIVE"
resp.virtual_node.virtual_node_name #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :mesh_name (required, String) —

  The name of the service mesh that the virtual node resides in.

• :virtual_node_name (required, String) —

  The name of the virtual node to describe.

Returns:

• (Types::DescribeVirtualNodeOutput) —

  Returns a response object which responds to the following methods:

  • #virtual_node => Types::VirtualNodeData

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-appmesh/client.rb', line 1436

def describe_virtual_node(params = {}, options = {})
  req = build_request(:describe_virtual_node, params)
  req.send_request(options)
end

#describe_virtual_router(params = {}) ⇒ Types::DescribeVirtualRouterOutput

Describes an existing virtual router.

Examples:

Request syntax with placeholder values

resp = client.describe_virtual_router({
  mesh_name: "ResourceName", # required
  virtual_router_name: "ResourceName", # required
})

Response structure

resp.virtual_router.mesh_name #=> String
resp.virtual_router.metadata.arn #=> String
resp.virtual_router.metadata.created_at #=> Time
resp.virtual_router.metadata.last_updated_at #=> Time
resp.virtual_router.metadata.uid #=> String
resp.virtual_router.metadata.version #=> Integer
resp.virtual_router.spec.listeners #=> Array
resp.virtual_router.spec.listeners[0].port_mapping.port #=> Integer
resp.virtual_router.spec.listeners[0].port_mapping.protocol #=> String, one of "grpc", "http", "http2", "tcp"
resp.virtual_router.status.status #=> String, one of "ACTIVE", "DELETED", "INACTIVE"
resp.virtual_router.virtual_router_name #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :mesh_name (required, String) —

  The name of the service mesh that the virtual router resides in.

• :virtual_router_name (required, String) —

  The name of the virtual router to describe.

Returns:

• (Types::DescribeVirtualRouterOutput) —

  Returns a response object which responds to the following methods:

  • #virtual_router => Types::VirtualRouterData

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-appmesh/client.rb', line 1478

def describe_virtual_router(params = {}, options = {})
  req = build_request(:describe_virtual_router, params)
  req.send_request(options)
end

#describe_virtual_service(params = {}) ⇒ Types::DescribeVirtualServiceOutput

Describes an existing virtual service.

Examples:

Request syntax with placeholder values

resp = client.describe_virtual_service({
  mesh_name: "ResourceName", # required
  virtual_service_name: "ServiceName", # required
})

Response structure

resp.virtual_service.mesh_name #=> String
resp.virtual_service.metadata.arn #=> String
resp.virtual_service.metadata.created_at #=> Time
resp.virtual_service.metadata.last_updated_at #=> Time
resp.virtual_service.metadata.uid #=> String
resp.virtual_service.metadata.version #=> Integer
resp.virtual_service.spec.provider.virtual_node.virtual_node_name #=> String
resp.virtual_service.spec.provider.virtual_router.virtual_router_name #=> String
resp.virtual_service.status.status #=> String, one of "ACTIVE", "DELETED", "INACTIVE"
resp.virtual_service.virtual_service_name #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :mesh_name (required, String) —

  The name of the service mesh that the virtual service resides in.

• :virtual_service_name (required, String) —

  The name of the virtual service to describe.

Returns:

• (Types::DescribeVirtualServiceOutput) —

  Returns a response object which responds to the following methods:

  • #virtual_service => Types::VirtualServiceData

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-appmesh/client.rb', line 1519

def describe_virtual_service(params = {}, options = {})
  req = build_request(:describe_virtual_service, params)
  req.send_request(options)
end

#list_meshes(params = {}) ⇒ Types::ListMeshesOutput

Returns a list of existing service meshes.

Examples:

Request syntax with placeholder values

resp = client.list_meshes({
  limit: 1,
  next_token: "String",
})

Response structure

resp.meshes #=> Array
resp.meshes[0].arn #=> String
resp.meshes[0].mesh_name #=> String
resp.next_token #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :limit (Integer) —

  The maximum number of results returned by ‘ListMeshes` in paginated output. When you use this parameter, `ListMeshes` returns only `limit` results in a single page along with a `nextToken` response element. You can see the remaining results of the initial request by sending another `ListMeshes` request with the returned `nextToken` value. This value can be between 1 and 100. If you don’t use this parameter, ‘ListMeshes` returns up to 100 results and a `nextToken` value if applicable.

• :next_token (String) —

  The ‘nextToken` value returned from a previous paginated `ListMeshes` request where `limit` was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the `nextToken` value.

  <note markdown=“1”> This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

  </note>
  

Returns:

• (Types::ListMeshesOutput) —

  Returns a response object which responds to the following methods:

  • #meshes => Array&lt;Types::MeshRef&gt;

  • #next_token => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-appmesh/client.rb', line 1571

def list_meshes(params = {}, options = {})
  req = build_request(:list_meshes, params)
  req.send_request(options)
end

#list_routes(params = {}) ⇒ Types::ListRoutesOutput

Returns a list of existing routes in a service mesh.

Examples:

Request syntax with placeholder values

resp = client.list_routes({
  limit: 1,
  mesh_name: "ResourceName", # required
  next_token: "String",
  virtual_router_name: "ResourceName", # required
})

Response structure

resp.next_token #=> String
resp.routes #=> Array
resp.routes[0].arn #=> String
resp.routes[0].mesh_name #=> String
resp.routes[0].route_name #=> String
resp.routes[0].virtual_router_name #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :limit (Integer) —

  The maximum number of results returned by ‘ListRoutes` in paginated output. When you use this parameter, `ListRoutes` returns only `limit` results in a single page along with a `nextToken` response element. You can see the remaining results of the initial request by sending another `ListRoutes` request with the returned `nextToken` value. This value can be between 1 and 100. If you don’t use this parameter, ‘ListRoutes` returns up to 100 results and a `nextToken` value if applicable.

• :mesh_name (required, String) —

  The name of the service mesh to list routes in.

• :next_token (String) —

  The ‘nextToken` value returned from a previous paginated `ListRoutes` request where `limit` was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the `nextToken` value.

• :virtual_router_name (required, String) —

  The name of the virtual router to list routes in.

Returns:

• (Types::ListRoutesOutput) —

  Returns a response object which responds to the following methods:

  • #next_token => String

  • #routes => Array&lt;Types::RouteRef&gt;

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-appmesh/client.rb', line 1627

def list_routes(params = {}, options = {})
  req = build_request(:list_routes, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput

List the tags for an App Mesh resource.

Examples:

Request syntax with placeholder values

resp = client.list_tags_for_resource({
  limit: 1,
  next_token: "String",
  resource_arn: "Arn", # required
})

Response structure

resp.next_token #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :limit (Integer) —

  The maximum number of tag results returned by ‘ListTagsForResource` in paginated output. When this parameter is used, `ListTagsForResource` returns only `limit` results in a single page along with a `nextToken` response element. You can see the remaining results of the initial request by sending another `ListTagsForResource` request with the returned `nextToken` value. This value can be between 1 and 100. If you don’t use this parameter, ‘ListTagsForResource` returns up to 100 results and a `nextToken` value if applicable.

• :next_token (String) —

  The ‘nextToken` value returned from a previous paginated `ListTagsForResource` request where `limit` was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the `nextToken` value.

• :resource_arn (required, String) —

  The Amazon Resource Name (ARN) that identifies the resource to list the tags for.

Returns:

• (Types::ListTagsForResourceOutput) —

  Returns a response object which responds to the following methods:

  • #next_token => String

  • #tags => Array&lt;Types::TagRef&gt;

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-appmesh/client.rb', line 1678

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#list_virtual_nodes(params = {}) ⇒ Types::ListVirtualNodesOutput

Returns a list of existing virtual nodes.

Examples:

Request syntax with placeholder values

resp = client.list_virtual_nodes({
  limit: 1,
  mesh_name: "ResourceName", # required
  next_token: "String",
})

Response structure

resp.next_token #=> String
resp.virtual_nodes #=> Array
resp.virtual_nodes[0].arn #=> String
resp.virtual_nodes[0].mesh_name #=> String
resp.virtual_nodes[0].virtual_node_name #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :limit (Integer) —

  The maximum number of results returned by ‘ListVirtualNodes` in paginated output. When you use this parameter, `ListVirtualNodes` returns only `limit` results in a single page along with a `nextToken` response element. You can see the remaining results of the initial request by sending another `ListVirtualNodes` request with the returned `nextToken` value. This value can be between 1 and 100. If you don’t use this parameter, ‘ListVirtualNodes` returns up to 100 results and a `nextToken` value if applicable.

• :mesh_name (required, String) —

  The name of the service mesh to list virtual nodes in.

• :next_token (String) —

  The ‘nextToken` value returned from a previous paginated `ListVirtualNodes` request where `limit` was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the `nextToken` value.

Returns:

• (Types::ListVirtualNodesOutput) —

  Returns a response object which responds to the following methods:

  • #next_token => String

  • #virtual_nodes => Array&lt;Types::VirtualNodeRef&gt;

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-appmesh/client.rb', line 1729

def list_virtual_nodes(params = {}, options = {})
  req = build_request(:list_virtual_nodes, params)
  req.send_request(options)
end

#list_virtual_routers(params = {}) ⇒ Types::ListVirtualRoutersOutput

Returns a list of existing virtual routers in a service mesh.

Examples:

Request syntax with placeholder values

resp = client.list_virtual_routers({
  limit: 1,
  mesh_name: "ResourceName", # required
  next_token: "String",
})

Response structure

resp.next_token #=> String
resp.virtual_routers #=> Array
resp.virtual_routers[0].arn #=> String
resp.virtual_routers[0].mesh_name #=> String
resp.virtual_routers[0].virtual_router_name #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :limit (Integer) —

  The maximum number of results returned by ‘ListVirtualRouters` in paginated output. When you use this parameter, `ListVirtualRouters` returns only `limit` results in a single page along with a `nextToken` response element. You can see the remaining results of the initial request by sending another `ListVirtualRouters` request with the returned `nextToken` value. This value can be between 1 and 100. If you don’t use this parameter, ‘ListVirtualRouters` returns up to 100 results and a `nextToken` value if applicable.

• :mesh_name (required, String) —

  The name of the service mesh to list virtual routers in.

• :next_token (String) —

  The ‘nextToken` value returned from a previous paginated `ListVirtualRouters` request where `limit` was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the `nextToken` value.

Returns:

• (Types::ListVirtualRoutersOutput) —

  Returns a response object which responds to the following methods:

  • #next_token => String

  • #virtual_routers => Array&lt;Types::VirtualRouterRef&gt;

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-appmesh/client.rb', line 1780

def list_virtual_routers(params = {}, options = {})
  req = build_request(:list_virtual_routers, params)
  req.send_request(options)
end

#list_virtual_services(params = {}) ⇒ Types::ListVirtualServicesOutput

Returns a list of existing virtual services in a service mesh.

Examples:

Request syntax with placeholder values

resp = client.list_virtual_services({
  limit: 1,
  mesh_name: "ResourceName", # required
  next_token: "String",
})

Response structure

resp.next_token #=> String
resp.virtual_services #=> Array
resp.virtual_services[0].arn #=> String
resp.virtual_services[0].mesh_name #=> String
resp.virtual_services[0].virtual_service_name #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :limit (Integer) —

  The maximum number of results returned by ‘ListVirtualServices` in paginated output. When you use this parameter, `ListVirtualServices` returns only `limit` results in a single page along with a `nextToken` response element. You can see the remaining results of the initial request by sending another `ListVirtualServices` request with the returned `nextToken` value. This value can be between 1 and 100. If you don’t use this parameter, ‘ListVirtualServices` returns up to 100 results and a `nextToken` value if applicable.

• :mesh_name (required, String) —

  The name of the service mesh to list virtual services in.

• :next_token (String) —

  The ‘nextToken` value returned from a previous paginated `ListVirtualServices` request where `limit` was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the `nextToken` value.

Returns:

• (Types::ListVirtualServicesOutput) —

  Returns a response object which responds to the following methods:

  • #next_token => String

  • #virtual_services => Array&lt;Types::VirtualServiceRef&gt;

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-appmesh/client.rb', line 1831

def list_virtual_services(params = {}, options = {})
  req = build_request(:list_virtual_services, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values

resp = client.tag_resource({
  resource_arn: "Arn", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
})

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :resource_arn (required, String) —

  The Amazon Resource Name (ARN) of the resource to add tags to.

• :tags (required, Array<Types::TagRef>) —

  The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-appmesh/client.rb', line 1867

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Deletes specified tags from a resource.

Examples:

Request syntax with placeholder values

resp = client.untag_resource({
  resource_arn: "Arn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :resource_arn (required, String) —

  The Amazon Resource Name (ARN) of the resource to delete tags from.

• :tag_keys (required, Array<String>) —

  The keys of the tags to be removed.

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-appmesh/client.rb', line 1893

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_mesh(params = {}) ⇒ Types::UpdateMeshOutput

Updates an existing service mesh.

Examples:

Request syntax with placeholder values

resp = client.update_mesh({
  client_token: "String",
  mesh_name: "ResourceName", # required
  spec: {
    egress_filter: {
      type: "ALLOW_ALL", # required, accepts ALLOW_ALL, DROP_ALL
    },
  },
})

Response structure

resp.mesh.mesh_name #=> String
resp.mesh.metadata.arn #=> String
resp.mesh.metadata.created_at #=> Time
resp.mesh.metadata.last_updated_at #=> Time
resp.mesh.metadata.uid #=> String
resp.mesh.metadata.version #=> Integer
resp.mesh.spec.egress_filter.type #=> String, one of "ALLOW_ALL", "DROP_ALL"
resp.mesh.status.status #=> String, one of "ACTIVE", "DELETED", "INACTIVE"

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :client_token (String) —

  Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

  **A suitable default value is auto-generated.** You should normally not need to pass this option.**

• :mesh_name (required, String) —

  The name of the service mesh to update.

• :spec (Types::MeshSpec) —

  The service mesh specification to apply.

Returns:

• (Types::UpdateMeshOutput) —

  Returns a response object which responds to the following methods:

  • #mesh => Types::MeshData

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-appmesh/client.rb', line 1945

def update_mesh(params = {}, options = {})
  req = build_request(:update_mesh, params)
  req.send_request(options)
end

#update_route(params = {}) ⇒ Types::UpdateRouteOutput

Updates an existing route for a specified service mesh and virtual router.

Examples:

Request syntax with placeholder values

resp = client.update_route({
  client_token: "String",
  mesh_name: "ResourceName", # required
  route_name: "ResourceName", # required
  spec: { # required
    grpc_route: {
      action: { # required
        weighted_targets: [ # required
          {
            virtual_node: "ResourceName", # required
            weight: 1, # required
          },
        ],
      },
      match: { # required
        metadata: [
          {
            invert: false,
            match: {
              exact: "HeaderMatch",
              prefix: "HeaderMatch",
              range: {
                end: 1, # required
                start: 1, # required
              },
              regex: "HeaderMatch",
              suffix: "HeaderMatch",
            },
            name: "HeaderName", # required
          },
        ],
        method_name: "MethodName",
        service_name: "ServiceName",
      },
      retry_policy: {
        grpc_retry_events: ["cancelled"], # accepts cancelled, deadline-exceeded, internal, resource-exhausted, unavailable
        http_retry_events: ["HttpRetryPolicyEvent"],
        max_retries: 1, # required
        per_retry_timeout: { # required
          unit: "ms", # accepts ms, s
          value: 1,
        },
        tcp_retry_events: ["connection-error"], # accepts connection-error
      },
    },
    http2_route: {
      action: { # required
        weighted_targets: [ # required
          {
            virtual_node: "ResourceName", # required
            weight: 1, # required
          },
        ],
      },
      match: { # required
        headers: [
          {
            invert: false,
            match: {
              exact: "HeaderMatch",
              prefix: "HeaderMatch",
              range: {
                end: 1, # required
                start: 1, # required
              },
              regex: "HeaderMatch",
              suffix: "HeaderMatch",
            },
            name: "HeaderName", # required
          },
        ],
        method: "CONNECT", # accepts CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, TRACE
        prefix: "String", # required
        scheme: "http", # accepts http, https
      },
      retry_policy: {
        http_retry_events: ["HttpRetryPolicyEvent"],
        max_retries: 1, # required
        per_retry_timeout: { # required
          unit: "ms", # accepts ms, s
          value: 1,
        },
        tcp_retry_events: ["connection-error"], # accepts connection-error
      },
    },
    http_route: {
      action: { # required
        weighted_targets: [ # required
          {
            virtual_node: "ResourceName", # required
            weight: 1, # required
          },
        ],
      },
      match: { # required
        headers: [
          {
            invert: false,
            match: {
              exact: "HeaderMatch",
              prefix: "HeaderMatch",
              range: {
                end: 1, # required
                start: 1, # required
              },
              regex: "HeaderMatch",
              suffix: "HeaderMatch",
            },
            name: "HeaderName", # required
          },
        ],
        method: "CONNECT", # accepts CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, TRACE
        prefix: "String", # required
        scheme: "http", # accepts http, https
      },
      retry_policy: {
        http_retry_events: ["HttpRetryPolicyEvent"],
        max_retries: 1, # required
        per_retry_timeout: { # required
          unit: "ms", # accepts ms, s
          value: 1,
        },
        tcp_retry_events: ["connection-error"], # accepts connection-error
      },
    },
    priority: 1,
    tcp_route: {
      action: { # required
        weighted_targets: [ # required
          {
            virtual_node: "ResourceName", # required
            weight: 1, # required
          },
        ],
      },
    },
  },
  virtual_router_name: "ResourceName", # required
})

Response structure

resp.route.mesh_name #=> String
resp.route.metadata.arn #=> String
resp.route.metadata.created_at #=> Time
resp.route.metadata.last_updated_at #=> Time
resp.route.metadata.uid #=> String
resp.route.metadata.version #=> Integer
resp.route.route_name #=> String
resp.route.spec.grpc_route.action.weighted_targets #=> Array
resp.route.spec.grpc_route.action.weighted_targets[0].virtual_node #=> String
resp.route.spec.grpc_route.action.weighted_targets[0].weight #=> Integer
resp.route.spec.grpc_route.match.metadata #=> Array
resp.route.spec.grpc_route.match.metadata[0].invert #=> Boolean
resp.route.spec.grpc_route.match.metadata[0].match.exact #=> String
resp.route.spec.grpc_route.match.metadata[0].match.prefix #=> String
resp.route.spec.grpc_route.match.metadata[0].match.range.end #=> Integer
resp.route.spec.grpc_route.match.metadata[0].match.range.start #=> Integer
resp.route.spec.grpc_route.match.metadata[0].match.regex #=> String
resp.route.spec.grpc_route.match.metadata[0].match.suffix #=> String
resp.route.spec.grpc_route.match.metadata[0].name #=> String
resp.route.spec.grpc_route.match.method_name #=> String
resp.route.spec.grpc_route.match.service_name #=> String
resp.route.spec.grpc_route.retry_policy.grpc_retry_events #=> Array
resp.route.spec.grpc_route.retry_policy.grpc_retry_events[0] #=> String, one of "cancelled", "deadline-exceeded", "internal", "resource-exhausted", "unavailable"
resp.route.spec.grpc_route.retry_policy.http_retry_events #=> Array
resp.route.spec.grpc_route.retry_policy.http_retry_events[0] #=> String
resp.route.spec.grpc_route.retry_policy.max_retries #=> Integer
resp.route.spec.grpc_route.retry_policy.per_retry_timeout.unit #=> String, one of "ms", "s"
resp.route.spec.grpc_route.retry_policy.per_retry_timeout.value #=> Integer
resp.route.spec.grpc_route.retry_policy.tcp_retry_events #=> Array
resp.route.spec.grpc_route.retry_policy.tcp_retry_events[0] #=> String, one of "connection-error"
resp.route.spec.http2_route.action.weighted_targets #=> Array
resp.route.spec.http2_route.action.weighted_targets[0].virtual_node #=> String
resp.route.spec.http2_route.action.weighted_targets[0].weight #=> Integer
resp.route.spec.http2_route.match.headers #=> Array
resp.route.spec.http2_route.match.headers[0].invert #=> Boolean
resp.route.spec.http2_route.match.headers[0].match.exact #=> String
resp.route.spec.http2_route.match.headers[0].match.prefix #=> String
resp.route.spec.http2_route.match.headers[0].match.range.end #=> Integer
resp.route.spec.http2_route.match.headers[0].match.range.start #=> Integer
resp.route.spec.http2_route.match.headers[0].match.regex #=> String
resp.route.spec.http2_route.match.headers[0].match.suffix #=> String
resp.route.spec.http2_route.match.headers[0].name #=> String
resp.route.spec.http2_route.match.method #=> String, one of "CONNECT", "DELETE", "GET", "HEAD", "OPTIONS", "PATCH", "POST", "PUT", "TRACE"
resp.route.spec.http2_route.match.prefix #=> String
resp.route.spec.http2_route.match.scheme #=> String, one of "http", "https"
resp.route.spec.http2_route.retry_policy.http_retry_events #=> Array
resp.route.spec.http2_route.retry_policy.http_retry_events[0] #=> String
resp.route.spec.http2_route.retry_policy.max_retries #=> Integer
resp.route.spec.http2_route.retry_policy.per_retry_timeout.unit #=> String, one of "ms", "s"
resp.route.spec.http2_route.retry_policy.per_retry_timeout.value #=> Integer
resp.route.spec.http2_route.retry_policy.tcp_retry_events #=> Array
resp.route.spec.http2_route.retry_policy.tcp_retry_events[0] #=> String, one of "connection-error"
resp.route.spec.http_route.action.weighted_targets #=> Array
resp.route.spec.http_route.action.weighted_targets[0].virtual_node #=> String
resp.route.spec.http_route.action.weighted_targets[0].weight #=> Integer
resp.route.spec.http_route.match.headers #=> Array
resp.route.spec.http_route.match.headers[0].invert #=> Boolean
resp.route.spec.http_route.match.headers[0].match.exact #=> String
resp.route.spec.http_route.match.headers[0].match.prefix #=> String
resp.route.spec.http_route.match.headers[0].match.range.end #=> Integer
resp.route.spec.http_route.match.headers[0].match.range.start #=> Integer
resp.route.spec.http_route.match.headers[0].match.regex #=> String
resp.route.spec.http_route.match.headers[0].match.suffix #=> String
resp.route.spec.http_route.match.headers[0].name #=> String
resp.route.spec.http_route.match.method #=> String, one of "CONNECT", "DELETE", "GET", "HEAD", "OPTIONS", "PATCH", "POST", "PUT", "TRACE"
resp.route.spec.http_route.match.prefix #=> String
resp.route.spec.http_route.match.scheme #=> String, one of "http", "https"
resp.route.spec.http_route.retry_policy.http_retry_events #=> Array
resp.route.spec.http_route.retry_policy.http_retry_events[0] #=> String
resp.route.spec.http_route.retry_policy.max_retries #=> Integer
resp.route.spec.http_route.retry_policy.per_retry_timeout.unit #=> String, one of "ms", "s"
resp.route.spec.http_route.retry_policy.per_retry_timeout.value #=> Integer
resp.route.spec.http_route.retry_policy.tcp_retry_events #=> Array
resp.route.spec.http_route.retry_policy.tcp_retry_events[0] #=> String, one of "connection-error"
resp.route.spec.priority #=> Integer
resp.route.spec.tcp_route.action.weighted_targets #=> Array
resp.route.spec.tcp_route.action.weighted_targets[0].virtual_node #=> String
resp.route.spec.tcp_route.action.weighted_targets[0].weight #=> Integer
resp.route.status.status #=> String, one of "ACTIVE", "DELETED", "INACTIVE"
resp.route.virtual_router_name #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :client_token (String) —

  Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

  **A suitable default value is auto-generated.** You should normally not need to pass this option.**

• :mesh_name (required, String) —

  The name of the service mesh that the route resides in.

• :route_name (required, String) —

  The name of the route to update.

• :spec (required, Types::RouteSpec) —

  The new route specification to apply. This overwrites the existing data.

• :virtual_router_name (required, String) —

  The name of the virtual router that the route is associated with.

Returns:

• (Types::UpdateRouteOutput) —

  Returns a response object which responds to the following methods:

  • #route => Types::RouteData

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-appmesh/client.rb', line 2207

def update_route(params = {}, options = {})
  req = build_request(:update_route, params)
  req.send_request(options)
end

#update_virtual_node(params = {}) ⇒ Types::UpdateVirtualNodeOutput

Updates an existing virtual node in a specified service mesh.

Examples:

Request syntax with placeholder values

resp = client.update_virtual_node({
  client_token: "String",
  mesh_name: "ResourceName", # required
  spec: { # required
    backends: [
      {
        virtual_service: {
          virtual_service_name: "ServiceName", # required
        },
      },
    ],
    listeners: [
      {
        health_check: {
          healthy_threshold: 1, # required
          interval_millis: 1, # required
          path: "String",
          port: 1,
          protocol: "grpc", # required, accepts grpc, http, http2, tcp
          timeout_millis: 1, # required
          unhealthy_threshold: 1, # required
        },
        port_mapping: { # required
          port: 1, # required
          protocol: "grpc", # required, accepts grpc, http, http2, tcp
        },
      },
    ],
    logging: {
      access_log: {
        file: {
          path: "FilePath", # required
        },
      },
    },
    service_discovery: {
      aws_cloud_map: {
        attributes: [
          {
            key: "AwsCloudMapInstanceAttributeKey", # required
            value: "AwsCloudMapInstanceAttributeValue", # required
          },
        ],
        namespace_name: "AwsCloudMapName", # required
        service_name: "AwsCloudMapName", # required
      },
      dns: {
        hostname: "Hostname", # required
      },
    },
  },
  virtual_node_name: "ResourceName", # required
})

Response structure

resp.virtual_node.mesh_name #=> String
resp.virtual_node.metadata.arn #=> String
resp.virtual_node.metadata.created_at #=> Time
resp.virtual_node.metadata.last_updated_at #=> Time
resp.virtual_node.metadata.uid #=> String
resp.virtual_node.metadata.version #=> Integer
resp.virtual_node.spec.backends #=> Array
resp.virtual_node.spec.backends[0].virtual_service.virtual_service_name #=> String
resp.virtual_node.spec.listeners #=> Array
resp.virtual_node.spec.listeners[0].health_check.healthy_threshold #=> Integer
resp.virtual_node.spec.listeners[0].health_check.interval_millis #=> Integer
resp.virtual_node.spec.listeners[0].health_check.path #=> String
resp.virtual_node.spec.listeners[0].health_check.port #=> Integer
resp.virtual_node.spec.listeners[0].health_check.protocol #=> String, one of "grpc", "http", "http2", "tcp"
resp.virtual_node.spec.listeners[0].health_check.timeout_millis #=> Integer
resp.virtual_node.spec.listeners[0].health_check.unhealthy_threshold #=> Integer
resp.virtual_node.spec.listeners[0].port_mapping.port #=> Integer
resp.virtual_node.spec.listeners[0].port_mapping.protocol #=> String, one of "grpc", "http", "http2", "tcp"
resp.virtual_node.spec.logging.access_log.file.path #=> String
resp.virtual_node.spec.service_discovery.aws_cloud_map.attributes #=> Array
resp.virtual_node.spec.service_discovery.aws_cloud_map.attributes[0].key #=> String
resp.virtual_node.spec.service_discovery.aws_cloud_map.attributes[0].value #=> String
resp.virtual_node.spec.service_discovery.aws_cloud_map.namespace_name #=> String
resp.virtual_node.spec.service_discovery.aws_cloud_map.service_name #=> String
resp.virtual_node.spec.service_discovery.dns.hostname #=> String
resp.virtual_node.status.status #=> String, one of "ACTIVE", "DELETED", "INACTIVE"
resp.virtual_node.virtual_node_name #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :client_token (String) —

  Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

  **A suitable default value is auto-generated.** You should normally not need to pass this option.**

• :mesh_name (required, String) —

  The name of the service mesh that the virtual node resides in.

• :spec (required, Types::VirtualNodeSpec) —

  The new virtual node specification to apply. This overwrites the existing data.

• :virtual_node_name (required, String) —

  The name of the virtual node to update.

Returns:

• (Types::UpdateVirtualNodeOutput) —

  Returns a response object which responds to the following methods:

  • #virtual_node => Types::VirtualNodeData

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-appmesh/client.rb', line 2326

def update_virtual_node(params = {}, options = {})
  req = build_request(:update_virtual_node, params)
  req.send_request(options)
end

#update_virtual_router(params = {}) ⇒ Types::UpdateVirtualRouterOutput

Updates an existing virtual router in a specified service mesh.

Examples:

Request syntax with placeholder values

resp = client.update_virtual_router({
  client_token: "String",
  mesh_name: "ResourceName", # required
  spec: { # required
    listeners: [
      {
        port_mapping: { # required
          port: 1, # required
          protocol: "grpc", # required, accepts grpc, http, http2, tcp
        },
      },
    ],
  },
  virtual_router_name: "ResourceName", # required
})

Response structure

resp.virtual_router.mesh_name #=> String
resp.virtual_router.metadata.arn #=> String
resp.virtual_router.metadata.created_at #=> Time
resp.virtual_router.metadata.last_updated_at #=> Time
resp.virtual_router.metadata.uid #=> String
resp.virtual_router.metadata.version #=> Integer
resp.virtual_router.spec.listeners #=> Array
resp.virtual_router.spec.listeners[0].port_mapping.port #=> Integer
resp.virtual_router.spec.listeners[0].port_mapping.protocol #=> String, one of "grpc", "http", "http2", "tcp"
resp.virtual_router.status.status #=> String, one of "ACTIVE", "DELETED", "INACTIVE"
resp.virtual_router.virtual_router_name #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :client_token (String) —

  Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

  **A suitable default value is auto-generated.** You should normally not need to pass this option.**

• :mesh_name (required, String) —

  The name of the service mesh that the virtual router resides in.

• :spec (required, Types::VirtualRouterSpec) —

  The new virtual router specification to apply. This overwrites the existing data.

• :virtual_router_name (required, String) —

  The name of the virtual router to update.

Returns:

• (Types::UpdateVirtualRouterOutput) —

  Returns a response object which responds to the following methods:

  • #virtual_router => Types::VirtualRouterData

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-appmesh/client.rb', line 2391

def update_virtual_router(params = {}, options = {})
  req = build_request(:update_virtual_router, params)
  req.send_request(options)
end

#update_virtual_service(params = {}) ⇒ Types::UpdateVirtualServiceOutput

Updates an existing virtual service in a specified service mesh.

Examples:

Request syntax with placeholder values

resp = client.update_virtual_service({
  client_token: "String",
  mesh_name: "ResourceName", # required
  spec: { # required
    provider: {
      virtual_node: {
        virtual_node_name: "ResourceName", # required
      },
      virtual_router: {
        virtual_router_name: "ResourceName", # required
      },
    },
  },
  virtual_service_name: "ServiceName", # required
})

Response structure

resp.virtual_service.mesh_name #=> String
resp.virtual_service.metadata.arn #=> String
resp.virtual_service.metadata.created_at #=> Time
resp.virtual_service.metadata.last_updated_at #=> Time
resp.virtual_service.metadata.uid #=> String
resp.virtual_service.metadata.version #=> Integer
resp.virtual_service.spec.provider.virtual_node.virtual_node_name #=> String
resp.virtual_service.spec.provider.virtual_router.virtual_router_name #=> String
resp.virtual_service.status.status #=> String, one of "ACTIVE", "DELETED", "INACTIVE"
resp.virtual_service.virtual_service_name #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :client_token (String) —

  Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

  **A suitable default value is auto-generated.** You should normally not need to pass this option.**

• :mesh_name (required, String) —

  The name of the service mesh that the virtual service resides in.

• :spec (required, Types::VirtualServiceSpec) —

  The new virtual service specification to apply. This overwrites the existing data.

• :virtual_service_name (required, String) —

  The name of the virtual service to update.

Returns:

• (Types::UpdateVirtualServiceOutput) —

  Returns a response object which responds to the following methods:

  • #virtual_service => Types::VirtualServiceData

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-appmesh/client.rb', line 2455

def update_virtual_service(params = {}, options = {})
  req = build_request(:update_virtual_service, params)
  req.send_request(options)
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.

Deprecated.

# File 'lib/aws-sdk-appmesh/client.rb', line 2479

def waiter_names
  []
end