Class: Aws::AppMesh::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb

Overview

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

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

For details on configuring region and credentials see the developer guide.

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

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

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

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider)

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

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

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

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

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

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

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

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

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts.
  • :region (required, String)

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

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false

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

  • :adaptive_retry_wait_to_fill (Boolean) — default: true

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false

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

  • :client_side_monitoring_client_id (String) — default: ""

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

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

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

  • :client_side_monitoring_port (Integer) — default: 31000

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

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

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

  • :convert_params (Boolean) — default: true

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

  • :correct_clock_skew (Boolean) — default: true

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :disable_host_prefix_injection (Boolean) — default: false

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

  • :endpoint (String)

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

  • :endpoint_cache_max_entries (Integer) — default: 1000

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

  • :endpoint_cache_max_threads (Integer) — default: 10

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

  • :endpoint_cache_poll_interval (Integer) — default: 60

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

  • :endpoint_discovery (Boolean) — default: false

    When set to true, endpoint discovery will be enabled for operations when available.

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

    The log formatter.

  • :log_level (Symbol) — default: :info

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

  • :logger (Logger)

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

  • :max_attempts (Integer) — default: 3

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

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

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

  • :retry_backoff (Proc)

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

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

  • :retry_limit (Integer) — default: 3

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy"

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

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

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

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

  • :validate_params (Boolean) — default: true

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

  • :http_proxy (URI::HTTP, String)

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15

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

  • :http_read_timeout (Integer) — default: 60

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

  • :http_idle_timeout (Float) — default: 5

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

  • :http_continue_timeout (Float) — default: 1

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

  • :http_wire_trace (Boolean) — default: false

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

  • :ssl_verify_peer (Boolean) — default: true

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

  • :ssl_ca_bundle (String)

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

  • :ssl_ca_directory (String)

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



324
325
326
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 324

def initialize(*args)
  super
end

Instance Method Details

#create_gateway_route(params = {}) ⇒ 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",
    },
  ],
  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", "DELETED", "INACTIVE"
resp.gateway_route.virtual_gateway_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String)

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

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

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



464
465
466
467
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 464

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

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

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", "DELETED", "INACTIVE"

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String)

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

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

  • :mesh_name (required, String)

    The name to use for the service mesh.

  • :spec (Types::MeshSpec)

    The service mesh specification to apply.

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

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

Returns:

See Also:



543
544
545
546
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 543

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

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

Creates a route that is associated with a virtual router.

You can 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: "ms", # accepts ms, s
          value: 1,
        },
        tcp_retry_events: ["connection-error"], # accepts connection-error
      },
      timeout: {
        idle: {
          unit: "ms", # accepts ms, s
          value: 1,
        },
        per_request: {
          unit: "ms", # accepts ms, s
          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: "CONNECT", # accepts CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, TRACE
        prefix: "String", # required
        scheme: "http", # accepts http, https
      },
      retry_policy: {
        http_retry_events: ["HttpRetryPolicyEvent"],
        max_retries: 1, # required
        per_retry_timeout: { # required
          unit: "ms", # accepts ms, s
          value: 1,
        },
        tcp_retry_events: ["connection-error"], # accepts connection-error
      },
      timeout: {
        idle: {
          unit: "ms", # accepts ms, s
          value: 1,
        },
        per_request: {
          unit: "ms", # accepts ms, s
          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: "CONNECT", # accepts CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, TRACE
        prefix: "String", # required
        scheme: "http", # accepts http, https
      },
      retry_policy: {
        http_retry_events: ["HttpRetryPolicyEvent"],
        max_retries: 1, # required
        per_retry_timeout: { # required
          unit: "ms", # accepts ms, s
          value: 1,
        },
        tcp_retry_events: ["connection-error"], # accepts connection-error
      },
      timeout: {
        idle: {
          unit: "ms", # accepts ms, s
          value: 1,
        },
        per_request: {
          unit: "ms", # accepts ms, s
          value: 1,
        },
      },
    },
    priority: 1,
    tcp_route: {
      action: { # required
        weighted_targets: [ # required
          {
            virtual_node: "ResourceName", # required
            weight: 1, # required
          },
        ],
      },
      timeout: {
        idle: {
          unit: "ms", # accepts ms, s
          value: 1,
        },
      },
    },
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
  virtual_router_name: "ResourceName", # required
})

Response structure


resp.route.mesh_name #=> String
resp.route..arn #=> String
resp.route..created_at #=> Time
resp.route..last_updated_at #=> Time
resp.route..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 #=> Boolean
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 "ms", "s"
resp.route.spec.grpc_route.retry_policy.per_retry_timeout.value #=> Integer
resp.route.spec.grpc_route.retry_policy.tcp_retry_events #=> Array
resp.route.spec.grpc_route.retry_policy.tcp_retry_events[0] #=> String, one of "connection-error"
resp.route.spec.grpc_route.timeout.idle.unit #=> String, one of "ms", "s"
resp.route.spec.grpc_route.timeout.idle.value #=> Integer
resp.route.spec.grpc_route.timeout.per_request.unit #=> String, one of "ms", "s"
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 #=> Boolean
resp.route.spec.http2_route.match.headers[0].match.exact #=> String
resp.route.spec.http2_route.match.headers[0].match.prefix #=> String
resp.route.spec.http2_route.match.headers[0].match.range.end #=> Integer
resp.route.spec.http2_route.match.headers[0].match.range.start #=> Integer
resp.route.spec.http2_route.match.headers[0].match.regex #=> String
resp.route.spec.http2_route.match.headers[0].match.suffix #=> String
resp.route.spec.http2_route.match.headers[0].name #=> String
resp.route.spec.http2_route.match.method #=> String, one of "CONNECT", "DELETE", "GET", "HEAD", "OPTIONS", "PATCH", "POST", "PUT", "TRACE"
resp.route.spec.http2_route.match.prefix #=> String
resp.route.spec.http2_route.match.scheme #=> String, one of "http", "https"
resp.route.spec.http2_route.retry_policy.http_retry_events #=> Array
resp.route.spec.http2_route.retry_policy.http_retry_events[0] #=> String
resp.route.spec.http2_route.retry_policy.max_retries #=> Integer
resp.route.spec.http2_route.retry_policy.per_retry_timeout.unit #=> String, one of "ms", "s"
resp.route.spec.http2_route.retry_policy.per_retry_timeout.value #=> Integer
resp.route.spec.http2_route.retry_policy.tcp_retry_events #=> Array
resp.route.spec.http2_route.retry_policy.tcp_retry_events[0] #=> String, one of "connection-error"
resp.route.spec.http2_route.timeout.idle.unit #=> String, one of "ms", "s"
resp.route.spec.http2_route.timeout.idle.value #=> Integer
resp.route.spec.http2_route.timeout.per_request.unit #=> String, one of "ms", "s"
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 #=> Boolean
resp.route.spec.http_route.match.headers[0].match.exact #=> String
resp.route.spec.http_route.match.headers[0].match.prefix #=> String
resp.route.spec.http_route.match.headers[0].match.range.end #=> Integer
resp.route.spec.http_route.match.headers[0].match.range.start #=> Integer
resp.route.spec.http_route.match.headers[0].match.regex #=> String
resp.route.spec.http_route.match.headers[0].match.suffix #=> String
resp.route.spec.http_route.match.headers[0].name #=> String
resp.route.spec.http_route.match.method #=> String, one of "CONNECT", "DELETE", "GET", "HEAD", "OPTIONS", "PATCH", "POST", "PUT", "TRACE"
resp.route.spec.http_route.match.prefix #=> String
resp.route.spec.http_route.match.scheme #=> String, one of "http", "https"
resp.route.spec.http_route.retry_policy.http_retry_events #=> Array
resp.route.spec.http_route.retry_policy.http_retry_events[0] #=> String
resp.route.spec.http_route.retry_policy.max_retries #=> Integer
resp.route.spec.http_route.retry_policy.per_retry_timeout.unit #=> String, one of "ms", "s"
resp.route.spec.http_route.retry_policy.per_retry_timeout.value #=> Integer
resp.route.spec.http_route.retry_policy.tcp_retry_events #=> Array
resp.route.spec.http_route.retry_policy.tcp_retry_events[0] #=> String, one of "connection-error"
resp.route.spec.http_route.timeout.idle.unit #=> String, one of "ms", "s"
resp.route.spec.http_route.timeout.idle.value #=> Integer
resp.route.spec.http_route.timeout.per_request.unit #=> String, one of "ms", "s"
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 "ms", "s"
resp.route.spec.tcp_route.timeout.idle.value #=> Integer
resp.route.status.status #=> String, one of "ACTIVE", "DELETED", "INACTIVE"
resp.route.virtual_router_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String)

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

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

  • :mesh_name (required, String)

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

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



891
892
893
894
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 891

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

#create_virtual_gateway(params = {}) ⇒ 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
      {
        health_check: {
          healthy_threshold: 1, # required
          interval_millis: 1, # required
          path: "String",
          port: 1,
          protocol: "grpc", # required, accepts grpc, http, http2
          timeout_millis: 1, # required
          unhealthy_threshold: 1, # required
        },
        port_mapping: { # required
          port: 1, # required
          protocol: "grpc", # required, accepts grpc, http, http2
        },
        tls: {
          certificate: { # required
            acm: {
              certificate_arn: "Arn", # required
            },
            file: {
              certificate_chain: "FilePath", # required
              private_key: "FilePath", # required
            },
          },
          mode: "DISABLED", # required, accepts DISABLED, PERMISSIVE, STRICT
        },
      },
    ],
    logging: {
      access_log: {
        file: {
          path: "FilePath", # required
        },
      },
    },
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
  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 #=> Boolean
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].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 "grpc", "http", "http2"
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 "grpc", "http", "http2"
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 "DISABLED", "PERMISSIVE", "STRICT"
resp.virtual_gateway.spec.logging.access_log.file.path #=> String
resp.virtual_gateway.status.status #=> String, one of "ACTIVE", "DELETED", "INACTIVE"
resp.virtual_gateway.virtual_gateway_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String)

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

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

  • :mesh_name (required, String)

    The name of the service mesh to create the virtual 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:



1060
1061
1062
1063
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 1060

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

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

Creates a virtual node within a service mesh.

A virtual node acts as a logical pointer to a particular task group, such as an Amazon ECS service or a Kubernetes deployment. When you create a virtual node, you can specify the service discovery information for your task group, 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 (either the full ARN or the truncated resource name: for example, mesh/default/virtualNode/simpleapp) as the APPMESH_VIRTUAL_NODE_NAME environment variable for your task group's Envoy proxy container in your task definition or pod spec. This is then mapped to the node.id and node.cluster Envoy parameters.

If you require your Envoy stats or tracing to use a different name, you can override the node.cluster value that is set by APPMESH_VIRTUAL_NODE_NAME with the APPMESH_VIRTUAL_NODE_CLUSTER environment variable.

For more information about virtual nodes, see Virtual nodes.

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: [
      {
        health_check: {
          healthy_threshold: 1, # required
          interval_millis: 1, # required
          path: "String",
          port: 1,
          protocol: "grpc", # required, accepts grpc, http, http2, tcp
          timeout_millis: 1, # required
          unhealthy_threshold: 1, # required
        },
        port_mapping: { # required
          port: 1, # required
          protocol: "grpc", # required, accepts grpc, http, http2, tcp
        },
        timeout: {
          grpc: {
            idle: {
              unit: "ms", # accepts ms, s
              value: 1,
            },
            per_request: {
              unit: "ms", # accepts ms, s
              value: 1,
            },
          },
          http: {
            idle: {
              unit: "ms", # accepts ms, s
              value: 1,
            },
            per_request: {
              unit: "ms", # accepts ms, s
              value: 1,
            },
          },
          http2: {
            idle: {
              unit: "ms", # accepts ms, s
              value: 1,
            },
            per_request: {
              unit: "ms", # accepts ms, s
              value: 1,
            },
          },
          tcp: {
            idle: {
              unit: "ms", # accepts ms, s
              value: 1,
            },
          },
        },
        tls: {
          certificate: { # required
            acm: {
              certificate_arn: "Arn", # required
            },
            file: {
              certificate_chain: "FilePath", # required
              private_key: "FilePath", # required
            },
          },
          mode: "DISABLED", # required, accepts DISABLED, PERMISSIVE, STRICT
        },
      },
    ],
    logging: {
      access_log: {
        file: {
          path: "FilePath", # required
        },
      },
    },
    service_discovery: {
      aws_cloud_map: {
        attributes: [
          {
            key: "AwsCloudMapInstanceAttributeKey", # required
            value: "AwsCloudMapInstanceAttributeValue", # required
          },
        ],
        namespace_name: "AwsCloudMapName", # required
        service_name: "AwsCloudMapName", # required
      },
      dns: {
        hostname: "Hostname", # required
      },
    },
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
  virtual_node_name: "ResourceName", # required
})

Response structure


resp.virtual_node.mesh_name #=> String
resp.virtual_node..arn #=> String
resp.virtual_node..created_at #=> Time
resp.virtual_node..last_updated_at #=> Time
resp.virtual_node..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 #=> Boolean
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 #=> Boolean
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].health_check.healthy_threshold #=> Integer
resp.virtual_node.spec.listeners[0].health_check.interval_millis #=> Integer
resp.virtual_node.spec.listeners[0].health_check.path #=> String
resp.virtual_node.spec.listeners[0].health_check.port #=> Integer
resp.virtual_node.spec.listeners[0].health_check.protocol #=> String, one of "grpc", "http", "http2", "tcp"
resp.virtual_node.spec.listeners[0].health_check.timeout_millis #=> Integer
resp.virtual_node.spec.listeners[0].health_check.unhealthy_threshold #=> Integer
resp.virtual_node.spec.listeners[0].port_mapping.port #=> Integer
resp.virtual_node.spec.listeners[0].port_mapping.protocol #=> String, one of "grpc", "http", "http2", "tcp"
resp.virtual_node.spec.listeners[0].timeout.grpc.idle.unit #=> String, one of "ms", "s"
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 "ms", "s"
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 "ms", "s"
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 "ms", "s"
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 "ms", "s"
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 "ms", "s"
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 "ms", "s"
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 "DISABLED", "PERMISSIVE", "STRICT"
resp.virtual_node.spec.logging.access_log.file.path #=> String
resp.virtual_node.spec.service_discovery.aws_cloud_map.attributes #=> Array
resp.virtual_node.spec.service_discovery.aws_cloud_map.attributes[0].key #=> String
resp.virtual_node.spec.service_discovery.aws_cloud_map.attributes[0].value #=> String
resp.virtual_node.spec.service_discovery.aws_cloud_map.namespace_name #=> String
resp.virtual_node.spec.service_discovery.aws_cloud_map.service_name #=> String
resp.virtual_node.spec.service_discovery.dns.hostname #=> String
resp.virtual_node.status.status #=> String, one of "ACTIVE", "DELETED", "INACTIVE"
resp.virtual_node.virtual_node_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String)

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

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

  • :mesh_name (required, String)

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

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



1352
1353
1354
1355
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 1352

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

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

Creates a virtual router within a service mesh.

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

Response structure


resp.virtual_router.mesh_name #=> String
resp.virtual_router..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 "grpc", "http", "http2", "tcp"
resp.virtual_router.status.status #=> String, one of "ACTIVE", "DELETED", "INACTIVE"
resp.virtual_router.virtual_router_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String)

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

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

  • :mesh_name (required, String)

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

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



1456
1457
1458
1459
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 1456

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

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

Creates a virtual service within a service mesh.

A virtual service is an abstraction of a real service that is provided by a virtual node directly or indirectly by means of a virtual router. Dependent services call your virtual service by its virtualServiceName, and those requests are routed to the virtual node or virtual router that is specified as the provider for the virtual service.

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",
    },
  ],
  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", "DELETED", "INACTIVE"
resp.virtual_service.virtual_service_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String)

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

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

  • :mesh_name (required, String)

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

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



1560
1561
1562
1563
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 1560

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

#delete_gateway_route(params = {}) ⇒ 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", "DELETED", "INACTIVE"
resp.gateway_route.virtual_gateway_name #=> String

Parameters:

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

    ({})

Options Hash (params):

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



1623
1624
1625
1626
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 1623

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

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

Deletes an existing service mesh.

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :mesh_name (required, String)

    The name of the service mesh to delete.

Returns:

See Also:



1664
1665
1666
1667
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 1664

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

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

Deletes an existing route.

Examples:

Request syntax with placeholder values


resp = client.delete_route({
  mesh_name: "ResourceName", # required
  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 #=> Boolean
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 "ms", "s"
resp.route.spec.grpc_route.retry_policy.per_retry_timeout.value #=> Integer
resp.route.spec.grpc_route.retry_policy.tcp_retry_events #=> Array
resp.route.spec.grpc_route.retry_policy.tcp_retry_events[0] #=> String, one of "connection-error"
resp.route.spec.grpc_route.timeout.idle.unit #=> String, one of "ms", "s"
resp.route.spec.grpc_route.timeout.idle.value #=> Integer
resp.route.spec.grpc_route.timeout.per_request.unit #=> String, one of "ms", "s"
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 #=> Boolean
resp.route.spec.http2_route.match.headers[0].match.exact #=> String
resp.route.spec.http2_route.match.headers[0].match.prefix #=> String
resp.route.spec.http2_route.match.headers[0].match.range.end #=> Integer
resp.route.spec.http2_route.match.headers[0].match.range.start #=> Integer
resp.route.spec.http2_route.match.headers[0].match.regex #=> String
resp.route.spec.http2_route.match.headers[0].match.suffix #=> String
resp.route.spec.http2_route.match.headers[0].name #=> String
resp.route.spec.http2_route.match.method #=> String, one of "CONNECT", "DELETE", "GET", "HEAD", "OPTIONS", "PATCH", "POST", "PUT", "TRACE"
resp.route.spec.http2_route.match.prefix #=> String
resp.route.spec.http2_route.match.scheme #=> String, one of "http", "https"
resp.route.spec.http2_route.retry_policy.http_retry_events #=> Array
resp.route.spec.http2_route.retry_policy.http_retry_events[0] #=> String
resp.route.spec.http2_route.retry_policy.max_retries #=> Integer
resp.route.spec.http2_route.retry_policy.per_retry_timeout.unit #=> String, one of "ms", "s"
resp.route.spec.http2_route.retry_policy.per_retry_timeout.value #=> Integer
resp.route.spec.http2_route.retry_policy.tcp_retry_events #=> Array
resp.route.spec.http2_route.retry_policy.tcp_retry_events[0] #=> String, one of "connection-error"
resp.route.spec.http2_route.timeout.idle.unit #=> String, one of "ms", "s"
resp.route.spec.http2_route.timeout.idle.value #=> Integer
resp.route.spec.http2_route.timeout.per_request.unit #=> String, one of "ms", "s"
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 #=> Boolean
resp.route.spec.http_route.match.headers[0].match.exact #=> String
resp.route.spec.http_route.match.headers[0].match.prefix #=> String
resp.route.spec.http_route.match.headers[0].match.range.end #=> Integer
resp.route.spec.http_route.match.headers[0].match.range.start #=> Integer
resp.route.spec.http_route.match.headers[0].match.regex #=> String
resp.route.spec.http_route.match.headers[0].match.suffix #=> String
resp.route.spec.http_route.match.headers[0].name #=> String
resp.route.spec.http_route.match.method #=> String, one of "CONNECT", "DELETE", "GET", "HEAD", "OPTIONS", "PATCH", "POST", "PUT", "TRACE"
resp.route.spec.http_route.match.prefix #=> String
resp.route.spec.http_route.match.scheme #=> String, one of "http", "https"
resp.route.spec.http_route.retry_policy.http_retry_events #=> Array
resp.route.spec.http_route.retry_policy.http_retry_events[0] #=> String
resp.route.spec.http_route.retry_policy.max_retries #=> Integer
resp.route.spec.http_route.retry_policy.per_retry_timeout.unit #=> String, one of "ms", "s"
resp.route.spec.http_route.retry_policy.per_retry_timeout.value #=> Integer
resp.route.spec.http_route.retry_policy.tcp_retry_events #=> Array
resp.route.spec.http_route.retry_policy.tcp_retry_events[0] #=> String, one of "connection-error"
resp.route.spec.http_route.timeout.idle.unit #=> String, one of "ms", "s"
resp.route.spec.http_route.timeout.idle.value #=> Integer
resp.route.spec.http_route.timeout.per_request.unit #=> String, one of "ms", "s"
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 "ms", "s"
resp.route.spec.tcp_route.timeout.idle.value #=> Integer
resp.route.status.status #=> String, one of "ACTIVE", "DELETED", "INACTIVE"
resp.route.virtual_router_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :mesh_name (required, String)

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

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



1806
1807
1808
1809
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 1806

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

#delete_virtual_gateway(params = {}) ⇒ 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 #=> Boolean
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].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 "grpc", "http", "http2"
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 "grpc", "http", "http2"
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 "DISABLED", "PERMISSIVE", "STRICT"
resp.virtual_gateway.spec.logging.access_log.file.path #=> String
resp.virtual_gateway.status.status #=> String, one of "ACTIVE", "DELETED", "INACTIVE"
resp.virtual_gateway.virtual_gateway_name #=> String

Parameters:

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

    ({})

Options Hash (params):

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



1880
1881
1882
1883
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 1880

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

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

Deletes an existing virtual node.

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

Examples:

Request syntax with placeholder values


resp = client.delete_virtual_node({
  mesh_name: "ResourceName", # required
  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 #=> Boolean
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 #=> Boolean
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].health_check.healthy_threshold #=> Integer
resp.virtual_node.spec.listeners[0].health_check.interval_millis #=> Integer
resp.virtual_node.spec.listeners[0].health_check.path #=> String
resp.virtual_node.spec.listeners[0].health_check.port #=> Integer
resp.virtual_node.spec.listeners[0].health_check.protocol #=> String, one of "grpc", "http", "http2", "tcp"
resp.virtual_node.spec.listeners[0].health_check.timeout_millis #=> Integer
resp.virtual_node.spec.listeners[0].health_check.unhealthy_threshold #=> Integer
resp.virtual_node.spec.listeners[0].port_mapping.port #=> Integer
resp.virtual_node.spec.listeners[0].port_mapping.protocol #=> String, one of "grpc", "http", "http2", "tcp"
resp.virtual_node.spec.listeners[0].timeout.grpc.idle.unit #=> String, one of "ms", "s"
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 "ms", "s"
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 "ms", "s"
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 "ms", "s"
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 "ms", "s"
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 "ms", "s"
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 "ms", "s"
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 "DISABLED", "PERMISSIVE", "STRICT"
resp.virtual_node.spec.logging.access_log.file.path #=> String
resp.virtual_node.spec.service_discovery.aws_cloud_map.attributes #=> Array
resp.virtual_node.spec.service_discovery.aws_cloud_map.attributes[0].key #=> String
resp.virtual_node.spec.service_discovery.aws_cloud_map.attributes[0].value #=> String
resp.virtual_node.spec.service_discovery.aws_cloud_map.namespace_name #=> String
resp.virtual_node.spec.service_discovery.aws_cloud_map.service_name #=> String
resp.virtual_node.spec.service_discovery.dns.hostname #=> String
resp.virtual_node.status.status #=> String, one of "ACTIVE", "DELETED", "INACTIVE"
resp.virtual_node.virtual_node_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :mesh_name (required, String)

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

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



1984
1985
1986
1987
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 1984

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

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

Deletes an existing virtual router.

You must delete any routes associated with the virtual router before you can delete the router itself.

Examples:

Request syntax with placeholder values


resp = client.delete_virtual_router({
  mesh_name: "ResourceName", # required
  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 "grpc", "http", "http2", "tcp"
resp.virtual_router.status.status #=> String, one of "ACTIVE", "DELETED", "INACTIVE"
resp.virtual_router.virtual_router_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :mesh_name (required, String)

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

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



2042
2043
2044
2045
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 2042

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

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

Deletes an existing virtual service.

Examples:

Request syntax with placeholder values


resp = client.delete_virtual_service({
  mesh_name: "ResourceName", # required
  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", "DELETED", "INACTIVE"
resp.virtual_service.virtual_service_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :mesh_name (required, String)

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

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



2096
2097
2098
2099
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 2096

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

#describe_gateway_route(params = {}) ⇒ 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", "DELETED", "INACTIVE"
resp.gateway_route.virtual_gateway_name #=> String

Parameters:

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

    ({})

Options Hash (params):

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



2160
2161
2162
2163
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 2160

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

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

Describes an existing service mesh.

Examples:

Request syntax with placeholder values


resp = client.describe_mesh({
  mesh_name: "ResourceName", # required
  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", "DELETED", "INACTIVE"

Parameters:

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

    ({})

Options Hash (params):

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



2208
2209
2210
2211
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 2208

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

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

Describes an existing route.

Examples:

Request syntax with placeholder values


resp = client.describe_route({
  mesh_name: "ResourceName", # required
  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 #=> Boolean
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 "ms", "s"
resp.route.spec.grpc_route.retry_policy.per_retry_timeout.value #=> Integer
resp.route.spec.grpc_route.retry_policy.tcp_retry_events #=> Array
resp.route.spec.grpc_route.retry_policy.tcp_retry_events[0] #=> String, one of "connection-error"
resp.route.spec.grpc_route.timeout.idle.unit #=> String, one of "ms", "s"
resp.route.spec.grpc_route.timeout.idle.value #=> Integer
resp.route.spec.grpc_route.timeout.per_request.unit #=> String, one of "ms", "s"
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 #=> Boolean
resp.route.spec.http2_route.match.headers[0].match.exact #=> String
resp.route.spec.http2_route.match.headers[0].match.prefix #=> String
resp.route.spec.http2_route.match.headers[0].match.range.end #=> Integer
resp.route.spec.http2_route.match.headers[0].match.range.start #=> Integer
resp.route.spec.http2_route.match.headers[0].match.regex #=> String
resp.route.spec.http2_route.match.headers[0].match.suffix #=> String
resp.route.spec.http2_route.match.headers[0].name #=> String
resp.route.spec.http2_route.match.method #=> String, one of "CONNECT", "DELETE", "GET", "HEAD", "OPTIONS", "PATCH", "POST", "PUT", "TRACE"
resp.route.spec.http2_route.match.prefix #=> String
resp.route.spec.http2_route.match.scheme #=> String, one of "http", "https"
resp.route.spec.http2_route.retry_policy.http_retry_events #=> Array
resp.route.spec.http2_route.retry_policy.http_retry_events[0] #=> String
resp.route.spec.http2_route.retry_policy.max_retries #=> Integer
resp.route.spec.http2_route.retry_policy.per_retry_timeout.unit #=> String, one of "ms", "s"
resp.route.spec.http2_route.retry_policy.per_retry_timeout.value #=> Integer
resp.route.spec.http2_route.retry_policy.tcp_retry_events #=> Array
resp.route.spec.http2_route.retry_policy.tcp_retry_events[0] #=> String, one of "connection-error"
resp.route.spec.http2_route.timeout.idle.unit #=> String, one of "ms", "s"
resp.route.spec.http2_route.timeout.idle.value #=> Integer
resp.route.spec.http2_route.timeout.per_request.unit #=> String, one of "ms", "s"
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 #=> Boolean
resp.route.spec.http_route.match.headers[0].match.exact #=> String
resp.route.spec.http_route.match.headers[0].match.prefix #=> String
resp.route.spec.http_route.match.headers[0].match.range.end #=> Integer
resp.route.spec.http_route.match.headers[0].match.range.start #=> Integer
resp.route.spec.http_route.match.headers[0].match.regex #=> String
resp.route.spec.http_route.match.headers[0].match.suffix #=> String
resp.route.spec.http_route.match.headers[0].name #=> String
resp.route.spec.http_route.match.method #=> String, one of "CONNECT", "DELETE", "GET", "HEAD", "OPTIONS", "PATCH", "POST", "PUT", "TRACE"
resp.route.spec.http_route.match.prefix #=> String
resp.route.spec.http_route.match.scheme #=> String, one of "http", "https"
resp.route.spec.http_route.retry_policy.http_retry_events #=> Array
resp.route.spec.http_route.retry_policy.http_retry_events[0] #=> String
resp.route.spec.http_route.retry_policy.max_retries #=> Integer
resp.route.spec.http_route.retry_policy.per_retry_timeout.unit #=> String, one of "ms", "s"
resp.route.spec.http_route.retry_policy.per_retry_timeout.value #=> Integer
resp.route.spec.http_route.retry_policy.tcp_retry_events #=> Array
resp.route.spec.http_route.retry_policy.tcp_retry_events[0] #=> String, one of "connection-error"
resp.route.spec.http_route.timeout.idle.unit #=> String, one of "ms", "s"
resp.route.spec.http_route.timeout.idle.value #=> Integer
resp.route.spec.http_route.timeout.per_request.unit #=> String, one of "ms", "s"
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 "ms", "s"
resp.route.spec.tcp_route.timeout.idle.value #=> Integer
resp.route.status.status #=> String, one of "ACTIVE", "DELETED", "INACTIVE"
resp.route.virtual_router_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :mesh_name (required, String)

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

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



2350
2351
2352
2353
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 2350

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

#describe_virtual_gateway(params = {}) ⇒ 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 #=> Boolean
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].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 "grpc", "http", "http2"
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 "grpc", "http", "http2"
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 "DISABLED", "PERMISSIVE", "STRICT"
resp.virtual_gateway.spec.logging.access_log.file.path #=> String
resp.virtual_gateway.status.status #=> String, one of "ACTIVE", "DELETED", "INACTIVE"
resp.virtual_gateway.virtual_gateway_name #=> String

Parameters:

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

    ({})

Options Hash (params):

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



2423
2424
2425
2426
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 2423

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

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

Describes an existing virtual node.

Examples:

Request syntax with placeholder values


resp = client.describe_virtual_node({
  mesh_name: "ResourceName", # required
  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 #=> Boolean
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 #=> Boolean
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].health_check.healthy_threshold #=> Integer
resp.virtual_node.spec.listeners[0].health_check.interval_millis #=> Integer
resp.virtual_node.spec.listeners[0].health_check.path #=> String
resp.virtual_node.spec.listeners[0].health_check.port #=> Integer
resp.virtual_node.spec.listeners[0].health_check.protocol #=> String, one of "grpc", "http", "http2", "tcp"
resp.virtual_node.spec.listeners[0].health_check.timeout_millis #=> Integer
resp.virtual_node.spec.listeners[0].health_check.unhealthy_threshold #=> Integer
resp.virtual_node.spec.listeners[0].port_mapping.port #=> Integer
resp.virtual_node.spec.listeners[0].port_mapping.protocol #=> String, one of "grpc", "http", "http2", "tcp"
resp.virtual_node.spec.listeners[0].timeout.grpc.idle.unit #=> String, one of "ms", "s"
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 "ms", "s"
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 "ms", "s"
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 "ms", "s"
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 "ms", "s"
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 "ms", "s"
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 "ms", "s"
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 "DISABLED", "PERMISSIVE", "STRICT"
resp.virtual_node.spec.logging.access_log.file.path #=> String
resp.virtual_node.spec.service_discovery.aws_cloud_map.attributes #=> Array
resp.virtual_node.spec.service_discovery.aws_cloud_map.attributes[0].key #=> String
resp.virtual_node.spec.service_discovery.aws_cloud_map.attributes[0].value #=> String
resp.virtual_node.spec.service_discovery.aws_cloud_map.namespace_name #=> String
resp.virtual_node.spec.service_discovery.aws_cloud_map.service_name #=> String
resp.virtual_node.spec.service_discovery.dns.hostname #=> String
resp.virtual_node.status.status #=> String, one of "ACTIVE", "DELETED", "INACTIVE"
resp.virtual_node.virtual_node_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :mesh_name (required, String)

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

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



2524
2525
2526
2527
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 2524

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

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

Describes an existing virtual router.

Examples:

Request syntax with placeholder values


resp = client.describe_virtual_router({
  mesh_name: "ResourceName", # required
  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 "grpc", "http", "http2", "tcp"
resp.virtual_router.status.status #=> String, one of "ACTIVE", "DELETED", "INACTIVE"
resp.virtual_router.virtual_router_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :mesh_name (required, String)

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

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



2579
2580
2581
2582
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 2579

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

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

Describes an existing virtual service.

Examples:

Request syntax with placeholder values


resp = client.describe_virtual_service({
  mesh_name: "ResourceName", # required
  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", "DELETED", "INACTIVE"
resp.virtual_service.virtual_service_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :mesh_name (required, String)

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

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



2633
2634
2635
2636
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 2633

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

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

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

Parameters:

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

    ({})

Options Hash (params):

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



2708
2709
2710
2711
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 2708

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

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

Returns a list of existing service meshes.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

Parameters:

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

    ({})

Options Hash (params):

  • :limit (Integer)

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

  • :next_token (String)

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

    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:



2767
2768
2769
2770
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 2767

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

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

Returns a list of existing routes in a service mesh.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

Parameters:

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

    ({})

Options Hash (params):

  • :limit (Integer)

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

  • :mesh_name (required, String)

    The name of the service mesh to list routes in.

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



2841
2842
2843
2844
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 2841

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

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

List the tags for an App Mesh resource.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :limit (Integer)

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

  • :next_token (String)

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

  • :resource_arn (required, String)

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

Returns:

See Also:



2894
2895
2896
2897
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 2894

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

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

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

Parameters:

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

    ({})

Options Hash (params):

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



2963
2964
2965
2966
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 2963

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

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

Returns a list of existing virtual nodes.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

Parameters:

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

    ({})

Options Hash (params):

  • :limit (Integer)

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

  • :mesh_name (required, String)

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

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



3032
3033
3034
3035
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 3032

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

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

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

Parameters:

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

    ({})

Options Hash (params):

  • :limit (Integer)

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

  • :mesh_name (required, String)

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

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



3101
3102
3103
3104
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 3101

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

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

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

Parameters:

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

    ({})

Options Hash (params):

  • :limit (Integer)

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

  • :mesh_name (required, String)

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

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



3170
3171
3172
3173
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 3170

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

#tag_resource(params = {}) ⇒ Struct

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are also deleted.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)

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

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

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



3206
3207
3208
3209
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 3206

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

#untag_resource(params = {}) ⇒ Struct

Deletes specified tags from a resource.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)

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

  • :tag_keys (required, Array<String>)

    The keys of the tags to be removed.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



3232
3233
3234
3235
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 3232

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

#update_gateway_route(params = {}) ⇒ 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", "DELETED", "INACTIVE"
resp.gateway_route.virtual_gateway_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String)

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

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

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



3348
3349
3350
3351
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 3348

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

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

Updates an existing service mesh.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String)

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

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

  • :mesh_name (required, String)

    The name of the service mesh to update.

  • :spec (Types::MeshSpec)

    The service mesh specification to apply.

Returns:

See Also:



3402
3403
3404
3405
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 3402

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

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

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

Examples:

Request syntax with placeholder values


resp = client.update_route({
  client_token: "String",
  mesh_name: "ResourceName", # required
  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: "ms", # accepts ms, s
          value: 1,
        },
        tcp_retry_events: ["connection-error"], # accepts connection-error
      },
      timeout: {
        idle: {
          unit: "ms", # accepts ms, s
          value: 1,
        },
        per_request: {
          unit: "ms", # accepts ms, s
          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: "CONNECT", # accepts CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, TRACE
        prefix: "String", # required
        scheme: "http", # accepts http, https
      },
      retry_policy: {
        http_retry_events: ["HttpRetryPolicyEvent"],
        max_retries: 1, # required
        per_retry_timeout: { # required
          unit: "ms", # accepts ms, s
          value: 1,
        },
        tcp_retry_events: ["connection-error"], # accepts connection-error
      },
      timeout: {
        idle: {
          unit: "ms", # accepts ms, s
          value: 1,
        },
        per_request: {
          unit: "ms", # accepts ms, s
          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: "CONNECT", # accepts CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, TRACE
        prefix: "String", # required
        scheme: "http", # accepts http, https
      },
      retry_policy: {
        http_retry_events: ["HttpRetryPolicyEvent"],
        max_retries: 1, # required
        per_retry_timeout: { # required
          unit: "ms", # accepts ms, s
          value: 1,
        },
        tcp_retry_events: ["connection-error"], # accepts connection-error
      },
      timeout: {
        idle: {
          unit: "ms", # accepts ms, s
          value: 1,
        },
        per_request: {
          unit: "ms", # accepts ms, s
          value: 1,
        },
      },
    },
    priority: 1,
    tcp_route: {
      action: { # required
        weighted_targets: [ # required
          {
            virtual_node: "ResourceName", # required
            weight: 1, # required
          },
        ],
      },
      timeout: {
        idle: {
          unit: "ms", # accepts ms, s
          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 #=> Boolean
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 "ms", "s"
resp.route.spec.grpc_route.retry_policy.per_retry_timeout.value #=> Integer
resp.route.spec.grpc_route.retry_policy.tcp_retry_events #=> Array
resp.route.spec.grpc_route.retry_policy.tcp_retry_events[0] #=> String, one of "connection-error"
resp.route.spec.grpc_route.timeout.idle.unit #=> String, one of "ms", "s"
resp.route.spec.grpc_route.timeout.idle.value #=> Integer
resp.route.spec.grpc_route.timeout.per_request.unit #=> String, one of "ms", "s"
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 #=> Boolean
resp.route.spec.http2_route.match.headers[0].match.exact #=> String
resp.route.spec.http2_route.match.headers[0].match.prefix #=> String
resp.route.spec.http2_route.match.headers[0].match.range.end #=> Integer
resp.route.spec.http2_route.match.headers[0].match.range.start #=> Integer
resp.route.spec.http2_route.match.headers[0].match.regex #=> String
resp.route.spec.http2_route.match.headers[0].match.suffix #=> String
resp.route.spec.http2_route.match.headers[0].name #=> String
resp.route.spec.http2_route.match.method #=> String, one of "CONNECT", "DELETE", "GET", "HEAD", "OPTIONS", "PATCH", "POST", "PUT", "TRACE"
resp.route.spec.http2_route.match.prefix #=> String
resp.route.spec.http2_route.match.scheme #=> String, one of "http", "https"
resp.route.spec.http2_route.retry_policy.http_retry_events #=> Array
resp.route.spec.http2_route.retry_policy.http_retry_events[0] #=> String
resp.route.spec.http2_route.retry_policy.max_retries #=> Integer
resp.route.spec.http2_route.retry_policy.per_retry_timeout.unit #=> String, one of "ms", "s"
resp.route.spec.http2_route.retry_policy.per_retry_timeout.value #=> Integer
resp.route.spec.http2_route.retry_policy.tcp_retry_events #=> Array
resp.route.spec.http2_route.retry_policy.tcp_retry_events[0] #=> String, one of "connection-error"
resp.route.spec.http2_route.timeout.idle.unit #=> String, one of "ms", "s"
resp.route.spec.http2_route.timeout.idle.value #=> Integer
resp.route.spec.http2_route.timeout.per_request.unit #=> String, one of "ms", "s"
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 #=> Boolean
resp.route.spec.http_route.match.headers[0].match.exact #=> String
resp.route.spec.http_route.match.headers[0].match.prefix #=> String
resp.route.spec.http_route.match.headers[0].match.range.end #=> Integer
resp.route.spec.http_route.match.headers[0].match.range.start #=> Integer
resp.route.spec.http_route.match.headers[0].match.regex #=> String
resp.route.spec.http_route.match.headers[0].match.suffix #=> String
resp.route.spec.http_route.match.headers[0].name #=> String
resp.route.spec.http_route.match.method #=> String, one of "CONNECT", "DELETE", "GET", "HEAD", "OPTIONS", "PATCH", "POST", "PUT", "TRACE"
resp.route.spec.http_route.match.prefix #=> String
resp.route.spec.http_route.match.scheme #=> String, one of "http", "https"
resp.route.spec.http_route.retry_policy.http_retry_events #=> Array
resp.route.spec.http_route.retry_policy.http_retry_events[0] #=> String
resp.route.spec.http_route.retry_policy.max_retries #=> Integer
resp.route.spec.http_route.retry_policy.per_retry_timeout.unit #=> String, one of "ms", "s"
resp.route.spec.http_route.retry_policy.per_retry_timeout.value #=> Integer
resp.route.spec.http_route.retry_policy.tcp_retry_events #=> Array
resp.route.spec.http_route.retry_policy.tcp_retry_events[0] #=> String, one of "connection-error"
resp.route.spec.http_route.timeout.idle.unit #=> String, one of "ms", "s"
resp.route.spec.http_route.timeout.idle.value #=> Integer
resp.route.spec.http_route.timeout.per_request.unit #=> String, one of "ms", "s"
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 "ms", "s"
resp.route.spec.tcp_route.timeout.idle.value #=> Integer
resp.route.status.status #=> String, one of "ACTIVE", "DELETED", "INACTIVE"
resp.route.virtual_router_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String)

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

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

  • :mesh_name (required, String)

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

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



3727
3728
3729
3730
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 3727

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

#update_virtual_gateway(params = {}) ⇒ 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
      {
        health_check: {
          healthy_threshold: 1, # required
          interval_millis: 1, # required
          path: "String",
          port: 1,
          protocol: "grpc", # required, accepts grpc, http, http2
          timeout_millis: 1, # required
          unhealthy_threshold: 1, # required
        },
        port_mapping: { # required
          port: 1, # required
          protocol: "grpc", # required, accepts grpc, http, http2
        },
        tls: {
          certificate: { # required
            acm: {
              certificate_arn: "Arn", # required
            },
            file: {
              certificate_chain: "FilePath", # required
              private_key: "FilePath", # required
            },
          },
          mode: "DISABLED", # required, accepts DISABLED, PERMISSIVE, STRICT
        },
      },
    ],
    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 #=> Boolean
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].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 "grpc", "http", "http2"
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 "grpc", "http", "http2"
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 "DISABLED", "PERMISSIVE", "STRICT"
resp.virtual_gateway.spec.logging.access_log.file.path #=> String
resp.virtual_gateway.status.status #=> String, one of "ACTIVE", "DELETED", "INACTIVE"
resp.virtual_gateway.virtual_gateway_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String)

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

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

  • :mesh_name (required, String)

    The name of the service mesh that the virtual 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:



3869
3870
3871
3872
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 3869

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

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

Updates an existing virtual node in a specified service mesh.

Examples:

Request syntax with placeholder values


resp = client.update_virtual_node({
  client_token: "String",
  mesh_name: "ResourceName", # required
  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: [
      {
        health_check: {
          healthy_threshold: 1, # required
          interval_millis: 1, # required
          path: "String",
          port: 1,
          protocol: "grpc", # required, accepts grpc, http, http2, tcp
          timeout_millis: 1, # required
          unhealthy_threshold: 1, # required
        },
        port_mapping: { # required
          port: 1, # required
          protocol: "grpc", # required, accepts grpc, http, http2, tcp
        },
        timeout: {
          grpc: {
            idle: {
              unit: "ms", # accepts ms, s
              value: 1,
            },
            per_request: {
              unit: "ms", # accepts ms, s
              value: 1,
            },
          },
          http: {
            idle: {
              unit: "ms", # accepts ms, s
              value: 1,
            },
            per_request: {
              unit: "ms", # accepts ms, s
              value: 1,
            },
          },
          http2: {
            idle: {
              unit: "ms", # accepts ms, s
              value: 1,
            },
            per_request: {
              unit: "ms", # accepts ms, s
              value: 1,
            },
          },
          tcp: {
            idle: {
              unit: "ms", # accepts ms, s
              value: 1,
            },
          },
        },
        tls: {
          certificate: { # required
            acm: {
              certificate_arn: "Arn", # required
            },
            file: {
              certificate_chain: "FilePath", # required
              private_key: "FilePath", # required
            },
          },
          mode: "DISABLED", # required, accepts DISABLED, PERMISSIVE, STRICT
        },
      },
    ],
    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 #=> Boolean
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 #=> Boolean
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].health_check.healthy_threshold #=> Integer
resp.virtual_node.spec.listeners[0].health_check.interval_millis #=> Integer
resp.virtual_node.spec.listeners[0].health_check.path #=> String
resp.virtual_node.spec.listeners[0].health_check.port #=> Integer
resp.virtual_node.spec.listeners[0].health_check.protocol #=> String, one of "grpc", "http", "http2", "tcp"
resp.virtual_node.spec.listeners[0].health_check.timeout_millis #=> Integer
resp.virtual_node.spec.listeners[0].health_check.unhealthy_threshold #=> Integer
resp.virtual_node.spec.listeners[0].port_mapping.port #=> Integer
resp.virtual_node.spec.listeners[0].port_mapping.protocol #=> String, one of "grpc", "http", "http2", "tcp"
resp.virtual_node.spec.listeners[0].timeout.grpc.idle.unit #=> String, one of "ms", "s"
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 "ms", "s"
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 "ms", "s"
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 "ms", "s"
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 "ms", "s"
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 "ms", "s"
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 "ms", "s"
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 "DISABLED", "PERMISSIVE", "STRICT"
resp.virtual_node.spec.logging.access_log.file.path #=> String
resp.virtual_node.spec.service_discovery.aws_cloud_map.attributes #=> Array
resp.virtual_node.spec.service_discovery.aws_cloud_map.attributes[0].key #=> String
resp.virtual_node.spec.service_discovery.aws_cloud_map.attributes[0].value #=> String
resp.virtual_node.spec.service_discovery.aws_cloud_map.namespace_name #=> String
resp.virtual_node.spec.service_discovery.aws_cloud_map.service_name #=> String
resp.virtual_node.spec.service_discovery.dns.hostname #=> String
resp.virtual_node.status.status #=> String, one of "ACTIVE", "DELETED", "INACTIVE"
resp.virtual_node.virtual_node_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String)

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

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

  • :mesh_name (required, String)

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

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



4115
4116
4117
4118
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 4115

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

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

Updates an existing virtual router in a specified service mesh.

Examples:

Request syntax with placeholder values


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

Response structure


resp.virtual_router.mesh_name #=> String
resp.virtual_router..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 "grpc", "http", "http2", "tcp"
resp.virtual_router.status.status #=> String, one of "ACTIVE", "DELETED", "INACTIVE"
resp.virtual_router.virtual_router_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String)

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

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

  • :mesh_name (required, String)

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

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



4193
4194
4195
4196
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 4193

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

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

Updates an existing virtual service in a specified service mesh.

Examples:

Request syntax with placeholder values


resp = client.update_virtual_service({
  client_token: "String",
  mesh_name: "ResourceName", # required
  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", "DELETED", "INACTIVE"
resp.virtual_service.virtual_service_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String)

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

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

  • :mesh_name (required, String)

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

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



4270
4271
4272
4273
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 4270

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