You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::AppMesh::Client

Inherits:
Seahorse::Client::Base show all
Defined in:
(unknown)

Overview

An API client for AWS App Mesh. To construct a client, you need to configure a :region and :credentials.

appmesh = Aws::AppMesh::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

See #initialize for a full list of supported configuration options.

Region

You can configure a default region in the following locations:

  • ENV['AWS_REGION']
  • Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

  • ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
  • Aws.config[:credentials]
  • The shared credentials ini file at ~/.aws/credentials (more information)
  • From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::AppMesh::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options = {}) ⇒ Aws::AppMesh::Client

Constructs an API client.

Options Hash (options):

  • :access_key_id (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :active_endpoint_cache (Boolean)

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types. See Plugins::ParamConverter for more details.

  • :credentials (required, Credentials)

    Your AWS credentials. The following locations will be searched in order for credentials:

    • :access_key_id, :secret_access_key, and :session_token options
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • HOME/.aws/credentials shared credentials file
    • EC2 instance profile credentials See Plugins::RequestSigner for more details.
  • :disable_host_prefix_injection (Boolean)

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available. See Plugins::EndpointPattern for more details.

  • :endpoint (String)

    A default endpoint is constructed from the :region. See Plugins::RegionalEndpoint for more details.

  • :endpoint_cache_max_entries (Integer)

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_max_threads (Integer)

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_poll_interval (Integer)

    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. See Plugins::EndpointDiscovery for more details.

  • :endpoint_discovery (Boolean)

    When set to true, endpoint discovery will be enabled for operations when available. Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :http_continue_timeout (Float) — default: 1

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_idle_timeout (Integer) — default: 5

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_open_timeout (Integer) — default: 15

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_proxy (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_read_timeout (Integer) — default: 60

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_wire_trace (Boolean) — default: false

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the logger at. See Plugins::Logging for more details.

  • :log_formatter (Logging::LogFormatter)

    The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Plugins::Logging for more details.

  • :logger (Logger) — default: nil

    The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Plugins::Logging for more details.

  • :profile (String)

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Plugins::RequestSigner for more details.

  • :raise_response_errors (Boolean) — default: true

    When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.

  • :region (required, String)

    The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.

  • :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. See Plugins::RetryErrors for more details.

  • :secret_access_key (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :session_token (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :ssl_ca_bundle (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_directory (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_store (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_verify_peer (Boolean) — default: true

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :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. See Plugins::StubResponses for more details.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request. See Plugins::ParamValidator for more details.

Instance Method Details

#create_mesh(options = {}) ⇒ Types::CreateMeshOutput

Creates a service mesh. A service mesh is a logical boundary for network traffic between the services that reside within it.

     <p>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.</p>

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..arn #=> String
resp.mesh..created_at #=> Time
resp.mesh..last_updated_at #=> Time
resp.mesh..uid #=> String
resp.mesh..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"

Options Hash (options):

  • :client_token (String)

    This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided.

  • :mesh_name (required, String)
  • :spec (Types::MeshSpec)

    An object representing the specification of a service mesh.

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

Returns:

See Also:

#create_route(options = {}) ⇒ Types::CreateRouteOutput

Creates a route that is associated with a virtual router.

     <p>You can use the <code>prefix</code> parameter in your route specification for path-based
     routing of requests. For example, if your virtual service name is
        <code>my-service.local</code> and you want the route to match requests to
        <code>my-service.local/metrics</code>, your prefix should be
     <code>/metrics</code>.</p>
     <p>If your route matches a request, you can distribute traffic to one or more target
     virtual nodes with relative weighting.</p>

Examples:

Request syntax with placeholder values


resp = client.create_route({
  client_token: "String",
  mesh_name: "ResourceName", # required
  route_name: "ResourceName", # required
  spec: { # required
    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..arn #=> String
resp.route..created_at #=> Time
resp.route..last_updated_at #=> Time
resp.route..uid #=> String
resp.route..version #=> Integer
resp.route.route_name #=> String
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 #=> true/false
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

Options Hash (options):

  • :client_token (String)

    This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided.

  • :mesh_name (required, String)
  • :route_name (required, String)
  • :spec (required, Types::RouteSpec)

    An object representing the specification of a route.

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

Returns:

See Also:

#create_virtual_node(options = {}) ⇒ Types::CreateVirtualNodeOutput

Creates a virtual node within a service mesh.

     <p>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.</p>
     <p>Any inbound traffic that your virtual node expects should be specified as a
        <code>listener</code>. Any outbound traffic that your virtual node expects to reach
     should be specified as a <code>backend</code>.</p>
     <p>The response metadata for your new virtual node contains the <code>arn</code> that is
     associated with the virtual node. Set this value (either the full ARN or the truncated
     resource name: for example, <code>mesh/default/virtualNode/simpleapp</code>) as the
        <code>APPMESH_VIRTUAL_NODE_NAME</code> environment variable for your task group's Envoy
     proxy container in your task definition or pod spec. This is then mapped to the
        <code>node.id</code> and <code>node.cluster</code> Envoy parameters.</p>
     <note>
        <p>If you require your Envoy stats or tracing to use a different name, you can override
        the <code>node.cluster</code> value that is set by
           <code>APPMESH_VIRTUAL_NODE_NAME</code> with the
           <code>APPMESH_VIRTUAL_NODE_CLUSTER</code> environment variable.</p>
     </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: "http", # required, accepts http, tcp
          timeout_millis: 1, # required
          unhealthy_threshold: 1, # required
        },
        port_mapping: { # required
          port: 1, # required
          protocol: "http", # required, accepts http, 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..arn #=> String
resp.virtual_node..created_at #=> Time
resp.virtual_node..last_updated_at #=> Time
resp.virtual_node..uid #=> String
resp.virtual_node..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 "http", "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 "http", "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

Options Hash (options):

  • :client_token (String)

    This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided.

  • :mesh_name (required, String)
  • :spec (required, Types::VirtualNodeSpec)

    An object representing the specification of a virtual node.

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

Returns:

See Also:

#create_virtual_router(options = {}) ⇒ Types::CreateVirtualRouterOutput

Creates a virtual router within a service mesh.

     <p>Any inbound traffic that your virtual router expects should be specified as a
        <code>listener</code>. </p>
     <p>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.</p>

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: "http", # required, accepts http, tcp
        },
      },
    ],
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
  virtual_router_name: "ResourceName", # required
})

Response structure


resp.virtual_router.mesh_name #=> String
resp.virtual_router..arn #=> String
resp.virtual_router..created_at #=> Time
resp.virtual_router..last_updated_at #=> Time
resp.virtual_router..uid #=> String
resp.virtual_router..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 "http", "tcp"
resp.virtual_router.status.status #=> String, one of "ACTIVE", "DELETED", "INACTIVE"
resp.virtual_router.virtual_router_name #=> String

Options Hash (options):

  • :client_token (String)

    This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided.

  • :mesh_name (required, String)
  • :spec (required, Types::VirtualRouterSpec)

    An object representing the specification of a virtual router.

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

Returns:

See Also:

#create_virtual_service(options = {}) ⇒ Types::CreateVirtualServiceOutput

Creates a virtual service within a service mesh.

     <p>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 <code>virtualServiceName</code>, and those requests are routed to the
     virtual node or virtual router that is specified as the provider for the virtual
     service.</p>

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..arn #=> String
resp.virtual_service..created_at #=> Time
resp.virtual_service..last_updated_at #=> Time
resp.virtual_service..uid #=> String
resp.virtual_service..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

Options Hash (options):

  • :client_token (String)

    This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided.

  • :mesh_name (required, String)
  • :spec (required, Types::VirtualServiceSpec)

    An object representing the specification of a virtual service.

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

Returns:

See Also:

#delete_mesh(options = {}) ⇒ Types::DeleteMeshOutput

Deletes an existing service mesh.

     <p>You must delete all resources (virtual services, routes, virtual routers, and virtual
     nodes) in the service mesh before you can delete the mesh itself.</p>

Examples:

Request syntax with placeholder values


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

Response structure


resp.mesh.mesh_name #=> String
resp.mesh..arn #=> String
resp.mesh..created_at #=> Time
resp.mesh..last_updated_at #=> Time
resp.mesh..uid #=> String
resp.mesh..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"

Options Hash (options):

  • :mesh_name (required, String)

Returns:

See Also:

#delete_route(options = {}) ⇒ 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..arn #=> String
resp.route..created_at #=> Time
resp.route..last_updated_at #=> Time
resp.route..uid #=> String
resp.route..version #=> Integer
resp.route.route_name #=> String
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 #=> true/false
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

Options Hash (options):

  • :mesh_name (required, String)
  • :route_name (required, String)
  • :virtual_router_name (required, String)

Returns:

See Also:

#delete_virtual_node(options = {}) ⇒ Types::DeleteVirtualNodeOutput

Deletes an existing virtual node.

     <p>You must delete any virtual services that list a virtual node as a service provider
     before you can delete the virtual node itself.</p>

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..arn #=> String
resp.virtual_node..created_at #=> Time
resp.virtual_node..last_updated_at #=> Time
resp.virtual_node..uid #=> String
resp.virtual_node..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 "http", "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 "http", "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

Options Hash (options):

  • :mesh_name (required, String)
  • :virtual_node_name (required, String)

Returns:

See Also:

#delete_virtual_router(options = {}) ⇒ Types::DeleteVirtualRouterOutput

Deletes an existing virtual router.

     <p>You must delete any routes associated with the virtual router before you can delete the
     router itself.</p>

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..arn #=> String
resp.virtual_router..created_at #=> Time
resp.virtual_router..last_updated_at #=> Time
resp.virtual_router..uid #=> String
resp.virtual_router..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 "http", "tcp"
resp.virtual_router.status.status #=> String, one of "ACTIVE", "DELETED", "INACTIVE"
resp.virtual_router.virtual_router_name #=> String

Options Hash (options):

  • :mesh_name (required, String)
  • :virtual_router_name (required, String)

Returns:

See Also:

#delete_virtual_service(options = {}) ⇒ 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..arn #=> String
resp.virtual_service..created_at #=> Time
resp.virtual_service..last_updated_at #=> Time
resp.virtual_service..uid #=> String
resp.virtual_service..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

Options Hash (options):

  • :mesh_name (required, String)
  • :virtual_service_name (required, String)

Returns:

See Also:

#describe_mesh(options = {}) ⇒ 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..arn #=> String
resp.mesh..created_at #=> Time
resp.mesh..last_updated_at #=> Time
resp.mesh..uid #=> String
resp.mesh..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"

Options Hash (options):

  • :mesh_name (required, String)

Returns:

See Also:

#describe_route(options = {}) ⇒ 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..arn #=> String
resp.route..created_at #=> Time
resp.route..last_updated_at #=> Time
resp.route..uid #=> String
resp.route..version #=> Integer
resp.route.route_name #=> String
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 #=> true/false
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

Options Hash (options):

  • :mesh_name (required, String)
  • :route_name (required, String)
  • :virtual_router_name (required, String)

Returns:

See Also:

#describe_virtual_node(options = {}) ⇒ 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..arn #=> String
resp.virtual_node..created_at #=> Time
resp.virtual_node..last_updated_at #=> Time
resp.virtual_node..uid #=> String
resp.virtual_node..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 "http", "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 "http", "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

Options Hash (options):

  • :mesh_name (required, String)
  • :virtual_node_name (required, String)

Returns:

See Also:

#describe_virtual_router(options = {}) ⇒ 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..arn #=> String
resp.virtual_router..created_at #=> Time
resp.virtual_router..last_updated_at #=> Time
resp.virtual_router..uid #=> String
resp.virtual_router..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 "http", "tcp"
resp.virtual_router.status.status #=> String, one of "ACTIVE", "DELETED", "INACTIVE"
resp.virtual_router.virtual_router_name #=> String

Options Hash (options):

  • :mesh_name (required, String)
  • :virtual_router_name (required, String)

Returns:

See Also:

#describe_virtual_service(options = {}) ⇒ 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..arn #=> String
resp.virtual_service..created_at #=> Time
resp.virtual_service..last_updated_at #=> Time
resp.virtual_service..uid #=> String
resp.virtual_service..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

Options Hash (options):

  • :mesh_name (required, String)
  • :virtual_service_name (required, String)

Returns:

See Also:

#list_meshes(options = {}) ⇒ 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

Options Hash (options):

  • :limit (Integer)
  • :next_token (String)

Returns:

See Also:

#list_routes(options = {}) ⇒ 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

Options Hash (options):

  • :limit (Integer)
  • :mesh_name (required, String)
  • :next_token (String)
  • :virtual_router_name (required, String)

Returns:

See Also:

#list_tags_for_resource(options = {}) ⇒ 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

Options Hash (options):

  • :limit (Integer)
  • :next_token (String)
  • :resource_arn (required, String)

Returns:

See Also:

#list_virtual_nodes(options = {}) ⇒ 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

Options Hash (options):

  • :limit (Integer)
  • :mesh_name (required, String)
  • :next_token (String)

Returns:

See Also:

#list_virtual_routers(options = {}) ⇒ 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

Options Hash (options):

  • :limit (Integer)
  • :mesh_name (required, String)
  • :next_token (String)

Returns:

See Also:

#list_virtual_services(options = {}) ⇒ 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

Options Hash (options):

  • :limit (Integer)
  • :mesh_name (required, String)
  • :next_token (String)

Returns:

See Also:

#tag_resource(options = {}) ⇒ 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",
    },
  ],
})

Options Hash (options):

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#untag_resource(options = {}) ⇒ 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
})

Options Hash (options):

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#update_mesh(options = {}) ⇒ 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..arn #=> String
resp.mesh..created_at #=> Time
resp.mesh..last_updated_at #=> Time
resp.mesh..uid #=> String
resp.mesh..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"

Options Hash (options):

  • :client_token (String)

    This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided.

  • :mesh_name (required, String)
  • :spec (Types::MeshSpec)

    An object representing the specification of a service mesh.

Returns:

See Also:

#update_route(options = {}) ⇒ 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
    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..arn #=> String
resp.route..created_at #=> Time
resp.route..last_updated_at #=> Time
resp.route..uid #=> String
resp.route..version #=> Integer
resp.route.route_name #=> String
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 #=> true/false
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

Options Hash (options):

  • :client_token (String)

    This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided.

  • :mesh_name (required, String)
  • :route_name (required, String)
  • :spec (required, Types::RouteSpec)

    An object representing the specification of a route.

  • :virtual_router_name (required, String)

Returns:

See Also:

#update_virtual_node(options = {}) ⇒ 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: "http", # required, accepts http, tcp
          timeout_millis: 1, # required
          unhealthy_threshold: 1, # required
        },
        port_mapping: { # required
          port: 1, # required
          protocol: "http", # required, accepts http, 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..arn #=> String
resp.virtual_node..created_at #=> Time
resp.virtual_node..last_updated_at #=> Time
resp.virtual_node..uid #=> String
resp.virtual_node..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 "http", "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 "http", "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

Options Hash (options):

  • :client_token (String)

    This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided.

  • :mesh_name (required, String)
  • :spec (required, Types::VirtualNodeSpec)

    An object representing the specification of a virtual node.

  • :virtual_node_name (required, String)

Returns:

See Also:

#update_virtual_router(options = {}) ⇒ 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: "http", # required, accepts http, tcp
        },
      },
    ],
  },
  virtual_router_name: "ResourceName", # required
})

Response structure


resp.virtual_router.mesh_name #=> String
resp.virtual_router..arn #=> String
resp.virtual_router..created_at #=> Time
resp.virtual_router..last_updated_at #=> Time
resp.virtual_router..uid #=> String
resp.virtual_router..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 "http", "tcp"
resp.virtual_router.status.status #=> String, one of "ACTIVE", "DELETED", "INACTIVE"
resp.virtual_router.virtual_router_name #=> String

Options Hash (options):

  • :client_token (String)

    This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided.

  • :mesh_name (required, String)
  • :spec (required, Types::VirtualRouterSpec)

    An object representing the specification of a virtual router.

  • :virtual_router_name (required, String)

Returns:

See Also:

#update_virtual_service(options = {}) ⇒ 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..arn #=> String
resp.virtual_service..created_at #=> Time
resp.virtual_service..last_updated_at #=> Time
resp.virtual_service..uid #=> String
resp.virtual_service..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

Options Hash (options):

  • :client_token (String)

    This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided.

  • :mesh_name (required, String)
  • :spec (required, Types::VirtualServiceSpec)

    An object representing the specification of a virtual service.

  • :virtual_service_name (required, String)

Returns:

See Also:

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end

Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Parameters:

  • waiter_name (Symbol)

    The name of the waiter. See #waiter_names for a full list of supported waiters.

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

    Additional request parameters. See the #waiter_names for a list of supported waiters and what request they call. The called request determines the list of accepted parameters.

Yield Parameters:

Returns:

  • (Boolean)

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError)

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError)

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError)

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError)

    Raised when you request to wait for an unknown state.

#waiter_namesArray<Symbol>

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter NameClient MethodDefault Delay:Default Max Attempts:

Returns:

  • (Array<Symbol>)

    the list of supported waiters.