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_gateway_route(options = {}) ⇒ Types::CreateGatewayRouteOutput

Creates a gateway route.

A gateway route is attached to a virtual gateway and routes traffic to an existing virtual service. If a route matches a request, it can distribute traffic to a target virtual service.

For more information about gateway routes, see Gateway routes.

Examples:

Request syntax with placeholder values


resp = client.create_gateway_route({
  client_token: "String",
  gateway_route_name: "ResourceName", # required
  mesh_name: "ResourceName", # required
  mesh_owner: "AccountId",
  spec: { # required
    grpc_route: {
      action: { # required
        target: { # required
          virtual_service: { # required
            virtual_service_name: "ResourceName", # required
          },
        },
      },
      match: { # required
        service_name: "ServiceName",
      },
    },
    http2_route: {
      action: { # required
        target: { # required
          virtual_service: { # required
            virtual_service_name: "ResourceName", # required
          },
        },
      },
      match: { # required
        prefix: "String", # required
      },
    },
    http_route: {
      action: { # required
        target: { # required
          virtual_service: { # required
            virtual_service_name: "ResourceName", # required
          },
        },
      },
      match: { # required
        prefix: "String", # required
      },
    },
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  virtual_gateway_name: "ResourceName", # required
})

Response structure


resp.gateway_route.gateway_route_name #=> String
resp.gateway_route.mesh_name #=> String
resp.gateway_route..arn #=> String
resp.gateway_route..created_at #=> Time
resp.gateway_route..last_updated_at #=> Time
resp.gateway_route..mesh_owner #=> String
resp.gateway_route..resource_owner #=> String
resp.gateway_route..uid #=> String
resp.gateway_route..version #=> Integer
resp.gateway_route.spec.grpc_route.action.target.virtual_service.virtual_service_name #=> String
resp.gateway_route.spec.grpc_route.match.service_name #=> String
resp.gateway_route.spec.http2_route.action.target.virtual_service.virtual_service_name #=> String
resp.gateway_route.spec.http2_route.match.prefix #=> String
resp.gateway_route.spec.http_route.action.target.virtual_service.virtual_service_name #=> String
resp.gateway_route.spec.http_route.match.prefix #=> String
resp.gateway_route.status.status #=> String, one of "ACTIVE", "INACTIVE", "DELETED"
resp.gateway_route.virtual_gateway_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. Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

  • :gateway_route_name (required, String)

    The name to use for the gateway route.

  • :mesh_name (required, String)

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

  • :mesh_owner (String)

    The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes.

  • :spec (required, Types::GatewayRouteSpec)

    The gateway route specification to apply.

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

    Optional metadata that you can apply to the gateway 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_gateway_name (required, String)

    The name of the virtual gateway to associate the gateway route with. If the virtual gateway is in a shared mesh, then you must be the owner of the virtual gateway resource.

Returns:

See Also:

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

Creates a service mesh.

A service mesh is a logical boundary for network traffic between services that are represented by resources within the mesh. 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.

For more information about service meshes, see Service meshes.

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", # 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..mesh_owner #=> String
resp.mesh..resource_owner #=> String
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", "INACTIVE", "DELETED"

Options Hash (options):

  • :client_token (String)

    This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided. Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

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

See Also:

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

Creates a route that is associated with a virtual router.

You can route several different protocols and define a retry policy for a route. Traffic can be routed to one or more virtual nodes.

For more information about routes, see Routes.

Examples:

Request syntax with placeholder values


resp = client.create_route({
  client_token: "String",
  mesh_name: "ResourceName", # required
  mesh_owner: "AccountId",
  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: "s", # accepts s, ms
          value: 1,
        },
        tcp_retry_events: ["connection-error"], # accepts connection-error
      },
      timeout: {
        idle: {
          unit: "s", # accepts s, ms
          value: 1,
        },
        per_request: {
          unit: "s", # accepts s, ms
          value: 1,
        },
      },
    },
    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: "GET", # accepts GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE, PATCH
        prefix: "String", # required
        scheme: "http", # accepts http, https
      },
      retry_policy: {
        http_retry_events: ["HttpRetryPolicyEvent"],
        max_retries: 1, # required
        per_retry_timeout: { # required
          unit: "s", # accepts s, ms
          value: 1,
        },
        tcp_retry_events: ["connection-error"], # accepts connection-error
      },
      timeout: {
        idle: {
          unit: "s", # accepts s, ms
          value: 1,
        },
        per_request: {
          unit: "s", # accepts s, ms
          value: 1,
        },
      },
    },
    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: "GET", # accepts GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE, PATCH
        prefix: "String", # required
        scheme: "http", # accepts http, https
      },
      retry_policy: {
        http_retry_events: ["HttpRetryPolicyEvent"],
        max_retries: 1, # required
        per_retry_timeout: { # required
          unit: "s", # accepts s, ms
          value: 1,
        },
        tcp_retry_events: ["connection-error"], # accepts connection-error
      },
      timeout: {
        idle: {
          unit: "s", # accepts s, ms
          value: 1,
        },
        per_request: {
          unit: "s", # accepts s, ms
          value: 1,
        },
      },
    },
    priority: 1,
    tcp_route: {
      action: { # required
        weighted_targets: [ # required
          {
            virtual_node: "ResourceName", # required
            weight: 1, # required
          },
        ],
      },
      timeout: {
        idle: {
          unit: "s", # accepts s, ms
          value: 1,
        },
      },
    },
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # 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..mesh_owner #=> String
resp.route..resource_owner #=> String
resp.route..uid #=> String
resp.route..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. #=> Array
resp.route.spec.grpc_route.match.[0].invert #=> true/false
resp.route.spec.grpc_route.match.[0].match.exact #=> String
resp.route.spec.grpc_route.match.[0].match.prefix #=> String
resp.route.spec.grpc_route.match.[0].match.range.end #=> Integer
resp.route.spec.grpc_route.match.[0].match.range.start #=> Integer
resp.route.spec.grpc_route.match.[0].match.regex #=> String
resp.route.spec.grpc_route.match.[0].match.suffix #=> String
resp.route.spec.grpc_route.match.[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 "s", "ms"
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.grpc_route.timeout.idle.unit #=> String, one of "s", "ms"
resp.route.spec.grpc_route.timeout.idle.value #=> Integer
resp.route.spec.grpc_route.timeout.per_request.unit #=> String, one of "s", "ms"
resp.route.spec.grpc_route.timeout.per_request.value #=> Integer
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 #=> true/false
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 "GET", "HEAD", "POST", "PUT", "DELETE", "CONNECT", "OPTIONS", "TRACE", "PATCH"
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 "s", "ms"
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.http2_route.timeout.idle.unit #=> String, one of "s", "ms"
resp.route.spec.http2_route.timeout.idle.value #=> Integer
resp.route.spec.http2_route.timeout.per_request.unit #=> String, one of "s", "ms"
resp.route.spec.http2_route.timeout.per_request.value #=> Integer
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 "GET", "HEAD", "POST", "PUT", "DELETE", "CONNECT", "OPTIONS", "TRACE", "PATCH"
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 "s", "ms"
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.http_route.timeout.idle.unit #=> String, one of "s", "ms"
resp.route.spec.http_route.timeout.idle.value #=> Integer
resp.route.spec.http_route.timeout.per_request.unit #=> String, one of "s", "ms"
resp.route.spec.http_route.timeout.per_request.value #=> Integer
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.spec.tcp_route.timeout.idle.unit #=> String, one of "s", "ms"
resp.route.spec.tcp_route.timeout.idle.value #=> Integer
resp.route.status.status #=> String, one of "ACTIVE", "INACTIVE", "DELETED"
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. Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

  • :mesh_name (required, String)

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

  • :mesh_owner (String)

    The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes.

  • :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. If the virtual router is in a shared mesh, then you must be the owner of the virtual router resource.

Returns:

See Also:

#create_virtual_gateway(options = {}) ⇒ Types::CreateVirtualGatewayOutput

Creates a virtual gateway.

A virtual gateway allows resources outside your mesh to communicate to resources that are inside your mesh. The virtual gateway represents an Envoy proxy running in an Amazon ECS task, in a Kubernetes service, or on an Amazon EC2 instance. Unlike a virtual node, which represents an Envoy running with an application, a virtual gateway represents Envoy deployed by itself.

For more information about virtual gateways, see Virtual gateways.

Examples:

Request syntax with placeholder values


resp = client.create_virtual_gateway({
  client_token: "String",
  mesh_name: "ResourceName", # required
  mesh_owner: "AccountId",
  spec: { # required
    backend_defaults: {
      client_policy: {
        tls: {
          enforce: false,
          ports: [1],
          validation: { # required
            trust: { # required
              acm: {
                certificate_authority_arns: ["Arn"], # required
              },
              file: {
                certificate_chain: "FilePath", # required
              },
            },
          },
        },
      },
    },
    listeners: [ # required
      {
        connection_pool: {
          grpc: {
            max_requests: 1, # required
          },
          http: {
            max_connections: 1, # required
            max_pending_requests: 1,
          },
          http2: {
            max_requests: 1, # required
          },
        },
        health_check: {
          healthy_threshold: 1, # required
          interval_millis: 1, # required
          path: "String",
          port: 1,
          protocol: "http", # required, accepts http, http2, grpc
          timeout_millis: 1, # required
          unhealthy_threshold: 1, # required
        },
        port_mapping: { # required
          port: 1, # required
          protocol: "http", # required, accepts http, http2, grpc
        },
        tls: {
          certificate: { # required
            acm: {
              certificate_arn: "Arn", # required
            },
            file: {
              certificate_chain: "FilePath", # required
              private_key: "FilePath", # required
            },
          },
          mode: "STRICT", # required, accepts STRICT, PERMISSIVE, DISABLED
        },
      },
    ],
    logging: {
      access_log: {
        file: {
          path: "FilePath", # required
        },
      },
    },
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  virtual_gateway_name: "ResourceName", # required
})

Response structure


resp.virtual_gateway.mesh_name #=> String
resp.virtual_gateway..arn #=> String
resp.virtual_gateway..created_at #=> Time
resp.virtual_gateway..last_updated_at #=> Time
resp.virtual_gateway..mesh_owner #=> String
resp.virtual_gateway..resource_owner #=> String
resp.virtual_gateway..uid #=> String
resp.virtual_gateway..version #=> Integer
resp.virtual_gateway.spec.backend_defaults.client_policy.tls.enforce #=> true/false
resp.virtual_gateway.spec.backend_defaults.client_policy.tls.ports #=> Array
resp.virtual_gateway.spec.backend_defaults.client_policy.tls.ports[0] #=> Integer
resp.virtual_gateway.spec.backend_defaults.client_policy.tls.validation.trust.acm.certificate_authority_arns #=> Array
resp.virtual_gateway.spec.backend_defaults.client_policy.tls.validation.trust.acm.certificate_authority_arns[0] #=> String
resp.virtual_gateway.spec.backend_defaults.client_policy.tls.validation.trust.file.certificate_chain #=> String
resp.virtual_gateway.spec.listeners #=> Array
resp.virtual_gateway.spec.listeners[0].connection_pool.grpc.max_requests #=> Integer
resp.virtual_gateway.spec.listeners[0].connection_pool.http.max_connections #=> Integer
resp.virtual_gateway.spec.listeners[0].connection_pool.http.max_pending_requests #=> Integer
resp.virtual_gateway.spec.listeners[0].connection_pool.http2.max_requests #=> Integer
resp.virtual_gateway.spec.listeners[0].health_check.healthy_threshold #=> Integer
resp.virtual_gateway.spec.listeners[0].health_check.interval_millis #=> Integer
resp.virtual_gateway.spec.listeners[0].health_check.path #=> String
resp.virtual_gateway.spec.listeners[0].health_check.port #=> Integer
resp.virtual_gateway.spec.listeners[0].health_check.protocol #=> String, one of "http", "http2", "grpc"
resp.virtual_gateway.spec.listeners[0].health_check.timeout_millis #=> Integer
resp.virtual_gateway.spec.listeners[0].health_check.unhealthy_threshold #=> Integer
resp.virtual_gateway.spec.listeners[0].port_mapping.port #=> Integer
resp.virtual_gateway.spec.listeners[0].port_mapping.protocol #=> String, one of "http", "http2", "grpc"
resp.virtual_gateway.spec.listeners[0].tls.certificate.acm.certificate_arn #=> String
resp.virtual_gateway.spec.listeners[0].tls.certificate.file.certificate_chain #=> String
resp.virtual_gateway.spec.listeners[0].tls.certificate.file.private_key #=> String
resp.virtual_gateway.spec.listeners[0].tls.mode #=> String, one of "STRICT", "PERMISSIVE", "DISABLED"
resp.virtual_gateway.spec.logging.access_log.file.path #=> String
resp.virtual_gateway.status.status #=> String, one of "ACTIVE", "INACTIVE", "DELETED"
resp.virtual_gateway.virtual_gateway_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. Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

  • :mesh_name (required, String)

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

  • :mesh_owner (String)

    The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes.

  • :spec (required, Types::VirtualGatewaySpec)

    The virtual gateway specification to apply.

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

    Optional metadata that you can apply to the virtual gateway 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_gateway_name (required, String)

    The name to use for the virtual gateway.

Returns:

See Also:

#create_virtual_node(options = {}) ⇒ 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, and whether the proxy running in a task group will communicate with other proxies using Transport Layer Security (TLS).

You define a listener for any inbound traffic that your virtual node expects. Any virtual service that your virtual node expects to communicate to is 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 to the full ARN; for example, arn:aws:appmesh:us-west-2:123456789012:myMesh/default/virtualNode/myApp) as the APPMESH_RESOURCE_ARN 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.

By default, App Mesh uses the name of the resource you specified in APPMESH_RESOURCE_ARN when Envoy is referring to itself in metrics and traces. You can override this behavior by setting the APPMESH_RESOURCE_CLUSTER environment variable with your own name.

AWS Cloud Map is not available in the eu-south-1 Region.

For more information about virtual nodes, see Virtual nodes. You must be using 1.15.0 or later of the Envoy image when setting these variables. For more information about App Mesh Envoy variables, see Envoy image in the AWS App Mesh User Guide.

Examples:

Request syntax with placeholder values


resp = client.create_virtual_node({
  client_token: "String",
  mesh_name: "ResourceName", # required
  mesh_owner: "AccountId",
  spec: { # required
    backend_defaults: {
      client_policy: {
        tls: {
          enforce: false,
          ports: [1],
          validation: { # required
            trust: { # required
              acm: {
                certificate_authority_arns: ["Arn"], # required
              },
              file: {
                certificate_chain: "FilePath", # required
              },
            },
          },
        },
      },
    },
    backends: [
      {
        virtual_service: {
          client_policy: {
            tls: {
              enforce: false,
              ports: [1],
              validation: { # required
                trust: { # required
                  acm: {
                    certificate_authority_arns: ["Arn"], # required
                  },
                  file: {
                    certificate_chain: "FilePath", # required
                  },
                },
              },
            },
          },
          virtual_service_name: "ServiceName", # required
        },
      },
    ],
    listeners: [
      {
        connection_pool: {
          grpc: {
            max_requests: 1, # required
          },
          http: {
            max_connections: 1, # required
            max_pending_requests: 1,
          },
          http2: {
            max_requests: 1, # required
          },
          tcp: {
            max_connections: 1, # required
          },
        },
        health_check: {
          healthy_threshold: 1, # required
          interval_millis: 1, # required
          path: "String",
          port: 1,
          protocol: "http", # required, accepts http, tcp, http2, grpc
          timeout_millis: 1, # required
          unhealthy_threshold: 1, # required
        },
        outlier_detection: {
          base_ejection_duration: { # required
            unit: "s", # accepts s, ms
            value: 1,
          },
          interval: { # required
            unit: "s", # accepts s, ms
            value: 1,
          },
          max_ejection_percent: 1, # required
          max_server_errors: 1, # required
        },
        port_mapping: { # required
          port: 1, # required
          protocol: "http", # required, accepts http, tcp, http2, grpc
        },
        timeout: {
          grpc: {
            idle: {
              unit: "s", # accepts s, ms
              value: 1,
            },
            per_request: {
              unit: "s", # accepts s, ms
              value: 1,
            },
          },
          http: {
            idle: {
              unit: "s", # accepts s, ms
              value: 1,
            },
            per_request: {
              unit: "s", # accepts s, ms
              value: 1,
            },
          },
          http2: {
            idle: {
              unit: "s", # accepts s, ms
              value: 1,
            },
            per_request: {
              unit: "s", # accepts s, ms
              value: 1,
            },
          },
          tcp: {
            idle: {
              unit: "s", # accepts s, ms
              value: 1,
            },
          },
        },
        tls: {
          certificate: { # required
            acm: {
              certificate_arn: "Arn", # required
            },
            file: {
              certificate_chain: "FilePath", # required
              private_key: "FilePath", # required
            },
          },
          mode: "STRICT", # required, accepts STRICT, PERMISSIVE, DISABLED
        },
      },
    ],
    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", # 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..mesh_owner #=> String
resp.virtual_node..resource_owner #=> String
resp.virtual_node..uid #=> String
resp.virtual_node..version #=> Integer
resp.virtual_node.spec.backend_defaults.client_policy.tls.enforce #=> true/false
resp.virtual_node.spec.backend_defaults.client_policy.tls.ports #=> Array
resp.virtual_node.spec.backend_defaults.client_policy.tls.ports[0] #=> Integer
resp.virtual_node.spec.backend_defaults.client_policy.tls.validation.trust.acm.certificate_authority_arns #=> Array
resp.virtual_node.spec.backend_defaults.client_policy.tls.validation.trust.acm.certificate_authority_arns[0] #=> String
resp.virtual_node.spec.backend_defaults.client_policy.tls.validation.trust.file.certificate_chain #=> String
resp.virtual_node.spec.backends #=> Array
resp.virtual_node.spec.backends[0].virtual_service.client_policy.tls.enforce #=> true/false
resp.virtual_node.spec.backends[0].virtual_service.client_policy.tls.ports #=> Array
resp.virtual_node.spec.backends[0].virtual_service.client_policy.tls.ports[0] #=> Integer
resp.virtual_node.spec.backends[0].virtual_service.client_policy.tls.validation.trust.acm.certificate_authority_arns #=> Array
resp.virtual_node.spec.backends[0].virtual_service.client_policy.tls.validation.trust.acm.certificate_authority_arns[0] #=> String
resp.virtual_node.spec.backends[0].virtual_service.client_policy.tls.validation.trust.file.certificate_chain #=> String
resp.virtual_node.spec.backends[0].virtual_service.virtual_service_name #=> String
resp.virtual_node.spec.listeners #=> Array
resp.virtual_node.spec.listeners[0].connection_pool.grpc.max_requests #=> Integer
resp.virtual_node.spec.listeners[0].connection_pool.http.max_connections #=> Integer
resp.virtual_node.spec.listeners[0].connection_pool.http.max_pending_requests #=> Integer
resp.virtual_node.spec.listeners[0].connection_pool.http2.max_requests #=> Integer
resp.virtual_node.spec.listeners[0].connection_pool.tcp.max_connections #=> Integer
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", "http2", "grpc"
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].outlier_detection.base_ejection_duration.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].outlier_detection.base_ejection_duration.value #=> Integer
resp.virtual_node.spec.listeners[0].outlier_detection.interval.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].outlier_detection.interval.value #=> Integer
resp.virtual_node.spec.listeners[0].outlier_detection.max_ejection_percent #=> Integer
resp.virtual_node.spec.listeners[0].outlier_detection.max_server_errors #=> 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", "http2", "grpc"
resp.virtual_node.spec.listeners[0].timeout.grpc.idle.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].timeout.grpc.idle.value #=> Integer
resp.virtual_node.spec.listeners[0].timeout.grpc.per_request.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].timeout.grpc.per_request.value #=> Integer
resp.virtual_node.spec.listeners[0].timeout.http.idle.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].timeout.http.idle.value #=> Integer
resp.virtual_node.spec.listeners[0].timeout.http.per_request.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].timeout.http.per_request.value #=> Integer
resp.virtual_node.spec.listeners[0].timeout.http2.idle.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].timeout.http2.idle.value #=> Integer
resp.virtual_node.spec.listeners[0].timeout.http2.per_request.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].timeout.http2.per_request.value #=> Integer
resp.virtual_node.spec.listeners[0].timeout.tcp.idle.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].timeout.tcp.idle.value #=> Integer
resp.virtual_node.spec.listeners[0].tls.certificate.acm.certificate_arn #=> String
resp.virtual_node.spec.listeners[0].tls.certificate.file.certificate_chain #=> String
resp.virtual_node.spec.listeners[0].tls.certificate.file.private_key #=> String
resp.virtual_node.spec.listeners[0].tls.mode #=> String, one of "STRICT", "PERMISSIVE", "DISABLED"
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", "INACTIVE", "DELETED"
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. Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

  • :mesh_name (required, String)

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

  • :mesh_owner (String)

    The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes.

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

See Also:

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

Creates a virtual router within a service mesh.

Specify a listener for any inbound traffic that your virtual router receives. Create a virtual router for each protocol and port that you need to route. 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.

For more information about virtual routers, see Virtual routers.

Examples:

Request syntax with placeholder values


resp = client.create_virtual_router({
  client_token: "String",
  mesh_name: "ResourceName", # required
  mesh_owner: "AccountId",
  spec: { # required
    listeners: [
      {
        port_mapping: { # required
          port: 1, # required
          protocol: "http", # required, accepts http, tcp, http2, grpc
        },
      },
    ],
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # 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..mesh_owner #=> String
resp.virtual_router..resource_owner #=> String
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", "http2", "grpc"
resp.virtual_router.status.status #=> String, one of "ACTIVE", "INACTIVE", "DELETED"
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. Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

  • :mesh_name (required, String)

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

  • :mesh_owner (String)

    The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes.

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

See Also:

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

For more information about virtual services, see Virtual services.

Examples:

Request syntax with placeholder values


resp = client.create_virtual_service({
  client_token: "String",
  mesh_name: "ResourceName", # required
  mesh_owner: "AccountId",
  spec: { # required
    provider: {
      virtual_node: {
        virtual_node_name: "ResourceName", # required
      },
      virtual_router: {
        virtual_router_name: "ResourceName", # required
      },
    },
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # 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..mesh_owner #=> String
resp.virtual_service..resource_owner #=> String
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", "INACTIVE", "DELETED"
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. Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

  • :mesh_name (required, String)

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

  • :mesh_owner (String)

    The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes.

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

See Also:

#delete_gateway_route(options = {}) ⇒ Types::DeleteGatewayRouteOutput

Deletes an existing gateway route.

Examples:

Request syntax with placeholder values


resp = client.delete_gateway_route({
  gateway_route_name: "ResourceName", # required
  mesh_name: "ResourceName", # required
  mesh_owner: "AccountId",
  virtual_gateway_name: "ResourceName", # required
})

Response structure


resp.gateway_route.gateway_route_name #=> String
resp.gateway_route.mesh_name #=> String
resp.gateway_route..arn #=> String
resp.gateway_route..created_at #=> Time
resp.gateway_route..last_updated_at #=> Time
resp.gateway_route..mesh_owner #=> String
resp.gateway_route..resource_owner #=> String
resp.gateway_route..uid #=> String
resp.gateway_route..version #=> Integer
resp.gateway_route.spec.grpc_route.action.target.virtual_service.virtual_service_name #=> String
resp.gateway_route.spec.grpc_route.match.service_name #=> String
resp.gateway_route.spec.http2_route.action.target.virtual_service.virtual_service_name #=> String
resp.gateway_route.spec.http2_route.match.prefix #=> String
resp.gateway_route.spec.http_route.action.target.virtual_service.virtual_service_name #=> String
resp.gateway_route.spec.http_route.match.prefix #=> String
resp.gateway_route.status.status #=> String, one of "ACTIVE", "INACTIVE", "DELETED"
resp.gateway_route.virtual_gateway_name #=> String

Options Hash (options):

  • :gateway_route_name (required, String)

    The name of the gateway route to delete.

  • :mesh_name (required, String)

    The name of the service mesh to delete the gateway route from.

  • :mesh_owner (String)

    The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it\'s the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

  • :virtual_gateway_name (required, String)

    The name of the virtual gateway to delete the route from.

Returns:

See Also:

#delete_mesh(options = {}) ⇒ 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..arn #=> String
resp.mesh..created_at #=> Time
resp.mesh..last_updated_at #=> Time
resp.mesh..mesh_owner #=> String
resp.mesh..resource_owner #=> String
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", "INACTIVE", "DELETED"

Options Hash (options):

  • :mesh_name (required, String)

    The name of the service mesh to delete.

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
  mesh_owner: "AccountId",
  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..mesh_owner #=> String
resp.route..resource_owner #=> String
resp.route..uid #=> String
resp.route..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. #=> Array
resp.route.spec.grpc_route.match.[0].invert #=> true/false
resp.route.spec.grpc_route.match.[0].match.exact #=> String
resp.route.spec.grpc_route.match.[0].match.prefix #=> String
resp.route.spec.grpc_route.match.[0].match.range.end #=> Integer
resp.route.spec.grpc_route.match.[0].match.range.start #=> Integer
resp.route.spec.grpc_route.match.[0].match.regex #=> String
resp.route.spec.grpc_route.match.[0].match.suffix #=> String
resp.route.spec.grpc_route.match.[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 "s", "ms"
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.grpc_route.timeout.idle.unit #=> String, one of "s", "ms"
resp.route.spec.grpc_route.timeout.idle.value #=> Integer
resp.route.spec.grpc_route.timeout.per_request.unit #=> String, one of "s", "ms"
resp.route.spec.grpc_route.timeout.per_request.value #=> Integer
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 #=> true/false
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 "GET", "HEAD", "POST", "PUT", "DELETE", "CONNECT", "OPTIONS", "TRACE", "PATCH"
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 "s", "ms"
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.http2_route.timeout.idle.unit #=> String, one of "s", "ms"
resp.route.spec.http2_route.timeout.idle.value #=> Integer
resp.route.spec.http2_route.timeout.per_request.unit #=> String, one of "s", "ms"
resp.route.spec.http2_route.timeout.per_request.value #=> Integer
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 "GET", "HEAD", "POST", "PUT", "DELETE", "CONNECT", "OPTIONS", "TRACE", "PATCH"
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 "s", "ms"
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.http_route.timeout.idle.unit #=> String, one of "s", "ms"
resp.route.spec.http_route.timeout.idle.value #=> Integer
resp.route.spec.http_route.timeout.per_request.unit #=> String, one of "s", "ms"
resp.route.spec.http_route.timeout.per_request.value #=> Integer
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.spec.tcp_route.timeout.idle.unit #=> String, one of "s", "ms"
resp.route.spec.tcp_route.timeout.idle.value #=> Integer
resp.route.status.status #=> String, one of "ACTIVE", "INACTIVE", "DELETED"
resp.route.virtual_router_name #=> String

Options Hash (options):

  • :mesh_name (required, String)

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

  • :mesh_owner (String)

    The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it\'s the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

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

See Also:

#delete_virtual_gateway(options = {}) ⇒ Types::DeleteVirtualGatewayOutput

Deletes an existing virtual gateway. You cannot delete a virtual gateway if any gateway routes are associated to it.

Examples:

Request syntax with placeholder values


resp = client.delete_virtual_gateway({
  mesh_name: "ResourceName", # required
  mesh_owner: "AccountId",
  virtual_gateway_name: "ResourceName", # required
})

Response structure


resp.virtual_gateway.mesh_name #=> String
resp.virtual_gateway..arn #=> String
resp.virtual_gateway..created_at #=> Time
resp.virtual_gateway..last_updated_at #=> Time
resp.virtual_gateway..mesh_owner #=> String
resp.virtual_gateway..resource_owner #=> String
resp.virtual_gateway..uid #=> String
resp.virtual_gateway..version #=> Integer
resp.virtual_gateway.spec.backend_defaults.client_policy.tls.enforce #=> true/false
resp.virtual_gateway.spec.backend_defaults.client_policy.tls.ports #=> Array
resp.virtual_gateway.spec.backend_defaults.client_policy.tls.ports[0] #=> Integer
resp.virtual_gateway.spec.backend_defaults.client_policy.tls.validation.trust.acm.certificate_authority_arns #=> Array
resp.virtual_gateway.spec.backend_defaults.client_policy.tls.validation.trust.acm.certificate_authority_arns[0] #=> String
resp.virtual_gateway.spec.backend_defaults.client_policy.tls.validation.trust.file.certificate_chain #=> String
resp.virtual_gateway.spec.listeners #=> Array
resp.virtual_gateway.spec.listeners[0].connection_pool.grpc.max_requests #=> Integer
resp.virtual_gateway.spec.listeners[0].connection_pool.http.max_connections #=> Integer
resp.virtual_gateway.spec.listeners[0].connection_pool.http.max_pending_requests #=> Integer
resp.virtual_gateway.spec.listeners[0].connection_pool.http2.max_requests #=> Integer
resp.virtual_gateway.spec.listeners[0].health_check.healthy_threshold #=> Integer
resp.virtual_gateway.spec.listeners[0].health_check.interval_millis #=> Integer
resp.virtual_gateway.spec.listeners[0].health_check.path #=> String
resp.virtual_gateway.spec.listeners[0].health_check.port #=> Integer
resp.virtual_gateway.spec.listeners[0].health_check.protocol #=> String, one of "http", "http2", "grpc"
resp.virtual_gateway.spec.listeners[0].health_check.timeout_millis #=> Integer
resp.virtual_gateway.spec.listeners[0].health_check.unhealthy_threshold #=> Integer
resp.virtual_gateway.spec.listeners[0].port_mapping.port #=> Integer
resp.virtual_gateway.spec.listeners[0].port_mapping.protocol #=> String, one of "http", "http2", "grpc"
resp.virtual_gateway.spec.listeners[0].tls.certificate.acm.certificate_arn #=> String
resp.virtual_gateway.spec.listeners[0].tls.certificate.file.certificate_chain #=> String
resp.virtual_gateway.spec.listeners[0].tls.certificate.file.private_key #=> String
resp.virtual_gateway.spec.listeners[0].tls.mode #=> String, one of "STRICT", "PERMISSIVE", "DISABLED"
resp.virtual_gateway.spec.logging.access_log.file.path #=> String
resp.virtual_gateway.status.status #=> String, one of "ACTIVE", "INACTIVE", "DELETED"
resp.virtual_gateway.virtual_gateway_name #=> String

Options Hash (options):

  • :mesh_name (required, String)

    The name of the service mesh to delete the virtual gateway from.

  • :mesh_owner (String)

    The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it\'s the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

  • :virtual_gateway_name (required, String)

    The name of the virtual gateway to delete.

Returns:

See Also:

#delete_virtual_node(options = {}) ⇒ 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
  mesh_owner: "AccountId",
  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..mesh_owner #=> String
resp.virtual_node..resource_owner #=> String
resp.virtual_node..uid #=> String
resp.virtual_node..version #=> Integer
resp.virtual_node.spec.backend_defaults.client_policy.tls.enforce #=> true/false
resp.virtual_node.spec.backend_defaults.client_policy.tls.ports #=> Array
resp.virtual_node.spec.backend_defaults.client_policy.tls.ports[0] #=> Integer
resp.virtual_node.spec.backend_defaults.client_policy.tls.validation.trust.acm.certificate_authority_arns #=> Array
resp.virtual_node.spec.backend_defaults.client_policy.tls.validation.trust.acm.certificate_authority_arns[0] #=> String
resp.virtual_node.spec.backend_defaults.client_policy.tls.validation.trust.file.certificate_chain #=> String
resp.virtual_node.spec.backends #=> Array
resp.virtual_node.spec.backends[0].virtual_service.client_policy.tls.enforce #=> true/false
resp.virtual_node.spec.backends[0].virtual_service.client_policy.tls.ports #=> Array
resp.virtual_node.spec.backends[0].virtual_service.client_policy.tls.ports[0] #=> Integer
resp.virtual_node.spec.backends[0].virtual_service.client_policy.tls.validation.trust.acm.certificate_authority_arns #=> Array
resp.virtual_node.spec.backends[0].virtual_service.client_policy.tls.validation.trust.acm.certificate_authority_arns[0] #=> String
resp.virtual_node.spec.backends[0].virtual_service.client_policy.tls.validation.trust.file.certificate_chain #=> String
resp.virtual_node.spec.backends[0].virtual_service.virtual_service_name #=> String
resp.virtual_node.spec.listeners #=> Array
resp.virtual_node.spec.listeners[0].connection_pool.grpc.max_requests #=> Integer
resp.virtual_node.spec.listeners[0].connection_pool.http.max_connections #=> Integer
resp.virtual_node.spec.listeners[0].connection_pool.http.max_pending_requests #=> Integer
resp.virtual_node.spec.listeners[0].connection_pool.http2.max_requests #=> Integer
resp.virtual_node.spec.listeners[0].connection_pool.tcp.max_connections #=> Integer
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", "http2", "grpc"
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].outlier_detection.base_ejection_duration.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].outlier_detection.base_ejection_duration.value #=> Integer
resp.virtual_node.spec.listeners[0].outlier_detection.interval.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].outlier_detection.interval.value #=> Integer
resp.virtual_node.spec.listeners[0].outlier_detection.max_ejection_percent #=> Integer
resp.virtual_node.spec.listeners[0].outlier_detection.max_server_errors #=> 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", "http2", "grpc"
resp.virtual_node.spec.listeners[0].timeout.grpc.idle.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].timeout.grpc.idle.value #=> Integer
resp.virtual_node.spec.listeners[0].timeout.grpc.per_request.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].timeout.grpc.per_request.value #=> Integer
resp.virtual_node.spec.listeners[0].timeout.http.idle.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].timeout.http.idle.value #=> Integer
resp.virtual_node.spec.listeners[0].timeout.http.per_request.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].timeout.http.per_request.value #=> Integer
resp.virtual_node.spec.listeners[0].timeout.http2.idle.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].timeout.http2.idle.value #=> Integer
resp.virtual_node.spec.listeners[0].timeout.http2.per_request.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].timeout.http2.per_request.value #=> Integer
resp.virtual_node.spec.listeners[0].timeout.tcp.idle.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].timeout.tcp.idle.value #=> Integer
resp.virtual_node.spec.listeners[0].tls.certificate.acm.certificate_arn #=> String
resp.virtual_node.spec.listeners[0].tls.certificate.file.certificate_chain #=> String
resp.virtual_node.spec.listeners[0].tls.certificate.file.private_key #=> String
resp.virtual_node.spec.listeners[0].tls.mode #=> String, one of "STRICT", "PERMISSIVE", "DISABLED"
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", "INACTIVE", "DELETED"
resp.virtual_node.virtual_node_name #=> String

Options Hash (options):

  • :mesh_name (required, String)

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

  • :mesh_owner (String)

    The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it\'s the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

  • :virtual_node_name (required, String)

    The name of the virtual node to delete.

Returns:

See Also:

#delete_virtual_router(options = {}) ⇒ 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
  mesh_owner: "AccountId",
  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..mesh_owner #=> String
resp.virtual_router..resource_owner #=> String
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", "http2", "grpc"
resp.virtual_router.status.status #=> String, one of "ACTIVE", "INACTIVE", "DELETED"
resp.virtual_router.virtual_router_name #=> String

Options Hash (options):

  • :mesh_name (required, String)

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

  • :mesh_owner (String)

    The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it\'s the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

  • :virtual_router_name (required, String)

    The name of the virtual router to delete.

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
  mesh_owner: "AccountId",
  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..mesh_owner #=> String
resp.virtual_service..resource_owner #=> String
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", "INACTIVE", "DELETED"
resp.virtual_service.virtual_service_name #=> String

Options Hash (options):

  • :mesh_name (required, String)

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

  • :mesh_owner (String)

    The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it\'s the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

  • :virtual_service_name (required, String)

    The name of the virtual service to delete.

Returns:

See Also:

#describe_gateway_route(options = {}) ⇒ Types::DescribeGatewayRouteOutput

Describes an existing gateway route.

Examples:

Request syntax with placeholder values


resp = client.describe_gateway_route({
  gateway_route_name: "ResourceName", # required
  mesh_name: "ResourceName", # required
  mesh_owner: "AccountId",
  virtual_gateway_name: "ResourceName", # required
})

Response structure


resp.gateway_route.gateway_route_name #=> String
resp.gateway_route.mesh_name #=> String
resp.gateway_route..arn #=> String
resp.gateway_route..created_at #=> Time
resp.gateway_route..last_updated_at #=> Time
resp.gateway_route..mesh_owner #=> String
resp.gateway_route..resource_owner #=> String
resp.gateway_route..uid #=> String
resp.gateway_route..version #=> Integer
resp.gateway_route.spec.grpc_route.action.target.virtual_service.virtual_service_name #=> String
resp.gateway_route.spec.grpc_route.match.service_name #=> String
resp.gateway_route.spec.http2_route.action.target.virtual_service.virtual_service_name #=> String
resp.gateway_route.spec.http2_route.match.prefix #=> String
resp.gateway_route.spec.http_route.action.target.virtual_service.virtual_service_name #=> String
resp.gateway_route.spec.http_route.match.prefix #=> String
resp.gateway_route.status.status #=> String, one of "ACTIVE", "INACTIVE", "DELETED"
resp.gateway_route.virtual_gateway_name #=> String

Options Hash (options):

  • :gateway_route_name (required, String)

    The name of the gateway route to describe.

  • :mesh_name (required, String)

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

  • :mesh_owner (String)

    The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it\'s the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

  • :virtual_gateway_name (required, String)

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

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
  mesh_owner: "AccountId",
})

Response structure


resp.mesh.mesh_name #=> String
resp.mesh..arn #=> String
resp.mesh..created_at #=> Time
resp.mesh..last_updated_at #=> Time
resp.mesh..mesh_owner #=> String
resp.mesh..resource_owner #=> String
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", "INACTIVE", "DELETED"

Options Hash (options):

  • :mesh_name (required, String)

    The name of the service mesh to describe.

  • :mesh_owner (String)

    The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it\'s the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

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
  mesh_owner: "AccountId",
  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..mesh_owner #=> String
resp.route..resource_owner #=> String
resp.route..uid #=> String
resp.route..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. #=> Array
resp.route.spec.grpc_route.match.[0].invert #=> true/false
resp.route.spec.grpc_route.match.[0].match.exact #=> String
resp.route.spec.grpc_route.match.[0].match.prefix #=> String
resp.route.spec.grpc_route.match.[0].match.range.end #=> Integer
resp.route.spec.grpc_route.match.[0].match.range.start #=> Integer
resp.route.spec.grpc_route.match.[0].match.regex #=> String
resp.route.spec.grpc_route.match.[0].match.suffix #=> String
resp.route.spec.grpc_route.match.[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 "s", "ms"
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.grpc_route.timeout.idle.unit #=> String, one of "s", "ms"
resp.route.spec.grpc_route.timeout.idle.value #=> Integer
resp.route.spec.grpc_route.timeout.per_request.unit #=> String, one of "s", "ms"
resp.route.spec.grpc_route.timeout.per_request.value #=> Integer
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 #=> true/false
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 "GET", "HEAD", "POST", "PUT", "DELETE", "CONNECT", "OPTIONS", "TRACE", "PATCH"
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 "s", "ms"
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.http2_route.timeout.idle.unit #=> String, one of "s", "ms"
resp.route.spec.http2_route.timeout.idle.value #=> Integer
resp.route.spec.http2_route.timeout.per_request.unit #=> String, one of "s", "ms"
resp.route.spec.http2_route.timeout.per_request.value #=> Integer
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 "GET", "HEAD", "POST", "PUT", "DELETE", "CONNECT", "OPTIONS", "TRACE", "PATCH"
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 "s", "ms"
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.http_route.timeout.idle.unit #=> String, one of "s", "ms"
resp.route.spec.http_route.timeout.idle.value #=> Integer
resp.route.spec.http_route.timeout.per_request.unit #=> String, one of "s", "ms"
resp.route.spec.http_route.timeout.per_request.value #=> Integer
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.spec.tcp_route.timeout.idle.unit #=> String, one of "s", "ms"
resp.route.spec.tcp_route.timeout.idle.value #=> Integer
resp.route.status.status #=> String, one of "ACTIVE", "INACTIVE", "DELETED"
resp.route.virtual_router_name #=> String

Options Hash (options):

  • :mesh_name (required, String)

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

  • :mesh_owner (String)

    The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it\'s the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

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

See Also:

#describe_virtual_gateway(options = {}) ⇒ Types::DescribeVirtualGatewayOutput

Describes an existing virtual gateway.

Examples:

Request syntax with placeholder values


resp = client.describe_virtual_gateway({
  mesh_name: "ResourceName", # required
  mesh_owner: "AccountId",
  virtual_gateway_name: "ResourceName", # required
})

Response structure


resp.virtual_gateway.mesh_name #=> String
resp.virtual_gateway..arn #=> String
resp.virtual_gateway..created_at #=> Time
resp.virtual_gateway..last_updated_at #=> Time
resp.virtual_gateway..mesh_owner #=> String
resp.virtual_gateway..resource_owner #=> String
resp.virtual_gateway..uid #=> String
resp.virtual_gateway..version #=> Integer
resp.virtual_gateway.spec.backend_defaults.client_policy.tls.enforce #=> true/false
resp.virtual_gateway.spec.backend_defaults.client_policy.tls.ports #=> Array
resp.virtual_gateway.spec.backend_defaults.client_policy.tls.ports[0] #=> Integer
resp.virtual_gateway.spec.backend_defaults.client_policy.tls.validation.trust.acm.certificate_authority_arns #=> Array
resp.virtual_gateway.spec.backend_defaults.client_policy.tls.validation.trust.acm.certificate_authority_arns[0] #=> String
resp.virtual_gateway.spec.backend_defaults.client_policy.tls.validation.trust.file.certificate_chain #=> String
resp.virtual_gateway.spec.listeners #=> Array
resp.virtual_gateway.spec.listeners[0].connection_pool.grpc.max_requests #=> Integer
resp.virtual_gateway.spec.listeners[0].connection_pool.http.max_connections #=> Integer
resp.virtual_gateway.spec.listeners[0].connection_pool.http.max_pending_requests #=> Integer
resp.virtual_gateway.spec.listeners[0].connection_pool.http2.max_requests #=> Integer
resp.virtual_gateway.spec.listeners[0].health_check.healthy_threshold #=> Integer
resp.virtual_gateway.spec.listeners[0].health_check.interval_millis #=> Integer
resp.virtual_gateway.spec.listeners[0].health_check.path #=> String
resp.virtual_gateway.spec.listeners[0].health_check.port #=> Integer
resp.virtual_gateway.spec.listeners[0].health_check.protocol #=> String, one of "http", "http2", "grpc"
resp.virtual_gateway.spec.listeners[0].health_check.timeout_millis #=> Integer
resp.virtual_gateway.spec.listeners[0].health_check.unhealthy_threshold #=> Integer
resp.virtual_gateway.spec.listeners[0].port_mapping.port #=> Integer
resp.virtual_gateway.spec.listeners[0].port_mapping.protocol #=> String, one of "http", "http2", "grpc"
resp.virtual_gateway.spec.listeners[0].tls.certificate.acm.certificate_arn #=> String
resp.virtual_gateway.spec.listeners[0].tls.certificate.file.certificate_chain #=> String
resp.virtual_gateway.spec.listeners[0].tls.certificate.file.private_key #=> String
resp.virtual_gateway.spec.listeners[0].tls.mode #=> String, one of "STRICT", "PERMISSIVE", "DISABLED"
resp.virtual_gateway.spec.logging.access_log.file.path #=> String
resp.virtual_gateway.status.status #=> String, one of "ACTIVE", "INACTIVE", "DELETED"
resp.virtual_gateway.virtual_gateway_name #=> String

Options Hash (options):

  • :mesh_name (required, String)

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

  • :mesh_owner (String)

    The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it\'s the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

  • :virtual_gateway_name (required, String)

    The name of the virtual gateway to describe.

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
  mesh_owner: "AccountId",
  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..mesh_owner #=> String
resp.virtual_node..resource_owner #=> String
resp.virtual_node..uid #=> String
resp.virtual_node..version #=> Integer
resp.virtual_node.spec.backend_defaults.client_policy.tls.enforce #=> true/false
resp.virtual_node.spec.backend_defaults.client_policy.tls.ports #=> Array
resp.virtual_node.spec.backend_defaults.client_policy.tls.ports[0] #=> Integer
resp.virtual_node.spec.backend_defaults.client_policy.tls.validation.trust.acm.certificate_authority_arns #=> Array
resp.virtual_node.spec.backend_defaults.client_policy.tls.validation.trust.acm.certificate_authority_arns[0] #=> String
resp.virtual_node.spec.backend_defaults.client_policy.tls.validation.trust.file.certificate_chain #=> String
resp.virtual_node.spec.backends #=> Array
resp.virtual_node.spec.backends[0].virtual_service.client_policy.tls.enforce #=> true/false
resp.virtual_node.spec.backends[0].virtual_service.client_policy.tls.ports #=> Array
resp.virtual_node.spec.backends[0].virtual_service.client_policy.tls.ports[0] #=> Integer
resp.virtual_node.spec.backends[0].virtual_service.client_policy.tls.validation.trust.acm.certificate_authority_arns #=> Array
resp.virtual_node.spec.backends[0].virtual_service.client_policy.tls.validation.trust.acm.certificate_authority_arns[0] #=> String
resp.virtual_node.spec.backends[0].virtual_service.client_policy.tls.validation.trust.file.certificate_chain #=> String
resp.virtual_node.spec.backends[0].virtual_service.virtual_service_name #=> String
resp.virtual_node.spec.listeners #=> Array
resp.virtual_node.spec.listeners[0].connection_pool.grpc.max_requests #=> Integer
resp.virtual_node.spec.listeners[0].connection_pool.http.max_connections #=> Integer
resp.virtual_node.spec.listeners[0].connection_pool.http.max_pending_requests #=> Integer
resp.virtual_node.spec.listeners[0].connection_pool.http2.max_requests #=> Integer
resp.virtual_node.spec.listeners[0].connection_pool.tcp.max_connections #=> Integer
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", "http2", "grpc"
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].outlier_detection.base_ejection_duration.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].outlier_detection.base_ejection_duration.value #=> Integer
resp.virtual_node.spec.listeners[0].outlier_detection.interval.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].outlier_detection.interval.value #=> Integer
resp.virtual_node.spec.listeners[0].outlier_detection.max_ejection_percent #=> Integer
resp.virtual_node.spec.listeners[0].outlier_detection.max_server_errors #=> 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", "http2", "grpc"
resp.virtual_node.spec.listeners[0].timeout.grpc.idle.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].timeout.grpc.idle.value #=> Integer
resp.virtual_node.spec.listeners[0].timeout.grpc.per_request.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].timeout.grpc.per_request.value #=> Integer
resp.virtual_node.spec.listeners[0].timeout.http.idle.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].timeout.http.idle.value #=> Integer
resp.virtual_node.spec.listeners[0].timeout.http.per_request.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].timeout.http.per_request.value #=> Integer
resp.virtual_node.spec.listeners[0].timeout.http2.idle.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].timeout.http2.idle.value #=> Integer
resp.virtual_node.spec.listeners[0].timeout.http2.per_request.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].timeout.http2.per_request.value #=> Integer
resp.virtual_node.spec.listeners[0].timeout.tcp.idle.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].timeout.tcp.idle.value #=> Integer
resp.virtual_node.spec.listeners[0].tls.certificate.acm.certificate_arn #=> String
resp.virtual_node.spec.listeners[0].tls.certificate.file.certificate_chain #=> String
resp.virtual_node.spec.listeners[0].tls.certificate.file.private_key #=> String
resp.virtual_node.spec.listeners[0].tls.mode #=> String, one of "STRICT", "PERMISSIVE", "DISABLED"
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", "INACTIVE", "DELETED"
resp.virtual_node.virtual_node_name #=> String

Options Hash (options):

  • :mesh_name (required, String)

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

  • :mesh_owner (String)

    The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it\'s the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

  • :virtual_node_name (required, String)

    The name of the virtual node to describe.

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
  mesh_owner: "AccountId",
  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..mesh_owner #=> String
resp.virtual_router..resource_owner #=> String
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", "http2", "grpc"
resp.virtual_router.status.status #=> String, one of "ACTIVE", "INACTIVE", "DELETED"
resp.virtual_router.virtual_router_name #=> String

Options Hash (options):

  • :mesh_name (required, String)

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

  • :mesh_owner (String)

    The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it\'s the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

  • :virtual_router_name (required, String)

    The name of the virtual router to describe.

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
  mesh_owner: "AccountId",
  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..mesh_owner #=> String
resp.virtual_service..resource_owner #=> String
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", "INACTIVE", "DELETED"
resp.virtual_service.virtual_service_name #=> String

Options Hash (options):

  • :mesh_name (required, String)

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

  • :mesh_owner (String)

    The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it\'s the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

  • :virtual_service_name (required, String)

    The name of the virtual service to describe.

Returns:

See Also:

#list_gateway_routes(options = {}) ⇒ Types::ListGatewayRoutesOutput

Returns a list of existing gateway routes that are associated to a virtual gateway.

Examples:

Request syntax with placeholder values


resp = client.list_gateway_routes({
  limit: 1,
  mesh_name: "ResourceName", # required
  mesh_owner: "AccountId",
  next_token: "String",
  virtual_gateway_name: "ResourceName", # required
})

Response structure


resp.gateway_routes #=> Array
resp.gateway_routes[0].arn #=> String
resp.gateway_routes[0].created_at #=> Time
resp.gateway_routes[0].gateway_route_name #=> String
resp.gateway_routes[0].last_updated_at #=> Time
resp.gateway_routes[0].mesh_name #=> String
resp.gateway_routes[0].mesh_owner #=> String
resp.gateway_routes[0].resource_owner #=> String
resp.gateway_routes[0].version #=> Integer
resp.gateway_routes[0].virtual_gateway_name #=> String
resp.next_token #=> String

Options Hash (options):

  • :limit (Integer)

    The maximum number of results returned by ListGatewayRoutes in paginated output. When you use this parameter, ListGatewayRoutes 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 ListGatewayRoutes request with the returned nextToken value. This value can be between 1 and 100. If you don\'t use this parameter, ListGatewayRoutes returns up to 100 results and a nextToken value if applicable.

  • :mesh_name (required, String)

    The name of the service mesh to list gateway routes in.

  • :mesh_owner (String)

    The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it\'s the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

  • :next_token (String)

    The nextToken value returned from a previous paginated ListGatewayRoutes 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_gateway_name (required, String)

    The name of the virtual gateway to list gateway routes in.

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].created_at #=> Time
resp.meshes[0].last_updated_at #=> Time
resp.meshes[0].mesh_name #=> String
resp.meshes[0].mesh_owner #=> String
resp.meshes[0].resource_owner #=> String
resp.meshes[0].version #=> Integer
resp.next_token #=> String

Options Hash (options):

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

    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.

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
  mesh_owner: "AccountId",
  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].created_at #=> Time
resp.routes[0].last_updated_at #=> Time
resp.routes[0].mesh_name #=> String
resp.routes[0].mesh_owner #=> String
resp.routes[0].resource_owner #=> String
resp.routes[0].route_name #=> String
resp.routes[0].version #=> Integer
resp.routes[0].virtual_router_name #=> String

Options Hash (options):

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

  • :mesh_owner (String)

    The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it\'s the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

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

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)

    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:

See Also:

#list_virtual_gateways(options = {}) ⇒ Types::ListVirtualGatewaysOutput

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.next_token #=> String
resp.virtual_gateways #=> Array
resp.virtual_gateways[0].arn #=> String
resp.virtual_gateways[0].created_at #=> Time
resp.virtual_gateways[0].last_updated_at #=> Time
resp.virtual_gateways[0].mesh_name #=> String
resp.virtual_gateways[0].mesh_owner #=> String
resp.virtual_gateways[0].resource_owner #=> String
resp.virtual_gateways[0].version #=> Integer
resp.virtual_gateways[0].virtual_gateway_name #=> String

Options Hash (options):

  • :limit (Integer)

    The maximum number of results returned by ListVirtualGateways in paginated output. When you use this parameter, ListVirtualGateways 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 ListVirtualGateways request with the returned nextToken value. This value can be between 1 and 100. If you don\'t use this parameter, ListVirtualGateways returns up to 100 results and a nextToken value if applicable.

  • :mesh_name (required, String)

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

  • :mesh_owner (String)

    The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it\'s the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

  • :next_token (String)

    The nextToken value returned from a previous paginated ListVirtualGateways 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:

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
  mesh_owner: "AccountId",
  next_token: "String",
})

Response structure


resp.next_token #=> String
resp.virtual_nodes #=> Array
resp.virtual_nodes[0].arn #=> String
resp.virtual_nodes[0].created_at #=> Time
resp.virtual_nodes[0].last_updated_at #=> Time
resp.virtual_nodes[0].mesh_name #=> String
resp.virtual_nodes[0].mesh_owner #=> String
resp.virtual_nodes[0].resource_owner #=> String
resp.virtual_nodes[0].version #=> Integer
resp.virtual_nodes[0].virtual_node_name #=> String

Options Hash (options):

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

  • :mesh_owner (String)

    The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it\'s the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

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

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
  mesh_owner: "AccountId",
  next_token: "String",
})

Response structure


resp.next_token #=> String
resp.virtual_routers #=> Array
resp.virtual_routers[0].arn #=> String
resp.virtual_routers[0].created_at #=> Time
resp.virtual_routers[0].last_updated_at #=> Time
resp.virtual_routers[0].mesh_name #=> String
resp.virtual_routers[0].mesh_owner #=> String
resp.virtual_routers[0].resource_owner #=> String
resp.virtual_routers[0].version #=> Integer
resp.virtual_routers[0].virtual_router_name #=> String

Options Hash (options):

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

  • :mesh_owner (String)

    The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it\'s the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

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

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
  mesh_owner: "AccountId",
  next_token: "String",
})

Response structure


resp.next_token #=> String
resp.virtual_services #=> Array
resp.virtual_services[0].arn #=> String
resp.virtual_services[0].created_at #=> Time
resp.virtual_services[0].last_updated_at #=> Time
resp.virtual_services[0].mesh_name #=> String
resp.virtual_services[0].mesh_owner #=> String
resp.virtual_services[0].resource_owner #=> String
resp.virtual_services[0].version #=> Integer
resp.virtual_services[0].virtual_service_name #=> String

Options Hash (options):

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

  • :mesh_owner (String)

    The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it\'s the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

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

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", # required
    },
  ],
})

Options Hash (options):

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

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

    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:

#update_gateway_route(options = {}) ⇒ Types::UpdateGatewayRouteOutput

Updates an existing gateway route that is associated to a specified virtual gateway in a service mesh.

Examples:

Request syntax with placeholder values


resp = client.update_gateway_route({
  client_token: "String",
  gateway_route_name: "ResourceName", # required
  mesh_name: "ResourceName", # required
  mesh_owner: "AccountId",
  spec: { # required
    grpc_route: {
      action: { # required
        target: { # required
          virtual_service: { # required
            virtual_service_name: "ResourceName", # required
          },
        },
      },
      match: { # required
        service_name: "ServiceName",
      },
    },
    http2_route: {
      action: { # required
        target: { # required
          virtual_service: { # required
            virtual_service_name: "ResourceName", # required
          },
        },
      },
      match: { # required
        prefix: "String", # required
      },
    },
    http_route: {
      action: { # required
        target: { # required
          virtual_service: { # required
            virtual_service_name: "ResourceName", # required
          },
        },
      },
      match: { # required
        prefix: "String", # required
      },
    },
  },
  virtual_gateway_name: "ResourceName", # required
})

Response structure


resp.gateway_route.gateway_route_name #=> String
resp.gateway_route.mesh_name #=> String
resp.gateway_route..arn #=> String
resp.gateway_route..created_at #=> Time
resp.gateway_route..last_updated_at #=> Time
resp.gateway_route..mesh_owner #=> String
resp.gateway_route..resource_owner #=> String
resp.gateway_route..uid #=> String
resp.gateway_route..version #=> Integer
resp.gateway_route.spec.grpc_route.action.target.virtual_service.virtual_service_name #=> String
resp.gateway_route.spec.grpc_route.match.service_name #=> String
resp.gateway_route.spec.http2_route.action.target.virtual_service.virtual_service_name #=> String
resp.gateway_route.spec.http2_route.match.prefix #=> String
resp.gateway_route.spec.http_route.action.target.virtual_service.virtual_service_name #=> String
resp.gateway_route.spec.http_route.match.prefix #=> String
resp.gateway_route.status.status #=> String, one of "ACTIVE", "INACTIVE", "DELETED"
resp.gateway_route.virtual_gateway_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. Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

  • :gateway_route_name (required, String)

    The name of the gateway route to update.

  • :mesh_name (required, String)

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

  • :mesh_owner (String)

    The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it\'s the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

  • :spec (required, Types::GatewayRouteSpec)

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

  • :virtual_gateway_name (required, String)

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

Returns:

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..mesh_owner #=> String
resp.mesh..resource_owner #=> String
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", "INACTIVE", "DELETED"

Options Hash (options):

  • :client_token (String)

    This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided. Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

  • :mesh_name (required, String)

    The name of the service mesh to update.

  • :spec (Types::MeshSpec)

    The service mesh specification to apply.

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
  mesh_owner: "AccountId",
  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: "s", # accepts s, ms
          value: 1,
        },
        tcp_retry_events: ["connection-error"], # accepts connection-error
      },
      timeout: {
        idle: {
          unit: "s", # accepts s, ms
          value: 1,
        },
        per_request: {
          unit: "s", # accepts s, ms
          value: 1,
        },
      },
    },
    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: "GET", # accepts GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE, PATCH
        prefix: "String", # required
        scheme: "http", # accepts http, https
      },
      retry_policy: {
        http_retry_events: ["HttpRetryPolicyEvent"],
        max_retries: 1, # required
        per_retry_timeout: { # required
          unit: "s", # accepts s, ms
          value: 1,
        },
        tcp_retry_events: ["connection-error"], # accepts connection-error
      },
      timeout: {
        idle: {
          unit: "s", # accepts s, ms
          value: 1,
        },
        per_request: {
          unit: "s", # accepts s, ms
          value: 1,
        },
      },
    },
    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: "GET", # accepts GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE, PATCH
        prefix: "String", # required
        scheme: "http", # accepts http, https
      },
      retry_policy: {
        http_retry_events: ["HttpRetryPolicyEvent"],
        max_retries: 1, # required
        per_retry_timeout: { # required
          unit: "s", # accepts s, ms
          value: 1,
        },
        tcp_retry_events: ["connection-error"], # accepts connection-error
      },
      timeout: {
        idle: {
          unit: "s", # accepts s, ms
          value: 1,
        },
        per_request: {
          unit: "s", # accepts s, ms
          value: 1,
        },
      },
    },
    priority: 1,
    tcp_route: {
      action: { # required
        weighted_targets: [ # required
          {
            virtual_node: "ResourceName", # required
            weight: 1, # required
          },
        ],
      },
      timeout: {
        idle: {
          unit: "s", # accepts s, ms
          value: 1,
        },
      },
    },
  },
  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..mesh_owner #=> String
resp.route..resource_owner #=> String
resp.route..uid #=> String
resp.route..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. #=> Array
resp.route.spec.grpc_route.match.[0].invert #=> true/false
resp.route.spec.grpc_route.match.[0].match.exact #=> String
resp.route.spec.grpc_route.match.[0].match.prefix #=> String
resp.route.spec.grpc_route.match.[0].match.range.end #=> Integer
resp.route.spec.grpc_route.match.[0].match.range.start #=> Integer
resp.route.spec.grpc_route.match.[0].match.regex #=> String
resp.route.spec.grpc_route.match.[0].match.suffix #=> String
resp.route.spec.grpc_route.match.[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 "s", "ms"
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.grpc_route.timeout.idle.unit #=> String, one of "s", "ms"
resp.route.spec.grpc_route.timeout.idle.value #=> Integer
resp.route.spec.grpc_route.timeout.per_request.unit #=> String, one of "s", "ms"
resp.route.spec.grpc_route.timeout.per_request.value #=> Integer
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 #=> true/false
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 "GET", "HEAD", "POST", "PUT", "DELETE", "CONNECT", "OPTIONS", "TRACE", "PATCH"
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 "s", "ms"
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.http2_route.timeout.idle.unit #=> String, one of "s", "ms"
resp.route.spec.http2_route.timeout.idle.value #=> Integer
resp.route.spec.http2_route.timeout.per_request.unit #=> String, one of "s", "ms"
resp.route.spec.http2_route.timeout.per_request.value #=> Integer
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 "GET", "HEAD", "POST", "PUT", "DELETE", "CONNECT", "OPTIONS", "TRACE", "PATCH"
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 "s", "ms"
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.http_route.timeout.idle.unit #=> String, one of "s", "ms"
resp.route.spec.http_route.timeout.idle.value #=> Integer
resp.route.spec.http_route.timeout.per_request.unit #=> String, one of "s", "ms"
resp.route.spec.http_route.timeout.per_request.value #=> Integer
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.spec.tcp_route.timeout.idle.unit #=> String, one of "s", "ms"
resp.route.spec.tcp_route.timeout.idle.value #=> Integer
resp.route.status.status #=> String, one of "ACTIVE", "INACTIVE", "DELETED"
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. Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

  • :mesh_name (required, String)

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

  • :mesh_owner (String)

    The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it\'s the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

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

See Also:

#update_virtual_gateway(options = {}) ⇒ Types::UpdateVirtualGatewayOutput

Updates an existing virtual gateway in a specified service mesh.

Examples:

Request syntax with placeholder values


resp = client.update_virtual_gateway({
  client_token: "String",
  mesh_name: "ResourceName", # required
  mesh_owner: "AccountId",
  spec: { # required
    backend_defaults: {
      client_policy: {
        tls: {
          enforce: false,
          ports: [1],
          validation: { # required
            trust: { # required
              acm: {
                certificate_authority_arns: ["Arn"], # required
              },
              file: {
                certificate_chain: "FilePath", # required
              },
            },
          },
        },
      },
    },
    listeners: [ # required
      {
        connection_pool: {
          grpc: {
            max_requests: 1, # required
          },
          http: {
            max_connections: 1, # required
            max_pending_requests: 1,
          },
          http2: {
            max_requests: 1, # required
          },
        },
        health_check: {
          healthy_threshold: 1, # required
          interval_millis: 1, # required
          path: "String",
          port: 1,
          protocol: "http", # required, accepts http, http2, grpc
          timeout_millis: 1, # required
          unhealthy_threshold: 1, # required
        },
        port_mapping: { # required
          port: 1, # required
          protocol: "http", # required, accepts http, http2, grpc
        },
        tls: {
          certificate: { # required
            acm: {
              certificate_arn: "Arn", # required
            },
            file: {
              certificate_chain: "FilePath", # required
              private_key: "FilePath", # required
            },
          },
          mode: "STRICT", # required, accepts STRICT, PERMISSIVE, DISABLED
        },
      },
    ],
    logging: {
      access_log: {
        file: {
          path: "FilePath", # required
        },
      },
    },
  },
  virtual_gateway_name: "ResourceName", # required
})

Response structure


resp.virtual_gateway.mesh_name #=> String
resp.virtual_gateway..arn #=> String
resp.virtual_gateway..created_at #=> Time
resp.virtual_gateway..last_updated_at #=> Time
resp.virtual_gateway..mesh_owner #=> String
resp.virtual_gateway..resource_owner #=> String
resp.virtual_gateway..uid #=> String
resp.virtual_gateway..version #=> Integer
resp.virtual_gateway.spec.backend_defaults.client_policy.tls.enforce #=> true/false
resp.virtual_gateway.spec.backend_defaults.client_policy.tls.ports #=> Array
resp.virtual_gateway.spec.backend_defaults.client_policy.tls.ports[0] #=> Integer
resp.virtual_gateway.spec.backend_defaults.client_policy.tls.validation.trust.acm.certificate_authority_arns #=> Array
resp.virtual_gateway.spec.backend_defaults.client_policy.tls.validation.trust.acm.certificate_authority_arns[0] #=> String
resp.virtual_gateway.spec.backend_defaults.client_policy.tls.validation.trust.file.certificate_chain #=> String
resp.virtual_gateway.spec.listeners #=> Array
resp.virtual_gateway.spec.listeners[0].connection_pool.grpc.max_requests #=> Integer
resp.virtual_gateway.spec.listeners[0].connection_pool.http.max_connections #=> Integer
resp.virtual_gateway.spec.listeners[0].connection_pool.http.max_pending_requests #=> Integer
resp.virtual_gateway.spec.listeners[0].connection_pool.http2.max_requests #=> Integer
resp.virtual_gateway.spec.listeners[0].health_check.healthy_threshold #=> Integer
resp.virtual_gateway.spec.listeners[0].health_check.interval_millis #=> Integer
resp.virtual_gateway.spec.listeners[0].health_check.path #=> String
resp.virtual_gateway.spec.listeners[0].health_check.port #=> Integer
resp.virtual_gateway.spec.listeners[0].health_check.protocol #=> String, one of "http", "http2", "grpc"
resp.virtual_gateway.spec.listeners[0].health_check.timeout_millis #=> Integer
resp.virtual_gateway.spec.listeners[0].health_check.unhealthy_threshold #=> Integer
resp.virtual_gateway.spec.listeners[0].port_mapping.port #=> Integer
resp.virtual_gateway.spec.listeners[0].port_mapping.protocol #=> String, one of "http", "http2", "grpc"
resp.virtual_gateway.spec.listeners[0].tls.certificate.acm.certificate_arn #=> String
resp.virtual_gateway.spec.listeners[0].tls.certificate.file.certificate_chain #=> String
resp.virtual_gateway.spec.listeners[0].tls.certificate.file.private_key #=> String
resp.virtual_gateway.spec.listeners[0].tls.mode #=> String, one of "STRICT", "PERMISSIVE", "DISABLED"
resp.virtual_gateway.spec.logging.access_log.file.path #=> String
resp.virtual_gateway.status.status #=> String, one of "ACTIVE", "INACTIVE", "DELETED"
resp.virtual_gateway.virtual_gateway_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. Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

  • :mesh_name (required, String)

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

  • :mesh_owner (String)

    The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it\'s the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

  • :spec (required, Types::VirtualGatewaySpec)

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

  • :virtual_gateway_name (required, String)

    The name of the virtual gateway to update.

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
  mesh_owner: "AccountId",
  spec: { # required
    backend_defaults: {
      client_policy: {
        tls: {
          enforce: false,
          ports: [1],
          validation: { # required
            trust: { # required
              acm: {
                certificate_authority_arns: ["Arn"], # required
              },
              file: {
                certificate_chain: "FilePath", # required
              },
            },
          },
        },
      },
    },
    backends: [
      {
        virtual_service: {
          client_policy: {
            tls: {
              enforce: false,
              ports: [1],
              validation: { # required
                trust: { # required
                  acm: {
                    certificate_authority_arns: ["Arn"], # required
                  },
                  file: {
                    certificate_chain: "FilePath", # required
                  },
                },
              },
            },
          },
          virtual_service_name: "ServiceName", # required
        },
      },
    ],
    listeners: [
      {
        connection_pool: {
          grpc: {
            max_requests: 1, # required
          },
          http: {
            max_connections: 1, # required
            max_pending_requests: 1,
          },
          http2: {
            max_requests: 1, # required
          },
          tcp: {
            max_connections: 1, # required
          },
        },
        health_check: {
          healthy_threshold: 1, # required
          interval_millis: 1, # required
          path: "String",
          port: 1,
          protocol: "http", # required, accepts http, tcp, http2, grpc
          timeout_millis: 1, # required
          unhealthy_threshold: 1, # required
        },
        outlier_detection: {
          base_ejection_duration: { # required
            unit: "s", # accepts s, ms
            value: 1,
          },
          interval: { # required
            unit: "s", # accepts s, ms
            value: 1,
          },
          max_ejection_percent: 1, # required
          max_server_errors: 1, # required
        },
        port_mapping: { # required
          port: 1, # required
          protocol: "http", # required, accepts http, tcp, http2, grpc
        },
        timeout: {
          grpc: {
            idle: {
              unit: "s", # accepts s, ms
              value: 1,
            },
            per_request: {
              unit: "s", # accepts s, ms
              value: 1,
            },
          },
          http: {
            idle: {
              unit: "s", # accepts s, ms
              value: 1,
            },
            per_request: {
              unit: "s", # accepts s, ms
              value: 1,
            },
          },
          http2: {
            idle: {
              unit: "s", # accepts s, ms
              value: 1,
            },
            per_request: {
              unit: "s", # accepts s, ms
              value: 1,
            },
          },
          tcp: {
            idle: {
              unit: "s", # accepts s, ms
              value: 1,
            },
          },
        },
        tls: {
          certificate: { # required
            acm: {
              certificate_arn: "Arn", # required
            },
            file: {
              certificate_chain: "FilePath", # required
              private_key: "FilePath", # required
            },
          },
          mode: "STRICT", # required, accepts STRICT, PERMISSIVE, DISABLED
        },
      },
    ],
    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..mesh_owner #=> String
resp.virtual_node..resource_owner #=> String
resp.virtual_node..uid #=> String
resp.virtual_node..version #=> Integer
resp.virtual_node.spec.backend_defaults.client_policy.tls.enforce #=> true/false
resp.virtual_node.spec.backend_defaults.client_policy.tls.ports #=> Array
resp.virtual_node.spec.backend_defaults.client_policy.tls.ports[0] #=> Integer
resp.virtual_node.spec.backend_defaults.client_policy.tls.validation.trust.acm.certificate_authority_arns #=> Array
resp.virtual_node.spec.backend_defaults.client_policy.tls.validation.trust.acm.certificate_authority_arns[0] #=> String
resp.virtual_node.spec.backend_defaults.client_policy.tls.validation.trust.file.certificate_chain #=> String
resp.virtual_node.spec.backends #=> Array
resp.virtual_node.spec.backends[0].virtual_service.client_policy.tls.enforce #=> true/false
resp.virtual_node.spec.backends[0].virtual_service.client_policy.tls.ports #=> Array
resp.virtual_node.spec.backends[0].virtual_service.client_policy.tls.ports[0] #=> Integer
resp.virtual_node.spec.backends[0].virtual_service.client_policy.tls.validation.trust.acm.certificate_authority_arns #=> Array
resp.virtual_node.spec.backends[0].virtual_service.client_policy.tls.validation.trust.acm.certificate_authority_arns[0] #=> String
resp.virtual_node.spec.backends[0].virtual_service.client_policy.tls.validation.trust.file.certificate_chain #=> String
resp.virtual_node.spec.backends[0].virtual_service.virtual_service_name #=> String
resp.virtual_node.spec.listeners #=> Array
resp.virtual_node.spec.listeners[0].connection_pool.grpc.max_requests #=> Integer
resp.virtual_node.spec.listeners[0].connection_pool.http.max_connections #=> Integer
resp.virtual_node.spec.listeners[0].connection_pool.http.max_pending_requests #=> Integer
resp.virtual_node.spec.listeners[0].connection_pool.http2.max_requests #=> Integer
resp.virtual_node.spec.listeners[0].connection_pool.tcp.max_connections #=> Integer
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", "http2", "grpc"
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].outlier_detection.base_ejection_duration.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].outlier_detection.base_ejection_duration.value #=> Integer
resp.virtual_node.spec.listeners[0].outlier_detection.interval.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].outlier_detection.interval.value #=> Integer
resp.virtual_node.spec.listeners[0].outlier_detection.max_ejection_percent #=> Integer
resp.virtual_node.spec.listeners[0].outlier_detection.max_server_errors #=> 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", "http2", "grpc"
resp.virtual_node.spec.listeners[0].timeout.grpc.idle.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].timeout.grpc.idle.value #=> Integer
resp.virtual_node.spec.listeners[0].timeout.grpc.per_request.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].timeout.grpc.per_request.value #=> Integer
resp.virtual_node.spec.listeners[0].timeout.http.idle.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].timeout.http.idle.value #=> Integer
resp.virtual_node.spec.listeners[0].timeout.http.per_request.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].timeout.http.per_request.value #=> Integer
resp.virtual_node.spec.listeners[0].timeout.http2.idle.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].timeout.http2.idle.value #=> Integer
resp.virtual_node.spec.listeners[0].timeout.http2.per_request.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].timeout.http2.per_request.value #=> Integer
resp.virtual_node.spec.listeners[0].timeout.tcp.idle.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].timeout.tcp.idle.value #=> Integer
resp.virtual_node.spec.listeners[0].tls.certificate.acm.certificate_arn #=> String
resp.virtual_node.spec.listeners[0].tls.certificate.file.certificate_chain #=> String
resp.virtual_node.spec.listeners[0].tls.certificate.file.private_key #=> String
resp.virtual_node.spec.listeners[0].tls.mode #=> String, one of "STRICT", "PERMISSIVE", "DISABLED"
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", "INACTIVE", "DELETED"
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. Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

  • :mesh_name (required, String)

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

  • :mesh_owner (String)

    The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it\'s the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

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

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
  mesh_owner: "AccountId",
  spec: { # required
    listeners: [
      {
        port_mapping: { # required
          port: 1, # required
          protocol: "http", # required, accepts http, tcp, http2, grpc
        },
      },
    ],
  },
  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..mesh_owner #=> String
resp.virtual_router..resource_owner #=> String
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", "http2", "grpc"
resp.virtual_router.status.status #=> String, one of "ACTIVE", "INACTIVE", "DELETED"
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. Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

  • :mesh_name (required, String)

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

  • :mesh_owner (String)

    The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it\'s the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

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

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
  mesh_owner: "AccountId",
  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..mesh_owner #=> String
resp.virtual_service..resource_owner #=> String
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", "INACTIVE", "DELETED"
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. Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

  • :mesh_name (required, String)

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

  • :mesh_owner (String)

    The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it\'s the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

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

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.