Class: Aws::AppMesh::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::AppMesh::Client
- 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
API Operations collapse
-
#create_gateway_route(params = {}) ⇒ Types::CreateGatewayRouteOutput
Creates a gateway route.
-
#create_mesh(params = {}) ⇒ Types::CreateMeshOutput
Creates a service mesh.
-
#create_route(params = {}) ⇒ Types::CreateRouteOutput
Creates a route that is associated with a virtual router.
-
#create_virtual_gateway(params = {}) ⇒ Types::CreateVirtualGatewayOutput
Creates a virtual gateway.
-
#create_virtual_node(params = {}) ⇒ Types::CreateVirtualNodeOutput
Creates a virtual node within a service mesh.
-
#create_virtual_router(params = {}) ⇒ Types::CreateVirtualRouterOutput
Creates a virtual router within a service mesh.
-
#create_virtual_service(params = {}) ⇒ Types::CreateVirtualServiceOutput
Creates a virtual service within a service mesh.
-
#delete_gateway_route(params = {}) ⇒ Types::DeleteGatewayRouteOutput
Deletes an existing gateway route.
-
#delete_mesh(params = {}) ⇒ Types::DeleteMeshOutput
Deletes an existing service mesh.
-
#delete_route(params = {}) ⇒ Types::DeleteRouteOutput
Deletes an existing route.
-
#delete_virtual_gateway(params = {}) ⇒ Types::DeleteVirtualGatewayOutput
Deletes an existing virtual gateway.
-
#delete_virtual_node(params = {}) ⇒ Types::DeleteVirtualNodeOutput
Deletes an existing virtual node.
-
#delete_virtual_router(params = {}) ⇒ Types::DeleteVirtualRouterOutput
Deletes an existing virtual router.
-
#delete_virtual_service(params = {}) ⇒ Types::DeleteVirtualServiceOutput
Deletes an existing virtual service.
-
#describe_gateway_route(params = {}) ⇒ Types::DescribeGatewayRouteOutput
Describes an existing gateway route.
-
#describe_mesh(params = {}) ⇒ Types::DescribeMeshOutput
Describes an existing service mesh.
-
#describe_route(params = {}) ⇒ Types::DescribeRouteOutput
Describes an existing route.
-
#describe_virtual_gateway(params = {}) ⇒ Types::DescribeVirtualGatewayOutput
Describes an existing virtual gateway.
-
#describe_virtual_node(params = {}) ⇒ Types::DescribeVirtualNodeOutput
Describes an existing virtual node.
-
#describe_virtual_router(params = {}) ⇒ Types::DescribeVirtualRouterOutput
Describes an existing virtual router.
-
#describe_virtual_service(params = {}) ⇒ Types::DescribeVirtualServiceOutput
Describes an existing virtual service.
-
#list_gateway_routes(params = {}) ⇒ Types::ListGatewayRoutesOutput
Returns a list of existing gateway routes that are associated to a virtual gateway.
-
#list_meshes(params = {}) ⇒ Types::ListMeshesOutput
Returns a list of existing service meshes.
-
#list_routes(params = {}) ⇒ Types::ListRoutesOutput
Returns a list of existing routes in a service mesh.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
List the tags for an App Mesh resource.
-
#list_virtual_gateways(params = {}) ⇒ Types::ListVirtualGatewaysOutput
Returns a list of existing virtual gateways in a service mesh.
-
#list_virtual_nodes(params = {}) ⇒ Types::ListVirtualNodesOutput
Returns a list of existing virtual nodes.
-
#list_virtual_routers(params = {}) ⇒ Types::ListVirtualRoutersOutput
Returns a list of existing virtual routers in a service mesh.
-
#list_virtual_services(params = {}) ⇒ Types::ListVirtualServicesOutput
Returns a list of existing virtual services in a service mesh.
-
#tag_resource(params = {}) ⇒ Struct
Associates the specified tags to a resource with the specified
resourceArn
. -
#untag_resource(params = {}) ⇒ Struct
Deletes specified tags from a resource.
-
#update_gateway_route(params = {}) ⇒ Types::UpdateGatewayRouteOutput
Updates an existing gateway route that is associated to a specified virtual gateway in a service mesh.
-
#update_mesh(params = {}) ⇒ Types::UpdateMeshOutput
Updates an existing service mesh.
-
#update_route(params = {}) ⇒ Types::UpdateRouteOutput
Updates an existing route for a specified service mesh and virtual router.
-
#update_virtual_gateway(params = {}) ⇒ Types::UpdateVirtualGatewayOutput
Updates an existing virtual gateway in a specified service mesh.
-
#update_virtual_node(params = {}) ⇒ Types::UpdateVirtualNodeOutput
Updates an existing virtual node in a specified service mesh.
-
#update_virtual_router(params = {}) ⇒ Types::UpdateVirtualRouterOutput
Updates an existing virtual router in a specified service mesh.
-
#update_virtual_service(params = {}) ⇒ Types::UpdateVirtualServiceOutput
Updates an existing virtual service in a specified service mesh.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
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):
-
:plugins
(Array<Seahorse::Client::Plugin>)
— default:
[]]
—
A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.
-
: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 fromaws 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
,:session_token
, and:account_id
options. - ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID']
~/.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::InstanceProfileCredentials
orAws::ECSCredentials
to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
-
: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)
- :account_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 tofalse
. -
: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 aRetryCapacityNotAvailableError
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. -
:defaults_mode
(String)
— default:
"legacy"
—
See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.
-
:disable_host_prefix_injection
(Boolean)
— default:
false
—
Set to true to disable SDK automatically adding host prefix to default service endpoint when available.
-
:disable_request_compression
(Boolean)
— default:
false
—
When set to 'true' the request body will not be compressed for supported operations.
-
:endpoint
(String, URI::HTTPS, URI::HTTP)
—
Normally you should not configure the
:endpoint
option directly. This is normally constructed from the:region
option. Configuring:endpoint
is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:'http://example.com' 'https://example.com' 'http://example.com:123'
-
: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. -
:ignore_configured_endpoint_urls
(Boolean)
—
Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.
-
: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
andadaptive
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.
-
:request_min_compression_size_bytes
(Integer)
— default:
10240
—
The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.
-
: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 ofstandard
mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.
-
:sdk_ua_app_id
(String)
—
A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.
- :secret_access_key (String)
- :session_token (String)
-
:sigv4a_signing_region_set
(Array)
—
A list of regions that should be signed with SigV4a signing. When not passed, a default
:sigv4a_signing_region_set
is searched for in the following locations:Aws.config[:sigv4a_signing_region_set]
ENV['AWS_SIGV4A_SIGNING_REGION_SET']
~/.aws/config
-
: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.
-
:telemetry_provider
(Aws::Telemetry::TelemetryProviderBase)
— default:
Aws::Telemetry::NoOpTelemetryProvider
—
Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses
NoOpTelemetryProvider
which will not record or emit any telemetry data. The SDK supports the following telemetry providers:- OpenTelemetry (OTel) - To use the OTel provider, install and require the
opentelemetry-sdk
gem and then, pass in an instance of aAws::Telemetry::OTelProvider
for telemetry provider.
- OpenTelemetry (OTel) - To use the OTel provider, install and require the
-
:token_provider
(Aws::TokenProvider)
—
A Bearer Token Provider. This can be an instance of any one of the following classes:
Aws::StaticTokenProvider
- Used for configuring static, non-refreshing tokens.Aws::SSOTokenProvider
- Used for loading tokens from AWS SSO using an access token generated fromaws login
.
When
:token_provider
is not configured directly, theAws::TokenProviderChain
will be used to search for tokens configured for your profile in shared configuration files. -
:use_dualstack_endpoint
(Boolean)
—
When set to
true
, dualstack enabled endpoints (with.aws
TLD) will be used if available. -
:use_fips_endpoint
(Boolean)
—
When set to
true
, fips compatible endpoints will be used if available. When afips
region is used, the region is normalized and this config is set totrue
. -
:validate_params
(Boolean)
— default:
true
—
When
true
, request parameters are validated before sending the request. -
:endpoint_provider
(Aws::AppMesh::EndpointProvider)
—
The endpoint provider used to resolve endpoints. Any object that responds to
#resolve_endpoint(parameters)
whereparameters
is a Struct similar toAws::AppMesh::EndpointParameters
. -
: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_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_open_timeout
(Float)
— default:
15
—
The default number of seconds to wait for response data. This value can safely be set per-request on the session.
-
:http_proxy
(URI::HTTP, String)
—
A proxy to send requests through. Formatted like 'http://proxy.com:123'.
-
:http_read_timeout
(Float)
— default:
60
—
The default number of seconds to wait for response data. 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
. -
:on_chunk_received
(Proc)
—
When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a
content-length
). -
:on_chunk_sent
(Proc)
—
When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.
-
:raise_response_errors
(Boolean)
— default:
true
—
When
true
, response errors are raised. -
: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. -
:ssl_ca_store
(String)
—
Sets the X509::Store to verify peer certificate.
-
:ssl_cert
(OpenSSL::X509::Certificate)
—
Sets a client certificate when creating http connections.
-
:ssl_key
(OpenSSL::PKey)
—
Sets a client key when creating http connections.
-
:ssl_timeout
(Float)
—
Sets the SSL timeout in seconds
-
:ssl_verify_peer
(Boolean)
— default:
true
—
When
true
, SSL peer certificates are verified when establishing a connection.
444 445 446 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 444 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
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
rewrite: {
hostname: {
default_target_hostname: "ENABLED", # accepts ENABLED, DISABLED
},
},
target: { # required
port: 1,
virtual_service: { # required
virtual_service_name: "ResourceName", # required
},
},
},
match: { # required
hostname: {
exact: "ExactHostName",
suffix: "SuffixHostname",
},
metadata: [
{
invert: false,
match: {
exact: "HeaderMatch",
prefix: "HeaderMatch",
range: {
end: 1, # required
start: 1, # required
},
regex: "HeaderMatch",
suffix: "HeaderMatch",
},
name: "HeaderName", # required
},
],
port: 1,
service_name: "ServiceName",
},
},
http2_route: {
action: { # required
rewrite: {
hostname: {
default_target_hostname: "ENABLED", # accepts ENABLED, DISABLED
},
path: {
exact: "HttpPathExact",
},
prefix: {
default_prefix: "ENABLED", # accepts ENABLED, DISABLED
value: "HttpGatewayRoutePrefix",
},
},
target: { # required
port: 1,
virtual_service: { # required
virtual_service_name: "ResourceName", # 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
},
],
hostname: {
exact: "ExactHostName",
suffix: "SuffixHostname",
},
method: "GET", # accepts GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE, PATCH
path: {
exact: "HttpPathExact",
regex: "HttpPathRegex",
},
port: 1,
prefix: "String",
query_parameters: [
{
match: {
exact: "String",
},
name: "QueryParameterName", # required
},
],
},
},
http_route: {
action: { # required
rewrite: {
hostname: {
default_target_hostname: "ENABLED", # accepts ENABLED, DISABLED
},
path: {
exact: "HttpPathExact",
},
prefix: {
default_prefix: "ENABLED", # accepts ENABLED, DISABLED
value: "HttpGatewayRoutePrefix",
},
},
target: { # required
port: 1,
virtual_service: { # required
virtual_service_name: "ResourceName", # 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
},
],
hostname: {
exact: "ExactHostName",
suffix: "SuffixHostname",
},
method: "GET", # accepts GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE, PATCH
path: {
exact: "HttpPathExact",
regex: "HttpPathRegex",
},
port: 1,
prefix: "String",
query_parameters: [
{
match: {
exact: "String",
},
name: "QueryParameterName", # required
},
],
},
},
priority: 1,
},
tags: [
{
key: "TagKey", # required
value: "TagValue", # required
},
],
virtual_gateway_name: "ResourceName", # required
})
Response structure
Response structure
resp.gateway_route.gateway_route_name #=> String
resp.gateway_route.mesh_name #=> String
resp.gateway_route.metadata.arn #=> String
resp.gateway_route.metadata.created_at #=> Time
resp.gateway_route.metadata.last_updated_at #=> Time
resp.gateway_route.metadata.mesh_owner #=> String
resp.gateway_route.metadata.resource_owner #=> String
resp.gateway_route.metadata.uid #=> String
resp.gateway_route.metadata.version #=> Integer
resp.gateway_route.spec.grpc_route.action.rewrite.hostname.default_target_hostname #=> String, one of "ENABLED", "DISABLED"
resp.gateway_route.spec.grpc_route.action.target.port #=> Integer
resp.gateway_route.spec.grpc_route.action.target.virtual_service.virtual_service_name #=> String
resp.gateway_route.spec.grpc_route.match.hostname.exact #=> String
resp.gateway_route.spec.grpc_route.match.hostname.suffix #=> String
resp.gateway_route.spec.grpc_route.match.metadata #=> Array
resp.gateway_route.spec.grpc_route.match.metadata[0].invert #=> Boolean
resp.gateway_route.spec.grpc_route.match.metadata[0].match.exact #=> String
resp.gateway_route.spec.grpc_route.match.metadata[0].match.prefix #=> String
resp.gateway_route.spec.grpc_route.match.metadata[0].match.range.end #=> Integer
resp.gateway_route.spec.grpc_route.match.metadata[0].match.range.start #=> Integer
resp.gateway_route.spec.grpc_route.match.metadata[0].match.regex #=> String
resp.gateway_route.spec.grpc_route.match.metadata[0].match.suffix #=> String
resp.gateway_route.spec.grpc_route.match.metadata[0].name #=> String
resp.gateway_route.spec.grpc_route.match.port #=> Integer
resp.gateway_route.spec.grpc_route.match.service_name #=> String
resp.gateway_route.spec.http2_route.action.rewrite.hostname.default_target_hostname #=> String, one of "ENABLED", "DISABLED"
resp.gateway_route.spec.http2_route.action.rewrite.path.exact #=> String
resp.gateway_route.spec.http2_route.action.rewrite.prefix.default_prefix #=> String, one of "ENABLED", "DISABLED"
resp.gateway_route.spec.http2_route.action.rewrite.prefix.value #=> String
resp.gateway_route.spec.http2_route.action.target.port #=> Integer
resp.gateway_route.spec.http2_route.action.target.virtual_service.virtual_service_name #=> String
resp.gateway_route.spec.http2_route.match.headers #=> Array
resp.gateway_route.spec.http2_route.match.headers[0].invert #=> Boolean
resp.gateway_route.spec.http2_route.match.headers[0].match.exact #=> String
resp.gateway_route.spec.http2_route.match.headers[0].match.prefix #=> String
resp.gateway_route.spec.http2_route.match.headers[0].match.range.end #=> Integer
resp.gateway_route.spec.http2_route.match.headers[0].match.range.start #=> Integer
resp.gateway_route.spec.http2_route.match.headers[0].match.regex #=> String
resp.gateway_route.spec.http2_route.match.headers[0].match.suffix #=> String
resp.gateway_route.spec.http2_route.match.headers[0].name #=> String
resp.gateway_route.spec.http2_route.match.hostname.exact #=> String
resp.gateway_route.spec.http2_route.match.hostname.suffix #=> String
resp.gateway_route.spec.http2_route.match.method #=> String, one of "GET", "HEAD", "POST", "PUT", "DELETE", "CONNECT", "OPTIONS", "TRACE", "PATCH"
resp.gateway_route.spec.http2_route.match.path.exact #=> String
resp.gateway_route.spec.http2_route.match.path.regex #=> String
resp.gateway_route.spec.http2_route.match.port #=> Integer
resp.gateway_route.spec.http2_route.match.prefix #=> String
resp.gateway_route.spec.http2_route.match.query_parameters #=> Array
resp.gateway_route.spec.http2_route.match.query_parameters[0].match.exact #=> String
resp.gateway_route.spec.http2_route.match.query_parameters[0].name #=> String
resp.gateway_route.spec.http_route.action.rewrite.hostname.default_target_hostname #=> String, one of "ENABLED", "DISABLED"
resp.gateway_route.spec.http_route.action.rewrite.path.exact #=> String
resp.gateway_route.spec.http_route.action.rewrite.prefix.default_prefix #=> String, one of "ENABLED", "DISABLED"
resp.gateway_route.spec.http_route.action.rewrite.prefix.value #=> String
resp.gateway_route.spec.http_route.action.target.port #=> Integer
resp.gateway_route.spec.http_route.action.target.virtual_service.virtual_service_name #=> String
resp.gateway_route.spec.http_route.match.headers #=> Array
resp.gateway_route.spec.http_route.match.headers[0].invert #=> Boolean
resp.gateway_route.spec.http_route.match.headers[0].match.exact #=> String
resp.gateway_route.spec.http_route.match.headers[0].match.prefix #=> String
resp.gateway_route.spec.http_route.match.headers[0].match.range.end #=> Integer
resp.gateway_route.spec.http_route.match.headers[0].match.range.start #=> Integer
resp.gateway_route.spec.http_route.match.headers[0].match.regex #=> String
resp.gateway_route.spec.http_route.match.headers[0].match.suffix #=> String
resp.gateway_route.spec.http_route.match.headers[0].name #=> String
resp.gateway_route.spec.http_route.match.hostname.exact #=> String
resp.gateway_route.spec.http_route.match.hostname.suffix #=> String
resp.gateway_route.spec.http_route.match.method #=> String, one of "GET", "HEAD", "POST", "PUT", "DELETE", "CONNECT", "OPTIONS", "TRACE", "PATCH"
resp.gateway_route.spec.http_route.match.path.exact #=> String
resp.gateway_route.spec.http_route.match.path.regex #=> String
resp.gateway_route.spec.http_route.match.port #=> Integer
resp.gateway_route.spec.http_route.match.prefix #=> String
resp.gateway_route.spec.http_route.match.query_parameters #=> Array
resp.gateway_route.spec.http_route.match.query_parameters[0].match.exact #=> String
resp.gateway_route.spec.http_route.match.query_parameters[0].name #=> String
resp.gateway_route.spec.priority #=> Integer
resp.gateway_route.status.status #=> String, one of "ACTIVE", "INACTIVE", "DELETED"
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 Amazon Web Services 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:
-
(Types::CreateGatewayRouteOutput)
—
Returns a response object which responds to the following methods:
- #gateway_route => Types::GatewayRouteData
See Also:
767 768 769 770 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 767 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
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
},
service_discovery: {
ip_preference: "IPv6_PREFERRED", # accepts IPv6_PREFERRED, IPv4_PREFERRED, IPv4_ONLY, IPv6_ONLY
},
},
tags: [
{
key: "TagKey", # required
value: "TagValue", # required
},
],
})
Response structure
Response structure
resp.mesh.mesh_name #=> String
resp.mesh.metadata.arn #=> String
resp.mesh.metadata.created_at #=> Time
resp.mesh.metadata.last_updated_at #=> Time
resp.mesh.metadata.mesh_owner #=> String
resp.mesh.metadata.resource_owner #=> String
resp.mesh.metadata.uid #=> String
resp.mesh.metadata.version #=> Integer
resp.mesh.spec.egress_filter.type #=> String, one of "ALLOW_ALL", "DROP_ALL"
resp.mesh.spec.service_discovery.ip_preference #=> String, one of "IPv6_PREFERRED", "IPv4_PREFERRED", "IPv4_ONLY", "IPv6_ONLY"
resp.mesh.status.status #=> String, one of "ACTIVE", "INACTIVE", "DELETED"
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:
850 851 852 853 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 850 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
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
{
port: 1,
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",
port: 1,
service_name: "ServiceName",
},
retry_policy: {
grpc_retry_events: ["cancelled"], # accepts cancelled, deadline-exceeded, internal, resource-exhausted, unavailable
http_retry_events: ["HttpRetryPolicyEvent"],
max_retries: 1, # required
per_retry_timeout: { # required
unit: "s", # accepts s, ms
value: 1,
},
tcp_retry_events: ["connection-error"], # accepts connection-error
},
timeout: {
idle: {
unit: "s", # accepts s, ms
value: 1,
},
per_request: {
unit: "s", # accepts s, ms
value: 1,
},
},
},
http2_route: {
action: { # required
weighted_targets: [ # required
{
port: 1,
virtual_node: "ResourceName", # required
weight: 1, # required
},
],
},
match: { # required
headers: [
{
invert: false,
match: {
exact: "HeaderMatch",
prefix: "HeaderMatch",
range: {
end: 1, # required
start: 1, # required
},
regex: "HeaderMatch",
suffix: "HeaderMatch",
},
name: "HeaderName", # required
},
],
method: "GET", # accepts GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE, PATCH
path: {
exact: "HttpPathExact",
regex: "HttpPathRegex",
},
port: 1,
prefix: "String",
query_parameters: [
{
match: {
exact: "String",
},
name: "QueryParameterName", # required
},
],
scheme: "http", # accepts http, https
},
retry_policy: {
http_retry_events: ["HttpRetryPolicyEvent"],
max_retries: 1, # required
per_retry_timeout: { # required
unit: "s", # accepts s, ms
value: 1,
},
tcp_retry_events: ["connection-error"], # accepts connection-error
},
timeout: {
idle: {
unit: "s", # accepts s, ms
value: 1,
},
per_request: {
unit: "s", # accepts s, ms
value: 1,
},
},
},
http_route: {
action: { # required
weighted_targets: [ # required
{
port: 1,
virtual_node: "ResourceName", # required
weight: 1, # required
},
],
},
match: { # required
headers: [
{
invert: false,
match: {
exact: "HeaderMatch",
prefix: "HeaderMatch",
range: {
end: 1, # required
start: 1, # required
},
regex: "HeaderMatch",
suffix: "HeaderMatch",
},
name: "HeaderName", # required
},
],
method: "GET", # accepts GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE, PATCH
path: {
exact: "HttpPathExact",
regex: "HttpPathRegex",
},
port: 1,
prefix: "String",
query_parameters: [
{
match: {
exact: "String",
},
name: "QueryParameterName", # required
},
],
scheme: "http", # accepts http, https
},
retry_policy: {
http_retry_events: ["HttpRetryPolicyEvent"],
max_retries: 1, # required
per_retry_timeout: { # required
unit: "s", # accepts s, ms
value: 1,
},
tcp_retry_events: ["connection-error"], # accepts connection-error
},
timeout: {
idle: {
unit: "s", # accepts s, ms
value: 1,
},
per_request: {
unit: "s", # accepts s, ms
value: 1,
},
},
},
priority: 1,
tcp_route: {
action: { # required
weighted_targets: [ # required
{
port: 1,
virtual_node: "ResourceName", # required
weight: 1, # required
},
],
},
match: {
port: 1,
},
timeout: {
idle: {
unit: "s", # accepts s, ms
value: 1,
},
},
},
},
tags: [
{
key: "TagKey", # required
value: "TagValue", # required
},
],
virtual_router_name: "ResourceName", # required
})
Response structure
Response structure
resp.route.mesh_name #=> String
resp.route.metadata.arn #=> String
resp.route.metadata.created_at #=> Time
resp.route.metadata.last_updated_at #=> Time
resp.route.metadata.mesh_owner #=> String
resp.route.metadata.resource_owner #=> String
resp.route.metadata.uid #=> String
resp.route.metadata.version #=> Integer
resp.route.route_name #=> String
resp.route.spec.grpc_route.action.weighted_targets #=> Array
resp.route.spec.grpc_route.action.weighted_targets[0].port #=> Integer
resp.route.spec.grpc_route.action.weighted_targets[0].virtual_node #=> String
resp.route.spec.grpc_route.action.weighted_targets[0].weight #=> Integer
resp.route.spec.grpc_route.match.metadata #=> Array
resp.route.spec.grpc_route.match.metadata[0].invert #=> Boolean
resp.route.spec.grpc_route.match.metadata[0].match.exact #=> String
resp.route.spec.grpc_route.match.metadata[0].match.prefix #=> String
resp.route.spec.grpc_route.match.metadata[0].match.range.end #=> Integer
resp.route.spec.grpc_route.match.metadata[0].match.range.start #=> Integer
resp.route.spec.grpc_route.match.metadata[0].match.regex #=> String
resp.route.spec.grpc_route.match.metadata[0].match.suffix #=> String
resp.route.spec.grpc_route.match.metadata[0].name #=> String
resp.route.spec.grpc_route.match.method_name #=> String
resp.route.spec.grpc_route.match.port #=> Integer
resp.route.spec.grpc_route.match.service_name #=> String
resp.route.spec.grpc_route.retry_policy.grpc_retry_events #=> Array
resp.route.spec.grpc_route.retry_policy.grpc_retry_events[0] #=> String, one of "cancelled", "deadline-exceeded", "internal", "resource-exhausted", "unavailable"
resp.route.spec.grpc_route.retry_policy.http_retry_events #=> Array
resp.route.spec.grpc_route.retry_policy.http_retry_events[0] #=> String
resp.route.spec.grpc_route.retry_policy.max_retries #=> Integer
resp.route.spec.grpc_route.retry_policy.per_retry_timeout.unit #=> String, one of "s", "ms"
resp.route.spec.grpc_route.retry_policy.per_retry_timeout.value #=> Integer
resp.route.spec.grpc_route.retry_policy.tcp_retry_events #=> Array
resp.route.spec.grpc_route.retry_policy.tcp_retry_events[0] #=> String, one of "connection-error"
resp.route.spec.grpc_route.timeout.idle.unit #=> String, one of "s", "ms"
resp.route.spec.grpc_route.timeout.idle.value #=> Integer
resp.route.spec.grpc_route.timeout.per_request.unit #=> String, one of "s", "ms"
resp.route.spec.grpc_route.timeout.per_request.value #=> Integer
resp.route.spec.http2_route.action.weighted_targets #=> Array
resp.route.spec.http2_route.action.weighted_targets[0].port #=> Integer
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 "GET", "HEAD", "POST", "PUT", "DELETE", "CONNECT", "OPTIONS", "TRACE", "PATCH"
resp.route.spec.http2_route.match.path.exact #=> String
resp.route.spec.http2_route.match.path.regex #=> String
resp.route.spec.http2_route.match.port #=> Integer
resp.route.spec.http2_route.match.prefix #=> String
resp.route.spec.http2_route.match.query_parameters #=> Array
resp.route.spec.http2_route.match.query_parameters[0].match.exact #=> String
resp.route.spec.http2_route.match.query_parameters[0].name #=> String
resp.route.spec.http2_route.match.scheme #=> String, one of "http", "https"
resp.route.spec.http2_route.retry_policy.http_retry_events #=> Array
resp.route.spec.http2_route.retry_policy.http_retry_events[0] #=> String
resp.route.spec.http2_route.retry_policy.max_retries #=> Integer
resp.route.spec.http2_route.retry_policy.per_retry_timeout.unit #=> String, one of "s", "ms"
resp.route.spec.http2_route.retry_policy.per_retry_timeout.value #=> Integer
resp.route.spec.http2_route.retry_policy.tcp_retry_events #=> Array
resp.route.spec.http2_route.retry_policy.tcp_retry_events[0] #=> String, one of "connection-error"
resp.route.spec.http2_route.timeout.idle.unit #=> String, one of "s", "ms"
resp.route.spec.http2_route.timeout.idle.value #=> Integer
resp.route.spec.http2_route.timeout.per_request.unit #=> String, one of "s", "ms"
resp.route.spec.http2_route.timeout.per_request.value #=> Integer
resp.route.spec.http_route.action.weighted_targets #=> Array
resp.route.spec.http_route.action.weighted_targets[0].port #=> Integer
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 "GET", "HEAD", "POST", "PUT", "DELETE", "CONNECT", "OPTIONS", "TRACE", "PATCH"
resp.route.spec.http_route.match.path.exact #=> String
resp.route.spec.http_route.match.path.regex #=> String
resp.route.spec.http_route.match.port #=> Integer
resp.route.spec.http_route.match.prefix #=> String
resp.route.spec.http_route.match.query_parameters #=> Array
resp.route.spec.http_route.match.query_parameters[0].match.exact #=> String
resp.route.spec.http_route.match.query_parameters[0].name #=> String
resp.route.spec.http_route.match.scheme #=> String, one of "http", "https"
resp.route.spec.http_route.retry_policy.http_retry_events #=> Array
resp.route.spec.http_route.retry_policy.http_retry_events[0] #=> String
resp.route.spec.http_route.retry_policy.max_retries #=> Integer
resp.route.spec.http_route.retry_policy.per_retry_timeout.unit #=> String, one of "s", "ms"
resp.route.spec.http_route.retry_policy.per_retry_timeout.value #=> Integer
resp.route.spec.http_route.retry_policy.tcp_retry_events #=> Array
resp.route.spec.http_route.retry_policy.tcp_retry_events[0] #=> String, one of "connection-error"
resp.route.spec.http_route.timeout.idle.unit #=> String, one of "s", "ms"
resp.route.spec.http_route.timeout.idle.value #=> Integer
resp.route.spec.http_route.timeout.per_request.unit #=> String, one of "s", "ms"
resp.route.spec.http_route.timeout.per_request.value #=> Integer
resp.route.spec.priority #=> Integer
resp.route.spec.tcp_route.action.weighted_targets #=> Array
resp.route.spec.tcp_route.action.weighted_targets[0].port #=> Integer
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.match.port #=> Integer
resp.route.spec.tcp_route.timeout.idle.unit #=> String, one of "s", "ms"
resp.route.spec.tcp_route.timeout.idle.value #=> Integer
resp.route.status.status #=> String, one of "ACTIVE", "INACTIVE", "DELETED"
resp.route.virtual_router_name #=> String
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 Amazon Web Services 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:
1250 1251 1252 1253 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 1250 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
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: {
certificate: {
file: {
certificate_chain: "FilePath", # required
private_key: "FilePath", # required
},
sds: {
secret_name: "VirtualGatewaySdsSecretName", # required
},
},
enforce: false,
ports: [1],
validation: { # required
subject_alternative_names: {
match: { # required
exact: ["SubjectAlternativeName"], # required
},
},
trust: { # required
acm: {
certificate_authority_arns: ["Arn"], # required
},
file: {
certificate_chain: "FilePath", # required
},
sds: {
secret_name: "VirtualGatewaySdsSecretName", # required
},
},
},
},
},
},
listeners: [ # required
{
connection_pool: {
grpc: {
max_requests: 1, # required
},
http: {
max_connections: 1, # required
max_pending_requests: 1,
},
http2: {
max_requests: 1, # required
},
},
health_check: {
healthy_threshold: 1, # required
interval_millis: 1, # required
path: "String",
port: 1,
protocol: "http", # required, accepts http, http2, grpc
timeout_millis: 1, # required
unhealthy_threshold: 1, # required
},
port_mapping: { # required
port: 1, # required
protocol: "http", # required, accepts http, http2, grpc
},
tls: {
certificate: { # required
acm: {
certificate_arn: "Arn", # required
},
file: {
certificate_chain: "FilePath", # required
private_key: "FilePath", # required
},
sds: {
secret_name: "VirtualGatewaySdsSecretName", # required
},
},
mode: "STRICT", # required, accepts STRICT, PERMISSIVE, DISABLED
validation: {
subject_alternative_names: {
match: { # required
exact: ["SubjectAlternativeName"], # required
},
},
trust: { # required
file: {
certificate_chain: "FilePath", # required
},
sds: {
secret_name: "VirtualGatewaySdsSecretName", # required
},
},
},
},
},
],
logging: {
access_log: {
file: {
format: {
json: [
{
key: "JsonKey", # required
value: "JsonValue", # required
},
],
text: "TextFormat",
},
path: "FilePath", # required
},
},
},
},
tags: [
{
key: "TagKey", # required
value: "TagValue", # required
},
],
virtual_gateway_name: "ResourceName", # required
})
Response structure
Response structure
resp.virtual_gateway.mesh_name #=> String
resp.virtual_gateway.metadata.arn #=> String
resp.virtual_gateway.metadata.created_at #=> Time
resp.virtual_gateway.metadata.last_updated_at #=> Time
resp.virtual_gateway.metadata.mesh_owner #=> String
resp.virtual_gateway.metadata.resource_owner #=> String
resp.virtual_gateway.metadata.uid #=> String
resp.virtual_gateway.metadata.version #=> Integer
resp.virtual_gateway.spec.backend_defaults.client_policy.tls.certificate.file.certificate_chain #=> String
resp.virtual_gateway.spec.backend_defaults.client_policy.tls.certificate.file.private_key #=> String
resp.virtual_gateway.spec.backend_defaults.client_policy.tls.certificate.sds.secret_name #=> String
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.subject_alternative_names.match.exact #=> Array
resp.virtual_gateway.spec.backend_defaults.client_policy.tls.validation.subject_alternative_names.match.exact[0] #=> String
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.backend_defaults.client_policy.tls.validation.trust.sds.secret_name #=> String
resp.virtual_gateway.spec.listeners #=> Array
resp.virtual_gateway.spec.listeners[0].connection_pool.grpc.max_requests #=> Integer
resp.virtual_gateway.spec.listeners[0].connection_pool.http.max_connections #=> Integer
resp.virtual_gateway.spec.listeners[0].connection_pool.http.max_pending_requests #=> Integer
resp.virtual_gateway.spec.listeners[0].connection_pool.http2.max_requests #=> Integer
resp.virtual_gateway.spec.listeners[0].health_check.healthy_threshold #=> Integer
resp.virtual_gateway.spec.listeners[0].health_check.interval_millis #=> Integer
resp.virtual_gateway.spec.listeners[0].health_check.path #=> String
resp.virtual_gateway.spec.listeners[0].health_check.port #=> Integer
resp.virtual_gateway.spec.listeners[0].health_check.protocol #=> String, one of "http", "http2", "grpc"
resp.virtual_gateway.spec.listeners[0].health_check.timeout_millis #=> Integer
resp.virtual_gateway.spec.listeners[0].health_check.unhealthy_threshold #=> Integer
resp.virtual_gateway.spec.listeners[0].port_mapping.port #=> Integer
resp.virtual_gateway.spec.listeners[0].port_mapping.protocol #=> String, one of "http", "http2", "grpc"
resp.virtual_gateway.spec.listeners[0].tls.certificate.acm.certificate_arn #=> String
resp.virtual_gateway.spec.listeners[0].tls.certificate.file.certificate_chain #=> String
resp.virtual_gateway.spec.listeners[0].tls.certificate.file.private_key #=> String
resp.virtual_gateway.spec.listeners[0].tls.certificate.sds.secret_name #=> String
resp.virtual_gateway.spec.listeners[0].tls.mode #=> String, one of "STRICT", "PERMISSIVE", "DISABLED"
resp.virtual_gateway.spec.listeners[0].tls.validation.subject_alternative_names.match.exact #=> Array
resp.virtual_gateway.spec.listeners[0].tls.validation.subject_alternative_names.match.exact[0] #=> String
resp.virtual_gateway.spec.listeners[0].tls.validation.trust.file.certificate_chain #=> String
resp.virtual_gateway.spec.listeners[0].tls.validation.trust.sds.secret_name #=> String
resp.virtual_gateway.spec.logging.access_log.file.format.json #=> Array
resp.virtual_gateway.spec.logging.access_log.file.format.json[0].key #=> String
resp.virtual_gateway.spec.logging.access_log.file.format.json[0].value #=> String
resp.virtual_gateway.spec.logging.access_log.file.format.text #=> String
resp.virtual_gateway.spec.logging.access_log.file.path #=> String
resp.virtual_gateway.status.status #=> String, one of "ACTIVE", "INACTIVE", "DELETED"
resp.virtual_gateway.virtual_gateway_name #=> String
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 Amazon Web Services 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:
-
(Types::CreateVirtualGatewayOutput)
—
Returns a response object which responds to the following methods:
- #virtual_gateway => Types::VirtualGatewayData
See Also:
1494 1495 1496 1497 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 1494 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 to the full
ARN; for example,
arn:aws:appmesh:us-west-2:123456789012:myMesh/default/virtualNode/myApp
)
as the APPMESH_RESOURCE_ARN
environment variable for your task
group's Envoy proxy container in your task definition or pod spec.
This is then mapped to the node.id
and node.cluster
Envoy
parameters.
APPMESH_RESOURCE_ARN
when Envoy is referring to itself in metrics
and traces. You can override this behavior by setting the
APPMESH_RESOURCE_CLUSTER
environment variable with your own name.
For more information about virtual nodes, see Virtual nodes. You
must be using 1.15.0
or later of the Envoy image when setting these
variables. For more information aboutApp Mesh Envoy variables, see
Envoy image in the App Mesh User Guide.
Examples:
Request syntax with placeholder values
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: {
certificate: {
file: {
certificate_chain: "FilePath", # required
private_key: "FilePath", # required
},
sds: {
secret_name: "SdsSecretName", # required
},
},
enforce: false,
ports: [1],
validation: { # required
subject_alternative_names: {
match: { # required
exact: ["SubjectAlternativeName"], # required
},
},
trust: { # required
acm: {
certificate_authority_arns: ["Arn"], # required
},
file: {
certificate_chain: "FilePath", # required
},
sds: {
secret_name: "SdsSecretName", # required
},
},
},
},
},
},
backends: [
{
virtual_service: {
client_policy: {
tls: {
certificate: {
file: {
certificate_chain: "FilePath", # required
private_key: "FilePath", # required
},
sds: {
secret_name: "SdsSecretName", # required
},
},
enforce: false,
ports: [1],
validation: { # required
subject_alternative_names: {
match: { # required
exact: ["SubjectAlternativeName"], # required
},
},
trust: { # required
acm: {
certificate_authority_arns: ["Arn"], # required
},
file: {
certificate_chain: "FilePath", # required
},
sds: {
secret_name: "SdsSecretName", # required
},
},
},
},
},
virtual_service_name: "ServiceName", # required
},
},
],
listeners: [
{
connection_pool: {
grpc: {
max_requests: 1, # required
},
http: {
max_connections: 1, # required
max_pending_requests: 1,
},
http2: {
max_requests: 1, # required
},
tcp: {
max_connections: 1, # required
},
},
health_check: {
healthy_threshold: 1, # required
interval_millis: 1, # required
path: "String",
port: 1,
protocol: "http", # required, accepts http, tcp, http2, grpc
timeout_millis: 1, # required
unhealthy_threshold: 1, # required
},
outlier_detection: {
base_ejection_duration: { # required
unit: "s", # accepts s, ms
value: 1,
},
interval: { # required
unit: "s", # accepts s, ms
value: 1,
},
max_ejection_percent: 1, # required
max_server_errors: 1, # required
},
port_mapping: { # required
port: 1, # required
protocol: "http", # required, accepts http, tcp, http2, grpc
},
timeout: {
grpc: {
idle: {
unit: "s", # accepts s, ms
value: 1,
},
per_request: {
unit: "s", # accepts s, ms
value: 1,
},
},
http: {
idle: {
unit: "s", # accepts s, ms
value: 1,
},
per_request: {
unit: "s", # accepts s, ms
value: 1,
},
},
http2: {
idle: {
unit: "s", # accepts s, ms
value: 1,
},
per_request: {
unit: "s", # accepts s, ms
value: 1,
},
},
tcp: {
idle: {
unit: "s", # accepts s, ms
value: 1,
},
},
},
tls: {
certificate: { # required
acm: {
certificate_arn: "Arn", # required
},
file: {
certificate_chain: "FilePath", # required
private_key: "FilePath", # required
},
sds: {
secret_name: "SdsSecretName", # required
},
},
mode: "STRICT", # required, accepts STRICT, PERMISSIVE, DISABLED
validation: {
subject_alternative_names: {
match: { # required
exact: ["SubjectAlternativeName"], # required
},
},
trust: { # required
file: {
certificate_chain: "FilePath", # required
},
sds: {
secret_name: "SdsSecretName", # required
},
},
},
},
},
],
logging: {
access_log: {
file: {
format: {
json: [
{
key: "JsonKey", # required
value: "JsonValue", # required
},
],
text: "TextFormat",
},
path: "FilePath", # required
},
},
},
service_discovery: {
aws_cloud_map: {
attributes: [
{
key: "AwsCloudMapInstanceAttributeKey", # required
value: "AwsCloudMapInstanceAttributeValue", # required
},
],
ip_preference: "IPv6_PREFERRED", # accepts IPv6_PREFERRED, IPv4_PREFERRED, IPv4_ONLY, IPv6_ONLY
namespace_name: "AwsCloudMapName", # required
service_name: "AwsCloudMapName", # required
},
dns: {
hostname: "Hostname", # required
ip_preference: "IPv6_PREFERRED", # accepts IPv6_PREFERRED, IPv4_PREFERRED, IPv4_ONLY, IPv6_ONLY
response_type: "LOADBALANCER", # accepts LOADBALANCER, ENDPOINTS
},
},
},
tags: [
{
key: "TagKey", # required
value: "TagValue", # required
},
],
virtual_node_name: "ResourceName", # required
})
Response structure
Response structure
resp.virtual_node.mesh_name #=> String
resp.virtual_node.metadata.arn #=> String
resp.virtual_node.metadata.created_at #=> Time
resp.virtual_node.metadata.last_updated_at #=> Time
resp.virtual_node.metadata.mesh_owner #=> String
resp.virtual_node.metadata.resource_owner #=> String
resp.virtual_node.metadata.uid #=> String
resp.virtual_node.metadata.version #=> Integer
resp.virtual_node.spec.backend_defaults.client_policy.tls.certificate.file.certificate_chain #=> String
resp.virtual_node.spec.backend_defaults.client_policy.tls.certificate.file.private_key #=> String
resp.virtual_node.spec.backend_defaults.client_policy.tls.certificate.sds.secret_name #=> String
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.subject_alternative_names.match.exact #=> Array
resp.virtual_node.spec.backend_defaults.client_policy.tls.validation.subject_alternative_names.match.exact[0] #=> String
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.backend_defaults.client_policy.tls.validation.trust.sds.secret_name #=> String
resp.virtual_node.spec.backends #=> Array
resp.virtual_node.spec.backends[0].virtual_service.client_policy.tls.certificate.file.certificate_chain #=> String
resp.virtual_node.spec.backends[0].virtual_service.client_policy.tls.certificate.file.private_key #=> String
resp.virtual_node.spec.backends[0].virtual_service.client_policy.tls.certificate.sds.secret_name #=> String
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.subject_alternative_names.match.exact #=> Array
resp.virtual_node.spec.backends[0].virtual_service.client_policy.tls.validation.subject_alternative_names.match.exact[0] #=> String
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.client_policy.tls.validation.trust.sds.secret_name #=> String
resp.virtual_node.spec.backends[0].virtual_service.virtual_service_name #=> String
resp.virtual_node.spec.listeners #=> Array
resp.virtual_node.spec.listeners[0].connection_pool.grpc.max_requests #=> Integer
resp.virtual_node.spec.listeners[0].connection_pool.http.max_connections #=> Integer
resp.virtual_node.spec.listeners[0].connection_pool.http.max_pending_requests #=> Integer
resp.virtual_node.spec.listeners[0].connection_pool.http2.max_requests #=> Integer
resp.virtual_node.spec.listeners[0].connection_pool.tcp.max_connections #=> Integer
resp.virtual_node.spec.listeners[0].health_check.healthy_threshold #=> Integer
resp.virtual_node.spec.listeners[0].health_check.interval_millis #=> Integer
resp.virtual_node.spec.listeners[0].health_check.path #=> String
resp.virtual_node.spec.listeners[0].health_check.port #=> Integer
resp.virtual_node.spec.listeners[0].health_check.protocol #=> String, one of "http", "tcp", "http2", "grpc"
resp.virtual_node.spec.listeners[0].health_check.timeout_millis #=> Integer
resp.virtual_node.spec.listeners[0].health_check.unhealthy_threshold #=> Integer
resp.virtual_node.spec.listeners[0].outlier_detection.base_ejection_duration.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].outlier_detection.base_ejection_duration.value #=> Integer
resp.virtual_node.spec.listeners[0].outlier_detection.interval.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].outlier_detection.interval.value #=> Integer
resp.virtual_node.spec.listeners[0].outlier_detection.max_ejection_percent #=> Integer
resp.virtual_node.spec.listeners[0].outlier_detection.max_server_errors #=> Integer
resp.virtual_node.spec.listeners[0].port_mapping.port #=> Integer
resp.virtual_node.spec.listeners[0].port_mapping.protocol #=> String, one of "http", "tcp", "http2", "grpc"
resp.virtual_node.spec.listeners[0].timeout.grpc.idle.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].timeout.grpc.idle.value #=> Integer
resp.virtual_node.spec.listeners[0].timeout.grpc.per_request.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].timeout.grpc.per_request.value #=> Integer
resp.virtual_node.spec.listeners[0].timeout.http.idle.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].timeout.http.idle.value #=> Integer
resp.virtual_node.spec.listeners[0].timeout.http.per_request.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].timeout.http.per_request.value #=> Integer
resp.virtual_node.spec.listeners[0].timeout.http2.idle.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].timeout.http2.idle.value #=> Integer
resp.virtual_node.spec.listeners[0].timeout.http2.per_request.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].timeout.http2.per_request.value #=> Integer
resp.virtual_node.spec.listeners[0].timeout.tcp.idle.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].timeout.tcp.idle.value #=> Integer
resp.virtual_node.spec.listeners[0].tls.certificate.acm.certificate_arn #=> String
resp.virtual_node.spec.listeners[0].tls.certificate.file.certificate_chain #=> String
resp.virtual_node.spec.listeners[0].tls.certificate.file.private_key #=> String
resp.virtual_node.spec.listeners[0].tls.certificate.sds.secret_name #=> String
resp.virtual_node.spec.listeners[0].tls.mode #=> String, one of "STRICT", "PERMISSIVE", "DISABLED"
resp.virtual_node.spec.listeners[0].tls.validation.subject_alternative_names.match.exact #=> Array
resp.virtual_node.spec.listeners[0].tls.validation.subject_alternative_names.match.exact[0] #=> String
resp.virtual_node.spec.listeners[0].tls.validation.trust.file.certificate_chain #=> String
resp.virtual_node.spec.listeners[0].tls.validation.trust.sds.secret_name #=> String
resp.virtual_node.spec.logging.access_log.file.format.json #=> Array
resp.virtual_node.spec.logging.access_log.file.format.json[0].key #=> String
resp.virtual_node.spec.logging.access_log.file.format.json[0].value #=> String
resp.virtual_node.spec.logging.access_log.file.format.text #=> String
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.ip_preference #=> String, one of "IPv6_PREFERRED", "IPv4_PREFERRED", "IPv4_ONLY", "IPv6_ONLY"
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.spec.service_discovery.dns.ip_preference #=> String, one of "IPv6_PREFERRED", "IPv4_PREFERRED", "IPv4_ONLY", "IPv6_ONLY"
resp.virtual_node.spec.service_discovery.dns.response_type #=> String, one of "LOADBALANCER", "ENDPOINTS"
resp.virtual_node.status.status #=> String, one of "ACTIVE", "INACTIVE", "DELETED"
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 Amazon Web Services 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:
-
(Types::CreateVirtualNodeOutput)
—
Returns a response object which responds to the following methods:
- #virtual_node => Types::VirtualNodeData
See Also:
1916 1917 1918 1919 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 1916 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
Request syntax with placeholder values
resp = client.create_virtual_router({
client_token: "String",
mesh_name: "ResourceName", # required
mesh_owner: "AccountId",
spec: { # required
listeners: [
{
port_mapping: { # required
port: 1, # required
protocol: "http", # required, accepts http, tcp, http2, grpc
},
},
],
},
tags: [
{
key: "TagKey", # required
value: "TagValue", # required
},
],
virtual_router_name: "ResourceName", # required
})
Response structure
Response structure
resp.virtual_router.mesh_name #=> String
resp.virtual_router.metadata.arn #=> String
resp.virtual_router.metadata.created_at #=> Time
resp.virtual_router.metadata.last_updated_at #=> Time
resp.virtual_router.metadata.mesh_owner #=> String
resp.virtual_router.metadata.resource_owner #=> String
resp.virtual_router.metadata.uid #=> String
resp.virtual_router.metadata.version #=> Integer
resp.virtual_router.spec.listeners #=> Array
resp.virtual_router.spec.listeners[0].port_mapping.port #=> Integer
resp.virtual_router.spec.listeners[0].port_mapping.protocol #=> String, one of "http", "tcp", "http2", "grpc"
resp.virtual_router.status.status #=> String, one of "ACTIVE", "INACTIVE", "DELETED"
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 Amazon Web Services 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:
-
(Types::CreateVirtualRouterOutput)
—
Returns a response object which responds to the following methods:
- #virtual_router => Types::VirtualRouterData
See Also:
2020 2021 2022 2023 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 2020 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
Request syntax with placeholder values
resp = client.create_virtual_service({
client_token: "String",
mesh_name: "ResourceName", # required
mesh_owner: "AccountId",
spec: { # required
provider: {
virtual_node: {
virtual_node_name: "ResourceName", # required
},
virtual_router: {
virtual_router_name: "ResourceName", # required
},
},
},
tags: [
{
key: "TagKey", # required
value: "TagValue", # required
},
],
virtual_service_name: "ServiceName", # required
})
Response structure
Response structure
resp.virtual_service.mesh_name #=> String
resp.virtual_service.metadata.arn #=> String
resp.virtual_service.metadata.created_at #=> Time
resp.virtual_service.metadata.last_updated_at #=> Time
resp.virtual_service.metadata.mesh_owner #=> String
resp.virtual_service.metadata.resource_owner #=> String
resp.virtual_service.metadata.uid #=> String
resp.virtual_service.metadata.version #=> Integer
resp.virtual_service.spec.provider.virtual_node.virtual_node_name #=> String
resp.virtual_service.spec.provider.virtual_router.virtual_router_name #=> String
resp.virtual_service.status.status #=> String, one of "ACTIVE", "INACTIVE", "DELETED"
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 Amazon Web Services 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:
-
(Types::CreateVirtualServiceOutput)
—
Returns a response object which responds to the following methods:
- #virtual_service => Types::VirtualServiceData
See Also:
2124 2125 2126 2127 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 2124 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
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
Response structure
resp.gateway_route.gateway_route_name #=> String
resp.gateway_route.mesh_name #=> String
resp.gateway_route.metadata.arn #=> String
resp.gateway_route.metadata.created_at #=> Time
resp.gateway_route.metadata.last_updated_at #=> Time
resp.gateway_route.metadata.mesh_owner #=> String
resp.gateway_route.metadata.resource_owner #=> String
resp.gateway_route.metadata.uid #=> String
resp.gateway_route.metadata.version #=> Integer
resp.gateway_route.spec.grpc_route.action.rewrite.hostname.default_target_hostname #=> String, one of "ENABLED", "DISABLED"
resp.gateway_route.spec.grpc_route.action.target.port #=> Integer
resp.gateway_route.spec.grpc_route.action.target.virtual_service.virtual_service_name #=> String
resp.gateway_route.spec.grpc_route.match.hostname.exact #=> String
resp.gateway_route.spec.grpc_route.match.hostname.suffix #=> String
resp.gateway_route.spec.grpc_route.match.metadata #=> Array
resp.gateway_route.spec.grpc_route.match.metadata[0].invert #=> Boolean
resp.gateway_route.spec.grpc_route.match.metadata[0].match.exact #=> String
resp.gateway_route.spec.grpc_route.match.metadata[0].match.prefix #=> String
resp.gateway_route.spec.grpc_route.match.metadata[0].match.range.end #=> Integer
resp.gateway_route.spec.grpc_route.match.metadata[0].match.range.start #=> Integer
resp.gateway_route.spec.grpc_route.match.metadata[0].match.regex #=> String
resp.gateway_route.spec.grpc_route.match.metadata[0].match.suffix #=> String
resp.gateway_route.spec.grpc_route.match.metadata[0].name #=> String
resp.gateway_route.spec.grpc_route.match.port #=> Integer
resp.gateway_route.spec.grpc_route.match.service_name #=> String
resp.gateway_route.spec.http2_route.action.rewrite.hostname.default_target_hostname #=> String, one of "ENABLED", "DISABLED"
resp.gateway_route.spec.http2_route.action.rewrite.path.exact #=> String
resp.gateway_route.spec.http2_route.action.rewrite.prefix.default_prefix #=> String, one of "ENABLED", "DISABLED"
resp.gateway_route.spec.http2_route.action.rewrite.prefix.value #=> String
resp.gateway_route.spec.http2_route.action.target.port #=> Integer
resp.gateway_route.spec.http2_route.action.target.virtual_service.virtual_service_name #=> String
resp.gateway_route.spec.http2_route.match.headers #=> Array
resp.gateway_route.spec.http2_route.match.headers[0].invert #=> Boolean
resp.gateway_route.spec.http2_route.match.headers[0].match.exact #=> String
resp.gateway_route.spec.http2_route.match.headers[0].match.prefix #=> String
resp.gateway_route.spec.http2_route.match.headers[0].match.range.end #=> Integer
resp.gateway_route.spec.http2_route.match.headers[0].match.range.start #=> Integer
resp.gateway_route.spec.http2_route.match.headers[0].match.regex #=> String
resp.gateway_route.spec.http2_route.match.headers[0].match.suffix #=> String
resp.gateway_route.spec.http2_route.match.headers[0].name #=> String
resp.gateway_route.spec.http2_route.match.hostname.exact #=> String
resp.gateway_route.spec.http2_route.match.hostname.suffix #=> String
resp.gateway_route.spec.http2_route.match.method #=> String, one of "GET", "HEAD", "POST", "PUT", "DELETE", "CONNECT", "OPTIONS", "TRACE", "PATCH"
resp.gateway_route.spec.http2_route.match.path.exact #=> String
resp.gateway_route.spec.http2_route.match.path.regex #=> String
resp.gateway_route.spec.http2_route.match.port #=> Integer
resp.gateway_route.spec.http2_route.match.prefix #=> String
resp.gateway_route.spec.http2_route.match.query_parameters #=> Array
resp.gateway_route.spec.http2_route.match.query_parameters[0].match.exact #=> String
resp.gateway_route.spec.http2_route.match.query_parameters[0].name #=> String
resp.gateway_route.spec.http_route.action.rewrite.hostname.default_target_hostname #=> String, one of "ENABLED", "DISABLED"
resp.gateway_route.spec.http_route.action.rewrite.path.exact #=> String
resp.gateway_route.spec.http_route.action.rewrite.prefix.default_prefix #=> String, one of "ENABLED", "DISABLED"
resp.gateway_route.spec.http_route.action.rewrite.prefix.value #=> String
resp.gateway_route.spec.http_route.action.target.port #=> Integer
resp.gateway_route.spec.http_route.action.target.virtual_service.virtual_service_name #=> String
resp.gateway_route.spec.http_route.match.headers #=> Array
resp.gateway_route.spec.http_route.match.headers[0].invert #=> Boolean
resp.gateway_route.spec.http_route.match.headers[0].match.exact #=> String
resp.gateway_route.spec.http_route.match.headers[0].match.prefix #=> String
resp.gateway_route.spec.http_route.match.headers[0].match.range.end #=> Integer
resp.gateway_route.spec.http_route.match.headers[0].match.range.start #=> Integer
resp.gateway_route.spec.http_route.match.headers[0].match.regex #=> String
resp.gateway_route.spec.http_route.match.headers[0].match.suffix #=> String
resp.gateway_route.spec.http_route.match.headers[0].name #=> String
resp.gateway_route.spec.http_route.match.hostname.exact #=> String
resp.gateway_route.spec.http_route.match.hostname.suffix #=> String
resp.gateway_route.spec.http_route.match.method #=> String, one of "GET", "HEAD", "POST", "PUT", "DELETE", "CONNECT", "OPTIONS", "TRACE", "PATCH"
resp.gateway_route.spec.http_route.match.path.exact #=> String
resp.gateway_route.spec.http_route.match.path.regex #=> String
resp.gateway_route.spec.http_route.match.port #=> Integer
resp.gateway_route.spec.http_route.match.prefix #=> String
resp.gateway_route.spec.http_route.match.query_parameters #=> Array
resp.gateway_route.spec.http_route.match.query_parameters[0].match.exact #=> String
resp.gateway_route.spec.http_route.match.query_parameters[0].name #=> String
resp.gateway_route.spec.priority #=> Integer
resp.gateway_route.status.status #=> String, one of "ACTIVE", "INACTIVE", "DELETED"
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 Amazon Web Services 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:
-
(Types::DeleteGatewayRouteOutput)
—
Returns a response object which responds to the following methods:
- #gateway_route => Types::GatewayRouteData
See Also:
2248 2249 2250 2251 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 2248 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
Request syntax with placeholder values
resp = client.delete_mesh({
mesh_name: "ResourceName", # required
})
Response structure
Response structure
resp.mesh.mesh_name #=> String
resp.mesh.metadata.arn #=> String
resp.mesh.metadata.created_at #=> Time
resp.mesh.metadata.last_updated_at #=> Time
resp.mesh.metadata.mesh_owner #=> String
resp.mesh.metadata.resource_owner #=> String
resp.mesh.metadata.uid #=> String
resp.mesh.metadata.version #=> Integer
resp.mesh.spec.egress_filter.type #=> String, one of "ALLOW_ALL", "DROP_ALL"
resp.mesh.spec.service_discovery.ip_preference #=> String, one of "IPv6_PREFERRED", "IPv4_PREFERRED", "IPv4_ONLY", "IPv6_ONLY"
resp.mesh.status.status #=> String, one of "ACTIVE", "INACTIVE", "DELETED"
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:mesh_name
(required, String)
—
The name of the service mesh to delete.
Returns:
See Also:
2290 2291 2292 2293 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 2290 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
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
Response structure
resp.route.mesh_name #=> String
resp.route.metadata.arn #=> String
resp.route.metadata.created_at #=> Time
resp.route.metadata.last_updated_at #=> Time
resp.route.metadata.mesh_owner #=> String
resp.route.metadata.resource_owner #=> String
resp.route.metadata.uid #=> String
resp.route.metadata.version #=> Integer
resp.route.route_name #=> String
resp.route.spec.grpc_route.action.weighted_targets #=> Array
resp.route.spec.grpc_route.action.weighted_targets[0].port #=> Integer
resp.route.spec.grpc_route.action.weighted_targets[0].virtual_node #=> String
resp.route.spec.grpc_route.action.weighted_targets[0].weight #=> Integer
resp.route.spec.grpc_route.match.metadata #=> Array
resp.route.spec.grpc_route.match.metadata[0].invert #=> Boolean
resp.route.spec.grpc_route.match.metadata[0].match.exact #=> String
resp.route.spec.grpc_route.match.metadata[0].match.prefix #=> String
resp.route.spec.grpc_route.match.metadata[0].match.range.end #=> Integer
resp.route.spec.grpc_route.match.metadata[0].match.range.start #=> Integer
resp.route.spec.grpc_route.match.metadata[0].match.regex #=> String
resp.route.spec.grpc_route.match.metadata[0].match.suffix #=> String
resp.route.spec.grpc_route.match.metadata[0].name #=> String
resp.route.spec.grpc_route.match.method_name #=> String
resp.route.spec.grpc_route.match.port #=> Integer
resp.route.spec.grpc_route.match.service_name #=> String
resp.route.spec.grpc_route.retry_policy.grpc_retry_events #=> Array
resp.route.spec.grpc_route.retry_policy.grpc_retry_events[0] #=> String, one of "cancelled", "deadline-exceeded", "internal", "resource-exhausted", "unavailable"
resp.route.spec.grpc_route.retry_policy.http_retry_events #=> Array
resp.route.spec.grpc_route.retry_policy.http_retry_events[0] #=> String
resp.route.spec.grpc_route.retry_policy.max_retries #=> Integer
resp.route.spec.grpc_route.retry_policy.per_retry_timeout.unit #=> String, one of "s", "ms"
resp.route.spec.grpc_route.retry_policy.per_retry_timeout.value #=> Integer
resp.route.spec.grpc_route.retry_policy.tcp_retry_events #=> Array
resp.route.spec.grpc_route.retry_policy.tcp_retry_events[0] #=> String, one of "connection-error"
resp.route.spec.grpc_route.timeout.idle.unit #=> String, one of "s", "ms"
resp.route.spec.grpc_route.timeout.idle.value #=> Integer
resp.route.spec.grpc_route.timeout.per_request.unit #=> String, one of "s", "ms"
resp.route.spec.grpc_route.timeout.per_request.value #=> Integer
resp.route.spec.http2_route.action.weighted_targets #=> Array
resp.route.spec.http2_route.action.weighted_targets[0].port #=> Integer
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 "GET", "HEAD", "POST", "PUT", "DELETE", "CONNECT", "OPTIONS", "TRACE", "PATCH"
resp.route.spec.http2_route.match.path.exact #=> String
resp.route.spec.http2_route.match.path.regex #=> String
resp.route.spec.http2_route.match.port #=> Integer
resp.route.spec.http2_route.match.prefix #=> String
resp.route.spec.http2_route.match.query_parameters #=> Array
resp.route.spec.http2_route.match.query_parameters[0].match.exact #=> String
resp.route.spec.http2_route.match.query_parameters[0].name #=> String
resp.route.spec.http2_route.match.scheme #=> String, one of "http", "https"
resp.route.spec.http2_route.retry_policy.http_retry_events #=> Array
resp.route.spec.http2_route.retry_policy.http_retry_events[0] #=> String
resp.route.spec.http2_route.retry_policy.max_retries #=> Integer
resp.route.spec.http2_route.retry_policy.per_retry_timeout.unit #=> String, one of "s", "ms"
resp.route.spec.http2_route.retry_policy.per_retry_timeout.value #=> Integer
resp.route.spec.http2_route.retry_policy.tcp_retry_events #=> Array
resp.route.spec.http2_route.retry_policy.tcp_retry_events[0] #=> String, one of "connection-error"
resp.route.spec.http2_route.timeout.idle.unit #=> String, one of "s", "ms"
resp.route.spec.http2_route.timeout.idle.value #=> Integer
resp.route.spec.http2_route.timeout.per_request.unit #=> String, one of "s", "ms"
resp.route.spec.http2_route.timeout.per_request.value #=> Integer
resp.route.spec.http_route.action.weighted_targets #=> Array
resp.route.spec.http_route.action.weighted_targets[0].port #=> Integer
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 "GET", "HEAD", "POST", "PUT", "DELETE", "CONNECT", "OPTIONS", "TRACE", "PATCH"
resp.route.spec.http_route.match.path.exact #=> String
resp.route.spec.http_route.match.path.regex #=> String
resp.route.spec.http_route.match.port #=> Integer
resp.route.spec.http_route.match.prefix #=> String
resp.route.spec.http_route.match.query_parameters #=> Array
resp.route.spec.http_route.match.query_parameters[0].match.exact #=> String
resp.route.spec.http_route.match.query_parameters[0].name #=> String
resp.route.spec.http_route.match.scheme #=> String, one of "http", "https"
resp.route.spec.http_route.retry_policy.http_retry_events #=> Array
resp.route.spec.http_route.retry_policy.http_retry_events[0] #=> String
resp.route.spec.http_route.retry_policy.max_retries #=> Integer
resp.route.spec.http_route.retry_policy.per_retry_timeout.unit #=> String, one of "s", "ms"
resp.route.spec.http_route.retry_policy.per_retry_timeout.value #=> Integer
resp.route.spec.http_route.retry_policy.tcp_retry_events #=> Array
resp.route.spec.http_route.retry_policy.tcp_retry_events[0] #=> String, one of "connection-error"
resp.route.spec.http_route.timeout.idle.unit #=> String, one of "s", "ms"
resp.route.spec.http_route.timeout.idle.value #=> Integer
resp.route.spec.http_route.timeout.per_request.unit #=> String, one of "s", "ms"
resp.route.spec.http_route.timeout.per_request.value #=> Integer
resp.route.spec.priority #=> Integer
resp.route.spec.tcp_route.action.weighted_targets #=> Array
resp.route.spec.tcp_route.action.weighted_targets[0].port #=> Integer
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.match.port #=> Integer
resp.route.spec.tcp_route.timeout.idle.unit #=> String, one of "s", "ms"
resp.route.spec.tcp_route.timeout.idle.value #=> Integer
resp.route.status.status #=> String, one of "ACTIVE", "INACTIVE", "DELETED"
resp.route.virtual_router_name #=> String
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 Amazon Web Services 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:
2450 2451 2452 2453 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 2450 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
Request syntax with placeholder values
resp = client.delete_virtual_gateway({
mesh_name: "ResourceName", # required
mesh_owner: "AccountId",
virtual_gateway_name: "ResourceName", # required
})
Response structure
Response structure
resp.virtual_gateway.mesh_name #=> String
resp.virtual_gateway.metadata.arn #=> String
resp.virtual_gateway.metadata.created_at #=> Time
resp.virtual_gateway.metadata.last_updated_at #=> Time
resp.virtual_gateway.metadata.mesh_owner #=> String
resp.virtual_gateway.metadata.resource_owner #=> String
resp.virtual_gateway.metadata.uid #=> String
resp.virtual_gateway.metadata.version #=> Integer
resp.virtual_gateway.spec.backend_defaults.client_policy.tls.certificate.file.certificate_chain #=> String
resp.virtual_gateway.spec.backend_defaults.client_policy.tls.certificate.file.private_key #=> String
resp.virtual_gateway.spec.backend_defaults.client_policy.tls.certificate.sds.secret_name #=> String
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.subject_alternative_names.match.exact #=> Array
resp.virtual_gateway.spec.backend_defaults.client_policy.tls.validation.subject_alternative_names.match.exact[0] #=> String
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.backend_defaults.client_policy.tls.validation.trust.sds.secret_name #=> String
resp.virtual_gateway.spec.listeners #=> Array
resp.virtual_gateway.spec.listeners[0].connection_pool.grpc.max_requests #=> Integer
resp.virtual_gateway.spec.listeners[0].connection_pool.http.max_connections #=> Integer
resp.virtual_gateway.spec.listeners[0].connection_pool.http.max_pending_requests #=> Integer
resp.virtual_gateway.spec.listeners[0].connection_pool.http2.max_requests #=> Integer
resp.virtual_gateway.spec.listeners[0].health_check.healthy_threshold #=> Integer
resp.virtual_gateway.spec.listeners[0].health_check.interval_millis #=> Integer
resp.virtual_gateway.spec.listeners[0].health_check.path #=> String
resp.virtual_gateway.spec.listeners[0].health_check.port #=> Integer
resp.virtual_gateway.spec.listeners[0].health_check.protocol #=> String, one of "http", "http2", "grpc"
resp.virtual_gateway.spec.listeners[0].health_check.timeout_millis #=> Integer
resp.virtual_gateway.spec.listeners[0].health_check.unhealthy_threshold #=> Integer
resp.virtual_gateway.spec.listeners[0].port_mapping.port #=> Integer
resp.virtual_gateway.spec.listeners[0].port_mapping.protocol #=> String, one of "http", "http2", "grpc"
resp.virtual_gateway.spec.listeners[0].tls.certificate.acm.certificate_arn #=> String
resp.virtual_gateway.spec.listeners[0].tls.certificate.file.certificate_chain #=> String
resp.virtual_gateway.spec.listeners[0].tls.certificate.file.private_key #=> String
resp.virtual_gateway.spec.listeners[0].tls.certificate.sds.secret_name #=> String
resp.virtual_gateway.spec.listeners[0].tls.mode #=> String, one of "STRICT", "PERMISSIVE", "DISABLED"
resp.virtual_gateway.spec.listeners[0].tls.validation.subject_alternative_names.match.exact #=> Array
resp.virtual_gateway.spec.listeners[0].tls.validation.subject_alternative_names.match.exact[0] #=> String
resp.virtual_gateway.spec.listeners[0].tls.validation.trust.file.certificate_chain #=> String
resp.virtual_gateway.spec.listeners[0].tls.validation.trust.sds.secret_name #=> String
resp.virtual_gateway.spec.logging.access_log.file.format.json #=> Array
resp.virtual_gateway.spec.logging.access_log.file.format.json[0].key #=> String
resp.virtual_gateway.spec.logging.access_log.file.format.json[0].value #=> String
resp.virtual_gateway.spec.logging.access_log.file.format.text #=> String
resp.virtual_gateway.spec.logging.access_log.file.path #=> String
resp.virtual_gateway.status.status #=> String, one of "ACTIVE", "INACTIVE", "DELETED"
resp.virtual_gateway.virtual_gateway_name #=> String
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 Amazon Web Services 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:
-
(Types::DeleteVirtualGatewayOutput)
—
Returns a response object which responds to the following methods:
- #virtual_gateway => Types::VirtualGatewayData
See Also:
2543 2544 2545 2546 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 2543 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
Request syntax with placeholder values
resp = client.delete_virtual_node({
mesh_name: "ResourceName", # required
mesh_owner: "AccountId",
virtual_node_name: "ResourceName", # required
})
Response structure
Response structure
resp.virtual_node.mesh_name #=> String
resp.virtual_node.metadata.arn #=> String
resp.virtual_node.metadata.created_at #=> Time
resp.virtual_node.metadata.last_updated_at #=> Time
resp.virtual_node.metadata.mesh_owner #=> String
resp.virtual_node.metadata.resource_owner #=> String
resp.virtual_node.metadata.uid #=> String
resp.virtual_node.metadata.version #=> Integer
resp.virtual_node.spec.backend_defaults.client_policy.tls.certificate.file.certificate_chain #=> String
resp.virtual_node.spec.backend_defaults.client_policy.tls.certificate.file.private_key #=> String
resp.virtual_node.spec.backend_defaults.client_policy.tls.certificate.sds.secret_name #=> String
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.subject_alternative_names.match.exact #=> Array
resp.virtual_node.spec.backend_defaults.client_policy.tls.validation.subject_alternative_names.match.exact[0] #=> String
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.backend_defaults.client_policy.tls.validation.trust.sds.secret_name #=> String
resp.virtual_node.spec.backends #=> Array
resp.virtual_node.spec.backends[0].virtual_service.client_policy.tls.certificate.file.certificate_chain #=> String
resp.virtual_node.spec.backends[0].virtual_service.client_policy.tls.certificate.file.private_key #=> String
resp.virtual_node.spec.backends[0].virtual_service.client_policy.tls.certificate.sds.secret_name #=> String
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.subject_alternative_names.match.exact #=> Array
resp.virtual_node.spec.backends[0].virtual_service.client_policy.tls.validation.subject_alternative_names.match.exact[0] #=> String
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.client_policy.tls.validation.trust.sds.secret_name #=> String
resp.virtual_node.spec.backends[0].virtual_service.virtual_service_name #=> String
resp.virtual_node.spec.listeners #=> Array
resp.virtual_node.spec.listeners[0].connection_pool.grpc.max_requests #=> Integer
resp.virtual_node.spec.listeners[0].connection_pool.http.max_connections #=> Integer
resp.virtual_node.spec.listeners[0].connection_pool.http.max_pending_requests #=> Integer
resp.virtual_node.spec.listeners[0].connection_pool.http2.max_requests #=> Integer
resp.virtual_node.spec.listeners[0].connection_pool.tcp.max_connections #=> Integer
resp.virtual_node.spec.listeners[0].health_check.healthy_threshold #=> Integer
resp.virtual_node.spec.listeners[0].health_check.interval_millis #=> Integer
resp.virtual_node.spec.listeners[0].health_check.path #=> String
resp.virtual_node.spec.listeners[0].health_check.port #=> Integer
resp.virtual_node.spec.listeners[0].health_check.protocol #=> String, one of "http", "tcp", "http2", "grpc"
resp.virtual_node.spec.listeners[0].health_check.timeout_millis #=> Integer
resp.virtual_node.spec.listeners[0].health_check.unhealthy_threshold #=> Integer
resp.virtual_node.spec.listeners[0].outlier_detection.base_ejection_duration.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].outlier_detection.base_ejection_duration.value #=> Integer
resp.virtual_node.spec.listeners[0].outlier_detection.interval.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].outlier_detection.interval.value #=> Integer
resp.virtual_node.spec.listeners[0].outlier_detection.max_ejection_percent #=> Integer
resp.virtual_node.spec.listeners[0].outlier_detection.max_server_errors #=> Integer
resp.virtual_node.spec.listeners[0].port_mapping.port #=> Integer
resp.virtual_node.spec.listeners[0].port_mapping.protocol #=> String, one of "http", "tcp", "http2", "grpc"
resp.virtual_node.spec.listeners[0].timeout.grpc.idle.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].timeout.grpc.idle.value #=> Integer
resp.virtual_node.spec.listeners[0].timeout.grpc.per_request.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].timeout.grpc.per_request.value #=> Integer
resp.virtual_node.spec.listeners[0].timeout.http.idle.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].timeout.http.idle.value #=> Integer
resp.virtual_node.spec.listeners[0].timeout.http.per_request.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].timeout.http.per_request.value #=> Integer
resp.virtual_node.spec.listeners[0].timeout.http2.idle.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].timeout.http2.idle.value #=> Integer
resp.virtual_node.spec.listeners[0].timeout.http2.per_request.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].timeout.http2.per_request.value #=> Integer
resp.virtual_node.spec.listeners[0].timeout.tcp.idle.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].timeout.tcp.idle.value #=> Integer
resp.virtual_node.spec.listeners[0].tls.certificate.acm.certificate_arn #=> String
resp.virtual_node.spec.listeners[0].tls.certificate.file.certificate_chain #=> String
resp.virtual_node.spec.listeners[0].tls.certificate.file.private_key #=> String
resp.virtual_node.spec.listeners[0].tls.certificate.sds.secret_name #=> String
resp.virtual_node.spec.listeners[0].tls.mode #=> String, one of "STRICT", "PERMISSIVE", "DISABLED"
resp.virtual_node.spec.listeners[0].tls.validation.subject_alternative_names.match.exact #=> Array
resp.virtual_node.spec.listeners[0].tls.validation.subject_alternative_names.match.exact[0] #=> String
resp.virtual_node.spec.listeners[0].tls.validation.trust.file.certificate_chain #=> String
resp.virtual_node.spec.listeners[0].tls.validation.trust.sds.secret_name #=> String
resp.virtual_node.spec.logging.access_log.file.format.json #=> Array
resp.virtual_node.spec.logging.access_log.file.format.json[0].key #=> String
resp.virtual_node.spec.logging.access_log.file.format.json[0].value #=> String
resp.virtual_node.spec.logging.access_log.file.format.text #=> String
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.ip_preference #=> String, one of "IPv6_PREFERRED", "IPv4_PREFERRED", "IPv4_ONLY", "IPv6_ONLY"
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.spec.service_discovery.dns.ip_preference #=> String, one of "IPv6_PREFERRED", "IPv4_PREFERRED", "IPv4_ONLY", "IPv6_ONLY"
resp.virtual_node.spec.service_discovery.dns.response_type #=> String, one of "LOADBALANCER", "ENDPOINTS"
resp.virtual_node.status.status #=> String, one of "ACTIVE", "INACTIVE", "DELETED"
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 Amazon Web Services 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:
-
(Types::DeleteVirtualNodeOutput)
—
Returns a response object which responds to the following methods:
- #virtual_node => Types::VirtualNodeData
See Also:
2682 2683 2684 2685 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 2682 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
Request syntax with placeholder values
resp = client.delete_virtual_router({
mesh_name: "ResourceName", # required
mesh_owner: "AccountId",
virtual_router_name: "ResourceName", # required
})
Response structure
Response structure
resp.virtual_router.mesh_name #=> String
resp.virtual_router.metadata.arn #=> String
resp.virtual_router.metadata.created_at #=> Time
resp.virtual_router.metadata.last_updated_at #=> Time
resp.virtual_router.metadata.mesh_owner #=> String
resp.virtual_router.metadata.resource_owner #=> String
resp.virtual_router.metadata.uid #=> String
resp.virtual_router.metadata.version #=> Integer
resp.virtual_router.spec.listeners #=> Array
resp.virtual_router.spec.listeners[0].port_mapping.port #=> Integer
resp.virtual_router.spec.listeners[0].port_mapping.protocol #=> String, one of "http", "tcp", "http2", "grpc"
resp.virtual_router.status.status #=> String, one of "ACTIVE", "INACTIVE", "DELETED"
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 Amazon Web Services 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:
-
(Types::DeleteVirtualRouterOutput)
—
Returns a response object which responds to the following methods:
- #virtual_router => Types::VirtualRouterData
See Also:
2740 2741 2742 2743 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 2740 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
Request syntax with placeholder values
resp = client.delete_virtual_service({
mesh_name: "ResourceName", # required
mesh_owner: "AccountId",
virtual_service_name: "ServiceName", # required
})
Response structure
Response structure
resp.virtual_service.mesh_name #=> String
resp.virtual_service.metadata.arn #=> String
resp.virtual_service.metadata.created_at #=> Time
resp.virtual_service.metadata.last_updated_at #=> Time
resp.virtual_service.metadata.mesh_owner #=> String
resp.virtual_service.metadata.resource_owner #=> String
resp.virtual_service.metadata.uid #=> String
resp.virtual_service.metadata.version #=> Integer
resp.virtual_service.spec.provider.virtual_node.virtual_node_name #=> String
resp.virtual_service.spec.provider.virtual_router.virtual_router_name #=> String
resp.virtual_service.status.status #=> String, one of "ACTIVE", "INACTIVE", "DELETED"
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 Amazon Web Services 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:
-
(Types::DeleteVirtualServiceOutput)
—
Returns a response object which responds to the following methods:
- #virtual_service => Types::VirtualServiceData
See Also:
2794 2795 2796 2797 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 2794 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
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
Response structure
resp.gateway_route.gateway_route_name #=> String
resp.gateway_route.mesh_name #=> String
resp.gateway_route.metadata.arn #=> String
resp.gateway_route.metadata.created_at #=> Time
resp.gateway_route.metadata.last_updated_at #=> Time
resp.gateway_route.metadata.mesh_owner #=> String
resp.gateway_route.metadata.resource_owner #=> String
resp.gateway_route.metadata.uid #=> String
resp.gateway_route.metadata.version #=> Integer
resp.gateway_route.spec.grpc_route.action.rewrite.hostname.default_target_hostname #=> String, one of "ENABLED", "DISABLED"
resp.gateway_route.spec.grpc_route.action.target.port #=> Integer
resp.gateway_route.spec.grpc_route.action.target.virtual_service.virtual_service_name #=> String
resp.gateway_route.spec.grpc_route.match.hostname.exact #=> String
resp.gateway_route.spec.grpc_route.match.hostname.suffix #=> String
resp.gateway_route.spec.grpc_route.match.metadata #=> Array
resp.gateway_route.spec.grpc_route.match.metadata[0].invert #=> Boolean
resp.gateway_route.spec.grpc_route.match.metadata[0].match.exact #=> String
resp.gateway_route.spec.grpc_route.match.metadata[0].match.prefix #=> String
resp.gateway_route.spec.grpc_route.match.metadata[0].match.range.end #=> Integer
resp.gateway_route.spec.grpc_route.match.metadata[0].match.range.start #=> Integer
resp.gateway_route.spec.grpc_route.match.metadata[0].match.regex #=> String
resp.gateway_route.spec.grpc_route.match.metadata[0].match.suffix #=> String
resp.gateway_route.spec.grpc_route.match.metadata[0].name #=> String
resp.gateway_route.spec.grpc_route.match.port #=> Integer
resp.gateway_route.spec.grpc_route.match.service_name #=> String
resp.gateway_route.spec.http2_route.action.rewrite.hostname.default_target_hostname #=> String, one of "ENABLED", "DISABLED"
resp.gateway_route.spec.http2_route.action.rewrite.path.exact #=> String
resp.gateway_route.spec.http2_route.action.rewrite.prefix.default_prefix #=> String, one of "ENABLED", "DISABLED"
resp.gateway_route.spec.http2_route.action.rewrite.prefix.value #=> String
resp.gateway_route.spec.http2_route.action.target.port #=> Integer
resp.gateway_route.spec.http2_route.action.target.virtual_service.virtual_service_name #=> String
resp.gateway_route.spec.http2_route.match.headers #=> Array
resp.gateway_route.spec.http2_route.match.headers[0].invert #=> Boolean
resp.gateway_route.spec.http2_route.match.headers[0].match.exact #=> String
resp.gateway_route.spec.http2_route.match.headers[0].match.prefix #=> String
resp.gateway_route.spec.http2_route.match.headers[0].match.range.end #=> Integer
resp.gateway_route.spec.http2_route.match.headers[0].match.range.start #=> Integer
resp.gateway_route.spec.http2_route.match.headers[0].match.regex #=> String
resp.gateway_route.spec.http2_route.match.headers[0].match.suffix #=> String
resp.gateway_route.spec.http2_route.match.headers[0].name #=> String
resp.gateway_route.spec.http2_route.match.hostname.exact #=> String
resp.gateway_route.spec.http2_route.match.hostname.suffix #=> String
resp.gateway_route.spec.http2_route.match.method #=> String, one of "GET", "HEAD", "POST", "PUT", "DELETE", "CONNECT", "OPTIONS", "TRACE", "PATCH"
resp.gateway_route.spec.http2_route.match.path.exact #=> String
resp.gateway_route.spec.http2_route.match.path.regex #=> String
resp.gateway_route.spec.http2_route.match.port #=> Integer
resp.gateway_route.spec.http2_route.match.prefix #=> String
resp.gateway_route.spec.http2_route.match.query_parameters #=> Array
resp.gateway_route.spec.http2_route.match.query_parameters[0].match.exact #=> String
resp.gateway_route.spec.http2_route.match.query_parameters[0].name #=> String
resp.gateway_route.spec.http_route.action.rewrite.hostname.default_target_hostname #=> String, one of "ENABLED", "DISABLED"
resp.gateway_route.spec.http_route.action.rewrite.path.exact #=> String
resp.gateway_route.spec.http_route.action.rewrite.prefix.default_prefix #=> String, one of "ENABLED", "DISABLED"
resp.gateway_route.spec.http_route.action.rewrite.prefix.value #=> String
resp.gateway_route.spec.http_route.action.target.port #=> Integer
resp.gateway_route.spec.http_route.action.target.virtual_service.virtual_service_name #=> String
resp.gateway_route.spec.http_route.match.headers #=> Array
resp.gateway_route.spec.http_route.match.headers[0].invert #=> Boolean
resp.gateway_route.spec.http_route.match.headers[0].match.exact #=> String
resp.gateway_route.spec.http_route.match.headers[0].match.prefix #=> String
resp.gateway_route.spec.http_route.match.headers[0].match.range.end #=> Integer
resp.gateway_route.spec.http_route.match.headers[0].match.range.start #=> Integer
resp.gateway_route.spec.http_route.match.headers[0].match.regex #=> String
resp.gateway_route.spec.http_route.match.headers[0].match.suffix #=> String
resp.gateway_route.spec.http_route.match.headers[0].name #=> String
resp.gateway_route.spec.http_route.match.hostname.exact #=> String
resp.gateway_route.spec.http_route.match.hostname.suffix #=> String
resp.gateway_route.spec.http_route.match.method #=> String, one of "GET", "HEAD", "POST", "PUT", "DELETE", "CONNECT", "OPTIONS", "TRACE", "PATCH"
resp.gateway_route.spec.http_route.match.path.exact #=> String
resp.gateway_route.spec.http_route.match.path.regex #=> String
resp.gateway_route.spec.http_route.match.port #=> Integer
resp.gateway_route.spec.http_route.match.prefix #=> String
resp.gateway_route.spec.http_route.match.query_parameters #=> Array
resp.gateway_route.spec.http_route.match.query_parameters[0].match.exact #=> String
resp.gateway_route.spec.http_route.match.query_parameters[0].name #=> String
resp.gateway_route.spec.priority #=> Integer
resp.gateway_route.status.status #=> String, one of "ACTIVE", "INACTIVE", "DELETED"
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 Amazon Web Services 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:
-
(Types::DescribeGatewayRouteOutput)
—
Returns a response object which responds to the following methods:
- #gateway_route => Types::GatewayRouteData
See Also:
2919 2920 2921 2922 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 2919 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
Request syntax with placeholder values
resp = client.describe_mesh({
mesh_name: "ResourceName", # required
mesh_owner: "AccountId",
})
Response structure
Response structure
resp.mesh.mesh_name #=> String
resp.mesh.metadata.arn #=> String
resp.mesh.metadata.created_at #=> Time
resp.mesh.metadata.last_updated_at #=> Time
resp.mesh.metadata.mesh_owner #=> String
resp.mesh.metadata.resource_owner #=> String
resp.mesh.metadata.uid #=> String
resp.mesh.metadata.version #=> Integer
resp.mesh.spec.egress_filter.type #=> String, one of "ALLOW_ALL", "DROP_ALL"
resp.mesh.spec.service_discovery.ip_preference #=> String, one of "IPv6_PREFERRED", "IPv4_PREFERRED", "IPv4_ONLY", "IPv6_ONLY"
resp.mesh.status.status #=> String, one of "ACTIVE", "INACTIVE", "DELETED"
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:mesh_name
(required, String)
—
The name of the service mesh to describe.
-
:mesh_owner
(String)
—
The Amazon Web Services 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:
2968 2969 2970 2971 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 2968 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
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
Response structure
resp.route.mesh_name #=> String
resp.route.metadata.arn #=> String
resp.route.metadata.created_at #=> Time
resp.route.metadata.last_updated_at #=> Time
resp.route.metadata.mesh_owner #=> String
resp.route.metadata.resource_owner #=> String
resp.route.metadata.uid #=> String
resp.route.metadata.version #=> Integer
resp.route.route_name #=> String
resp.route.spec.grpc_route.action.weighted_targets #=> Array
resp.route.spec.grpc_route.action.weighted_targets[0].port #=> Integer
resp.route.spec.grpc_route.action.weighted_targets[0].virtual_node #=> String
resp.route.spec.grpc_route.action.weighted_targets[0].weight #=> Integer
resp.route.spec.grpc_route.match.metadata #=> Array
resp.route.spec.grpc_route.match.metadata[0].invert #=> Boolean
resp.route.spec.grpc_route.match.metadata[0].match.exact #=> String
resp.route.spec.grpc_route.match.metadata[0].match.prefix #=> String
resp.route.spec.grpc_route.match.metadata[0].match.range.end #=> Integer
resp.route.spec.grpc_route.match.metadata[0].match.range.start #=> Integer
resp.route.spec.grpc_route.match.metadata[0].match.regex #=> String
resp.route.spec.grpc_route.match.metadata[0].match.suffix #=> String
resp.route.spec.grpc_route.match.metadata[0].name #=> String
resp.route.spec.grpc_route.match.method_name #=> String
resp.route.spec.grpc_route.match.port #=> Integer
resp.route.spec.grpc_route.match.service_name #=> String
resp.route.spec.grpc_route.retry_policy.grpc_retry_events #=> Array
resp.route.spec.grpc_route.retry_policy.grpc_retry_events[0] #=> String, one of "cancelled", "deadline-exceeded", "internal", "resource-exhausted", "unavailable"
resp.route.spec.grpc_route.retry_policy.http_retry_events #=> Array
resp.route.spec.grpc_route.retry_policy.http_retry_events[0] #=> String
resp.route.spec.grpc_route.retry_policy.max_retries #=> Integer
resp.route.spec.grpc_route.retry_policy.per_retry_timeout.unit #=> String, one of "s", "ms"
resp.route.spec.grpc_route.retry_policy.per_retry_timeout.value #=> Integer
resp.route.spec.grpc_route.retry_policy.tcp_retry_events #=> Array
resp.route.spec.grpc_route.retry_policy.tcp_retry_events[0] #=> String, one of "connection-error"
resp.route.spec.grpc_route.timeout.idle.unit #=> String, one of "s", "ms"
resp.route.spec.grpc_route.timeout.idle.value #=> Integer
resp.route.spec.grpc_route.timeout.per_request.unit #=> String, one of "s", "ms"
resp.route.spec.grpc_route.timeout.per_request.value #=> Integer
resp.route.spec.http2_route.action.weighted_targets #=> Array
resp.route.spec.http2_route.action.weighted_targets[0].port #=> Integer
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 "GET", "HEAD", "POST", "PUT", "DELETE", "CONNECT", "OPTIONS", "TRACE", "PATCH"
resp.route.spec.http2_route.match.path.exact #=> String
resp.route.spec.http2_route.match.path.regex #=> String
resp.route.spec.http2_route.match.port #=> Integer
resp.route.spec.http2_route.match.prefix #=> String
resp.route.spec.http2_route.match.query_parameters #=> Array
resp.route.spec.http2_route.match.query_parameters[0].match.exact #=> String
resp.route.spec.http2_route.match.query_parameters[0].name #=> String
resp.route.spec.http2_route.match.scheme #=> String, one of "http", "https"
resp.route.spec.http2_route.retry_policy.http_retry_events #=> Array
resp.route.spec.http2_route.retry_policy.http_retry_events[0] #=> String
resp.route.spec.http2_route.retry_policy.max_retries #=> Integer
resp.route.spec.http2_route.retry_policy.per_retry_timeout.unit #=> String, one of "s", "ms"
resp.route.spec.http2_route.retry_policy.per_retry_timeout.value #=> Integer
resp.route.spec.http2_route.retry_policy.tcp_retry_events #=> Array
resp.route.spec.http2_route.retry_policy.tcp_retry_events[0] #=> String, one of "connection-error"
resp.route.spec.http2_route.timeout.idle.unit #=> String, one of "s", "ms"
resp.route.spec.http2_route.timeout.idle.value #=> Integer
resp.route.spec.http2_route.timeout.per_request.unit #=> String, one of "s", "ms"
resp.route.spec.http2_route.timeout.per_request.value #=> Integer
resp.route.spec.http_route.action.weighted_targets #=> Array
resp.route.spec.http_route.action.weighted_targets[0].port #=> Integer
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 "GET", "HEAD", "POST", "PUT", "DELETE", "CONNECT", "OPTIONS", "TRACE", "PATCH"
resp.route.spec.http_route.match.path.exact #=> String
resp.route.spec.http_route.match.path.regex #=> String
resp.route.spec.http_route.match.port #=> Integer
resp.route.spec.http_route.match.prefix #=> String
resp.route.spec.http_route.match.query_parameters #=> Array
resp.route.spec.http_route.match.query_parameters[0].match.exact #=> String
resp.route.spec.http_route.match.query_parameters[0].name #=> String
resp.route.spec.http_route.match.scheme #=> String, one of "http", "https"
resp.route.spec.http_route.retry_policy.http_retry_events #=> Array
resp.route.spec.http_route.retry_policy.http_retry_events[0] #=> String
resp.route.spec.http_route.retry_policy.max_retries #=> Integer
resp.route.spec.http_route.retry_policy.per_retry_timeout.unit #=> String, one of "s", "ms"
resp.route.spec.http_route.retry_policy.per_retry_timeout.value #=> Integer
resp.route.spec.http_route.retry_policy.tcp_retry_events #=> Array
resp.route.spec.http_route.retry_policy.tcp_retry_events[0] #=> String, one of "connection-error"
resp.route.spec.http_route.timeout.idle.unit #=> String, one of "s", "ms"
resp.route.spec.http_route.timeout.idle.value #=> Integer
resp.route.spec.http_route.timeout.per_request.unit #=> String, one of "s", "ms"
resp.route.spec.http_route.timeout.per_request.value #=> Integer
resp.route.spec.priority #=> Integer
resp.route.spec.tcp_route.action.weighted_targets #=> Array
resp.route.spec.tcp_route.action.weighted_targets[0].port #=> Integer
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.match.port #=> Integer
resp.route.spec.tcp_route.timeout.idle.unit #=> String, one of "s", "ms"
resp.route.spec.tcp_route.timeout.idle.value #=> Integer
resp.route.status.status #=> String, one of "ACTIVE", "INACTIVE", "DELETED"
resp.route.virtual_router_name #=> String
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 Amazon Web Services 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:
3128 3129 3130 3131 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 3128 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
Request syntax with placeholder values
resp = client.describe_virtual_gateway({
mesh_name: "ResourceName", # required
mesh_owner: "AccountId",
virtual_gateway_name: "ResourceName", # required
})
Response structure
Response structure
resp.virtual_gateway.mesh_name #=> String
resp.virtual_gateway.metadata.arn #=> String
resp.virtual_gateway.metadata.created_at #=> Time
resp.virtual_gateway.metadata.last_updated_at #=> Time
resp.virtual_gateway.metadata.mesh_owner #=> String
resp.virtual_gateway.metadata.resource_owner #=> String
resp.virtual_gateway.metadata.uid #=> String
resp.virtual_gateway.metadata.version #=> Integer
resp.virtual_gateway.spec.backend_defaults.client_policy.tls.certificate.file.certificate_chain #=> String
resp.virtual_gateway.spec.backend_defaults.client_policy.tls.certificate.file.private_key #=> String
resp.virtual_gateway.spec.backend_defaults.client_policy.tls.certificate.sds.secret_name #=> String
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.subject_alternative_names.match.exact #=> Array
resp.virtual_gateway.spec.backend_defaults.client_policy.tls.validation.subject_alternative_names.match.exact[0] #=> String
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.backend_defaults.client_policy.tls.validation.trust.sds.secret_name #=> String
resp.virtual_gateway.spec.listeners #=> Array
resp.virtual_gateway.spec.listeners[0].connection_pool.grpc.max_requests #=> Integer
resp.virtual_gateway.spec.listeners[0].connection_pool.http.max_connections #=> Integer
resp.virtual_gateway.spec.listeners[0].connection_pool.http.max_pending_requests #=> Integer
resp.virtual_gateway.spec.listeners[0].connection_pool.http2.max_requests #=> Integer
resp.virtual_gateway.spec.listeners[0].health_check.healthy_threshold #=> Integer
resp.virtual_gateway.spec.listeners[0].health_check.interval_millis #=> Integer
resp.virtual_gateway.spec.listeners[0].health_check.path #=> String
resp.virtual_gateway.spec.listeners[0].health_check.port #=> Integer
resp.virtual_gateway.spec.listeners[0].health_check.protocol #=> String, one of "http", "http2", "grpc"
resp.virtual_gateway.spec.listeners[0].health_check.timeout_millis #=> Integer
resp.virtual_gateway.spec.listeners[0].health_check.unhealthy_threshold #=> Integer
resp.virtual_gateway.spec.listeners[0].port_mapping.port #=> Integer
resp.virtual_gateway.spec.listeners[0].port_mapping.protocol #=> String, one of "http", "http2", "grpc"
resp.virtual_gateway.spec.listeners[0].tls.certificate.acm.certificate_arn #=> String
resp.virtual_gateway.spec.listeners[0].tls.certificate.file.certificate_chain #=> String
resp.virtual_gateway.spec.listeners[0].tls.certificate.file.private_key #=> String
resp.virtual_gateway.spec.listeners[0].tls.certificate.sds.secret_name #=> String
resp.virtual_gateway.spec.listeners[0].tls.mode #=> String, one of "STRICT", "PERMISSIVE", "DISABLED"
resp.virtual_gateway.spec.listeners[0].tls.validation.subject_alternative_names.match.exact #=> Array
resp.virtual_gateway.spec.listeners[0].tls.validation.subject_alternative_names.match.exact[0] #=> String
resp.virtual_gateway.spec.listeners[0].tls.validation.trust.file.certificate_chain #=> String
resp.virtual_gateway.spec.listeners[0].tls.validation.trust.sds.secret_name #=> String
resp.virtual_gateway.spec.logging.access_log.file.format.json #=> Array
resp.virtual_gateway.spec.logging.access_log.file.format.json[0].key #=> String
resp.virtual_gateway.spec.logging.access_log.file.format.json[0].value #=> String
resp.virtual_gateway.spec.logging.access_log.file.format.text #=> String
resp.virtual_gateway.spec.logging.access_log.file.path #=> String
resp.virtual_gateway.status.status #=> String, one of "ACTIVE", "INACTIVE", "DELETED"
resp.virtual_gateway.virtual_gateway_name #=> String
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 Amazon Web Services 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:
-
(Types::DescribeVirtualGatewayOutput)
—
Returns a response object which responds to the following methods:
- #virtual_gateway => Types::VirtualGatewayData
See Also:
3220 3221 3222 3223 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 3220 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
Request syntax with placeholder values
resp = client.describe_virtual_node({
mesh_name: "ResourceName", # required
mesh_owner: "AccountId",
virtual_node_name: "ResourceName", # required
})
Response structure
Response structure
resp.virtual_node.mesh_name #=> String
resp.virtual_node.metadata.arn #=> String
resp.virtual_node.metadata.created_at #=> Time
resp.virtual_node.metadata.last_updated_at #=> Time
resp.virtual_node.metadata.mesh_owner #=> String
resp.virtual_node.metadata.resource_owner #=> String
resp.virtual_node.metadata.uid #=> String
resp.virtual_node.metadata.version #=> Integer
resp.virtual_node.spec.backend_defaults.client_policy.tls.certificate.file.certificate_chain #=> String
resp.virtual_node.spec.backend_defaults.client_policy.tls.certificate.file.private_key #=> String
resp.virtual_node.spec.backend_defaults.client_policy.tls.certificate.sds.secret_name #=> String
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.subject_alternative_names.match.exact #=> Array
resp.virtual_node.spec.backend_defaults.client_policy.tls.validation.subject_alternative_names.match.exact[0] #=> String
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.backend_defaults.client_policy.tls.validation.trust.sds.secret_name #=> String
resp.virtual_node.spec.backends #=> Array
resp.virtual_node.spec.backends[0].virtual_service.client_policy.tls.certificate.file.certificate_chain #=> String
resp.virtual_node.spec.backends[0].virtual_service.client_policy.tls.certificate.file.private_key #=> String
resp.virtual_node.spec.backends[0].virtual_service.client_policy.tls.certificate.sds.secret_name #=> String
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.subject_alternative_names.match.exact #=> Array
resp.virtual_node.spec.backends[0].virtual_service.client_policy.tls.validation.subject_alternative_names.match.exact[0] #=> String
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.client_policy.tls.validation.trust.sds.secret_name #=> String
resp.virtual_node.spec.backends[0].virtual_service.virtual_service_name #=> String
resp.virtual_node.spec.listeners #=> Array
resp.virtual_node.spec.listeners[0].connection_pool.grpc.max_requests #=> Integer
resp.virtual_node.spec.listeners[0].connection_pool.http.max_connections #=> Integer
resp.virtual_node.spec.listeners[0].connection_pool.http.max_pending_requests #=> Integer
resp.virtual_node.spec.listeners[0].connection_pool.http2.max_requests #=> Integer
resp.virtual_node.spec.listeners[0].connection_pool.tcp.max_connections #=> Integer
resp.virtual_node.spec.listeners[0].health_check.healthy_threshold #=> Integer
resp.virtual_node.spec.listeners[0].health_check.interval_millis #=> Integer
resp.virtual_node.spec.listeners[0].health_check.path #=> String
resp.virtual_node.spec.listeners[0].health_check.port #=> Integer
resp.virtual_node.spec.listeners[0].health_check.protocol #=> String, one of "http", "tcp", "http2", "grpc"
resp.virtual_node.spec.listeners[0].health_check.timeout_millis #=> Integer
resp.virtual_node.spec.listeners[0].health_check.unhealthy_threshold #=> Integer
resp.virtual_node.spec.listeners[0].outlier_detection.base_ejection_duration.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].outlier_detection.base_ejection_duration.value #=> Integer
resp.virtual_node.spec.listeners[0].outlier_detection.interval.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].outlier_detection.interval.value #=> Integer
resp.virtual_node.spec.listeners[0].outlier_detection.max_ejection_percent #=> Integer
resp.virtual_node.spec.listeners[0].outlier_detection.max_server_errors #=> Integer
resp.virtual_node.spec.listeners[0].port_mapping.port #=> Integer
resp.virtual_node.spec.listeners[0].port_mapping.protocol #=> String, one of "http", "tcp", "http2", "grpc"
resp.virtual_node.spec.listeners[0].timeout.grpc.idle.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].timeout.grpc.idle.value #=> Integer
resp.virtual_node.spec.listeners[0].timeout.grpc.per_request.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].timeout.grpc.per_request.value #=> Integer
resp.virtual_node.spec.listeners[0].timeout.http.idle.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].timeout.http.idle.value #=> Integer
resp.virtual_node.spec.listeners[0].timeout.http.per_request.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].timeout.http.per_request.value #=> Integer
resp.virtual_node.spec.listeners[0].timeout.http2.idle.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].timeout.http2.idle.value #=> Integer
resp.virtual_node.spec.listeners[0].timeout.http2.per_request.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].timeout.http2.per_request.value #=> Integer
resp.virtual_node.spec.listeners[0].timeout.tcp.idle.unit #=> String, one of "s", "ms"
resp.virtual_node.spec.listeners[0].timeout.tcp.idle.value #=> Integer
resp.virtual_node.spec.listeners[0].tls.certificate.acm.certificate_arn #=> String
resp.virtual_node.spec.listeners[0].tls.certificate.file.certificate_chain #=> String
resp.virtual_node.spec.listeners[0].tls.certificate.file.private_key #=> String
resp.virtual_node.spec.listeners[0].tls.certificate.sds.secret_name #=> String
resp.virtual_node.spec.listeners[0].tls.mode #=> String, one of "STRICT", "PERMISSIVE", "DISABLED"
resp.virtual_node.spec.listeners[0].tls.validation.subject_alternative_names.match.exact #=> Array
resp.virtual_node.spec.listeners[0].tls.validation.subject_alternative_names.match.exact[0] #=> String
resp.virtual_node.spec.listeners[0].tls.validation.trust.file.certificate_chain #=> String
resp.virtual_node.spec.listeners[0].tls.validation.trust.sds.secret_name #=> String
resp.virtual_node.spec.logging.access_log.file.format.json #=> Array
resp.virtual_node.spec.logging.access_log.file.format.json[0].key #=> String
resp.virtual_node.spec.logging.access_log.file.format.json[0].value #=> String
resp.virtual_node.spec.logging.access_log.file.format.text #=> String
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.ip_preference #=> String, one of "IPv6_PREFERRED", "IPv4_PREFERRED", "IPv4_ONLY", "IPv6_ONLY"
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.spec.service_discovery.dns.ip_preference #=> String, one of "IPv6_PREFERRED", "IPv4_PREFERRED", "IPv4_ONLY", "IPv6_ONLY"
resp.virtual_node.spec.service_discovery.dns.response_type #=> String, one of "LOADBALANCER", "ENDPOINTS"
resp.virtual_node.status.status #=> String, one of "ACTIVE", "INACTIVE", "DELETED"
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 Amazon Web Services 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:
-
(Types::DescribeVirtualNodeOutput)
—
Returns a response object which responds to the following methods:
- #virtual_node => Types::VirtualNodeData
See Also:
3356 3357 3358 3359 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 3356 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
Request syntax with placeholder values
resp = client.describe_virtual_router({
mesh_name: "ResourceName", # required
mesh_owner: "AccountId",
virtual_router_name: "ResourceName", # required
})
Response structure
Response structure
resp.virtual_router.mesh_name #=> String
resp.virtual_router.metadata.arn #=> String
resp.virtual_router.metadata.created_at #=> Time
resp.virtual_router.metadata.last_updated_at #=> Time
resp.virtual_router.metadata.mesh_owner #=> String
resp.virtual_router.metadata.resource_owner #=> String
resp.virtual_router.metadata.uid #=> String
resp.virtual_router.metadata.version #=> Integer
resp.virtual_router.spec.listeners #=> Array
resp.virtual_router.spec.listeners[0].port_mapping.port #=> Integer
resp.virtual_router.spec.listeners[0].port_mapping.protocol #=> String, one of "http", "tcp", "http2", "grpc"
resp.virtual_router.status.status #=> String, one of "ACTIVE", "INACTIVE", "DELETED"
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 Amazon Web Services 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:
-
(Types::DescribeVirtualRouterOutput)
—
Returns a response object which responds to the following methods:
- #virtual_router => Types::VirtualRouterData
See Also:
3411 3412 3413 3414 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 3411 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
Request syntax with placeholder values
resp = client.describe_virtual_service({
mesh_name: "ResourceName", # required
mesh_owner: "AccountId",
virtual_service_name: "ServiceName", # required
})
Response structure
Response structure
resp.virtual_service.mesh_name #=> String
resp.virtual_service.metadata.arn #=> String
resp.virtual_service.metadata.created_at #=> Time
resp.virtual_service.metadata.last_updated_at #=> Time
resp.virtual_service.metadata.mesh_owner #=> String
resp.virtual_service.metadata.resource_owner #=> String
resp.virtual_service.metadata.uid #=> String
resp.virtual_service.metadata.version #=> Integer
resp.virtual_service.spec.provider.virtual_node.virtual_node_name #=> String
resp.virtual_service.spec.provider.virtual_router.virtual_router_name #=> String
resp.virtual_service.status.status #=> String, one of "ACTIVE", "INACTIVE", "DELETED"
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 Amazon Web Services 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:
-
(Types::DescribeVirtualServiceOutput)
—
Returns a response object which responds to the following methods:
- #virtual_service => Types::VirtualServiceData
See Also:
3465 3466 3467 3468 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 3465 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
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
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 onlylimit
results in a single page along with anextToken
response element. You can see the remaining results of the initial request by sending anotherListGatewayRoutes
request with the returnednextToken
value. This value can be between 1 and 100. If you don't use this parameter,ListGatewayRoutes
returns up to 100 results and anextToken
value if applicable. -
:mesh_name
(required, String)
—
The name of the service mesh to list gateway routes in.
-
:mesh_owner
(String)
—
The Amazon Web Services 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 paginatedListGatewayRoutes
request wherelimit
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value. -
:virtual_gateway_name
(required, String)
—
The name of the virtual gateway to list gateway routes in.
Returns:
-
(Types::ListGatewayRoutesOutput)
—
Returns a response object which responds to the following methods:
- #gateway_routes => Array<Types::GatewayRouteRef>
- #next_token => String
See Also:
3540 3541 3542 3543 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 3540 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
Request syntax with placeholder values
resp = client.list_meshes({
limit: 1,
next_token: "String",
})
Response structure
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