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 used for authentication. This can be any class that includes and implements
Aws::CredentialProvider, or 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
:credentialsare 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_idoptions.ENV['AWS_ACCESS_KEY_ID'],ENV['AWS_SECRET_ACCESS_KEY'],ENV['AWS_SESSION_TOKEN'], andENV['AWS_ACCOUNT_ID'].~/.aws/credentials~/.aws/configEC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of
Aws::InstanceProfileCredentialsorAws::ECSCredentialsto enable retries and extended timeouts. Instance profile credential fetching can be disabled by settingENV['AWS_EC2_METADATA_DISABLED']totrue.
-
:region
(required, String)
—
The AWS region to connect to. The configured
:regionis used to determine the service:endpoint. When not passed, a default:regionis 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
adaptiveretry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise aRetryCapacityNotAvailableErrorand will not retry instead of sleeping. -
:auth_scheme_preference
(Array<String>)
—
A list of preferred authentication schemes to use when making a request. Supported values are:
sigv4,sigv4a,httpBearerAuth, andnoAuth. When set usingENV['AWS_AUTH_SCHEME_PREFERENCE']or in shared config asauth_scheme_preference, the value should be a comma-separated list. -
: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
standardandadaptiveretry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks. Takes effect only whendisable_clock_skew_correctionis not set. -
:defaults_mode
(String)
— default:
"legacy"
—
See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.
-
:disable_clock_skew_correction
(Boolean)
—
Used only in
standardandadaptiveretry modes. Whentrue, the SDK does not apply a clock skew correction, does not update its stored skew from responses, and does not retry clock skew errors. Clock skew correction is enabled by default. -
:disable_host_prefix_injection
(Boolean)
— default:
false
—
When
true, the SDK will not prepend the modeled host prefix to the endpoint. -
: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
:endpointoption directly. This is normally constructed from the:regionoption. Configuring:endpointis 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
:loggerat. -
: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
standardandadaptiveretry modes. Defaults to 3, except for DynamoDB and DynamoDB Streams, which default to 4. -
:profile
(String)
— default:
"default"
—
Used when loading credentials from the shared credentials file at
HOME/.aws/credentials. When not specified, 'default' is used. -
:request_checksum_calculation
(String)
— default:
"when_supported"
—
Determines when a checksum will be calculated for request payloads. Values are:
when_supported- (default) When set, a checksum will be calculated for all request payloads of operations modeled with thehttpChecksumtrait whererequestChecksumRequiredistrueand/or arequestAlgorithmMemberis modeled.when_required- When set, a checksum will only be calculated for request payloads of operations modeled with thehttpChecksumtrait whererequestChecksumRequiredistrueor where arequestAlgorithmMemberis modeled and supplied.
-
: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.
-
:response_checksum_validation
(String)
— default:
"when_supported"
—
Determines when checksum validation will be performed on response payloads. Values are:
when_supported- (default) When set, checksum validation is performed on all response payloads of operations modeled with thehttpChecksumtrait whereresponseAlgorithmsis modeled, except when no modeled checksum algorithms are supported.when_required- When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and therequestValidationModeMembermember is set toENABLED.
-
:retry_backoff
(Proc)
—
A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the
legacyretry 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
legacyretry 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
legacyretry 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
legacyretry 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
legacyretry mode. -
:retry_mode
(String)
— default:
"standard"
—
Specifies which retry algorithm to use. Values are:
legacy- The pre-existing retry behavior.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. This is the default value if no retry mode is provided.adaptive- A retry mode that includes all the functionality ofstandardmode along with automatic client side throttling.
-
: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_setis 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
NoOpTelemetryProviderwhich 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-sdkgem and then, pass in an instance of aAws::Telemetry::OTelProviderfor telemetry provider.
- OpenTelemetry (OTel) - To use the OTel provider, install and require the
-
:token_provider
(Aws::TokenProvider)
—
Your Bearer token used for authentication. This can be any class that includes and implements
Aws::TokenProvider, or 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_provideris not configured directly, theAws::TokenProviderChainwill 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.awsTLD) will be used if available. -
:use_fips_endpoint
(Boolean)
—
When set to
true, fips compatible endpoints will be used if available. When afipsregion 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)whereparametersis 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
nilwhich 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_bundleor:ssl_ca_directorythe 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_bundleor:ssl_ca_directorythe 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.
479 480 481 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 479 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:
802 803 804 805 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 802 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:
885 886 887 888 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 885 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:
1285 1286 1287 1288 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 1285 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:
1529 1530 1531 1532 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 1529 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:
1951 1952 1953 1954 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 1951 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:
2055 2056 2057 2058 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 2055 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:
2159 2160 2161 2162 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 2159 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:
2283 2284 2285 2286 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 2283 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:
2325 2326 2327 2328 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 2325 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:
2485 2486 2487 2488 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 2485 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:
2578 2579 2580 2581 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 2578 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:
2717 2718 2719 2720 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 2717 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:
2775 2776 2777 2778 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 2775 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:
2829 2830 2831 2832 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 2829 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:
2954 2955 2956 2957 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 2954 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:
3003 3004 3005 3006 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 3003 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:
3163 3164 3165 3166 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 3163 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:
3255 3256 3257 3258 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 3255 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:
3391 3392 3393 3394 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 3391 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:
3446 3447 3448 3449 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 3446 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:
3500 3501 3502 3503 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 3500 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
ListGatewayRoutesin paginated output. When you use this parameter,ListGatewayRoutesreturns onlylimitresults in a single page along with anextTokenresponse element. You can see the remaining results of the initial request by sending anotherListGatewayRoutesrequest with the returnednextTokenvalue. This value can be between 1 and 100. If you don't use this parameter,ListGatewayRoutesreturns up to 100 results and anextTokenvalue 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
nextTokenvalue returned from a previous paginatedListGatewayRoutesrequest wherelimitwas used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextTokenvalue. -
: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:
3575 3576 3577 3578 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 3575 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
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:limit
(Integer)
—
The maximum number of results returned by
ListMeshesin paginated output. When you use this parameter,ListMeshesreturns onlylimitresults in a single page along with anextTokenresponse element. You can see the remaining results of the initial request by sending anotherListMeshesrequest with the returnednextTokenvalue. This value can be between 1 and 100. If you don't use this parameter,ListMeshesreturns up to 100 results and anextTokenvalue if applicable. -
:next_token
(String)
—
The
nextTokenvalue returned from a previous paginatedListMeshesrequest wherelimitwas used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextTokenvalue.This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.
Returns:
-
(Types::ListMeshesOutput)
—
Returns a response object which responds to the following methods:
- #meshes => Array<Types::MeshRef>
- #next_token => String
See Also:
3634 3635 3636 3637 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 3634 def list_meshes(params = {}, options = {}) req = build_request(:list_meshes, params) req.send_request(options) end |
#list_routes(params = {}) ⇒ Types::ListRoutesOutput
Returns a list of existing routes in a service mesh.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_routes({
limit: 1,
mesh_name: "ResourceName", # required
mesh_owner: "AccountId",
next_token: "String",
virtual_router_name: "ResourceName", # required
})
Response structure
Response structure
resp.next_token #=> String
resp.routes #=> Array
resp.routes[0].arn #=> String
resp.routes[0].created_at #=> Time
resp.routes[0].last_updated_at #=> Time
resp.routes[0].mesh_name #=> String
resp.routes[0].mesh_owner #=> String
resp.routes[0].resource_owner #=> String
resp.routes[0].route_name #=> String
resp.routes[0].version #=> Integer
resp.routes[0].virtual_router_name #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:limit
(Integer)
—
The maximum number of results returned by
ListRoutesin paginated output. When you use this parameter,ListRoutesreturns onlylimitresults in a single page along with anextTokenresponse element. You can see the remaining results of the initial request by sending anotherListRoutesrequest with the returnednextTokenvalue. This value can be between 1 and 100. If you don't use this parameter,ListRoutesreturns up to 100 results and anextTokenvalue if applicable. -
:mesh_name
(required, String)
—
The name of the service mesh to list 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
nextTokenvalue returned from a previous paginatedListRoutesrequest wherelimitwas used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextTokenvalue. -
:virtual_router_name
(required, String)
—
The name of the virtual router to list routes in.
Returns:
-
(Types::ListRoutesOutput)
—
Returns a response object which responds to the following methods:
- #next_token => String
- #routes => Array<Types::RouteRef>
See Also:
3708 3709 3710 3711 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 3708 def list_routes(params = {}, options = {}) req = build_request(:list_routes, params) req.send_request(options) end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
List the tags for an App Mesh resource.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_tags_for_resource({
limit: 1,
next_token: "String",
resource_arn: "Arn", # required
})
Response structure
Response structure
resp.next_token #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:limit
(Integer)
—
The maximum number of tag results returned by
ListTagsForResourcein paginated output. When this parameter is used,ListTagsForResourcereturns onlylimitresults in a single page along with anextTokenresponse element. You can see the remaining results of the initial request by sending anotherListTagsForResourcerequest with the returnednextTokenvalue. This value can be between 1 and 100. If you don't use this parameter,ListTagsForResourcereturns up to 100 results and anextTokenvalue if applicable. -
:next_token
(String)
—
The
nextTokenvalue returned from a previous paginatedListTagsForResourcerequest wherelimitwas used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextTokenvalue. -
:resource_arn
(required, String)
—
The Amazon Resource Name (ARN) that identifies the resource to list the tags for.
Returns:
-
(Types::ListTagsForResourceOutput)
—
Returns a response object which responds to the following methods:
- #next_token => String
- #tags => Array<Types::TagRef>
See Also:
3761 3762 3763 3764 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 3761 def list_tags_for_resource(params = {}, options = {}) req = build_request(:list_tags_for_resource, params) req.send_request(options) end |
#list_virtual_gateways(params = {}) ⇒ Types::ListVirtualGatewaysOutput
Returns a list of existing virtual gateways in a service mesh.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_virtual_gateways({
limit: 1,
mesh_name: "ResourceName", # required
mesh_owner: "AccountId",
next_token: "String",
})
Response structure
Response structure
resp.next_token #=> String
resp.virtual_gateways #=> Array
resp.virtual_gateways[0].arn #=> String
resp.virtual_gateways[0].created_at #=> Time
resp.virtual_gateways[0].last_updated_at #=> Time
resp.virtual_gateways[0].mesh_name #=> String
resp.virtual_gateways[0].mesh_owner #=> String
resp.virtual_gateways[0].resource_owner #=> String
resp.virtual_gateways[0].version #=> Integer
resp.virtual_gateways[0].virtual_gateway_name #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:limit
(Integer)
—
The maximum number of results returned by
ListVirtualGatewaysin paginated output. When you use this parameter,ListVirtualGatewaysreturns onlylimitresults in a single page along with anextTokenresponse element. You can see the remaining results of the initial request by sending anotherListVirtualGatewaysrequest with the returnednextTokenvalue. This value can be between 1 and 100. If you don't use this parameter,ListVirtualGatewaysreturns up to 100 results and anextTokenvalue if applicable. -
:mesh_name
(required, String)
—
The name of the service mesh to list virtual gateways 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
nextTokenvalue returned from a previous paginatedListVirtualGatewaysrequest wherelimitwas used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextTokenvalue.
Returns:
-
(Types::ListVirtualGatewaysOutput)
—
Returns a response object which responds to the following methods:
- #next_token => String
- #virtual_gateways => Array<Types::VirtualGatewayRef>
See Also:
3830 3831 3832 3833 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 3830 def list_virtual_gateways(params = {}, options = {}) req = build_request(:list_virtual_gateways, params) req.send_request(options) end |
#list_virtual_nodes(params = {}) ⇒ Types::ListVirtualNodesOutput
Returns a list of existing virtual nodes.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_virtual_nodes({
limit: 1,
mesh_name: "ResourceName", # required
mesh_owner: "AccountId",
next_token: "String",
})
Response structure
Response structure
resp.next_token #=> String
resp.virtual_nodes #=> Array
resp.virtual_nodes[0].arn #=> String
resp.virtual_nodes[0].created_at #=> Time
resp.virtual_nodes[0].last_updated_at #=> Time
resp.virtual_nodes[0].mesh_name #=> String
resp.virtual_nodes[0].mesh_owner #=> String
resp.virtual_nodes[0].resource_owner #=> String
resp.virtual_nodes[0].version #=> Integer
resp.virtual_nodes[0].virtual_node_name #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:limit
(Integer)
—
The maximum number of results returned by
ListVirtualNodesin paginated output. When you use this parameter,ListVirtualNodesreturns onlylimitresults in a single page along with anextTokenresponse element. You can see the remaining results of the initial request by sending anotherListVirtualNodesrequest with the returnednextTokenvalue. This value can be between 1 and 100. If you don't use this parameter,ListVirtualNodesreturns up to 100 results and anextTokenvalue if applicable. -
:mesh_name
(required, String)
—
The name of the service mesh to list virtual nodes 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
nextTokenvalue returned from a previous paginatedListVirtualNodesrequest wherelimitwas used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextTokenvalue.
Returns:
-
(Types::ListVirtualNodesOutput)
—
Returns a response object which responds to the following methods:
- #next_token => String
- #virtual_nodes => Array<Types::VirtualNodeRef>
See Also:
3899 3900 3901 3902 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 3899 def list_virtual_nodes(params = {}, options = {}) req = build_request(:list_virtual_nodes, params) req.send_request(options) end |
#list_virtual_routers(params = {}) ⇒ Types::ListVirtualRoutersOutput
Returns a list of existing virtual routers in a service mesh.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_virtual_routers({
limit: 1,
mesh_name: "ResourceName", # required
mesh_owner: "AccountId",
next_token: "String",
})
Response structure
Response structure
resp.next_token #=> String
resp.virtual_routers #=> Array
resp.virtual_routers[0].arn #=> String
resp.virtual_routers[0].created_at #=> Time
resp.virtual_routers[0].last_updated_at #=> Time
resp.virtual_routers[0].mesh_name #=> String
resp.virtual_routers[0].mesh_owner #=> String
resp.virtual_routers[0].resource_owner #=> String
resp.virtual_routers[0].version #=> Integer
resp.virtual_routers[0].virtual_router_name #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:limit
(Integer)
—
The maximum number of results returned by
ListVirtualRoutersin paginated output. When you use this parameter,ListVirtualRoutersreturns onlylimitresults in a single page along with anextTokenresponse element. You can see the remaining results of the initial request by sending anotherListVirtualRoutersrequest with the returnednextTokenvalue. This value can be between 1 and 100. If you don't use this parameter,ListVirtualRoutersreturns up to 100 results and anextTokenvalue if applicable. -
:mesh_name
(required, String)
—
The name of the service mesh to list virtual routers 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
nextTokenvalue returned from a previous paginatedListVirtualRoutersrequest wherelimitwas used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextTokenvalue.
Returns:
-
(Types::ListVirtualRoutersOutput)
—
Returns a response object which responds to the following methods:
- #next_token => String
- #virtual_routers => Array<Types::VirtualRouterRef>
See Also:
3968 3969 3970 3971 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 3968 def list_virtual_routers(params = {}, options = {}) req = build_request(:list_virtual_routers, params) req.send_request(options) end |
#list_virtual_services(params = {}) ⇒ Types::ListVirtualServicesOutput
Returns a list of existing virtual services in a service mesh.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_virtual_services({
limit: 1,
mesh_name: "ResourceName", # required
mesh_owner: "AccountId",
next_token: "String",
})
Response structure
Response structure
resp.next_token #=> String
resp.virtual_services #=> Array
resp.virtual_services[0].arn #=> String
resp.virtual_services[0].created_at #=> Time
resp.virtual_services[0].last_updated_at #=> Time
resp.virtual_services[0].mesh_name #=> String
resp.virtual_services[0].mesh_owner #=> String
resp.virtual_services[0].resource_owner #=> String
resp.virtual_services[0].version #=> Integer
resp.virtual_services[0].virtual_service_name #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:limit
(Integer)
—
The maximum number of results returned by
ListVirtualServicesin paginated output. When you use this parameter,ListVirtualServicesreturns onlylimitresults in a single page along with anextTokenresponse element. You can see the remaining results of the initial request by sending anotherListVirtualServicesrequest with the returnednextTokenvalue. This value can be between 1 and 100. If you don't use this parameter,ListVirtualServicesreturns up to 100 results and anextTokenvalue if applicable. -
:mesh_name
(required, String)
—
The name of the service mesh to list virtual services 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
nextTokenvalue returned from a previous paginatedListVirtualServicesrequest wherelimitwas used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextTokenvalue.
Returns:
-
(Types::ListVirtualServicesOutput)
—
Returns a response object which responds to the following methods:
- #next_token => String
- #virtual_services => Array<Types::VirtualServiceRef>
See Also:
4037 4038 4039 4040 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 4037 def list_virtual_services(params = {}, options = {}) req = build_request(:list_virtual_services, params) req.send_request(options) end |
#tag_resource(params = {}) ⇒ Struct
Associates the specified tags to a resource with the specified
resourceArn. If existing tags on a resource aren't specified in the
request parameters, they aren't changed. When a resource is deleted,
the tags associated with that resource are also deleted.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.tag_resource({
resource_arn: "Arn", # required
tags: [ # required
{
key: "TagKey", # required
value: "TagValue", # required
},
],
})
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:resource_arn
(required, String)
—
The Amazon Resource Name (ARN) of the resource to add tags to.
-
:tags
(required, Array<Types::TagRef>)
—
The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
Returns:
-
(Struct)
—
Returns an empty response.
See Also:
4073 4074 4075 4076 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 4073 def tag_resource(params = {}, options = {}) req = build_request(:tag_resource, params) req.send_request(options) end |
#untag_resource(params = {}) ⇒ Struct
Deletes specified tags from a resource.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.untag_resource({
resource_arn: "Arn", # required
tag_keys: ["TagKey"], # required
})
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:resource_arn
(required, String)
—
The Amazon Resource Name (ARN) of the resource to delete tags from.
-
:tag_keys
(required, Array<String>)
—
The keys of the tags to be removed.
Returns:
-
(Struct)
—
Returns an empty response.
See Also:
4099 4100 4101 4102 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 4099 def untag_resource(params = {}, options = {}) req = build_request(:untag_resource, params) req.send_request(options) end |
#update_gateway_route(params = {}) ⇒ Types::UpdateGatewayRouteOutput
Updates an existing gateway route that is associated to a specified virtual gateway in a service mesh.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.update_gateway_route({
client_token: "String",
gateway_route_name: "ResourceName", # required
mesh_name: "ResourceName", # required
mesh_owner: "AccountId",
spec: { # required
grpc_route: {
action: { # required
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,
},
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 of the gateway route to update.
-
:mesh_name
(required, String)
—
The name of the service mesh that the gateway route resides in.
-
:mesh_owner
(String)
—
The 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.
-
:spec
(required, Types::GatewayRouteSpec)
—
The new gateway route specification to apply. This overwrites the existing data.
-
:virtual_gateway_name
(required, String)
—
The name of the virtual gateway that the gateway route is associated with.
Returns:
-
(Types::UpdateGatewayRouteOutput)
—
Returns a response object which responds to the following methods:
- #gateway_route => Types::GatewayRouteData
See Also:
4398 4399 4400 4401 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 4398 def update_gateway_route(params = {}, options = {}) req = build_request(:update_gateway_route, params) req.send_request(options) end |
#update_mesh(params = {}) ⇒ Types::UpdateMeshOutput
Updates an existing service mesh.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.update_mesh({
client_token: "String",
mesh_name: "ResourceName", # required
spec: {
egress_filter: {
type: "ALLOW_ALL", # required, accepts ALLOW_ALL, DROP_ALL
},
service_discovery: {
ip_preference: "IPv6_PREFERRED", # accepts IPv6_PREFERRED, IPv4_PREFERRED, IPv4_ONLY, IPv6_ONLY
},
},
})
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 of the service mesh to update.
-
:spec
(Types::MeshSpec)
—
The service mesh specification to apply.
Returns:
See Also:
4456 4457 4458 4459 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 4456 def update_mesh(params = {}, options = {}) req = build_request(:update_mesh, params) req.send_request(options) end |
#update_route(params = {}) ⇒ Types::UpdateRouteOutput
Updates an existing route for a specified service mesh and virtual router.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.update_route({
client_token: "String",
mesh_name: "ResourceName", # required
mesh_owner: "AccountId",
route_name: "ResourceName", # required
spec: { # required
grpc_route: {
action: { # required
weighted_targets: [ # required
{
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,
},
},
},
},
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 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 update.
-
:spec
(required, Types::RouteSpec)
—
The new route specification to apply. This overwrites the existing data.
-
:virtual_router_name
(required, String)
—
The name of the virtual router that the route is associated with.
Returns:
See Also:
4833 4834 4835 4836 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 4833 def update_route(params = {}, options = {}) req = build_request(:update_route, params) req.send_request(options) end |
#update_virtual_gateway(params = {}) ⇒ Types::UpdateVirtualGatewayOutput
Updates an existing virtual gateway in a specified service mesh.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.update_virtual_gateway({
client_token: "String",
mesh_name: "ResourceName", # required
mesh_owner: "AccountId",
spec: { # required
backend_defaults: {
client_policy: {
tls: {
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
},
},
},
},
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 that the virtual gateway 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.
-
:spec
(required, Types::VirtualGatewaySpec)
—
The new virtual gateway specification to apply. This overwrites the existing data.
-
:virtual_gateway_name
(required, String)
—
The name of the virtual gateway to update.
Returns:
-
(Types::UpdateVirtualGatewayOutput)
—
Returns a response object which responds to the following methods:
- #virtual_gateway => Types::VirtualGatewayData
See Also:
5050 5051 5052 5053 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 5050 def update_virtual_gateway(params = {}, options = {}) req = build_request(:update_virtual_gateway, params) req.send_request(options) end |
#update_virtual_node(params = {}) ⇒ Types::UpdateVirtualNodeOutput
Updates an existing virtual node in a specified service mesh.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.update_virtual_node({
client_token: "String",
mesh_name: "ResourceName", # required
mesh_owner: "AccountId",
spec: { # required
backend_defaults: {
client_policy: {
tls: {
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
},
},
},
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 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.
-
:spec
(required, Types::VirtualNodeSpec)
—
The new virtual node specification to apply. This overwrites the existing data.
-
:virtual_node_name
(required, String)
—
The name of the virtual node to update.
Returns:
-
(Types::UpdateVirtualNodeOutput)
—
Returns a response object which responds to the following methods:
- #virtual_node => Types::VirtualNodeData
See Also:
5422 5423 5424 5425 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 5422 def update_virtual_node(params = {}, options = {}) req = build_request(:update_virtual_node, params) req.send_request(options) end |
#update_virtual_router(params = {}) ⇒ Types::UpdateVirtualRouterOutput
Updates an existing virtual router in a specified service mesh.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.update_virtual_router({
client_token: "String",
mesh_name: "ResourceName", # required
mesh_owner: "AccountId",
spec: { # required
listeners: [
{
port_mapping: { # required
port: 1, # required
protocol: "http", # required, accepts http, tcp, http2, grpc
},
},
],
},
virtual_router_name: "ResourceName", # required
})
Response structure
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 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.
-
:spec
(required, Types::VirtualRouterSpec)
—
The new virtual router specification to apply. This overwrites the existing data.
-
:virtual_router_name
(required, String)
—
The name of the virtual router to update.
Returns:
-
(Types::UpdateVirtualRouterOutput)
—
Returns a response object which responds to the following methods:
- #virtual_router => Types::VirtualRouterData
See Also:
5500 5501 5502 5503 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 5500 def update_virtual_router(params = {}, options = {}) req = build_request(:update_virtual_router, params) req.send_request(options) end |
#update_virtual_service(params = {}) ⇒ Types::UpdateVirtualServiceOutput
Updates an existing virtual service in a specified service mesh.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.update_virtual_service({
client_token: "String",
mesh_name: "ResourceName", # required
mesh_owner: "AccountId",
spec: { # required
provider: {
virtual_node: {
virtual_node_name: "ResourceName", # required
},
virtual_router: {
virtual_router_name: "ResourceName", # required
},
},
},
virtual_service_name: "ServiceName", # required
})
Response structure
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 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.
-
:spec
(required, Types::VirtualServiceSpec)
—
The new virtual service specification to apply. This overwrites the existing data.
-
:virtual_service_name
(required, String)
—
The name of the virtual service to update.
Returns:
-
(Types::UpdateVirtualServiceOutput)
—
Returns a response object which responds to the following methods:
- #virtual_service => Types::VirtualServiceData
See Also:
5577 5578 5579 5580 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb', line 5577 def update_virtual_service(params = {}, options = {}) req = build_request(:update_virtual_service, params) req.send_request(options) end |