2021/06/10 - AWS App Mesh - 12 updated api methods
Changes AppMesh now supports additional routing capabilities in match and rewrites for Gateway Routes and Routes. Additionally, App Mesh also supports specifying DNS Response Types in Virtual Nodes.
{'spec': {'grpcRoute': {'action': {'rewrite': {'hostname': {'defaultTargetHostname': 'ENABLED '
'| '
'DISABLED'}}},
'match': {'hostname': {'exact': 'string',
'suffix': 'string'},
'metadata': [{'invert': 'boolean',
'match': {'exact': 'string',
'prefix': 'string',
'range': {'end': 'long',
'start': 'long'},
'regex': 'string',
'suffix': 'string'},
'name': 'string'}]}},
'http2Route': {'action': {'rewrite': {'hostname': {'defaultTargetHostname': 'ENABLED '
'| '
'DISABLED'},
'path': {'exact': 'string'},
'prefix': {'defaultPrefix': 'ENABLED '
'| '
'DISABLED',
'value': 'string'}}},
'match': {'headers': [{'invert': 'boolean',
'match': {'exact': 'string',
'prefix': 'string',
'range': {'end': 'long',
'start': 'long'},
'regex': 'string',
'suffix': 'string'},
'name': 'string'}],
'hostname': {'exact': 'string',
'suffix': 'string'},
'method': 'GET | HEAD | POST | PUT | DELETE '
'| CONNECT | OPTIONS | TRACE | '
'PATCH',
'path': {'exact': 'string',
'regex': 'string'},
'queryParameters': [{'match': {'exact': 'string'},
'name': 'string'}]}},
'httpRoute': {'action': {'rewrite': {'hostname': {'defaultTargetHostname': 'ENABLED '
'| '
'DISABLED'},
'path': {'exact': 'string'},
'prefix': {'defaultPrefix': 'ENABLED '
'| '
'DISABLED',
'value': 'string'}}},
'match': {'headers': [{'invert': 'boolean',
'match': {'exact': 'string',
'prefix': 'string',
'range': {'end': 'long',
'start': 'long'},
'regex': 'string',
'suffix': 'string'},
'name': 'string'}],
'hostname': {'exact': 'string',
'suffix': 'string'},
'method': 'GET | HEAD | POST | PUT | DELETE '
'| CONNECT | OPTIONS | TRACE | '
'PATCH',
'path': {'exact': 'string',
'regex': 'string'},
'queryParameters': [{'match': {'exact': 'string'},
'name': 'string'}]}},
'priority': 'integer'}}
Response {'gatewayRoute': {'spec': {'grpcRoute': {'action': {'rewrite': {'hostname': {'defaultTargetHostname': 'ENABLED '
'| '
'DISABLED'}}},
'match': {'hostname': {'exact': 'string',
'suffix': 'string'},
'metadata': [{'invert': 'boolean',
'match': {'exact': 'string',
'prefix': 'string',
'range': {'end': 'long',
'start': 'long'},
'regex': 'string',
'suffix': 'string'},
'name': 'string'}]}},
'http2Route': {'action': {'rewrite': {'hostname': {'defaultTargetHostname': 'ENABLED '
'| '
'DISABLED'},
'path': {'exact': 'string'},
'prefix': {'defaultPrefix': 'ENABLED '
'| '
'DISABLED',
'value': 'string'}}},
'match': {'headers': [{'invert': 'boolean',
'match': {'exact': 'string',
'prefix': 'string',
'range': {'end': 'long',
'start': 'long'},
'regex': 'string',
'suffix': 'string'},
'name': 'string'}],
'hostname': {'exact': 'string',
'suffix': 'string'},
'method': 'GET | HEAD | '
'POST | PUT | '
'DELETE | '
'CONNECT | '
'OPTIONS | TRACE '
'| PATCH',
'path': {'exact': 'string',
'regex': 'string'},
'queryParameters': [{'match': {'exact': 'string'},
'name': 'string'}]}},
'httpRoute': {'action': {'rewrite': {'hostname': {'defaultTargetHostname': 'ENABLED '
'| '
'DISABLED'},
'path': {'exact': 'string'},
'prefix': {'defaultPrefix': 'ENABLED '
'| '
'DISABLED',
'value': 'string'}}},
'match': {'headers': [{'invert': 'boolean',
'match': {'exact': 'string',
'prefix': 'string',
'range': {'end': 'long',
'start': 'long'},
'regex': 'string',
'suffix': 'string'},
'name': 'string'}],
'hostname': {'exact': 'string',
'suffix': 'string'},
'method': 'GET | HEAD | '
'POST | PUT | '
'DELETE | CONNECT '
'| OPTIONS | '
'TRACE | PATCH',
'path': {'exact': 'string',
'regex': 'string'},
'queryParameters': [{'match': {'exact': 'string'},
'name': 'string'}]}},
'priority': 'integer'}}}
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.
See also: AWS API Documentation
Request Syntax
client.create_gateway_route(
clientToken='string',
gatewayRouteName='string',
meshName='string',
meshOwner='string',
spec={
'grpcRoute': {
'action': {
'rewrite': {
'hostname': {
'defaultTargetHostname': 'ENABLED'|'DISABLED'
}
},
'target': {
'virtualService': {
'virtualServiceName': 'string'
}
}
},
'match': {
'hostname': {
'exact': 'string',
'suffix': 'string'
},
'metadata': [
{
'invert': True|False,
'match': {
'exact': 'string',
'prefix': 'string',
'range': {
'end': 123,
'start': 123
},
'regex': 'string',
'suffix': 'string'
},
'name': 'string'
},
],
'serviceName': 'string'
}
},
'http2Route': {
'action': {
'rewrite': {
'hostname': {
'defaultTargetHostname': 'ENABLED'|'DISABLED'
},
'path': {
'exact': 'string'
},
'prefix': {
'defaultPrefix': 'ENABLED'|'DISABLED',
'value': 'string'
}
},
'target': {
'virtualService': {
'virtualServiceName': 'string'
}
}
},
'match': {
'headers': [
{
'invert': True|False,
'match': {
'exact': 'string',
'prefix': 'string',
'range': {
'end': 123,
'start': 123
},
'regex': 'string',
'suffix': 'string'
},
'name': 'string'
},
],
'hostname': {
'exact': 'string',
'suffix': 'string'
},
'method': 'GET'|'HEAD'|'POST'|'PUT'|'DELETE'|'CONNECT'|'OPTIONS'|'TRACE'|'PATCH',
'path': {
'exact': 'string',
'regex': 'string'
},
'prefix': 'string',
'queryParameters': [
{
'match': {
'exact': 'string'
},
'name': 'string'
},
]
}
},
'httpRoute': {
'action': {
'rewrite': {
'hostname': {
'defaultTargetHostname': 'ENABLED'|'DISABLED'
},
'path': {
'exact': 'string'
},
'prefix': {
'defaultPrefix': 'ENABLED'|'DISABLED',
'value': 'string'
}
},
'target': {
'virtualService': {
'virtualServiceName': 'string'
}
}
},
'match': {
'headers': [
{
'invert': True|False,
'match': {
'exact': 'string',
'prefix': 'string',
'range': {
'end': 123,
'start': 123
},
'regex': 'string',
'suffix': 'string'
},
'name': 'string'
},
],
'hostname': {
'exact': 'string',
'suffix': 'string'
},
'method': 'GET'|'HEAD'|'POST'|'PUT'|'DELETE'|'CONNECT'|'OPTIONS'|'TRACE'|'PATCH',
'path': {
'exact': 'string',
'regex': 'string'
},
'prefix': 'string',
'queryParameters': [
{
'match': {
'exact': 'string'
},
'name': 'string'
},
]
}
},
'priority': 123
},
tags=[
{
'key': 'string',
'value': 'string'
},
],
virtualGatewayName='string'
)
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.
This field is autopopulated if not provided.
string
[REQUIRED]
The name to use for the gateway route.
string
[REQUIRED]
The name of the service mesh to create the gateway route in.
string
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes.
dict
[REQUIRED]
The gateway route specification to apply.
grpcRoute (dict) --
An object that represents the specification of a gRPC gateway route.
action (dict) -- [REQUIRED]
An object that represents the action to take if a match is determined.
rewrite (dict) --
The gateway route action to rewrite.
hostname (dict) --
The host name of the gateway route to rewrite.
defaultTargetHostname (string) --
The default target host name to write to.
target (dict) -- [REQUIRED]
An object that represents the target that traffic is routed to when a request matches the gateway route.
virtualService (dict) -- [REQUIRED]
An object that represents a virtual service gateway route target.
virtualServiceName (string) -- [REQUIRED]
The name of the virtual service that traffic is routed to.
match (dict) -- [REQUIRED]
An object that represents the criteria for determining a request match.
hostname (dict) --
The gateway route host name to be matched on.
exact (string) --
The exact host name to match on.
suffix (string) --
The specified ending characters of the host name to match on.
metadata (list) --
The gateway route metadata to be matched on.
(dict) --
An object representing the metadata of the gateway route.
invert (boolean) --
Specify True to match anything except the match criteria. The default value is False .
match (dict) --
The criteria for determining a metadata match.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: exact, prefix, range, regex, suffix.
exact (string) --
The exact method header to be matched on.
prefix (string) --
The specified beginning characters of the method header to be matched on.
range (dict) --
An object that represents the range of values to match on. The first character of the range is included in the range, though the last character is not. For example, if the range specified were 1-100, only values 1-99 would be matched.
end (integer) -- [REQUIRED]
The end of the range.
start (integer) -- [REQUIRED]
The start of the range.
regex (string) --
The regex used to match the method header.
suffix (string) --
The specified ending characters of the method header to match on.
name (string) -- [REQUIRED]
A name for the gateway route metadata.
serviceName (string) --
The fully qualified domain name for the service to match from the request.
http2Route (dict) --
An object that represents the specification of an HTTP/2 gateway route.
action (dict) -- [REQUIRED]
An object that represents the action to take if a match is determined.
rewrite (dict) --
The gateway route action to rewrite.
hostname (dict) --
The host name to rewrite.
defaultTargetHostname (string) --
The default target host name to write to.
path (dict) --
The path to rewrite.
exact (string) --
The exact path to rewrite.
prefix (dict) --
The specified beginning characters to rewrite.
defaultPrefix (string) --
The default prefix used to replace the incoming route prefix when rewritten.
value (string) --
The value used to replace the incoming route prefix when rewritten.
target (dict) -- [REQUIRED]
An object that represents the target that traffic is routed to when a request matches the gateway route.
virtualService (dict) -- [REQUIRED]
An object that represents a virtual service gateway route target.
virtualServiceName (string) -- [REQUIRED]
The name of the virtual service that traffic is routed to.
match (dict) -- [REQUIRED]
An object that represents the criteria for determining a request match.
headers (list) --
The client request headers to match on.
(dict) --
An object that represents the HTTP header in the gateway route.
invert (boolean) --
Specify True to match anything except the match criteria. The default value is False .
match (dict) --
An object that represents the method and value to match with the header value sent in a request. Specify one match method.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: exact, prefix, range, regex, suffix.
exact (string) --
The value sent by the client must match the specified value exactly.
prefix (string) --
The value sent by the client must begin with the specified characters.
range (dict) --
An object that represents the range of values to match on.
end (integer) -- [REQUIRED]
The end of the range.
start (integer) -- [REQUIRED]
The start of the range.
regex (string) --
The value sent by the client must include the specified characters.
suffix (string) --
The value sent by the client must end with the specified characters.
name (string) -- [REQUIRED]
A name for the HTTP header in the gateway route that will be matched on.
hostname (dict) --
The host name to match on.
exact (string) --
The exact host name to match on.
suffix (string) --
The specified ending characters of the host name to match on.
method (string) --
The method to match on.
path (dict) --
The path to match on.
exact (string) --
The exact path to match on.
regex (string) --
The regex used to match the path.
prefix (string) --
Specifies the path to match requests with. This parameter must always start with / , which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics , your prefix should be /metrics .
queryParameters (list) --
The query parameter to match on.
(dict) --
An object that represents the query parameter in the request.
match (dict) --
The query parameter to match on.
exact (string) --
The exact query parameter to match on.
name (string) -- [REQUIRED]
A name for the query parameter that will be matched on.
httpRoute (dict) --
An object that represents the specification of an HTTP gateway route.
action (dict) -- [REQUIRED]
An object that represents the action to take if a match is determined.
rewrite (dict) --
The gateway route action to rewrite.
hostname (dict) --
The host name to rewrite.
defaultTargetHostname (string) --
The default target host name to write to.
path (dict) --
The path to rewrite.
exact (string) --
The exact path to rewrite.
prefix (dict) --
The specified beginning characters to rewrite.
defaultPrefix (string) --
The default prefix used to replace the incoming route prefix when rewritten.
value (string) --
The value used to replace the incoming route prefix when rewritten.
target (dict) -- [REQUIRED]
An object that represents the target that traffic is routed to when a request matches the gateway route.
virtualService (dict) -- [REQUIRED]
An object that represents a virtual service gateway route target.
virtualServiceName (string) -- [REQUIRED]
The name of the virtual service that traffic is routed to.
match (dict) -- [REQUIRED]
An object that represents the criteria for determining a request match.
headers (list) --
The client request headers to match on.
(dict) --
An object that represents the HTTP header in the gateway route.
invert (boolean) --
Specify True to match anything except the match criteria. The default value is False .
match (dict) --
An object that represents the method and value to match with the header value sent in a request. Specify one match method.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: exact, prefix, range, regex, suffix.
exact (string) --
The value sent by the client must match the specified value exactly.
prefix (string) --
The value sent by the client must begin with the specified characters.
range (dict) --
An object that represents the range of values to match on.
end (integer) -- [REQUIRED]
The end of the range.
start (integer) -- [REQUIRED]
The start of the range.
regex (string) --
The value sent by the client must include the specified characters.
suffix (string) --
The value sent by the client must end with the specified characters.
name (string) -- [REQUIRED]
A name for the HTTP header in the gateway route that will be matched on.
hostname (dict) --
The host name to match on.
exact (string) --
The exact host name to match on.
suffix (string) --
The specified ending characters of the host name to match on.
method (string) --
The method to match on.
path (dict) --
The path to match on.
exact (string) --
The exact path to match on.
regex (string) --
The regex used to match the path.
prefix (string) --
Specifies the path to match requests with. This parameter must always start with / , which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics , your prefix should be /metrics .
queryParameters (list) --
The query parameter to match on.
(dict) --
An object that represents the query parameter in the request.
match (dict) --
The query parameter to match on.
exact (string) --
The exact query parameter to match on.
name (string) -- [REQUIRED]
A name for the query parameter that will be matched on.
priority (integer) --
The ordering of the gateway routes spec.
list
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.
(dict) --
Optional metadata that you apply to a resource 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.
key (string) -- [REQUIRED]
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
value (string) -- [REQUIRED]
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
string
[REQUIRED]
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.
dict
Response Syntax
{
'gatewayRoute': {
'gatewayRouteName': 'string',
'meshName': 'string',
'metadata': {
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'meshOwner': 'string',
'resourceOwner': 'string',
'uid': 'string',
'version': 123
},
'spec': {
'grpcRoute': {
'action': {
'rewrite': {
'hostname': {
'defaultTargetHostname': 'ENABLED'|'DISABLED'
}
},
'target': {
'virtualService': {
'virtualServiceName': 'string'
}
}
},
'match': {
'hostname': {
'exact': 'string',
'suffix': 'string'
},
'metadata': [
{
'invert': True|False,
'match': {
'exact': 'string',
'prefix': 'string',
'range': {
'end': 123,
'start': 123
},
'regex': 'string',
'suffix': 'string'
},
'name': 'string'
},
],
'serviceName': 'string'
}
},
'http2Route': {
'action': {
'rewrite': {
'hostname': {
'defaultTargetHostname': 'ENABLED'|'DISABLED'
},
'path': {
'exact': 'string'
},
'prefix': {
'defaultPrefix': 'ENABLED'|'DISABLED',
'value': 'string'
}
},
'target': {
'virtualService': {
'virtualServiceName': 'string'
}
}
},
'match': {
'headers': [
{
'invert': True|False,
'match': {
'exact': 'string',
'prefix': 'string',
'range': {
'end': 123,
'start': 123
},
'regex': 'string',
'suffix': 'string'
},
'name': 'string'
},
],
'hostname': {
'exact': 'string',
'suffix': 'string'
},
'method': 'GET'|'HEAD'|'POST'|'PUT'|'DELETE'|'CONNECT'|'OPTIONS'|'TRACE'|'PATCH',
'path': {
'exact': 'string',
'regex': 'string'
},
'prefix': 'string',
'queryParameters': [
{
'match': {
'exact': 'string'
},
'name': 'string'
},
]
}
},
'httpRoute': {
'action': {
'rewrite': {
'hostname': {
'defaultTargetHostname': 'ENABLED'|'DISABLED'
},
'path': {
'exact': 'string'
},
'prefix': {
'defaultPrefix': 'ENABLED'|'DISABLED',
'value': 'string'
}
},
'target': {
'virtualService': {
'virtualServiceName': 'string'
}
}
},
'match': {
'headers': [
{
'invert': True|False,
'match': {
'exact': 'string',
'prefix': 'string',
'range': {
'end': 123,
'start': 123
},
'regex': 'string',
'suffix': 'string'
},
'name': 'string'
},
],
'hostname': {
'exact': 'string',
'suffix': 'string'
},
'method': 'GET'|'HEAD'|'POST'|'PUT'|'DELETE'|'CONNECT'|'OPTIONS'|'TRACE'|'PATCH',
'path': {
'exact': 'string',
'regex': 'string'
},
'prefix': 'string',
'queryParameters': [
{
'match': {
'exact': 'string'
},
'name': 'string'
},
]
}
},
'priority': 123
},
'status': {
'status': 'ACTIVE'|'INACTIVE'|'DELETED'
},
'virtualGatewayName': 'string'
}
}
Response Structure
(dict) --
gatewayRoute (dict) --
The full description of your gateway route following the create call.
gatewayRouteName (string) --
The name of the gateway route.
meshName (string) --
The name of the service mesh that the resource resides in.
metadata (dict) --
An object that represents metadata for a resource.
arn (string) --
The full Amazon Resource Name (ARN) for the resource.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was created.
lastUpdatedAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was last updated.
meshOwner (string) --
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
resourceOwner (string) --
The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
uid (string) --
The unique identifier for the resource.
version (integer) --
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
spec (dict) --
The specifications of the gateway route.
grpcRoute (dict) --
An object that represents the specification of a gRPC gateway route.
action (dict) --
An object that represents the action to take if a match is determined.
rewrite (dict) --
The gateway route action to rewrite.
hostname (dict) --
The host name of the gateway route to rewrite.
defaultTargetHostname (string) --
The default target host name to write to.
target (dict) --
An object that represents the target that traffic is routed to when a request matches the gateway route.
virtualService (dict) --
An object that represents a virtual service gateway route target.
virtualServiceName (string) --
The name of the virtual service that traffic is routed to.
match (dict) --
An object that represents the criteria for determining a request match.
hostname (dict) --
The gateway route host name to be matched on.
exact (string) --
The exact host name to match on.
suffix (string) --
The specified ending characters of the host name to match on.
metadata (list) --
The gateway route metadata to be matched on.
(dict) --
An object representing the metadata of the gateway route.
invert (boolean) --
Specify True to match anything except the match criteria. The default value is False .
match (dict) --
The criteria for determining a metadata match.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: exact, prefix, range, regex, suffix. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
exact (string) --
The exact method header to be matched on.
prefix (string) --
The specified beginning characters of the method header to be matched on.
range (dict) --
An object that represents the range of values to match on. The first character of the range is included in the range, though the last character is not. For example, if the range specified were 1-100, only values 1-99 would be matched.
end (integer) --
The end of the range.
start (integer) --
The start of the range.
regex (string) --
The regex used to match the method header.
suffix (string) --
The specified ending characters of the method header to match on.
name (string) --
A name for the gateway route metadata.
serviceName (string) --
The fully qualified domain name for the service to match from the request.
http2Route (dict) --
An object that represents the specification of an HTTP/2 gateway route.
action (dict) --
An object that represents the action to take if a match is determined.
rewrite (dict) --
The gateway route action to rewrite.
hostname (dict) --
The host name to rewrite.
defaultTargetHostname (string) --
The default target host name to write to.
path (dict) --
The path to rewrite.
exact (string) --
The exact path to rewrite.
prefix (dict) --
The specified beginning characters to rewrite.
defaultPrefix (string) --
The default prefix used to replace the incoming route prefix when rewritten.
value (string) --
The value used to replace the incoming route prefix when rewritten.
target (dict) --
An object that represents the target that traffic is routed to when a request matches the gateway route.
virtualService (dict) --
An object that represents a virtual service gateway route target.
virtualServiceName (string) --
The name of the virtual service that traffic is routed to.
match (dict) --
An object that represents the criteria for determining a request match.
headers (list) --
The client request headers to match on.
(dict) --
An object that represents the HTTP header in the gateway route.
invert (boolean) --
Specify True to match anything except the match criteria. The default value is False .
match (dict) --
An object that represents the method and value to match with the header value sent in a request. Specify one match method.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: exact, prefix, range, regex, suffix. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
exact (string) --
The value sent by the client must match the specified value exactly.
prefix (string) --
The value sent by the client must begin with the specified characters.
range (dict) --
An object that represents the range of values to match on.
end (integer) --
The end of the range.
start (integer) --
The start of the range.
regex (string) --
The value sent by the client must include the specified characters.
suffix (string) --
The value sent by the client must end with the specified characters.
name (string) --
A name for the HTTP header in the gateway route that will be matched on.
hostname (dict) --
The host name to match on.
exact (string) --
The exact host name to match on.
suffix (string) --
The specified ending characters of the host name to match on.
method (string) --
The method to match on.
path (dict) --
The path to match on.
exact (string) --
The exact path to match on.
regex (string) --
The regex used to match the path.
prefix (string) --
Specifies the path to match requests with. This parameter must always start with / , which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics , your prefix should be /metrics .
queryParameters (list) --
The query parameter to match on.
(dict) --
An object that represents the query parameter in the request.
match (dict) --
The query parameter to match on.
exact (string) --
The exact query parameter to match on.
name (string) --
A name for the query parameter that will be matched on.
httpRoute (dict) --
An object that represents the specification of an HTTP gateway route.
action (dict) --
An object that represents the action to take if a match is determined.
rewrite (dict) --
The gateway route action to rewrite.
hostname (dict) --
The host name to rewrite.
defaultTargetHostname (string) --
The default target host name to write to.
path (dict) --
The path to rewrite.
exact (string) --
The exact path to rewrite.
prefix (dict) --
The specified beginning characters to rewrite.
defaultPrefix (string) --
The default prefix used to replace the incoming route prefix when rewritten.
value (string) --
The value used to replace the incoming route prefix when rewritten.
target (dict) --
An object that represents the target that traffic is routed to when a request matches the gateway route.
virtualService (dict) --
An object that represents a virtual service gateway route target.
virtualServiceName (string) --
The name of the virtual service that traffic is routed to.
match (dict) --
An object that represents the criteria for determining a request match.
headers (list) --
The client request headers to match on.
(dict) --
An object that represents the HTTP header in the gateway route.
invert (boolean) --
Specify True to match anything except the match criteria. The default value is False .
match (dict) --
An object that represents the method and value to match with the header value sent in a request. Specify one match method.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: exact, prefix, range, regex, suffix. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
exact (string) --
The value sent by the client must match the specified value exactly.
prefix (string) --
The value sent by the client must begin with the specified characters.
range (dict) --
An object that represents the range of values to match on.
end (integer) --
The end of the range.
start (integer) --
The start of the range.
regex (string) --
The value sent by the client must include the specified characters.
suffix (string) --
The value sent by the client must end with the specified characters.
name (string) --
A name for the HTTP header in the gateway route that will be matched on.
hostname (dict) --
The host name to match on.
exact (string) --
The exact host name to match on.
suffix (string) --
The specified ending characters of the host name to match on.
method (string) --
The method to match on.
path (dict) --
The path to match on.
exact (string) --
The exact path to match on.
regex (string) --
The regex used to match the path.
prefix (string) --
Specifies the path to match requests with. This parameter must always start with / , which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics , your prefix should be /metrics .
queryParameters (list) --
The query parameter to match on.
(dict) --
An object that represents the query parameter in the request.
match (dict) --
The query parameter to match on.
exact (string) --
The exact query parameter to match on.
name (string) --
A name for the query parameter that will be matched on.
priority (integer) --
The ordering of the gateway routes spec.
status (dict) --
The status of the gateway route.
status (string) --
The current status for the gateway route.
virtualGatewayName (string) --
The virtual gateway that the gateway route is associated with.
{'spec': {'http2Route': {'match': {'path': {'exact': 'string',
'regex': 'string'},
'queryParameters': [{'match': {'exact': 'string'},
'name': 'string'}]}},
'httpRoute': {'match': {'path': {'exact': 'string',
'regex': 'string'},
'queryParameters': [{'match': {'exact': 'string'},
'name': 'string'}]}}}}
Response {'route': {'spec': {'http2Route': {'match': {'path': {'exact': 'string',
'regex': 'string'},
'queryParameters': [{'match': {'exact': 'string'},
'name': 'string'}]}},
'httpRoute': {'match': {'path': {'exact': 'string',
'regex': 'string'},
'queryParameters': [{'match': {'exact': 'string'},
'name': 'string'}]}}}}}
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.
See also: AWS API Documentation
Request Syntax
client.create_route(
clientToken='string',
meshName='string',
meshOwner='string',
routeName='string',
spec={
'grpcRoute': {
'action': {
'weightedTargets': [
{
'virtualNode': 'string',
'weight': 123
},
]
},
'match': {
'metadata': [
{
'invert': True|False,
'match': {
'exact': 'string',
'prefix': 'string',
'range': {
'end': 123,
'start': 123
},
'regex': 'string',
'suffix': 'string'
},
'name': 'string'
},
],
'methodName': 'string',
'serviceName': 'string'
},
'retryPolicy': {
'grpcRetryEvents': [
'cancelled'|'deadline-exceeded'|'internal'|'resource-exhausted'|'unavailable',
],
'httpRetryEvents': [
'string',
],
'maxRetries': 123,
'perRetryTimeout': {
'unit': 's'|'ms',
'value': 123
},
'tcpRetryEvents': [
'connection-error',
]
},
'timeout': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
}
},
'http2Route': {
'action': {
'weightedTargets': [
{
'virtualNode': 'string',
'weight': 123
},
]
},
'match': {
'headers': [
{
'invert': True|False,
'match': {
'exact': 'string',
'prefix': 'string',
'range': {
'end': 123,
'start': 123
},
'regex': 'string',
'suffix': 'string'
},
'name': 'string'
},
],
'method': 'GET'|'HEAD'|'POST'|'PUT'|'DELETE'|'CONNECT'|'OPTIONS'|'TRACE'|'PATCH',
'path': {
'exact': 'string',
'regex': 'string'
},
'prefix': 'string',
'queryParameters': [
{
'match': {
'exact': 'string'
},
'name': 'string'
},
],
'scheme': 'http'|'https'
},
'retryPolicy': {
'httpRetryEvents': [
'string',
],
'maxRetries': 123,
'perRetryTimeout': {
'unit': 's'|'ms',
'value': 123
},
'tcpRetryEvents': [
'connection-error',
]
},
'timeout': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
}
},
'httpRoute': {
'action': {
'weightedTargets': [
{
'virtualNode': 'string',
'weight': 123
},
]
},
'match': {
'headers': [
{
'invert': True|False,
'match': {
'exact': 'string',
'prefix': 'string',
'range': {
'end': 123,
'start': 123
},
'regex': 'string',
'suffix': 'string'
},
'name': 'string'
},
],
'method': 'GET'|'HEAD'|'POST'|'PUT'|'DELETE'|'CONNECT'|'OPTIONS'|'TRACE'|'PATCH',
'path': {
'exact': 'string',
'regex': 'string'
},
'prefix': 'string',
'queryParameters': [
{
'match': {
'exact': 'string'
},
'name': 'string'
},
],
'scheme': 'http'|'https'
},
'retryPolicy': {
'httpRetryEvents': [
'string',
],
'maxRetries': 123,
'perRetryTimeout': {
'unit': 's'|'ms',
'value': 123
},
'tcpRetryEvents': [
'connection-error',
]
},
'timeout': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
}
},
'priority': 123,
'tcpRoute': {
'action': {
'weightedTargets': [
{
'virtualNode': 'string',
'weight': 123
},
]
},
'timeout': {
'idle': {
'unit': 's'|'ms',
'value': 123
}
}
}
},
tags=[
{
'key': 'string',
'value': 'string'
},
],
virtualRouterName='string'
)
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.
This field is autopopulated if not provided.
string
[REQUIRED]
The name of the service mesh to create the route in.
string
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes.
string
[REQUIRED]
The name to use for the route.
dict
[REQUIRED]
The route specification to apply.
grpcRoute (dict) --
An object that represents the specification of a gRPC route.
action (dict) -- [REQUIRED]
An object that represents the action to take if a match is determined.
weightedTargets (list) -- [REQUIRED]
An object that represents the targets that traffic is routed to when a request matches the route.
(dict) --
An object that represents a target and its relative weight. Traffic is distributed across targets according to their relative weight. For example, a weighted target with a relative weight of 50 receives five times as much traffic as one with a relative weight of 10. The total weight for all targets combined must be less than or equal to 100.
virtualNode (string) -- [REQUIRED]
The virtual node to associate with the weighted target.
weight (integer) -- [REQUIRED]
The relative weight of the weighted target.
match (dict) -- [REQUIRED]
An object that represents the criteria for determining a request match.
metadata (list) --
An object that represents the data to match from the request.
(dict) --
An object that represents the match metadata for the route.
invert (boolean) --
Specify True to match anything except the match criteria. The default value is False .
match (dict) --
An object that represents the data to match from the request.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: exact, prefix, range, regex, suffix.
exact (string) --
The value sent by the client must match the specified value exactly.
prefix (string) --
The value sent by the client must begin with the specified characters.
range (dict) --
An object that represents the range of values to match on.
end (integer) -- [REQUIRED]
The end of the range.
start (integer) -- [REQUIRED]
The start of the range.
regex (string) --
The value sent by the client must include the specified characters.
suffix (string) --
The value sent by the client must end with the specified characters.
name (string) -- [REQUIRED]
The name of the route.
methodName (string) --
The method name to match from the request. If you specify a name, you must also specify a serviceName .
serviceName (string) --
The fully qualified domain name for the service to match from the request.
retryPolicy (dict) --
An object that represents a retry policy.
grpcRetryEvents (list) --
Specify at least one of the valid values.
(string) --
httpRetryEvents (list) --
Specify at least one of the following values.
server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511
gateway-error – HTTP status codes 502, 503, and 504
client-error – HTTP status code 409
stream-error – Retry on refused stream
(string) --
maxRetries (integer) -- [REQUIRED]
The maximum number of retry attempts.
perRetryTimeout (dict) -- [REQUIRED]
The timeout for each retry attempt.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
tcpRetryEvents (list) --
Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.
(string) --
timeout (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
http2Route (dict) --
An object that represents the specification of an HTTP/2 route.
action (dict) -- [REQUIRED]
An object that represents the action to take if a match is determined.
weightedTargets (list) -- [REQUIRED]
An object that represents the targets that traffic is routed to when a request matches the route.
(dict) --
An object that represents a target and its relative weight. Traffic is distributed across targets according to their relative weight. For example, a weighted target with a relative weight of 50 receives five times as much traffic as one with a relative weight of 10. The total weight for all targets combined must be less than or equal to 100.
virtualNode (string) -- [REQUIRED]
The virtual node to associate with the weighted target.
weight (integer) -- [REQUIRED]
The relative weight of the weighted target.
match (dict) -- [REQUIRED]
An object that represents the criteria for determining a request match.
headers (list) --
The client request headers to match on.
(dict) --
An object that represents the HTTP header in the request.
invert (boolean) --
Specify True to match anything except the match criteria. The default value is False .
match (dict) --
The HeaderMatchMethod object.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: exact, prefix, range, regex, suffix.
exact (string) --
The value sent by the client must match the specified value exactly.
prefix (string) --
The value sent by the client must begin with the specified characters.
range (dict) --
An object that represents the range of values to match on.
end (integer) -- [REQUIRED]
The end of the range.
start (integer) -- [REQUIRED]
The start of the range.
regex (string) --
The value sent by the client must include the specified characters.
suffix (string) --
The value sent by the client must end with the specified characters.
name (string) -- [REQUIRED]
A name for the HTTP header in the client request that will be matched on.
method (string) --
The client request method to match on. Specify only one.
path (dict) --
The client request path to match on.
exact (string) --
The exact path to match on.
regex (string) --
The regex used to match the path.
prefix (string) --
Specifies the path to match requests with. This parameter must always start with / , which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics , your prefix should be /metrics .
queryParameters (list) --
The client request query parameters to match on.
(dict) --
An object that represents the query parameter in the request.
match (dict) --
The query parameter to match on.
exact (string) --
The exact query parameter to match on.
name (string) -- [REQUIRED]
A name for the query parameter that will be matched on.
scheme (string) --
The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.
retryPolicy (dict) --
An object that represents a retry policy.
httpRetryEvents (list) --
Specify at least one of the following values.
server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511
gateway-error – HTTP status codes 502, 503, and 504
client-error – HTTP status code 409
stream-error – Retry on refused stream
(string) --
maxRetries (integer) -- [REQUIRED]
The maximum number of retry attempts.
perRetryTimeout (dict) -- [REQUIRED]
The timeout for each retry attempt.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
tcpRetryEvents (list) --
Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.
(string) --
timeout (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
httpRoute (dict) --
An object that represents the specification of an HTTP route.
action (dict) -- [REQUIRED]
An object that represents the action to take if a match is determined.
weightedTargets (list) -- [REQUIRED]
An object that represents the targets that traffic is routed to when a request matches the route.
(dict) --
An object that represents a target and its relative weight. Traffic is distributed across targets according to their relative weight. For example, a weighted target with a relative weight of 50 receives five times as much traffic as one with a relative weight of 10. The total weight for all targets combined must be less than or equal to 100.
virtualNode (string) -- [REQUIRED]
The virtual node to associate with the weighted target.
weight (integer) -- [REQUIRED]
The relative weight of the weighted target.
match (dict) -- [REQUIRED]
An object that represents the criteria for determining a request match.
headers (list) --
The client request headers to match on.
(dict) --
An object that represents the HTTP header in the request.
invert (boolean) --
Specify True to match anything except the match criteria. The default value is False .
match (dict) --
The HeaderMatchMethod object.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: exact, prefix, range, regex, suffix.
exact (string) --
The value sent by the client must match the specified value exactly.
prefix (string) --
The value sent by the client must begin with the specified characters.
range (dict) --
An object that represents the range of values to match on.
end (integer) -- [REQUIRED]
The end of the range.
start (integer) -- [REQUIRED]
The start of the range.
regex (string) --
The value sent by the client must include the specified characters.
suffix (string) --
The value sent by the client must end with the specified characters.
name (string) -- [REQUIRED]
A name for the HTTP header in the client request that will be matched on.
method (string) --
The client request method to match on. Specify only one.
path (dict) --
The client request path to match on.
exact (string) --
The exact path to match on.
regex (string) --
The regex used to match the path.
prefix (string) --
Specifies the path to match requests with. This parameter must always start with / , which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics , your prefix should be /metrics .
queryParameters (list) --
The client request query parameters to match on.
(dict) --
An object that represents the query parameter in the request.
match (dict) --
The query parameter to match on.
exact (string) --
The exact query parameter to match on.
name (string) -- [REQUIRED]
A name for the query parameter that will be matched on.
scheme (string) --
The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.
retryPolicy (dict) --
An object that represents a retry policy.
httpRetryEvents (list) --
Specify at least one of the following values.
server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511
gateway-error – HTTP status codes 502, 503, and 504
client-error – HTTP status code 409
stream-error – Retry on refused stream
(string) --
maxRetries (integer) -- [REQUIRED]
The maximum number of retry attempts.
perRetryTimeout (dict) -- [REQUIRED]
The timeout for each retry attempt.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
tcpRetryEvents (list) --
Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.
(string) --
timeout (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
priority (integer) --
The priority for the route. Routes are matched based on the specified value, where 0 is the highest priority.
tcpRoute (dict) --
An object that represents the specification of a TCP route.
action (dict) -- [REQUIRED]
The action to take if a match is determined.
weightedTargets (list) -- [REQUIRED]
An object that represents the targets that traffic is routed to when a request matches the route.
(dict) --
An object that represents a target and its relative weight. Traffic is distributed across targets according to their relative weight. For example, a weighted target with a relative weight of 50 receives five times as much traffic as one with a relative weight of 10. The total weight for all targets combined must be less than or equal to 100.
virtualNode (string) -- [REQUIRED]
The virtual node to associate with the weighted target.
weight (integer) -- [REQUIRED]
The relative weight of the weighted target.
timeout (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
list
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.
(dict) --
Optional metadata that you apply to a resource 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.
key (string) -- [REQUIRED]
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
value (string) -- [REQUIRED]
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
string
[REQUIRED]
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.
dict
Response Syntax
{
'route': {
'meshName': 'string',
'metadata': {
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'meshOwner': 'string',
'resourceOwner': 'string',
'uid': 'string',
'version': 123
},
'routeName': 'string',
'spec': {
'grpcRoute': {
'action': {
'weightedTargets': [
{
'virtualNode': 'string',
'weight': 123
},
]
},
'match': {
'metadata': [
{
'invert': True|False,
'match': {
'exact': 'string',
'prefix': 'string',
'range': {
'end': 123,
'start': 123
},
'regex': 'string',
'suffix': 'string'
},
'name': 'string'
},
],
'methodName': 'string',
'serviceName': 'string'
},
'retryPolicy': {
'grpcRetryEvents': [
'cancelled'|'deadline-exceeded'|'internal'|'resource-exhausted'|'unavailable',
],
'httpRetryEvents': [
'string',
],
'maxRetries': 123,
'perRetryTimeout': {
'unit': 's'|'ms',
'value': 123
},
'tcpRetryEvents': [
'connection-error',
]
},
'timeout': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
}
},
'http2Route': {
'action': {
'weightedTargets': [
{
'virtualNode': 'string',
'weight': 123
},
]
},
'match': {
'headers': [
{
'invert': True|False,
'match': {
'exact': 'string',
'prefix': 'string',
'range': {
'end': 123,
'start': 123
},
'regex': 'string',
'suffix': 'string'
},
'name': 'string'
},
],
'method': 'GET'|'HEAD'|'POST'|'PUT'|'DELETE'|'CONNECT'|'OPTIONS'|'TRACE'|'PATCH',
'path': {
'exact': 'string',
'regex': 'string'
},
'prefix': 'string',
'queryParameters': [
{
'match': {
'exact': 'string'
},
'name': 'string'
},
],
'scheme': 'http'|'https'
},
'retryPolicy': {
'httpRetryEvents': [
'string',
],
'maxRetries': 123,
'perRetryTimeout': {
'unit': 's'|'ms',
'value': 123
},
'tcpRetryEvents': [
'connection-error',
]
},
'timeout': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
}
},
'httpRoute': {
'action': {
'weightedTargets': [
{
'virtualNode': 'string',
'weight': 123
},
]
},
'match': {
'headers': [
{
'invert': True|False,
'match': {
'exact': 'string',
'prefix': 'string',
'range': {
'end': 123,
'start': 123
},
'regex': 'string',
'suffix': 'string'
},
'name': 'string'
},
],
'method': 'GET'|'HEAD'|'POST'|'PUT'|'DELETE'|'CONNECT'|'OPTIONS'|'TRACE'|'PATCH',
'path': {
'exact': 'string',
'regex': 'string'
},
'prefix': 'string',
'queryParameters': [
{
'match': {
'exact': 'string'
},
'name': 'string'
},
],
'scheme': 'http'|'https'
},
'retryPolicy': {
'httpRetryEvents': [
'string',
],
'maxRetries': 123,
'perRetryTimeout': {
'unit': 's'|'ms',
'value': 123
},
'tcpRetryEvents': [
'connection-error',
]
},
'timeout': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
}
},
'priority': 123,
'tcpRoute': {
'action': {
'weightedTargets': [
{
'virtualNode': 'string',
'weight': 123
},
]
},
'timeout': {
'idle': {
'unit': 's'|'ms',
'value': 123
}
}
}
},
'status': {
'status': 'ACTIVE'|'INACTIVE'|'DELETED'
},
'virtualRouterName': 'string'
}
}
Response Structure
(dict) --
route (dict) --
The full description of your mesh following the create call.
meshName (string) --
The name of the service mesh that the route resides in.
metadata (dict) --
The associated metadata for the route.
arn (string) --
The full Amazon Resource Name (ARN) for the resource.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was created.
lastUpdatedAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was last updated.
meshOwner (string) --
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
resourceOwner (string) --
The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
uid (string) --
The unique identifier for the resource.
version (integer) --
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
routeName (string) --
The name of the route.
spec (dict) --
The specifications of the route.
grpcRoute (dict) --
An object that represents the specification of a gRPC route.
action (dict) --
An object that represents the action to take if a match is determined.
weightedTargets (list) --
An object that represents the targets that traffic is routed to when a request matches the route.
(dict) --
An object that represents a target and its relative weight. Traffic is distributed across targets according to their relative weight. For example, a weighted target with a relative weight of 50 receives five times as much traffic as one with a relative weight of 10. The total weight for all targets combined must be less than or equal to 100.
virtualNode (string) --
The virtual node to associate with the weighted target.
weight (integer) --
The relative weight of the weighted target.
match (dict) --
An object that represents the criteria for determining a request match.
metadata (list) --
An object that represents the data to match from the request.
(dict) --
An object that represents the match metadata for the route.
invert (boolean) --
Specify True to match anything except the match criteria. The default value is False .
match (dict) --
An object that represents the data to match from the request.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: exact, prefix, range, regex, suffix. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
exact (string) --
The value sent by the client must match the specified value exactly.
prefix (string) --
The value sent by the client must begin with the specified characters.
range (dict) --
An object that represents the range of values to match on.
end (integer) --
The end of the range.
start (integer) --
The start of the range.
regex (string) --
The value sent by the client must include the specified characters.
suffix (string) --
The value sent by the client must end with the specified characters.
name (string) --
The name of the route.
methodName (string) --
The method name to match from the request. If you specify a name, you must also specify a serviceName .
serviceName (string) --
The fully qualified domain name for the service to match from the request.
retryPolicy (dict) --
An object that represents a retry policy.
grpcRetryEvents (list) --
Specify at least one of the valid values.
(string) --
httpRetryEvents (list) --
Specify at least one of the following values.
server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511
gateway-error – HTTP status codes 502, 503, and 504
client-error – HTTP status code 409
stream-error – Retry on refused stream
(string) --
maxRetries (integer) --
The maximum number of retry attempts.
perRetryTimeout (dict) --
The timeout for each retry attempt.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
tcpRetryEvents (list) --
Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.
(string) --
timeout (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
http2Route (dict) --
An object that represents the specification of an HTTP/2 route.
action (dict) --
An object that represents the action to take if a match is determined.
weightedTargets (list) --
An object that represents the targets that traffic is routed to when a request matches the route.
(dict) --
An object that represents a target and its relative weight. Traffic is distributed across targets according to their relative weight. For example, a weighted target with a relative weight of 50 receives five times as much traffic as one with a relative weight of 10. The total weight for all targets combined must be less than or equal to 100.
virtualNode (string) --
The virtual node to associate with the weighted target.
weight (integer) --
The relative weight of the weighted target.
match (dict) --
An object that represents the criteria for determining a request match.
headers (list) --
The client request headers to match on.
(dict) --
An object that represents the HTTP header in the request.
invert (boolean) --
Specify True to match anything except the match criteria. The default value is False .
match (dict) --
The HeaderMatchMethod object.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: exact, prefix, range, regex, suffix. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
exact (string) --
The value sent by the client must match the specified value exactly.
prefix (string) --
The value sent by the client must begin with the specified characters.
range (dict) --
An object that represents the range of values to match on.
end (integer) --
The end of the range.
start (integer) --
The start of the range.
regex (string) --
The value sent by the client must include the specified characters.
suffix (string) --
The value sent by the client must end with the specified characters.
name (string) --
A name for the HTTP header in the client request that will be matched on.
method (string) --
The client request method to match on. Specify only one.
path (dict) --
The client request path to match on.
exact (string) --
The exact path to match on.
regex (string) --
The regex used to match the path.
prefix (string) --
Specifies the path to match requests with. This parameter must always start with / , which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics , your prefix should be /metrics .
queryParameters (list) --
The client request query parameters to match on.
(dict) --
An object that represents the query parameter in the request.
match (dict) --
The query parameter to match on.
exact (string) --
The exact query parameter to match on.
name (string) --
A name for the query parameter that will be matched on.
scheme (string) --
The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.
retryPolicy (dict) --
An object that represents a retry policy.
httpRetryEvents (list) --
Specify at least one of the following values.
server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511
gateway-error – HTTP status codes 502, 503, and 504
client-error – HTTP status code 409
stream-error – Retry on refused stream
(string) --
maxRetries (integer) --
The maximum number of retry attempts.
perRetryTimeout (dict) --
The timeout for each retry attempt.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
tcpRetryEvents (list) --
Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.
(string) --
timeout (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
httpRoute (dict) --
An object that represents the specification of an HTTP route.
action (dict) --
An object that represents the action to take if a match is determined.
weightedTargets (list) --
An object that represents the targets that traffic is routed to when a request matches the route.
(dict) --
An object that represents a target and its relative weight. Traffic is distributed across targets according to their relative weight. For example, a weighted target with a relative weight of 50 receives five times as much traffic as one with a relative weight of 10. The total weight for all targets combined must be less than or equal to 100.
virtualNode (string) --
The virtual node to associate with the weighted target.
weight (integer) --
The relative weight of the weighted target.
match (dict) --
An object that represents the criteria for determining a request match.
headers (list) --
The client request headers to match on.
(dict) --
An object that represents the HTTP header in the request.
invert (boolean) --
Specify True to match anything except the match criteria. The default value is False .
match (dict) --
The HeaderMatchMethod object.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: exact, prefix, range, regex, suffix. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
exact (string) --
The value sent by the client must match the specified value exactly.
prefix (string) --
The value sent by the client must begin with the specified characters.
range (dict) --
An object that represents the range of values to match on.
end (integer) --
The end of the range.
start (integer) --
The start of the range.
regex (string) --
The value sent by the client must include the specified characters.
suffix (string) --
The value sent by the client must end with the specified characters.
name (string) --
A name for the HTTP header in the client request that will be matched on.
method (string) --
The client request method to match on. Specify only one.
path (dict) --
The client request path to match on.
exact (string) --
The exact path to match on.
regex (string) --
The regex used to match the path.
prefix (string) --
Specifies the path to match requests with. This parameter must always start with / , which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics , your prefix should be /metrics .
queryParameters (list) --
The client request query parameters to match on.
(dict) --
An object that represents the query parameter in the request.
match (dict) --
The query parameter to match on.
exact (string) --
The exact query parameter to match on.
name (string) --
A name for the query parameter that will be matched on.
scheme (string) --
The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.
retryPolicy (dict) --
An object that represents a retry policy.
httpRetryEvents (list) --
Specify at least one of the following values.
server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511
gateway-error – HTTP status codes 502, 503, and 504
client-error – HTTP status code 409
stream-error – Retry on refused stream
(string) --
maxRetries (integer) --
The maximum number of retry attempts.
perRetryTimeout (dict) --
The timeout for each retry attempt.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
tcpRetryEvents (list) --
Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.
(string) --
timeout (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
priority (integer) --
The priority for the route. Routes are matched based on the specified value, where 0 is the highest priority.
tcpRoute (dict) --
An object that represents the specification of a TCP route.
action (dict) --
The action to take if a match is determined.
weightedTargets (list) --
An object that represents the targets that traffic is routed to when a request matches the route.
(dict) --
An object that represents a target and its relative weight. Traffic is distributed across targets according to their relative weight. For example, a weighted target with a relative weight of 50 receives five times as much traffic as one with a relative weight of 10. The total weight for all targets combined must be less than or equal to 100.
virtualNode (string) --
The virtual node to associate with the weighted target.
weight (integer) --
The relative weight of the weighted target.
timeout (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
status (dict) --
The status of the route.
status (string) --
The current status for the route.
virtualRouterName (string) --
The virtual router that the route is associated with.
{'spec': {'serviceDiscovery': {'dns': {'responseType': 'LOADBALANCER | '
'ENDPOINTS'}}}}
Response {'virtualNode': {'spec': {'serviceDiscovery': {'dns': {'responseType': 'LOADBALANCER '
'| '
'ENDPOINTS'}}}}}
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.
Note
By default, App Mesh uses the name of the resource you specified in APPMESH_RESOURCE_ARN when Envoy is referring to itself in metrics and traces. You can override this behavior by setting the APPMESH_RESOURCE_CLUSTER environment variable with your own name.
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 AWS App Mesh User Guide.
See also: AWS API Documentation
Request Syntax
client.create_virtual_node(
clientToken='string',
meshName='string',
meshOwner='string',
spec={
'backendDefaults': {
'clientPolicy': {
'tls': {
'certificate': {
'file': {
'certificateChain': 'string',
'privateKey': 'string'
},
'sds': {
'secretName': 'string'
}
},
'enforce': True|False,
'ports': [
123,
],
'validation': {
'subjectAlternativeNames': {
'match': {
'exact': [
'string',
]
}
},
'trust': {
'acm': {
'certificateAuthorityArns': [
'string',
]
},
'file': {
'certificateChain': 'string'
},
'sds': {
'secretName': 'string'
}
}
}
}
}
},
'backends': [
{
'virtualService': {
'clientPolicy': {
'tls': {
'certificate': {
'file': {
'certificateChain': 'string',
'privateKey': 'string'
},
'sds': {
'secretName': 'string'
}
},
'enforce': True|False,
'ports': [
123,
],
'validation': {
'subjectAlternativeNames': {
'match': {
'exact': [
'string',
]
}
},
'trust': {
'acm': {
'certificateAuthorityArns': [
'string',
]
},
'file': {
'certificateChain': 'string'
},
'sds': {
'secretName': 'string'
}
}
}
}
},
'virtualServiceName': 'string'
}
},
],
'listeners': [
{
'connectionPool': {
'grpc': {
'maxRequests': 123
},
'http': {
'maxConnections': 123,
'maxPendingRequests': 123
},
'http2': {
'maxRequests': 123
},
'tcp': {
'maxConnections': 123
}
},
'healthCheck': {
'healthyThreshold': 123,
'intervalMillis': 123,
'path': 'string',
'port': 123,
'protocol': 'http'|'tcp'|'http2'|'grpc',
'timeoutMillis': 123,
'unhealthyThreshold': 123
},
'outlierDetection': {
'baseEjectionDuration': {
'unit': 's'|'ms',
'value': 123
},
'interval': {
'unit': 's'|'ms',
'value': 123
},
'maxEjectionPercent': 123,
'maxServerErrors': 123
},
'portMapping': {
'port': 123,
'protocol': 'http'|'tcp'|'http2'|'grpc'
},
'timeout': {
'grpc': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
},
'http': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
},
'http2': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
},
'tcp': {
'idle': {
'unit': 's'|'ms',
'value': 123
}
}
},
'tls': {
'certificate': {
'acm': {
'certificateArn': 'string'
},
'file': {
'certificateChain': 'string',
'privateKey': 'string'
},
'sds': {
'secretName': 'string'
}
},
'mode': 'STRICT'|'PERMISSIVE'|'DISABLED',
'validation': {
'subjectAlternativeNames': {
'match': {
'exact': [
'string',
]
}
},
'trust': {
'file': {
'certificateChain': 'string'
},
'sds': {
'secretName': 'string'
}
}
}
}
},
],
'logging': {
'accessLog': {
'file': {
'path': 'string'
}
}
},
'serviceDiscovery': {
'awsCloudMap': {
'attributes': [
{
'key': 'string',
'value': 'string'
},
],
'namespaceName': 'string',
'serviceName': 'string'
},
'dns': {
'hostname': 'string',
'responseType': 'LOADBALANCER'|'ENDPOINTS'
}
}
},
tags=[
{
'key': 'string',
'value': 'string'
},
],
virtualNodeName='string'
)
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.
This field is autopopulated if not provided.
string
[REQUIRED]
The name of the service mesh to create the virtual node in.
string
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes.
dict
[REQUIRED]
The virtual node specification to apply.
backendDefaults (dict) --
A reference to an object that represents the defaults for backends.
clientPolicy (dict) --
A reference to an object that represents a client policy.
tls (dict) --
A reference to an object that represents a Transport Layer Security (TLS) client policy.
certificate (dict) --
A reference to an object that represents a client's TLS certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: file, sds.
file (dict) --
An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
certificateChain (string) -- [REQUIRED]
The certificate chain for the certificate.
privateKey (string) -- [REQUIRED]
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a client's TLS Secret Discovery Service certificate.
secretName (string) -- [REQUIRED]
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.
enforce (boolean) --
Whether the policy is enforced. The default is True , if a value isn't specified.
ports (list) --
One or more ports that the policy is enforced for.
(integer) --
validation (dict) -- [REQUIRED]
A reference to an object that represents a TLS validation context.
subjectAlternativeNames (dict) --
A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context.
match (dict) -- [REQUIRED]
An object that represents the criteria for determining a SANs match.
exact (list) -- [REQUIRED]
The values sent must match the specified values exactly.
(string) --
trust (dict) -- [REQUIRED]
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: acm, file, sds.
acm (dict) --
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.
certificateAuthorityArns (list) -- [REQUIRED]
One or more ACM Amazon Resource Name (ARN)s.
(string) --
file (dict) --
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
certificateChain (string) -- [REQUIRED]
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
secretName (string) -- [REQUIRED]
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
backends (list) --
The backends that the virtual node is expected to send outbound traffic to.
(dict) --
An object that represents the backends that a virtual node is expected to send outbound traffic to.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: virtualService.
virtualService (dict) --
Specifies a virtual service to use as a backend.
clientPolicy (dict) --
A reference to an object that represents the client policy for a backend.
tls (dict) --
A reference to an object that represents a Transport Layer Security (TLS) client policy.
certificate (dict) --
A reference to an object that represents a client's TLS certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: file, sds.
file (dict) --
An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
certificateChain (string) -- [REQUIRED]
The certificate chain for the certificate.
privateKey (string) -- [REQUIRED]
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a client's TLS Secret Discovery Service certificate.
secretName (string) -- [REQUIRED]
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.
enforce (boolean) --
Whether the policy is enforced. The default is True , if a value isn't specified.
ports (list) --
One or more ports that the policy is enforced for.
(integer) --
validation (dict) -- [REQUIRED]
A reference to an object that represents a TLS validation context.
subjectAlternativeNames (dict) --
A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context.
match (dict) -- [REQUIRED]
An object that represents the criteria for determining a SANs match.
exact (list) -- [REQUIRED]
The values sent must match the specified values exactly.
(string) --
trust (dict) -- [REQUIRED]
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: acm, file, sds.
acm (dict) --
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.
certificateAuthorityArns (list) -- [REQUIRED]
One or more ACM Amazon Resource Name (ARN)s.
(string) --
file (dict) --
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
certificateChain (string) -- [REQUIRED]
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
secretName (string) -- [REQUIRED]
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
virtualServiceName (string) -- [REQUIRED]
The name of the virtual service that is acting as a virtual node backend.
listeners (list) --
The listener that the virtual node is expected to receive inbound traffic from. You can specify one listener.
(dict) --
An object that represents a listener for a virtual node.
connectionPool (dict) --
The connection pool information for the listener.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: grpc, http, http2, tcp.
grpc (dict) --
An object that represents a type of connection pool.
maxRequests (integer) -- [REQUIRED]
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.
http (dict) --
An object that represents a type of connection pool.
maxConnections (integer) -- [REQUIRED]
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.
maxPendingRequests (integer) --
Number of overflowing requests after max_connections Envoy will queue to upstream cluster.
http2 (dict) --
An object that represents a type of connection pool.
maxRequests (integer) -- [REQUIRED]
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.
tcp (dict) --
An object that represents a type of connection pool.
maxConnections (integer) -- [REQUIRED]
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.
healthCheck (dict) --
The health check information for the listener.
healthyThreshold (integer) -- [REQUIRED]
The number of consecutive successful health checks that must occur before declaring listener healthy.
intervalMillis (integer) -- [REQUIRED]
The time period in milliseconds between each health check execution.
path (string) --
The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.
port (integer) --
The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.
protocol (string) -- [REQUIRED]
The protocol for the health check request. If you specify grpc , then your service must conform to the GRPC Health Checking Protocol.
timeoutMillis (integer) -- [REQUIRED]
The amount of time to wait when receiving a response from the health check, in milliseconds.
unhealthyThreshold (integer) -- [REQUIRED]
The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.
outlierDetection (dict) --
The outlier detection information for the listener.
baseEjectionDuration (dict) -- [REQUIRED]
The base amount of time for which a host is ejected.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
interval (dict) -- [REQUIRED]
The time interval between ejection sweep analysis.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
maxEjectionPercent (integer) -- [REQUIRED]
Maximum percentage of hosts in load balancing pool for upstream service that can be ejected. Will eject at least one host regardless of the value.
maxServerErrors (integer) -- [REQUIRED]
Number of consecutive 5xx errors required for ejection.
portMapping (dict) -- [REQUIRED]
The port mapping information for the listener.
port (integer) -- [REQUIRED]
The port used for the port mapping.
protocol (string) -- [REQUIRED]
The protocol used for the port mapping. Specify one protocol.
timeout (dict) --
An object that represents timeouts for different protocols.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: grpc, http, http2, tcp.
grpc (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
http (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
http2 (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
tcp (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
tls (dict) --
A reference to an object that represents the Transport Layer Security (TLS) properties for a listener.
certificate (dict) -- [REQUIRED]
A reference to an object that represents a listener's Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: acm, file, sds.
acm (dict) --
A reference to an object that represents an AWS Certicate Manager (ACM) certificate.
certificateArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
file (dict) --
A reference to an object that represents a local file certificate.
certificateChain (string) -- [REQUIRED]
The certificate chain for the certificate.
privateKey (string) -- [REQUIRED]
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a listener's Secret Discovery Service certificate.
secretName (string) -- [REQUIRED]
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.
mode (string) -- [REQUIRED]
Specify one of the following modes.
STRICT – Listener only accepts connections with TLS enabled.
PERMISSIVE – Listener accepts connections with or without TLS enabled.
DISABLED – Listener only accepts connections without TLS.
validation (dict) --
A reference to an object that represents a listener's Transport Layer Security (TLS) validation context.
subjectAlternativeNames (dict) --
A reference to an object that represents the SANs for a listener's Transport Layer Security (TLS) validation context.
match (dict) -- [REQUIRED]
An object that represents the criteria for determining a SANs match.
exact (list) -- [REQUIRED]
The values sent must match the specified values exactly.
(string) --
trust (dict) -- [REQUIRED]
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: file, sds.
file (dict) --
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
certificateChain (string) -- [REQUIRED]
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a listener's Transport Layer Security (TLS) Secret Discovery Service validation context trust.
secretName (string) -- [REQUIRED]
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
logging (dict) --
The inbound and outbound access logging information for the virtual node.
accessLog (dict) --
The access log configuration for a virtual node.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: file.
file (dict) --
The file object to send virtual node access logs to.
path (string) -- [REQUIRED]
The file path to write access logs to. You can use /dev/stdout to send access logs to standard out and configure your Envoy container to use a log driver, such as awslogs , to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk.
Note
The Envoy process must have write permissions to the path that you specify here. Otherwise, Envoy fails to bootstrap properly.
serviceDiscovery (dict) --
The service discovery information for the virtual node. If your virtual node does not expect ingress traffic, you can omit this parameter. If you specify a listener , then you must specify service discovery information.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: awsCloudMap, dns.
awsCloudMap (dict) --
Specifies any Cloud Map information for the virtual node.
attributes (list) --
A string map that contains attributes with values that you can use to filter instances by any custom attribute that you specified when you registered the instance. Only instances that match all of the specified key/value pairs will be returned.
(dict) --
An object that represents the Cloud Map attribute information for your virtual node.
Note
AWS Cloud Map is not available in the eu-south-1 Region.
key (string) -- [REQUIRED]
The name of an Cloud Map service instance attribute key. Any Cloud Map service instance that contains the specified key and value is returned.
value (string) -- [REQUIRED]
The value of an Cloud Map service instance attribute key. Any Cloud Map service instance that contains the specified key and value is returned.
namespaceName (string) -- [REQUIRED]
The name of the Cloud Map namespace to use.
serviceName (string) -- [REQUIRED]
The name of the Cloud Map service to use.
dns (dict) --
Specifies the DNS information for the virtual node.
hostname (string) -- [REQUIRED]
Specifies the DNS service discovery hostname for the virtual node.
responseType (string) --
Specifies the DNS response type for the virtual node.
list
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.
(dict) --
Optional metadata that you apply to a resource 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.
key (string) -- [REQUIRED]
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
value (string) -- [REQUIRED]
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
string
[REQUIRED]
The name to use for the virtual node.
dict
Response Syntax
{
'virtualNode': {
'meshName': 'string',
'metadata': {
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'meshOwner': 'string',
'resourceOwner': 'string',
'uid': 'string',
'version': 123
},
'spec': {
'backendDefaults': {
'clientPolicy': {
'tls': {
'certificate': {
'file': {
'certificateChain': 'string',
'privateKey': 'string'
},
'sds': {
'secretName': 'string'
}
},
'enforce': True|False,
'ports': [
123,
],
'validation': {
'subjectAlternativeNames': {
'match': {
'exact': [
'string',
]
}
},
'trust': {
'acm': {
'certificateAuthorityArns': [
'string',
]
},
'file': {
'certificateChain': 'string'
},
'sds': {
'secretName': 'string'
}
}
}
}
}
},
'backends': [
{
'virtualService': {
'clientPolicy': {
'tls': {
'certificate': {
'file': {
'certificateChain': 'string',
'privateKey': 'string'
},
'sds': {
'secretName': 'string'
}
},
'enforce': True|False,
'ports': [
123,
],
'validation': {
'subjectAlternativeNames': {
'match': {
'exact': [
'string',
]
}
},
'trust': {
'acm': {
'certificateAuthorityArns': [
'string',
]
},
'file': {
'certificateChain': 'string'
},
'sds': {
'secretName': 'string'
}
}
}
}
},
'virtualServiceName': 'string'
}
},
],
'listeners': [
{
'connectionPool': {
'grpc': {
'maxRequests': 123
},
'http': {
'maxConnections': 123,
'maxPendingRequests': 123
},
'http2': {
'maxRequests': 123
},
'tcp': {
'maxConnections': 123
}
},
'healthCheck': {
'healthyThreshold': 123,
'intervalMillis': 123,
'path': 'string',
'port': 123,
'protocol': 'http'|'tcp'|'http2'|'grpc',
'timeoutMillis': 123,
'unhealthyThreshold': 123
},
'outlierDetection': {
'baseEjectionDuration': {
'unit': 's'|'ms',
'value': 123
},
'interval': {
'unit': 's'|'ms',
'value': 123
},
'maxEjectionPercent': 123,
'maxServerErrors': 123
},
'portMapping': {
'port': 123,
'protocol': 'http'|'tcp'|'http2'|'grpc'
},
'timeout': {
'grpc': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
},
'http': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
},
'http2': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
},
'tcp': {
'idle': {
'unit': 's'|'ms',
'value': 123
}
}
},
'tls': {
'certificate': {
'acm': {
'certificateArn': 'string'
},
'file': {
'certificateChain': 'string',
'privateKey': 'string'
},
'sds': {
'secretName': 'string'
}
},
'mode': 'STRICT'|'PERMISSIVE'|'DISABLED',
'validation': {
'subjectAlternativeNames': {
'match': {
'exact': [
'string',
]
}
},
'trust': {
'file': {
'certificateChain': 'string'
},
'sds': {
'secretName': 'string'
}
}
}
}
},
],
'logging': {
'accessLog': {
'file': {
'path': 'string'
}
}
},
'serviceDiscovery': {
'awsCloudMap': {
'attributes': [
{
'key': 'string',
'value': 'string'
},
],
'namespaceName': 'string',
'serviceName': 'string'
},
'dns': {
'hostname': 'string',
'responseType': 'LOADBALANCER'|'ENDPOINTS'
}
}
},
'status': {
'status': 'ACTIVE'|'INACTIVE'|'DELETED'
},
'virtualNodeName': 'string'
}
}
Response Structure
(dict) --
virtualNode (dict) --
The full description of your virtual node following the create call.
meshName (string) --
The name of the service mesh that the virtual node resides in.
metadata (dict) --
The associated metadata for the virtual node.
arn (string) --
The full Amazon Resource Name (ARN) for the resource.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was created.
lastUpdatedAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was last updated.
meshOwner (string) --
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
resourceOwner (string) --
The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
uid (string) --
The unique identifier for the resource.
version (integer) --
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
spec (dict) --
The specifications of the virtual node.
backendDefaults (dict) --
A reference to an object that represents the defaults for backends.
clientPolicy (dict) --
A reference to an object that represents a client policy.
tls (dict) --
A reference to an object that represents a Transport Layer Security (TLS) client policy.
certificate (dict) --
A reference to an object that represents a client's TLS certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
file (dict) --
An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
certificateChain (string) --
The certificate chain for the certificate.
privateKey (string) --
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a client's TLS Secret Discovery Service certificate.
secretName (string) --
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.
enforce (boolean) --
Whether the policy is enforced. The default is True , if a value isn't specified.
ports (list) --
One or more ports that the policy is enforced for.
(integer) --
validation (dict) --
A reference to an object that represents a TLS validation context.
subjectAlternativeNames (dict) --
A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context.
match (dict) --
An object that represents the criteria for determining a SANs match.
exact (list) --
The values sent must match the specified values exactly.
(string) --
trust (dict) --
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: acm, file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
acm (dict) --
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.
certificateAuthorityArns (list) --
One or more ACM Amazon Resource Name (ARN)s.
(string) --
file (dict) --
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
certificateChain (string) --
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
secretName (string) --
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
backends (list) --
The backends that the virtual node is expected to send outbound traffic to.
(dict) --
An object that represents the backends that a virtual node is expected to send outbound traffic to.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: virtualService. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
virtualService (dict) --
Specifies a virtual service to use as a backend.
clientPolicy (dict) --
A reference to an object that represents the client policy for a backend.
tls (dict) --
A reference to an object that represents a Transport Layer Security (TLS) client policy.
certificate (dict) --
A reference to an object that represents a client's TLS certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
file (dict) --
An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
certificateChain (string) --
The certificate chain for the certificate.
privateKey (string) --
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a client's TLS Secret Discovery Service certificate.
secretName (string) --
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.
enforce (boolean) --
Whether the policy is enforced. The default is True , if a value isn't specified.
ports (list) --
One or more ports that the policy is enforced for.
(integer) --
validation (dict) --
A reference to an object that represents a TLS validation context.
subjectAlternativeNames (dict) --
A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context.
match (dict) --
An object that represents the criteria for determining a SANs match.
exact (list) --
The values sent must match the specified values exactly.
(string) --
trust (dict) --
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: acm, file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
acm (dict) --
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.
certificateAuthorityArns (list) --
One or more ACM Amazon Resource Name (ARN)s.
(string) --
file (dict) --
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
certificateChain (string) --
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
secretName (string) --
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
virtualServiceName (string) --
The name of the virtual service that is acting as a virtual node backend.
listeners (list) --
The listener that the virtual node is expected to receive inbound traffic from. You can specify one listener.
(dict) --
An object that represents a listener for a virtual node.
connectionPool (dict) --
The connection pool information for the listener.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: grpc, http, http2, tcp. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
grpc (dict) --
An object that represents a type of connection pool.
maxRequests (integer) --
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.
http (dict) --
An object that represents a type of connection pool.
maxConnections (integer) --
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.
maxPendingRequests (integer) --
Number of overflowing requests after max_connections Envoy will queue to upstream cluster.
http2 (dict) --
An object that represents a type of connection pool.
maxRequests (integer) --
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.
tcp (dict) --
An object that represents a type of connection pool.
maxConnections (integer) --
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.
healthCheck (dict) --
The health check information for the listener.
healthyThreshold (integer) --
The number of consecutive successful health checks that must occur before declaring listener healthy.
intervalMillis (integer) --
The time period in milliseconds between each health check execution.
path (string) --
The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.
port (integer) --
The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.
protocol (string) --
The protocol for the health check request. If you specify grpc , then your service must conform to the GRPC Health Checking Protocol.
timeoutMillis (integer) --
The amount of time to wait when receiving a response from the health check, in milliseconds.
unhealthyThreshold (integer) --
The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.
outlierDetection (dict) --
The outlier detection information for the listener.
baseEjectionDuration (dict) --
The base amount of time for which a host is ejected.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
interval (dict) --
The time interval between ejection sweep analysis.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
maxEjectionPercent (integer) --
Maximum percentage of hosts in load balancing pool for upstream service that can be ejected. Will eject at least one host regardless of the value.
maxServerErrors (integer) --
Number of consecutive 5xx errors required for ejection.
portMapping (dict) --
The port mapping information for the listener.
port (integer) --
The port used for the port mapping.
protocol (string) --
The protocol used for the port mapping. Specify one protocol.
timeout (dict) --
An object that represents timeouts for different protocols.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: grpc, http, http2, tcp. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
grpc (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
http (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
http2 (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
tcp (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
tls (dict) --
A reference to an object that represents the Transport Layer Security (TLS) properties for a listener.
certificate (dict) --
A reference to an object that represents a listener's Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: acm, file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
acm (dict) --
A reference to an object that represents an AWS Certicate Manager (ACM) certificate.
certificateArn (string) --
The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
file (dict) --
A reference to an object that represents a local file certificate.
certificateChain (string) --
The certificate chain for the certificate.
privateKey (string) --
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a listener's Secret Discovery Service certificate.
secretName (string) --
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.
mode (string) --
Specify one of the following modes.
STRICT – Listener only accepts connections with TLS enabled.
PERMISSIVE – Listener accepts connections with or without TLS enabled.
DISABLED – Listener only accepts connections without TLS.
validation (dict) --
A reference to an object that represents a listener's Transport Layer Security (TLS) validation context.
subjectAlternativeNames (dict) --
A reference to an object that represents the SANs for a listener's Transport Layer Security (TLS) validation context.
match (dict) --
An object that represents the criteria for determining a SANs match.
exact (list) --
The values sent must match the specified values exactly.
(string) --
trust (dict) --
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
file (dict) --
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
certificateChain (string) --
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a listener's Transport Layer Security (TLS) Secret Discovery Service validation context trust.
secretName (string) --
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
logging (dict) --
The inbound and outbound access logging information for the virtual node.
accessLog (dict) --
The access log configuration for a virtual node.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: file. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
file (dict) --
The file object to send virtual node access logs to.
path (string) --
The file path to write access logs to. You can use /dev/stdout to send access logs to standard out and configure your Envoy container to use a log driver, such as awslogs , to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk.
Note
The Envoy process must have write permissions to the path that you specify here. Otherwise, Envoy fails to bootstrap properly.
serviceDiscovery (dict) --
The service discovery information for the virtual node. If your virtual node does not expect ingress traffic, you can omit this parameter. If you specify a listener , then you must specify service discovery information.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: awsCloudMap, dns. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
awsCloudMap (dict) --
Specifies any Cloud Map information for the virtual node.
attributes (list) --
A string map that contains attributes with values that you can use to filter instances by any custom attribute that you specified when you registered the instance. Only instances that match all of the specified key/value pairs will be returned.
(dict) --
An object that represents the Cloud Map attribute information for your virtual node.
Note
AWS Cloud Map is not available in the eu-south-1 Region.
key (string) --
The name of an Cloud Map service instance attribute key. Any Cloud Map service instance that contains the specified key and value is returned.
value (string) --
The value of an Cloud Map service instance attribute key. Any Cloud Map service instance that contains the specified key and value is returned.
namespaceName (string) --
The name of the Cloud Map namespace to use.
serviceName (string) --
The name of the Cloud Map service to use.
dns (dict) --
Specifies the DNS information for the virtual node.
hostname (string) --
Specifies the DNS service discovery hostname for the virtual node.
responseType (string) --
Specifies the DNS response type for the virtual node.
status (dict) --
The current status for the virtual node.
status (string) --
The current status of the virtual node.
virtualNodeName (string) --
The name of the virtual node.
{'gatewayRoute': {'spec': {'grpcRoute': {'action': {'rewrite': {'hostname': {'defaultTargetHostname': 'ENABLED '
'| '
'DISABLED'}}},
'match': {'hostname': {'exact': 'string',
'suffix': 'string'},
'metadata': [{'invert': 'boolean',
'match': {'exact': 'string',
'prefix': 'string',
'range': {'end': 'long',
'start': 'long'},
'regex': 'string',
'suffix': 'string'},
'name': 'string'}]}},
'http2Route': {'action': {'rewrite': {'hostname': {'defaultTargetHostname': 'ENABLED '
'| '
'DISABLED'},
'path': {'exact': 'string'},
'prefix': {'defaultPrefix': 'ENABLED '
'| '
'DISABLED',
'value': 'string'}}},
'match': {'headers': [{'invert': 'boolean',
'match': {'exact': 'string',
'prefix': 'string',
'range': {'end': 'long',
'start': 'long'},
'regex': 'string',
'suffix': 'string'},
'name': 'string'}],
'hostname': {'exact': 'string',
'suffix': 'string'},
'method': 'GET | HEAD | '
'POST | PUT | '
'DELETE | '
'CONNECT | '
'OPTIONS | TRACE '
'| PATCH',
'path': {'exact': 'string',
'regex': 'string'},
'queryParameters': [{'match': {'exact': 'string'},
'name': 'string'}]}},
'httpRoute': {'action': {'rewrite': {'hostname': {'defaultTargetHostname': 'ENABLED '
'| '
'DISABLED'},
'path': {'exact': 'string'},
'prefix': {'defaultPrefix': 'ENABLED '
'| '
'DISABLED',
'value': 'string'}}},
'match': {'headers': [{'invert': 'boolean',
'match': {'exact': 'string',
'prefix': 'string',
'range': {'end': 'long',
'start': 'long'},
'regex': 'string',
'suffix': 'string'},
'name': 'string'}],
'hostname': {'exact': 'string',
'suffix': 'string'},
'method': 'GET | HEAD | '
'POST | PUT | '
'DELETE | CONNECT '
'| OPTIONS | '
'TRACE | PATCH',
'path': {'exact': 'string',
'regex': 'string'},
'queryParameters': [{'match': {'exact': 'string'},
'name': 'string'}]}},
'priority': 'integer'}}}
Deletes an existing gateway route.
See also: AWS API Documentation
Request Syntax
client.delete_gateway_route(
gatewayRouteName='string',
meshName='string',
meshOwner='string',
virtualGatewayName='string'
)
string
[REQUIRED]
The name of the gateway route to delete.
string
[REQUIRED]
The name of the service mesh to delete the gateway route from.
string
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
string
[REQUIRED]
The name of the virtual gateway to delete the route from.
dict
Response Syntax
{
'gatewayRoute': {
'gatewayRouteName': 'string',
'meshName': 'string',
'metadata': {
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'meshOwner': 'string',
'resourceOwner': 'string',
'uid': 'string',
'version': 123
},
'spec': {
'grpcRoute': {
'action': {
'rewrite': {
'hostname': {
'defaultTargetHostname': 'ENABLED'|'DISABLED'
}
},
'target': {
'virtualService': {
'virtualServiceName': 'string'
}
}
},
'match': {
'hostname': {
'exact': 'string',
'suffix': 'string'
},
'metadata': [
{
'invert': True|False,
'match': {
'exact': 'string',
'prefix': 'string',
'range': {
'end': 123,
'start': 123
},
'regex': 'string',
'suffix': 'string'
},
'name': 'string'
},
],
'serviceName': 'string'
}
},
'http2Route': {
'action': {
'rewrite': {
'hostname': {
'defaultTargetHostname': 'ENABLED'|'DISABLED'
},
'path': {
'exact': 'string'
},
'prefix': {
'defaultPrefix': 'ENABLED'|'DISABLED',
'value': 'string'
}
},
'target': {
'virtualService': {
'virtualServiceName': 'string'
}
}
},
'match': {
'headers': [
{
'invert': True|False,
'match': {
'exact': 'string',
'prefix': 'string',
'range': {
'end': 123,
'start': 123
},
'regex': 'string',
'suffix': 'string'
},
'name': 'string'
},
],
'hostname': {
'exact': 'string',
'suffix': 'string'
},
'method': 'GET'|'HEAD'|'POST'|'PUT'|'DELETE'|'CONNECT'|'OPTIONS'|'TRACE'|'PATCH',
'path': {
'exact': 'string',
'regex': 'string'
},
'prefix': 'string',
'queryParameters': [
{
'match': {
'exact': 'string'
},
'name': 'string'
},
]
}
},
'httpRoute': {
'action': {
'rewrite': {
'hostname': {
'defaultTargetHostname': 'ENABLED'|'DISABLED'
},
'path': {
'exact': 'string'
},
'prefix': {
'defaultPrefix': 'ENABLED'|'DISABLED',
'value': 'string'
}
},
'target': {
'virtualService': {
'virtualServiceName': 'string'
}
}
},
'match': {
'headers': [
{
'invert': True|False,
'match': {
'exact': 'string',
'prefix': 'string',
'range': {
'end': 123,
'start': 123
},
'regex': 'string',
'suffix': 'string'
},
'name': 'string'
},
],
'hostname': {
'exact': 'string',
'suffix': 'string'
},
'method': 'GET'|'HEAD'|'POST'|'PUT'|'DELETE'|'CONNECT'|'OPTIONS'|'TRACE'|'PATCH',
'path': {
'exact': 'string',
'regex': 'string'
},
'prefix': 'string',
'queryParameters': [
{
'match': {
'exact': 'string'
},
'name': 'string'
},
]
}
},
'priority': 123
},
'status': {
'status': 'ACTIVE'|'INACTIVE'|'DELETED'
},
'virtualGatewayName': 'string'
}
}
Response Structure
(dict) --
gatewayRoute (dict) --
The gateway route that was deleted.
gatewayRouteName (string) --
The name of the gateway route.
meshName (string) --
The name of the service mesh that the resource resides in.
metadata (dict) --
An object that represents metadata for a resource.
arn (string) --
The full Amazon Resource Name (ARN) for the resource.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was created.
lastUpdatedAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was last updated.
meshOwner (string) --
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
resourceOwner (string) --
The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
uid (string) --
The unique identifier for the resource.
version (integer) --
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
spec (dict) --
The specifications of the gateway route.
grpcRoute (dict) --
An object that represents the specification of a gRPC gateway route.
action (dict) --
An object that represents the action to take if a match is determined.
rewrite (dict) --
The gateway route action to rewrite.
hostname (dict) --
The host name of the gateway route to rewrite.
defaultTargetHostname (string) --
The default target host name to write to.
target (dict) --
An object that represents the target that traffic is routed to when a request matches the gateway route.
virtualService (dict) --
An object that represents a virtual service gateway route target.
virtualServiceName (string) --
The name of the virtual service that traffic is routed to.
match (dict) --
An object that represents the criteria for determining a request match.
hostname (dict) --
The gateway route host name to be matched on.
exact (string) --
The exact host name to match on.
suffix (string) --
The specified ending characters of the host name to match on.
metadata (list) --
The gateway route metadata to be matched on.
(dict) --
An object representing the metadata of the gateway route.
invert (boolean) --
Specify True to match anything except the match criteria. The default value is False .
match (dict) --
The criteria for determining a metadata match.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: exact, prefix, range, regex, suffix. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
exact (string) --
The exact method header to be matched on.
prefix (string) --
The specified beginning characters of the method header to be matched on.
range (dict) --
An object that represents the range of values to match on. The first character of the range is included in the range, though the last character is not. For example, if the range specified were 1-100, only values 1-99 would be matched.
end (integer) --
The end of the range.
start (integer) --
The start of the range.
regex (string) --
The regex used to match the method header.
suffix (string) --
The specified ending characters of the method header to match on.
name (string) --
A name for the gateway route metadata.
serviceName (string) --
The fully qualified domain name for the service to match from the request.
http2Route (dict) --
An object that represents the specification of an HTTP/2 gateway route.
action (dict) --
An object that represents the action to take if a match is determined.
rewrite (dict) --
The gateway route action to rewrite.
hostname (dict) --
The host name to rewrite.
defaultTargetHostname (string) --
The default target host name to write to.
path (dict) --
The path to rewrite.
exact (string) --
The exact path to rewrite.
prefix (dict) --
The specified beginning characters to rewrite.
defaultPrefix (string) --
The default prefix used to replace the incoming route prefix when rewritten.
value (string) --
The value used to replace the incoming route prefix when rewritten.
target (dict) --
An object that represents the target that traffic is routed to when a request matches the gateway route.
virtualService (dict) --
An object that represents a virtual service gateway route target.
virtualServiceName (string) --
The name of the virtual service that traffic is routed to.
match (dict) --
An object that represents the criteria for determining a request match.
headers (list) --
The client request headers to match on.
(dict) --
An object that represents the HTTP header in the gateway route.
invert (boolean) --
Specify True to match anything except the match criteria. The default value is False .
match (dict) --
An object that represents the method and value to match with the header value sent in a request. Specify one match method.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: exact, prefix, range, regex, suffix. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
exact (string) --
The value sent by the client must match the specified value exactly.
prefix (string) --
The value sent by the client must begin with the specified characters.
range (dict) --
An object that represents the range of values to match on.
end (integer) --
The end of the range.
start (integer) --
The start of the range.
regex (string) --
The value sent by the client must include the specified characters.
suffix (string) --
The value sent by the client must end with the specified characters.
name (string) --
A name for the HTTP header in the gateway route that will be matched on.
hostname (dict) --
The host name to match on.
exact (string) --
The exact host name to match on.
suffix (string) --
The specified ending characters of the host name to match on.
method (string) --
The method to match on.
path (dict) --
The path to match on.
exact (string) --
The exact path to match on.
regex (string) --
The regex used to match the path.
prefix (string) --
Specifies the path to match requests with. This parameter must always start with / , which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics , your prefix should be /metrics .
queryParameters (list) --
The query parameter to match on.
(dict) --
An object that represents the query parameter in the request.
match (dict) --
The query parameter to match on.
exact (string) --
The exact query parameter to match on.
name (string) --
A name for the query parameter that will be matched on.
httpRoute (dict) --
An object that represents the specification of an HTTP gateway route.
action (dict) --
An object that represents the action to take if a match is determined.
rewrite (dict) --
The gateway route action to rewrite.
hostname (dict) --
The host name to rewrite.
defaultTargetHostname (string) --
The default target host name to write to.
path (dict) --
The path to rewrite.
exact (string) --
The exact path to rewrite.
prefix (dict) --
The specified beginning characters to rewrite.
defaultPrefix (string) --
The default prefix used to replace the incoming route prefix when rewritten.
value (string) --
The value used to replace the incoming route prefix when rewritten.
target (dict) --
An object that represents the target that traffic is routed to when a request matches the gateway route.
virtualService (dict) --
An object that represents a virtual service gateway route target.
virtualServiceName (string) --
The name of the virtual service that traffic is routed to.
match (dict) --
An object that represents the criteria for determining a request match.
headers (list) --
The client request headers to match on.
(dict) --
An object that represents the HTTP header in the gateway route.
invert (boolean) --
Specify True to match anything except the match criteria. The default value is False .
match (dict) --
An object that represents the method and value to match with the header value sent in a request. Specify one match method.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: exact, prefix, range, regex, suffix. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
exact (string) --
The value sent by the client must match the specified value exactly.
prefix (string) --
The value sent by the client must begin with the specified characters.
range (dict) --
An object that represents the range of values to match on.
end (integer) --
The end of the range.
start (integer) --
The start of the range.
regex (string) --
The value sent by the client must include the specified characters.
suffix (string) --
The value sent by the client must end with the specified characters.
name (string) --
A name for the HTTP header in the gateway route that will be matched on.
hostname (dict) --
The host name to match on.
exact (string) --
The exact host name to match on.
suffix (string) --
The specified ending characters of the host name to match on.
method (string) --
The method to match on.
path (dict) --
The path to match on.
exact (string) --
The exact path to match on.
regex (string) --
The regex used to match the path.
prefix (string) --
Specifies the path to match requests with. This parameter must always start with / , which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics , your prefix should be /metrics .
queryParameters (list) --
The query parameter to match on.
(dict) --
An object that represents the query parameter in the request.
match (dict) --
The query parameter to match on.
exact (string) --
The exact query parameter to match on.
name (string) --
A name for the query parameter that will be matched on.
priority (integer) --
The ordering of the gateway routes spec.
status (dict) --
The status of the gateway route.
status (string) --
The current status for the gateway route.
virtualGatewayName (string) --
The virtual gateway that the gateway route is associated with.
{'route': {'spec': {'http2Route': {'match': {'path': {'exact': 'string',
'regex': 'string'},
'queryParameters': [{'match': {'exact': 'string'},
'name': 'string'}]}},
'httpRoute': {'match': {'path': {'exact': 'string',
'regex': 'string'},
'queryParameters': [{'match': {'exact': 'string'},
'name': 'string'}]}}}}}
Deletes an existing route.
See also: AWS API Documentation
Request Syntax
client.delete_route(
meshName='string',
meshOwner='string',
routeName='string',
virtualRouterName='string'
)
string
[REQUIRED]
The name of the service mesh to delete the route in.
string
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
string
[REQUIRED]
The name of the route to delete.
string
[REQUIRED]
The name of the virtual router to delete the route in.
dict
Response Syntax
{
'route': {
'meshName': 'string',
'metadata': {
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'meshOwner': 'string',
'resourceOwner': 'string',
'uid': 'string',
'version': 123
},
'routeName': 'string',
'spec': {
'grpcRoute': {
'action': {
'weightedTargets': [
{
'virtualNode': 'string',
'weight': 123
},
]
},
'match': {
'metadata': [
{
'invert': True|False,
'match': {
'exact': 'string',
'prefix': 'string',
'range': {
'end': 123,
'start': 123
},
'regex': 'string',
'suffix': 'string'
},
'name': 'string'
},
],
'methodName': 'string',
'serviceName': 'string'
},
'retryPolicy': {
'grpcRetryEvents': [
'cancelled'|'deadline-exceeded'|'internal'|'resource-exhausted'|'unavailable',
],
'httpRetryEvents': [
'string',
],
'maxRetries': 123,
'perRetryTimeout': {
'unit': 's'|'ms',
'value': 123
},
'tcpRetryEvents': [
'connection-error',
]
},
'timeout': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
}
},
'http2Route': {
'action': {
'weightedTargets': [
{
'virtualNode': 'string',
'weight': 123
},
]
},
'match': {
'headers': [
{
'invert': True|False,
'match': {
'exact': 'string',
'prefix': 'string',
'range': {
'end': 123,
'start': 123
},
'regex': 'string',
'suffix': 'string'
},
'name': 'string'
},
],
'method': 'GET'|'HEAD'|'POST'|'PUT'|'DELETE'|'CONNECT'|'OPTIONS'|'TRACE'|'PATCH',
'path': {
'exact': 'string',
'regex': 'string'
},
'prefix': 'string',
'queryParameters': [
{
'match': {
'exact': 'string'
},
'name': 'string'
},
],
'scheme': 'http'|'https'
},
'retryPolicy': {
'httpRetryEvents': [
'string',
],
'maxRetries': 123,
'perRetryTimeout': {
'unit': 's'|'ms',
'value': 123
},
'tcpRetryEvents': [
'connection-error',
]
},
'timeout': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
}
},
'httpRoute': {
'action': {
'weightedTargets': [
{
'virtualNode': 'string',
'weight': 123
},
]
},
'match': {
'headers': [
{
'invert': True|False,
'match': {
'exact': 'string',
'prefix': 'string',
'range': {
'end': 123,
'start': 123
},
'regex': 'string',
'suffix': 'string'
},
'name': 'string'
},
],
'method': 'GET'|'HEAD'|'POST'|'PUT'|'DELETE'|'CONNECT'|'OPTIONS'|'TRACE'|'PATCH',
'path': {
'exact': 'string',
'regex': 'string'
},
'prefix': 'string',
'queryParameters': [
{
'match': {
'exact': 'string'
},
'name': 'string'
},
],
'scheme': 'http'|'https'
},
'retryPolicy': {
'httpRetryEvents': [
'string',
],
'maxRetries': 123,
'perRetryTimeout': {
'unit': 's'|'ms',
'value': 123
},
'tcpRetryEvents': [
'connection-error',
]
},
'timeout': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
}
},
'priority': 123,
'tcpRoute': {
'action': {
'weightedTargets': [
{
'virtualNode': 'string',
'weight': 123
},
]
},
'timeout': {
'idle': {
'unit': 's'|'ms',
'value': 123
}
}
}
},
'status': {
'status': 'ACTIVE'|'INACTIVE'|'DELETED'
},
'virtualRouterName': 'string'
}
}
Response Structure
(dict) --
route (dict) --
The route that was deleted.
meshName (string) --
The name of the service mesh that the route resides in.
metadata (dict) --
The associated metadata for the route.
arn (string) --
The full Amazon Resource Name (ARN) for the resource.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was created.
lastUpdatedAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was last updated.
meshOwner (string) --
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
resourceOwner (string) --
The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
uid (string) --
The unique identifier for the resource.
version (integer) --
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
routeName (string) --
The name of the route.
spec (dict) --
The specifications of the route.
grpcRoute (dict) --
An object that represents the specification of a gRPC route.
action (dict) --
An object that represents the action to take if a match is determined.
weightedTargets (list) --
An object that represents the targets that traffic is routed to when a request matches the route.
(dict) --
An object that represents a target and its relative weight. Traffic is distributed across targets according to their relative weight. For example, a weighted target with a relative weight of 50 receives five times as much traffic as one with a relative weight of 10. The total weight for all targets combined must be less than or equal to 100.
virtualNode (string) --
The virtual node to associate with the weighted target.
weight (integer) --
The relative weight of the weighted target.
match (dict) --
An object that represents the criteria for determining a request match.
metadata (list) --
An object that represents the data to match from the request.
(dict) --
An object that represents the match metadata for the route.
invert (boolean) --
Specify True to match anything except the match criteria. The default value is False .
match (dict) --
An object that represents the data to match from the request.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: exact, prefix, range, regex, suffix. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
exact (string) --
The value sent by the client must match the specified value exactly.
prefix (string) --
The value sent by the client must begin with the specified characters.
range (dict) --
An object that represents the range of values to match on.
end (integer) --
The end of the range.
start (integer) --
The start of the range.
regex (string) --
The value sent by the client must include the specified characters.
suffix (string) --
The value sent by the client must end with the specified characters.
name (string) --
The name of the route.
methodName (string) --
The method name to match from the request. If you specify a name, you must also specify a serviceName .
serviceName (string) --
The fully qualified domain name for the service to match from the request.
retryPolicy (dict) --
An object that represents a retry policy.
grpcRetryEvents (list) --
Specify at least one of the valid values.
(string) --
httpRetryEvents (list) --
Specify at least one of the following values.
server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511
gateway-error – HTTP status codes 502, 503, and 504
client-error – HTTP status code 409
stream-error – Retry on refused stream
(string) --
maxRetries (integer) --
The maximum number of retry attempts.
perRetryTimeout (dict) --
The timeout for each retry attempt.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
tcpRetryEvents (list) --
Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.
(string) --
timeout (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
http2Route (dict) --
An object that represents the specification of an HTTP/2 route.
action (dict) --
An object that represents the action to take if a match is determined.
weightedTargets (list) --
An object that represents the targets that traffic is routed to when a request matches the route.
(dict) --
An object that represents a target and its relative weight. Traffic is distributed across targets according to their relative weight. For example, a weighted target with a relative weight of 50 receives five times as much traffic as one with a relative weight of 10. The total weight for all targets combined must be less than or equal to 100.
virtualNode (string) --
The virtual node to associate with the weighted target.
weight (integer) --
The relative weight of the weighted target.
match (dict) --
An object that represents the criteria for determining a request match.
headers (list) --
The client request headers to match on.
(dict) --
An object that represents the HTTP header in the request.
invert (boolean) --
Specify True to match anything except the match criteria. The default value is False .
match (dict) --
The HeaderMatchMethod object.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: exact, prefix, range, regex, suffix. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
exact (string) --
The value sent by the client must match the specified value exactly.
prefix (string) --
The value sent by the client must begin with the specified characters.
range (dict) --
An object that represents the range of values to match on.
end (integer) --
The end of the range.
start (integer) --
The start of the range.
regex (string) --
The value sent by the client must include the specified characters.
suffix (string) --
The value sent by the client must end with the specified characters.
name (string) --
A name for the HTTP header in the client request that will be matched on.
method (string) --
The client request method to match on. Specify only one.
path (dict) --
The client request path to match on.
exact (string) --
The exact path to match on.
regex (string) --
The regex used to match the path.
prefix (string) --
Specifies the path to match requests with. This parameter must always start with / , which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics , your prefix should be /metrics .
queryParameters (list) --
The client request query parameters to match on.
(dict) --
An object that represents the query parameter in the request.
match (dict) --
The query parameter to match on.
exact (string) --
The exact query parameter to match on.
name (string) --
A name for the query parameter that will be matched on.
scheme (string) --
The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.
retryPolicy (dict) --
An object that represents a retry policy.
httpRetryEvents (list) --
Specify at least one of the following values.
server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511
gateway-error – HTTP status codes 502, 503, and 504
client-error – HTTP status code 409
stream-error – Retry on refused stream
(string) --
maxRetries (integer) --
The maximum number of retry attempts.
perRetryTimeout (dict) --
The timeout for each retry attempt.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
tcpRetryEvents (list) --
Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.
(string) --
timeout (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
httpRoute (dict) --
An object that represents the specification of an HTTP route.
action (dict) --
An object that represents the action to take if a match is determined.
weightedTargets (list) --
An object that represents the targets that traffic is routed to when a request matches the route.
(dict) --
An object that represents a target and its relative weight. Traffic is distributed across targets according to their relative weight. For example, a weighted target with a relative weight of 50 receives five times as much traffic as one with a relative weight of 10. The total weight for all targets combined must be less than or equal to 100.
virtualNode (string) --
The virtual node to associate with the weighted target.
weight (integer) --
The relative weight of the weighted target.
match (dict) --
An object that represents the criteria for determining a request match.
headers (list) --
The client request headers to match on.
(dict) --
An object that represents the HTTP header in the request.
invert (boolean) --
Specify True to match anything except the match criteria. The default value is False .
match (dict) --
The HeaderMatchMethod object.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: exact, prefix, range, regex, suffix. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
exact (string) --
The value sent by the client must match the specified value exactly.
prefix (string) --
The value sent by the client must begin with the specified characters.
range (dict) --
An object that represents the range of values to match on.
end (integer) --
The end of the range.
start (integer) --
The start of the range.
regex (string) --
The value sent by the client must include the specified characters.
suffix (string) --
The value sent by the client must end with the specified characters.
name (string) --
A name for the HTTP header in the client request that will be matched on.
method (string) --
The client request method to match on. Specify only one.
path (dict) --
The client request path to match on.
exact (string) --
The exact path to match on.
regex (string) --
The regex used to match the path.
prefix (string) --
Specifies the path to match requests with. This parameter must always start with / , which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics , your prefix should be /metrics .
queryParameters (list) --
The client request query parameters to match on.
(dict) --
An object that represents the query parameter in the request.
match (dict) --
The query parameter to match on.
exact (string) --
The exact query parameter to match on.
name (string) --
A name for the query parameter that will be matched on.
scheme (string) --
The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.
retryPolicy (dict) --
An object that represents a retry policy.
httpRetryEvents (list) --
Specify at least one of the following values.
server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511
gateway-error – HTTP status codes 502, 503, and 504
client-error – HTTP status code 409
stream-error – Retry on refused stream
(string) --
maxRetries (integer) --
The maximum number of retry attempts.
perRetryTimeout (dict) --
The timeout for each retry attempt.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
tcpRetryEvents (list) --
Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.
(string) --
timeout (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
priority (integer) --
The priority for the route. Routes are matched based on the specified value, where 0 is the highest priority.
tcpRoute (dict) --
An object that represents the specification of a TCP route.
action (dict) --
The action to take if a match is determined.
weightedTargets (list) --
An object that represents the targets that traffic is routed to when a request matches the route.
(dict) --
An object that represents a target and its relative weight. Traffic is distributed across targets according to their relative weight. For example, a weighted target with a relative weight of 50 receives five times as much traffic as one with a relative weight of 10. The total weight for all targets combined must be less than or equal to 100.
virtualNode (string) --
The virtual node to associate with the weighted target.
weight (integer) --
The relative weight of the weighted target.
timeout (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
status (dict) --
The status of the route.
status (string) --
The current status for the route.
virtualRouterName (string) --
The virtual router that the route is associated with.
{'virtualNode': {'spec': {'serviceDiscovery': {'dns': {'responseType': 'LOADBALANCER '
'| '
'ENDPOINTS'}}}}}
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.
See also: AWS API Documentation
Request Syntax
client.delete_virtual_node(
meshName='string',
meshOwner='string',
virtualNodeName='string'
)
string
[REQUIRED]
The name of the service mesh to delete the virtual node in.
string
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
string
[REQUIRED]
The name of the virtual node to delete.
dict
Response Syntax
{
'virtualNode': {
'meshName': 'string',
'metadata': {
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'meshOwner': 'string',
'resourceOwner': 'string',
'uid': 'string',
'version': 123
},
'spec': {
'backendDefaults': {
'clientPolicy': {
'tls': {
'certificate': {
'file': {
'certificateChain': 'string',
'privateKey': 'string'
},
'sds': {
'secretName': 'string'
}
},
'enforce': True|False,
'ports': [
123,
],
'validation': {
'subjectAlternativeNames': {
'match': {
'exact': [
'string',
]
}
},
'trust': {
'acm': {
'certificateAuthorityArns': [
'string',
]
},
'file': {
'certificateChain': 'string'
},
'sds': {
'secretName': 'string'
}
}
}
}
}
},
'backends': [
{
'virtualService': {
'clientPolicy': {
'tls': {
'certificate': {
'file': {
'certificateChain': 'string',
'privateKey': 'string'
},
'sds': {
'secretName': 'string'
}
},
'enforce': True|False,
'ports': [
123,
],
'validation': {
'subjectAlternativeNames': {
'match': {
'exact': [
'string',
]
}
},
'trust': {
'acm': {
'certificateAuthorityArns': [
'string',
]
},
'file': {
'certificateChain': 'string'
},
'sds': {
'secretName': 'string'
}
}
}
}
},
'virtualServiceName': 'string'
}
},
],
'listeners': [
{
'connectionPool': {
'grpc': {
'maxRequests': 123
},
'http': {
'maxConnections': 123,
'maxPendingRequests': 123
},
'http2': {
'maxRequests': 123
},
'tcp': {
'maxConnections': 123
}
},
'healthCheck': {
'healthyThreshold': 123,
'intervalMillis': 123,
'path': 'string',
'port': 123,
'protocol': 'http'|'tcp'|'http2'|'grpc',
'timeoutMillis': 123,
'unhealthyThreshold': 123
},
'outlierDetection': {
'baseEjectionDuration': {
'unit': 's'|'ms',
'value': 123
},
'interval': {
'unit': 's'|'ms',
'value': 123
},
'maxEjectionPercent': 123,
'maxServerErrors': 123
},
'portMapping': {
'port': 123,
'protocol': 'http'|'tcp'|'http2'|'grpc'
},
'timeout': {
'grpc': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
},
'http': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
},
'http2': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
},
'tcp': {
'idle': {
'unit': 's'|'ms',
'value': 123
}
}
},
'tls': {
'certificate': {
'acm': {
'certificateArn': 'string'
},
'file': {
'certificateChain': 'string',
'privateKey': 'string'
},
'sds': {
'secretName': 'string'
}
},
'mode': 'STRICT'|'PERMISSIVE'|'DISABLED',
'validation': {
'subjectAlternativeNames': {
'match': {
'exact': [
'string',
]
}
},
'trust': {
'file': {
'certificateChain': 'string'
},
'sds': {
'secretName': 'string'
}
}
}
}
},
],
'logging': {
'accessLog': {
'file': {
'path': 'string'
}
}
},
'serviceDiscovery': {
'awsCloudMap': {
'attributes': [
{
'key': 'string',
'value': 'string'
},
],
'namespaceName': 'string',
'serviceName': 'string'
},
'dns': {
'hostname': 'string',
'responseType': 'LOADBALANCER'|'ENDPOINTS'
}
}
},
'status': {
'status': 'ACTIVE'|'INACTIVE'|'DELETED'
},
'virtualNodeName': 'string'
}
}
Response Structure
(dict) --
virtualNode (dict) --
The virtual node that was deleted.
meshName (string) --
The name of the service mesh that the virtual node resides in.
metadata (dict) --
The associated metadata for the virtual node.
arn (string) --
The full Amazon Resource Name (ARN) for the resource.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was created.
lastUpdatedAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was last updated.
meshOwner (string) --
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
resourceOwner (string) --
The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
uid (string) --
The unique identifier for the resource.
version (integer) --
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
spec (dict) --
The specifications of the virtual node.
backendDefaults (dict) --
A reference to an object that represents the defaults for backends.
clientPolicy (dict) --
A reference to an object that represents a client policy.
tls (dict) --
A reference to an object that represents a Transport Layer Security (TLS) client policy.
certificate (dict) --
A reference to an object that represents a client's TLS certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
file (dict) --
An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
certificateChain (string) --
The certificate chain for the certificate.
privateKey (string) --
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a client's TLS Secret Discovery Service certificate.
secretName (string) --
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.
enforce (boolean) --
Whether the policy is enforced. The default is True , if a value isn't specified.
ports (list) --
One or more ports that the policy is enforced for.
(integer) --
validation (dict) --
A reference to an object that represents a TLS validation context.
subjectAlternativeNames (dict) --
A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context.
match (dict) --
An object that represents the criteria for determining a SANs match.
exact (list) --
The values sent must match the specified values exactly.
(string) --
trust (dict) --
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: acm, file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
acm (dict) --
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.
certificateAuthorityArns (list) --
One or more ACM Amazon Resource Name (ARN)s.
(string) --
file (dict) --
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
certificateChain (string) --
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
secretName (string) --
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
backends (list) --
The backends that the virtual node is expected to send outbound traffic to.
(dict) --
An object that represents the backends that a virtual node is expected to send outbound traffic to.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: virtualService. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
virtualService (dict) --
Specifies a virtual service to use as a backend.
clientPolicy (dict) --
A reference to an object that represents the client policy for a backend.
tls (dict) --
A reference to an object that represents a Transport Layer Security (TLS) client policy.
certificate (dict) --
A reference to an object that represents a client's TLS certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
file (dict) --
An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
certificateChain (string) --
The certificate chain for the certificate.
privateKey (string) --
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a client's TLS Secret Discovery Service certificate.
secretName (string) --
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.
enforce (boolean) --
Whether the policy is enforced. The default is True , if a value isn't specified.
ports (list) --
One or more ports that the policy is enforced for.
(integer) --
validation (dict) --
A reference to an object that represents a TLS validation context.
subjectAlternativeNames (dict) --
A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context.
match (dict) --
An object that represents the criteria for determining a SANs match.
exact (list) --
The values sent must match the specified values exactly.
(string) --
trust (dict) --
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: acm, file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
acm (dict) --
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.
certificateAuthorityArns (list) --
One or more ACM Amazon Resource Name (ARN)s.
(string) --
file (dict) --
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
certificateChain (string) --
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
secretName (string) --
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
virtualServiceName (string) --
The name of the virtual service that is acting as a virtual node backend.
listeners (list) --
The listener that the virtual node is expected to receive inbound traffic from. You can specify one listener.
(dict) --
An object that represents a listener for a virtual node.
connectionPool (dict) --
The connection pool information for the listener.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: grpc, http, http2, tcp. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
grpc (dict) --
An object that represents a type of connection pool.
maxRequests (integer) --
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.
http (dict) --
An object that represents a type of connection pool.
maxConnections (integer) --
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.
maxPendingRequests (integer) --
Number of overflowing requests after max_connections Envoy will queue to upstream cluster.
http2 (dict) --
An object that represents a type of connection pool.
maxRequests (integer) --
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.
tcp (dict) --
An object that represents a type of connection pool.
maxConnections (integer) --
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.
healthCheck (dict) --
The health check information for the listener.
healthyThreshold (integer) --
The number of consecutive successful health checks that must occur before declaring listener healthy.
intervalMillis (integer) --
The time period in milliseconds between each health check execution.
path (string) --
The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.
port (integer) --
The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.
protocol (string) --
The protocol for the health check request. If you specify grpc , then your service must conform to the GRPC Health Checking Protocol.
timeoutMillis (integer) --
The amount of time to wait when receiving a response from the health check, in milliseconds.
unhealthyThreshold (integer) --
The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.
outlierDetection (dict) --
The outlier detection information for the listener.
baseEjectionDuration (dict) --
The base amount of time for which a host is ejected.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
interval (dict) --
The time interval between ejection sweep analysis.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
maxEjectionPercent (integer) --
Maximum percentage of hosts in load balancing pool for upstream service that can be ejected. Will eject at least one host regardless of the value.
maxServerErrors (integer) --
Number of consecutive 5xx errors required for ejection.
portMapping (dict) --
The port mapping information for the listener.
port (integer) --
The port used for the port mapping.
protocol (string) --
The protocol used for the port mapping. Specify one protocol.
timeout (dict) --
An object that represents timeouts for different protocols.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: grpc, http, http2, tcp. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
grpc (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
http (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
http2 (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
tcp (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
tls (dict) --
A reference to an object that represents the Transport Layer Security (TLS) properties for a listener.
certificate (dict) --
A reference to an object that represents a listener's Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: acm, file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
acm (dict) --
A reference to an object that represents an AWS Certicate Manager (ACM) certificate.
certificateArn (string) --
The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
file (dict) --
A reference to an object that represents a local file certificate.
certificateChain (string) --
The certificate chain for the certificate.
privateKey (string) --
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a listener's Secret Discovery Service certificate.
secretName (string) --
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.
mode (string) --
Specify one of the following modes.
STRICT – Listener only accepts connections with TLS enabled.
PERMISSIVE – Listener accepts connections with or without TLS enabled.
DISABLED – Listener only accepts connections without TLS.
validation (dict) --
A reference to an object that represents a listener's Transport Layer Security (TLS) validation context.
subjectAlternativeNames (dict) --
A reference to an object that represents the SANs for a listener's Transport Layer Security (TLS) validation context.
match (dict) --
An object that represents the criteria for determining a SANs match.
exact (list) --
The values sent must match the specified values exactly.
(string) --
trust (dict) --
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
file (dict) --
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
certificateChain (string) --
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a listener's Transport Layer Security (TLS) Secret Discovery Service validation context trust.
secretName (string) --
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
logging (dict) --
The inbound and outbound access logging information for the virtual node.
accessLog (dict) --
The access log configuration for a virtual node.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: file. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
file (dict) --
The file object to send virtual node access logs to.
path (string) --
The file path to write access logs to. You can use /dev/stdout to send access logs to standard out and configure your Envoy container to use a log driver, such as awslogs , to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk.
Note
The Envoy process must have write permissions to the path that you specify here. Otherwise, Envoy fails to bootstrap properly.
serviceDiscovery (dict) --
The service discovery information for the virtual node. If your virtual node does not expect ingress traffic, you can omit this parameter. If you specify a listener , then you must specify service discovery information.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: awsCloudMap, dns. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
awsCloudMap (dict) --
Specifies any Cloud Map information for the virtual node.
attributes (list) --
A string map that contains attributes with values that you can use to filter instances by any custom attribute that you specified when you registered the instance. Only instances that match all of the specified key/value pairs will be returned.
(dict) --
An object that represents the Cloud Map attribute information for your virtual node.
Note
AWS Cloud Map is not available in the eu-south-1 Region.
key (string) --
The name of an Cloud Map service instance attribute key. Any Cloud Map service instance that contains the specified key and value is returned.
value (string) --
The value of an Cloud Map service instance attribute key. Any Cloud Map service instance that contains the specified key and value is returned.
namespaceName (string) --
The name of the Cloud Map namespace to use.
serviceName (string) --
The name of the Cloud Map service to use.
dns (dict) --
Specifies the DNS information for the virtual node.
hostname (string) --
Specifies the DNS service discovery hostname for the virtual node.
responseType (string) --
Specifies the DNS response type for the virtual node.
status (dict) --
The current status for the virtual node.
status (string) --
The current status of the virtual node.
virtualNodeName (string) --
The name of the virtual node.
{'gatewayRoute': {'spec': {'grpcRoute': {'action': {'rewrite': {'hostname': {'defaultTargetHostname': 'ENABLED '
'| '
'DISABLED'}}},
'match': {'hostname': {'exact': 'string',
'suffix': 'string'},
'metadata': [{'invert': 'boolean',
'match': {'exact': 'string',
'prefix': 'string',
'range': {'end': 'long',
'start': 'long'},
'regex': 'string',
'suffix': 'string'},
'name': 'string'}]}},
'http2Route': {'action': {'rewrite': {'hostname': {'defaultTargetHostname': 'ENABLED '
'| '
'DISABLED'},
'path': {'exact': 'string'},
'prefix': {'defaultPrefix': 'ENABLED '
'| '
'DISABLED',
'value': 'string'}}},
'match': {'headers': [{'invert': 'boolean',
'match': {'exact': 'string',
'prefix': 'string',
'range': {'end': 'long',
'start': 'long'},
'regex': 'string',
'suffix': 'string'},
'name': 'string'}],
'hostname': {'exact': 'string',
'suffix': 'string'},
'method': 'GET | HEAD | '
'POST | PUT | '
'DELETE | '
'CONNECT | '
'OPTIONS | TRACE '
'| PATCH',
'path': {'exact': 'string',
'regex': 'string'},
'queryParameters': [{'match': {'exact': 'string'},
'name': 'string'}]}},
'httpRoute': {'action': {'rewrite': {'hostname': {'defaultTargetHostname': 'ENABLED '
'| '
'DISABLED'},
'path': {'exact': 'string'},
'prefix': {'defaultPrefix': 'ENABLED '
'| '
'DISABLED',
'value': 'string'}}},
'match': {'headers': [{'invert': 'boolean',
'match': {'exact': 'string',
'prefix': 'string',
'range': {'end': 'long',
'start': 'long'},
'regex': 'string',
'suffix': 'string'},
'name': 'string'}],
'hostname': {'exact': 'string',
'suffix': 'string'},
'method': 'GET | HEAD | '
'POST | PUT | '
'DELETE | CONNECT '
'| OPTIONS | '
'TRACE | PATCH',
'path': {'exact': 'string',
'regex': 'string'},
'queryParameters': [{'match': {'exact': 'string'},
'name': 'string'}]}},
'priority': 'integer'}}}
Describes an existing gateway route.
See also: AWS API Documentation
Request Syntax
client.describe_gateway_route(
gatewayRouteName='string',
meshName='string',
meshOwner='string',
virtualGatewayName='string'
)
string
[REQUIRED]
The name of the gateway route to describe.
string
[REQUIRED]
The name of the service mesh that the gateway route resides in.
string
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
string
[REQUIRED]
The name of the virtual gateway that the gateway route is associated with.
dict
Response Syntax
{
'gatewayRoute': {
'gatewayRouteName': 'string',
'meshName': 'string',
'metadata': {
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'meshOwner': 'string',
'resourceOwner': 'string',
'uid': 'string',
'version': 123
},
'spec': {
'grpcRoute': {
'action': {
'rewrite': {
'hostname': {
'defaultTargetHostname': 'ENABLED'|'DISABLED'
}
},
'target': {
'virtualService': {
'virtualServiceName': 'string'
}
}
},
'match': {
'hostname': {
'exact': 'string',
'suffix': 'string'
},
'metadata': [
{
'invert': True|False,
'match': {
'exact': 'string',
'prefix': 'string',
'range': {
'end': 123,
'start': 123
},
'regex': 'string',
'suffix': 'string'
},
'name': 'string'
},
],
'serviceName': 'string'
}
},
'http2Route': {
'action': {
'rewrite': {
'hostname': {
'defaultTargetHostname': 'ENABLED'|'DISABLED'
},
'path': {
'exact': 'string'
},
'prefix': {
'defaultPrefix': 'ENABLED'|'DISABLED',
'value': 'string'
}
},
'target': {
'virtualService': {
'virtualServiceName': 'string'
}
}
},
'match': {
'headers': [
{
'invert': True|False,
'match': {
'exact': 'string',
'prefix': 'string',
'range': {
'end': 123,
'start': 123
},
'regex': 'string',
'suffix': 'string'
},
'name': 'string'
},
],
'hostname': {
'exact': 'string',
'suffix': 'string'
},
'method': 'GET'|'HEAD'|'POST'|'PUT'|'DELETE'|'CONNECT'|'OPTIONS'|'TRACE'|'PATCH',
'path': {
'exact': 'string',
'regex': 'string'
},
'prefix': 'string',
'queryParameters': [
{
'match': {
'exact': 'string'
},
'name': 'string'
},
]
}
},
'httpRoute': {
'action': {
'rewrite': {
'hostname': {
'defaultTargetHostname': 'ENABLED'|'DISABLED'
},
'path': {
'exact': 'string'
},
'prefix': {
'defaultPrefix': 'ENABLED'|'DISABLED',
'value': 'string'
}
},
'target': {
'virtualService': {
'virtualServiceName': 'string'
}
}
},
'match': {
'headers': [
{
'invert': True|False,
'match': {
'exact': 'string',
'prefix': 'string',
'range': {
'end': 123,
'start': 123
},
'regex': 'string',
'suffix': 'string'
},
'name': 'string'
},
],
'hostname': {
'exact': 'string',
'suffix': 'string'
},
'method': 'GET'|'HEAD'|'POST'|'PUT'|'DELETE'|'CONNECT'|'OPTIONS'|'TRACE'|'PATCH',
'path': {
'exact': 'string',
'regex': 'string'
},
'prefix': 'string',
'queryParameters': [
{
'match': {
'exact': 'string'
},
'name': 'string'
},
]
}
},
'priority': 123
},
'status': {
'status': 'ACTIVE'|'INACTIVE'|'DELETED'
},
'virtualGatewayName': 'string'
}
}
Response Structure
(dict) --
gatewayRoute (dict) --
The full description of your gateway route.
gatewayRouteName (string) --
The name of the gateway route.
meshName (string) --
The name of the service mesh that the resource resides in.
metadata (dict) --
An object that represents metadata for a resource.
arn (string) --
The full Amazon Resource Name (ARN) for the resource.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was created.
lastUpdatedAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was last updated.
meshOwner (string) --
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
resourceOwner (string) --
The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
uid (string) --
The unique identifier for the resource.
version (integer) --
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
spec (dict) --
The specifications of the gateway route.
grpcRoute (dict) --
An object that represents the specification of a gRPC gateway route.
action (dict) --
An object that represents the action to take if a match is determined.
rewrite (dict) --
The gateway route action to rewrite.
hostname (dict) --
The host name of the gateway route to rewrite.
defaultTargetHostname (string) --
The default target host name to write to.
target (dict) --
An object that represents the target that traffic is routed to when a request matches the gateway route.
virtualService (dict) --
An object that represents a virtual service gateway route target.
virtualServiceName (string) --
The name of the virtual service that traffic is routed to.
match (dict) --
An object that represents the criteria for determining a request match.
hostname (dict) --
The gateway route host name to be matched on.
exact (string) --
The exact host name to match on.
suffix (string) --
The specified ending characters of the host name to match on.
metadata (list) --
The gateway route metadata to be matched on.
(dict) --
An object representing the metadata of the gateway route.
invert (boolean) --
Specify True to match anything except the match criteria. The default value is False .
match (dict) --
The criteria for determining a metadata match.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: exact, prefix, range, regex, suffix. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
exact (string) --
The exact method header to be matched on.
prefix (string) --
The specified beginning characters of the method header to be matched on.
range (dict) --
An object that represents the range of values to match on. The first character of the range is included in the range, though the last character is not. For example, if the range specified were 1-100, only values 1-99 would be matched.
end (integer) --
The end of the range.
start (integer) --
The start of the range.
regex (string) --
The regex used to match the method header.
suffix (string) --
The specified ending characters of the method header to match on.
name (string) --
A name for the gateway route metadata.
serviceName (string) --
The fully qualified domain name for the service to match from the request.
http2Route (dict) --
An object that represents the specification of an HTTP/2 gateway route.
action (dict) --
An object that represents the action to take if a match is determined.
rewrite (dict) --
The gateway route action to rewrite.
hostname (dict) --
The host name to rewrite.
defaultTargetHostname (string) --
The default target host name to write to.
path (dict) --
The path to rewrite.
exact (string) --
The exact path to rewrite.
prefix (dict) --
The specified beginning characters to rewrite.
defaultPrefix (string) --
The default prefix used to replace the incoming route prefix when rewritten.
value (string) --
The value used to replace the incoming route prefix when rewritten.
target (dict) --
An object that represents the target that traffic is routed to when a request matches the gateway route.
virtualService (dict) --
An object that represents a virtual service gateway route target.
virtualServiceName (string) --
The name of the virtual service that traffic is routed to.
match (dict) --
An object that represents the criteria for determining a request match.
headers (list) --
The client request headers to match on.
(dict) --
An object that represents the HTTP header in the gateway route.
invert (boolean) --
Specify True to match anything except the match criteria. The default value is False .
match (dict) --
An object that represents the method and value to match with the header value sent in a request. Specify one match method.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: exact, prefix, range, regex, suffix. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
exact (string) --
The value sent by the client must match the specified value exactly.
prefix (string) --
The value sent by the client must begin with the specified characters.
range (dict) --
An object that represents the range of values to match on.
end (integer) --
The end of the range.
start (integer) --
The start of the range.
regex (string) --
The value sent by the client must include the specified characters.
suffix (string) --
The value sent by the client must end with the specified characters.
name (string) --
A name for the HTTP header in the gateway route that will be matched on.
hostname (dict) --
The host name to match on.
exact (string) --
The exact host name to match on.
suffix (string) --
The specified ending characters of the host name to match on.
method (string) --
The method to match on.
path (dict) --
The path to match on.
exact (string) --
The exact path to match on.
regex (string) --
The regex used to match the path.
prefix (string) --
Specifies the path to match requests with. This parameter must always start with / , which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics , your prefix should be /metrics .
queryParameters (list) --
The query parameter to match on.
(dict) --
An object that represents the query parameter in the request.
match (dict) --
The query parameter to match on.
exact (string) --
The exact query parameter to match on.
name (string) --
A name for the query parameter that will be matched on.
httpRoute (dict) --
An object that represents the specification of an HTTP gateway route.
action (dict) --
An object that represents the action to take if a match is determined.
rewrite (dict) --
The gateway route action to rewrite.
hostname (dict) --
The host name to rewrite.
defaultTargetHostname (string) --
The default target host name to write to.
path (dict) --
The path to rewrite.
exact (string) --
The exact path to rewrite.
prefix (dict) --
The specified beginning characters to rewrite.
defaultPrefix (string) --
The default prefix used to replace the incoming route prefix when rewritten.
value (string) --
The value used to replace the incoming route prefix when rewritten.
target (dict) --
An object that represents the target that traffic is routed to when a request matches the gateway route.
virtualService (dict) --
An object that represents a virtual service gateway route target.
virtualServiceName (string) --
The name of the virtual service that traffic is routed to.
match (dict) --
An object that represents the criteria for determining a request match.
headers (list) --
The client request headers to match on.
(dict) --
An object that represents the HTTP header in the gateway route.
invert (boolean) --
Specify True to match anything except the match criteria. The default value is False .
match (dict) --
An object that represents the method and value to match with the header value sent in a request. Specify one match method.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: exact, prefix, range, regex, suffix. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
exact (string) --
The value sent by the client must match the specified value exactly.
prefix (string) --
The value sent by the client must begin with the specified characters.
range (dict) --
An object that represents the range of values to match on.
end (integer) --
The end of the range.
start (integer) --
The start of the range.
regex (string) --
The value sent by the client must include the specified characters.
suffix (string) --
The value sent by the client must end with the specified characters.
name (string) --
A name for the HTTP header in the gateway route that will be matched on.
hostname (dict) --
The host name to match on.
exact (string) --
The exact host name to match on.
suffix (string) --
The specified ending characters of the host name to match on.
method (string) --
The method to match on.
path (dict) --
The path to match on.
exact (string) --
The exact path to match on.
regex (string) --
The regex used to match the path.
prefix (string) --
Specifies the path to match requests with. This parameter must always start with / , which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics , your prefix should be /metrics .
queryParameters (list) --
The query parameter to match on.
(dict) --
An object that represents the query parameter in the request.
match (dict) --
The query parameter to match on.
exact (string) --
The exact query parameter to match on.
name (string) --
A name for the query parameter that will be matched on.
priority (integer) --
The ordering of the gateway routes spec.
status (dict) --
The status of the gateway route.
status (string) --
The current status for the gateway route.
virtualGatewayName (string) --
The virtual gateway that the gateway route is associated with.
{'route': {'spec': {'http2Route': {'match': {'path': {'exact': 'string',
'regex': 'string'},
'queryParameters': [{'match': {'exact': 'string'},
'name': 'string'}]}},
'httpRoute': {'match': {'path': {'exact': 'string',
'regex': 'string'},
'queryParameters': [{'match': {'exact': 'string'},
'name': 'string'}]}}}}}
Describes an existing route.
See also: AWS API Documentation
Request Syntax
client.describe_route(
meshName='string',
meshOwner='string',
routeName='string',
virtualRouterName='string'
)
string
[REQUIRED]
The name of the service mesh that the route resides in.
string
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
string
[REQUIRED]
The name of the route to describe.
string
[REQUIRED]
The name of the virtual router that the route is associated with.
dict
Response Syntax
{
'route': {
'meshName': 'string',
'metadata': {
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'meshOwner': 'string',
'resourceOwner': 'string',
'uid': 'string',
'version': 123
},
'routeName': 'string',
'spec': {
'grpcRoute': {
'action': {
'weightedTargets': [
{
'virtualNode': 'string',
'weight': 123
},
]
},
'match': {
'metadata': [
{
'invert': True|False,
'match': {
'exact': 'string',
'prefix': 'string',
'range': {
'end': 123,
'start': 123
},
'regex': 'string',
'suffix': 'string'
},
'name': 'string'
},
],
'methodName': 'string',
'serviceName': 'string'
},
'retryPolicy': {
'grpcRetryEvents': [
'cancelled'|'deadline-exceeded'|'internal'|'resource-exhausted'|'unavailable',
],
'httpRetryEvents': [
'string',
],
'maxRetries': 123,
'perRetryTimeout': {
'unit': 's'|'ms',
'value': 123
},
'tcpRetryEvents': [
'connection-error',
]
},
'timeout': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
}
},
'http2Route': {
'action': {
'weightedTargets': [
{
'virtualNode': 'string',
'weight': 123
},
]
},
'match': {
'headers': [
{
'invert': True|False,
'match': {
'exact': 'string',
'prefix': 'string',
'range': {
'end': 123,
'start': 123
},
'regex': 'string',
'suffix': 'string'
},
'name': 'string'
},
],
'method': 'GET'|'HEAD'|'POST'|'PUT'|'DELETE'|'CONNECT'|'OPTIONS'|'TRACE'|'PATCH',
'path': {
'exact': 'string',
'regex': 'string'
},
'prefix': 'string',
'queryParameters': [
{
'match': {
'exact': 'string'
},
'name': 'string'
},
],
'scheme': 'http'|'https'
},
'retryPolicy': {
'httpRetryEvents': [
'string',
],
'maxRetries': 123,
'perRetryTimeout': {
'unit': 's'|'ms',
'value': 123
},
'tcpRetryEvents': [
'connection-error',
]
},
'timeout': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
}
},
'httpRoute': {
'action': {
'weightedTargets': [
{
'virtualNode': 'string',
'weight': 123
},
]
},
'match': {
'headers': [
{
'invert': True|False,
'match': {
'exact': 'string',
'prefix': 'string',
'range': {
'end': 123,
'start': 123
},
'regex': 'string',
'suffix': 'string'
},
'name': 'string'
},
],
'method': 'GET'|'HEAD'|'POST'|'PUT'|'DELETE'|'CONNECT'|'OPTIONS'|'TRACE'|'PATCH',
'path': {
'exact': 'string',
'regex': 'string'
},
'prefix': 'string',
'queryParameters': [
{
'match': {
'exact': 'string'
},
'name': 'string'
},
],
'scheme': 'http'|'https'
},
'retryPolicy': {
'httpRetryEvents': [
'string',
],
'maxRetries': 123,
'perRetryTimeout': {
'unit': 's'|'ms',
'value': 123
},
'tcpRetryEvents': [
'connection-error',
]
},
'timeout': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
}
},
'priority': 123,
'tcpRoute': {
'action': {
'weightedTargets': [
{
'virtualNode': 'string',
'weight': 123
},
]
},
'timeout': {
'idle': {
'unit': 's'|'ms',
'value': 123
}
}
}
},
'status': {
'status': 'ACTIVE'|'INACTIVE'|'DELETED'
},
'virtualRouterName': 'string'
}
}
Response Structure
(dict) --
route (dict) --
The full description of your route.
meshName (string) --
The name of the service mesh that the route resides in.
metadata (dict) --
The associated metadata for the route.
arn (string) --
The full Amazon Resource Name (ARN) for the resource.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was created.
lastUpdatedAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was last updated.
meshOwner (string) --
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
resourceOwner (string) --
The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
uid (string) --
The unique identifier for the resource.
version (integer) --
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
routeName (string) --
The name of the route.
spec (dict) --
The specifications of the route.
grpcRoute (dict) --
An object that represents the specification of a gRPC route.
action (dict) --
An object that represents the action to take if a match is determined.
weightedTargets (list) --
An object that represents the targets that traffic is routed to when a request matches the route.
(dict) --
An object that represents a target and its relative weight. Traffic is distributed across targets according to their relative weight. For example, a weighted target with a relative weight of 50 receives five times as much traffic as one with a relative weight of 10. The total weight for all targets combined must be less than or equal to 100.
virtualNode (string) --
The virtual node to associate with the weighted target.
weight (integer) --
The relative weight of the weighted target.
match (dict) --
An object that represents the criteria for determining a request match.
metadata (list) --
An object that represents the data to match from the request.
(dict) --
An object that represents the match metadata for the route.
invert (boolean) --
Specify True to match anything except the match criteria. The default value is False .
match (dict) --
An object that represents the data to match from the request.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: exact, prefix, range, regex, suffix. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
exact (string) --
The value sent by the client must match the specified value exactly.
prefix (string) --
The value sent by the client must begin with the specified characters.
range (dict) --
An object that represents the range of values to match on.
end (integer) --
The end of the range.
start (integer) --
The start of the range.
regex (string) --
The value sent by the client must include the specified characters.
suffix (string) --
The value sent by the client must end with the specified characters.
name (string) --
The name of the route.
methodName (string) --
The method name to match from the request. If you specify a name, you must also specify a serviceName .
serviceName (string) --
The fully qualified domain name for the service to match from the request.
retryPolicy (dict) --
An object that represents a retry policy.
grpcRetryEvents (list) --
Specify at least one of the valid values.
(string) --
httpRetryEvents (list) --
Specify at least one of the following values.
server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511
gateway-error – HTTP status codes 502, 503, and 504
client-error – HTTP status code 409
stream-error – Retry on refused stream
(string) --
maxRetries (integer) --
The maximum number of retry attempts.
perRetryTimeout (dict) --
The timeout for each retry attempt.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
tcpRetryEvents (list) --
Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.
(string) --
timeout (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
http2Route (dict) --
An object that represents the specification of an HTTP/2 route.
action (dict) --
An object that represents the action to take if a match is determined.
weightedTargets (list) --
An object that represents the targets that traffic is routed to when a request matches the route.
(dict) --
An object that represents a target and its relative weight. Traffic is distributed across targets according to their relative weight. For example, a weighted target with a relative weight of 50 receives five times as much traffic as one with a relative weight of 10. The total weight for all targets combined must be less than or equal to 100.
virtualNode (string) --
The virtual node to associate with the weighted target.
weight (integer) --
The relative weight of the weighted target.
match (dict) --
An object that represents the criteria for determining a request match.
headers (list) --
The client request headers to match on.
(dict) --
An object that represents the HTTP header in the request.
invert (boolean) --
Specify True to match anything except the match criteria. The default value is False .
match (dict) --
The HeaderMatchMethod object.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: exact, prefix, range, regex, suffix. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
exact (string) --
The value sent by the client must match the specified value exactly.
prefix (string) --
The value sent by the client must begin with the specified characters.
range (dict) --
An object that represents the range of values to match on.
end (integer) --
The end of the range.
start (integer) --
The start of the range.
regex (string) --
The value sent by the client must include the specified characters.
suffix (string) --
The value sent by the client must end with the specified characters.
name (string) --
A name for the HTTP header in the client request that will be matched on.
method (string) --
The client request method to match on. Specify only one.
path (dict) --
The client request path to match on.
exact (string) --
The exact path to match on.
regex (string) --
The regex used to match the path.
prefix (string) --
Specifies the path to match requests with. This parameter must always start with / , which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics , your prefix should be /metrics .
queryParameters (list) --
The client request query parameters to match on.
(dict) --
An object that represents the query parameter in the request.
match (dict) --
The query parameter to match on.
exact (string) --
The exact query parameter to match on.
name (string) --
A name for the query parameter that will be matched on.
scheme (string) --
The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.
retryPolicy (dict) --
An object that represents a retry policy.
httpRetryEvents (list) --
Specify at least one of the following values.
server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511
gateway-error – HTTP status codes 502, 503, and 504
client-error – HTTP status code 409
stream-error – Retry on refused stream
(string) --
maxRetries (integer) --
The maximum number of retry attempts.
perRetryTimeout (dict) --
The timeout for each retry attempt.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
tcpRetryEvents (list) --
Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.
(string) --
timeout (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
httpRoute (dict) --
An object that represents the specification of an HTTP route.
action (dict) --
An object that represents the action to take if a match is determined.
weightedTargets (list) --
An object that represents the targets that traffic is routed to when a request matches the route.
(dict) --
An object that represents a target and its relative weight. Traffic is distributed across targets according to their relative weight. For example, a weighted target with a relative weight of 50 receives five times as much traffic as one with a relative weight of 10. The total weight for all targets combined must be less than or equal to 100.
virtualNode (string) --
The virtual node to associate with the weighted target.
weight (integer) --
The relative weight of the weighted target.
match (dict) --
An object that represents the criteria for determining a request match.
headers (list) --
The client request headers to match on.
(dict) --
An object that represents the HTTP header in the request.
invert (boolean) --
Specify True to match anything except the match criteria. The default value is False .
match (dict) --
The HeaderMatchMethod object.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: exact, prefix, range, regex, suffix. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
exact (string) --
The value sent by the client must match the specified value exactly.
prefix (string) --
The value sent by the client must begin with the specified characters.
range (dict) --
An object that represents the range of values to match on.
end (integer) --
The end of the range.
start (integer) --
The start of the range.
regex (string) --
The value sent by the client must include the specified characters.
suffix (string) --
The value sent by the client must end with the specified characters.
name (string) --
A name for the HTTP header in the client request that will be matched on.
method (string) --
The client request method to match on. Specify only one.
path (dict) --
The client request path to match on.
exact (string) --
The exact path to match on.
regex (string) --
The regex used to match the path.
prefix (string) --
Specifies the path to match requests with. This parameter must always start with / , which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics , your prefix should be /metrics .
queryParameters (list) --
The client request query parameters to match on.
(dict) --
An object that represents the query parameter in the request.
match (dict) --
The query parameter to match on.
exact (string) --
The exact query parameter to match on.
name (string) --
A name for the query parameter that will be matched on.
scheme (string) --
The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.
retryPolicy (dict) --
An object that represents a retry policy.
httpRetryEvents (list) --
Specify at least one of the following values.
server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511
gateway-error – HTTP status codes 502, 503, and 504
client-error – HTTP status code 409
stream-error – Retry on refused stream
(string) --
maxRetries (integer) --
The maximum number of retry attempts.
perRetryTimeout (dict) --
The timeout for each retry attempt.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
tcpRetryEvents (list) --
Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.
(string) --
timeout (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
priority (integer) --
The priority for the route. Routes are matched based on the specified value, where 0 is the highest priority.
tcpRoute (dict) --
An object that represents the specification of a TCP route.
action (dict) --
The action to take if a match is determined.
weightedTargets (list) --
An object that represents the targets that traffic is routed to when a request matches the route.
(dict) --
An object that represents a target and its relative weight. Traffic is distributed across targets according to their relative weight. For example, a weighted target with a relative weight of 50 receives five times as much traffic as one with a relative weight of 10. The total weight for all targets combined must be less than or equal to 100.
virtualNode (string) --
The virtual node to associate with the weighted target.
weight (integer) --
The relative weight of the weighted target.
timeout (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
status (dict) --
The status of the route.
status (string) --
The current status for the route.
virtualRouterName (string) --
The virtual router that the route is associated with.
{'virtualNode': {'spec': {'serviceDiscovery': {'dns': {'responseType': 'LOADBALANCER '
'| '
'ENDPOINTS'}}}}}
Describes an existing virtual node.
See also: AWS API Documentation
Request Syntax
client.describe_virtual_node(
meshName='string',
meshOwner='string',
virtualNodeName='string'
)
string
[REQUIRED]
The name of the service mesh that the virtual node resides in.
string
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
string
[REQUIRED]
The name of the virtual node to describe.
dict
Response Syntax
{
'virtualNode': {
'meshName': 'string',
'metadata': {
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'meshOwner': 'string',
'resourceOwner': 'string',
'uid': 'string',
'version': 123
},
'spec': {
'backendDefaults': {
'clientPolicy': {
'tls': {
'certificate': {
'file': {
'certificateChain': 'string',
'privateKey': 'string'
},
'sds': {
'secretName': 'string'
}
},
'enforce': True|False,
'ports': [
123,
],
'validation': {
'subjectAlternativeNames': {
'match': {
'exact': [
'string',
]
}
},
'trust': {
'acm': {
'certificateAuthorityArns': [
'string',
]
},
'file': {
'certificateChain': 'string'
},
'sds': {
'secretName': 'string'
}
}
}
}
}
},
'backends': [
{
'virtualService': {
'clientPolicy': {
'tls': {
'certificate': {
'file': {
'certificateChain': 'string',
'privateKey': 'string'
},
'sds': {
'secretName': 'string'
}
},
'enforce': True|False,
'ports': [
123,
],
'validation': {
'subjectAlternativeNames': {
'match': {
'exact': [
'string',
]
}
},
'trust': {
'acm': {
'certificateAuthorityArns': [
'string',
]
},
'file': {
'certificateChain': 'string'
},
'sds': {
'secretName': 'string'
}
}
}
}
},
'virtualServiceName': 'string'
}
},
],
'listeners': [
{
'connectionPool': {
'grpc': {
'maxRequests': 123
},
'http': {
'maxConnections': 123,
'maxPendingRequests': 123
},
'http2': {
'maxRequests': 123
},
'tcp': {
'maxConnections': 123
}
},
'healthCheck': {
'healthyThreshold': 123,
'intervalMillis': 123,
'path': 'string',
'port': 123,
'protocol': 'http'|'tcp'|'http2'|'grpc',
'timeoutMillis': 123,
'unhealthyThreshold': 123
},
'outlierDetection': {
'baseEjectionDuration': {
'unit': 's'|'ms',
'value': 123
},
'interval': {
'unit': 's'|'ms',
'value': 123
},
'maxEjectionPercent': 123,
'maxServerErrors': 123
},
'portMapping': {
'port': 123,
'protocol': 'http'|'tcp'|'http2'|'grpc'
},
'timeout': {
'grpc': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
},
'http': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
},
'http2': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
},
'tcp': {
'idle': {
'unit': 's'|'ms',
'value': 123
}
}
},
'tls': {
'certificate': {
'acm': {
'certificateArn': 'string'
},
'file': {
'certificateChain': 'string',
'privateKey': 'string'
},
'sds': {
'secretName': 'string'
}
},
'mode': 'STRICT'|'PERMISSIVE'|'DISABLED',
'validation': {
'subjectAlternativeNames': {
'match': {
'exact': [
'string',
]
}
},
'trust': {
'file': {
'certificateChain': 'string'
},
'sds': {
'secretName': 'string'
}
}
}
}
},
],
'logging': {
'accessLog': {
'file': {
'path': 'string'
}
}
},
'serviceDiscovery': {
'awsCloudMap': {
'attributes': [
{
'key': 'string',
'value': 'string'
},
],
'namespaceName': 'string',
'serviceName': 'string'
},
'dns': {
'hostname': 'string',
'responseType': 'LOADBALANCER'|'ENDPOINTS'
}
}
},
'status': {
'status': 'ACTIVE'|'INACTIVE'|'DELETED'
},
'virtualNodeName': 'string'
}
}
Response Structure
(dict) --
virtualNode (dict) --
The full description of your virtual node.
meshName (string) --
The name of the service mesh that the virtual node resides in.
metadata (dict) --
The associated metadata for the virtual node.
arn (string) --
The full Amazon Resource Name (ARN) for the resource.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was created.
lastUpdatedAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was last updated.
meshOwner (string) --
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
resourceOwner (string) --
The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
uid (string) --
The unique identifier for the resource.
version (integer) --
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
spec (dict) --
The specifications of the virtual node.
backendDefaults (dict) --
A reference to an object that represents the defaults for backends.
clientPolicy (dict) --
A reference to an object that represents a client policy.
tls (dict) --
A reference to an object that represents a Transport Layer Security (TLS) client policy.
certificate (dict) --
A reference to an object that represents a client's TLS certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
file (dict) --
An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
certificateChain (string) --
The certificate chain for the certificate.
privateKey (string) --
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a client's TLS Secret Discovery Service certificate.
secretName (string) --
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.
enforce (boolean) --
Whether the policy is enforced. The default is True , if a value isn't specified.
ports (list) --
One or more ports that the policy is enforced for.
(integer) --
validation (dict) --
A reference to an object that represents a TLS validation context.
subjectAlternativeNames (dict) --
A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context.
match (dict) --
An object that represents the criteria for determining a SANs match.
exact (list) --
The values sent must match the specified values exactly.
(string) --
trust (dict) --
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: acm, file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
acm (dict) --
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.
certificateAuthorityArns (list) --
One or more ACM Amazon Resource Name (ARN)s.
(string) --
file (dict) --
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
certificateChain (string) --
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
secretName (string) --
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
backends (list) --
The backends that the virtual node is expected to send outbound traffic to.
(dict) --
An object that represents the backends that a virtual node is expected to send outbound traffic to.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: virtualService. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
virtualService (dict) --
Specifies a virtual service to use as a backend.
clientPolicy (dict) --
A reference to an object that represents the client policy for a backend.
tls (dict) --
A reference to an object that represents a Transport Layer Security (TLS) client policy.
certificate (dict) --
A reference to an object that represents a client's TLS certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
file (dict) --
An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
certificateChain (string) --
The certificate chain for the certificate.
privateKey (string) --
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a client's TLS Secret Discovery Service certificate.
secretName (string) --
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.
enforce (boolean) --
Whether the policy is enforced. The default is True , if a value isn't specified.
ports (list) --
One or more ports that the policy is enforced for.
(integer) --
validation (dict) --
A reference to an object that represents a TLS validation context.
subjectAlternativeNames (dict) --
A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context.
match (dict) --
An object that represents the criteria for determining a SANs match.
exact (list) --
The values sent must match the specified values exactly.
(string) --
trust (dict) --
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: acm, file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
acm (dict) --
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.
certificateAuthorityArns (list) --
One or more ACM Amazon Resource Name (ARN)s.
(string) --
file (dict) --
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
certificateChain (string) --
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
secretName (string) --
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
virtualServiceName (string) --
The name of the virtual service that is acting as a virtual node backend.
listeners (list) --
The listener that the virtual node is expected to receive inbound traffic from. You can specify one listener.
(dict) --
An object that represents a listener for a virtual node.
connectionPool (dict) --
The connection pool information for the listener.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: grpc, http, http2, tcp. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
grpc (dict) --
An object that represents a type of connection pool.
maxRequests (integer) --
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.
http (dict) --
An object that represents a type of connection pool.
maxConnections (integer) --
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.
maxPendingRequests (integer) --
Number of overflowing requests after max_connections Envoy will queue to upstream cluster.
http2 (dict) --
An object that represents a type of connection pool.
maxRequests (integer) --
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.
tcp (dict) --
An object that represents a type of connection pool.
maxConnections (integer) --
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.
healthCheck (dict) --
The health check information for the listener.
healthyThreshold (integer) --
The number of consecutive successful health checks that must occur before declaring listener healthy.
intervalMillis (integer) --
The time period in milliseconds between each health check execution.
path (string) --
The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.
port (integer) --
The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.
protocol (string) --
The protocol for the health check request. If you specify grpc , then your service must conform to the GRPC Health Checking Protocol.
timeoutMillis (integer) --
The amount of time to wait when receiving a response from the health check, in milliseconds.
unhealthyThreshold (integer) --
The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.
outlierDetection (dict) --
The outlier detection information for the listener.
baseEjectionDuration (dict) --
The base amount of time for which a host is ejected.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
interval (dict) --
The time interval between ejection sweep analysis.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
maxEjectionPercent (integer) --
Maximum percentage of hosts in load balancing pool for upstream service that can be ejected. Will eject at least one host regardless of the value.
maxServerErrors (integer) --
Number of consecutive 5xx errors required for ejection.
portMapping (dict) --
The port mapping information for the listener.
port (integer) --
The port used for the port mapping.
protocol (string) --
The protocol used for the port mapping. Specify one protocol.
timeout (dict) --
An object that represents timeouts for different protocols.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: grpc, http, http2, tcp. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
grpc (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
http (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
http2 (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
tcp (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
tls (dict) --
A reference to an object that represents the Transport Layer Security (TLS) properties for a listener.
certificate (dict) --
A reference to an object that represents a listener's Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: acm, file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
acm (dict) --
A reference to an object that represents an AWS Certicate Manager (ACM) certificate.
certificateArn (string) --
The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
file (dict) --
A reference to an object that represents a local file certificate.
certificateChain (string) --
The certificate chain for the certificate.
privateKey (string) --
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a listener's Secret Discovery Service certificate.
secretName (string) --
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.
mode (string) --
Specify one of the following modes.
STRICT – Listener only accepts connections with TLS enabled.
PERMISSIVE – Listener accepts connections with or without TLS enabled.
DISABLED – Listener only accepts connections without TLS.
validation (dict) --
A reference to an object that represents a listener's Transport Layer Security (TLS) validation context.
subjectAlternativeNames (dict) --
A reference to an object that represents the SANs for a listener's Transport Layer Security (TLS) validation context.
match (dict) --
An object that represents the criteria for determining a SANs match.
exact (list) --
The values sent must match the specified values exactly.
(string) --
trust (dict) --
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
file (dict) --
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
certificateChain (string) --
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a listener's Transport Layer Security (TLS) Secret Discovery Service validation context trust.
secretName (string) --
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
logging (dict) --
The inbound and outbound access logging information for the virtual node.
accessLog (dict) --
The access log configuration for a virtual node.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: file. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
file (dict) --
The file object to send virtual node access logs to.
path (string) --
The file path to write access logs to. You can use /dev/stdout to send access logs to standard out and configure your Envoy container to use a log driver, such as awslogs , to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk.
Note
The Envoy process must have write permissions to the path that you specify here. Otherwise, Envoy fails to bootstrap properly.
serviceDiscovery (dict) --
The service discovery information for the virtual node. If your virtual node does not expect ingress traffic, you can omit this parameter. If you specify a listener , then you must specify service discovery information.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: awsCloudMap, dns. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
awsCloudMap (dict) --
Specifies any Cloud Map information for the virtual node.
attributes (list) --
A string map that contains attributes with values that you can use to filter instances by any custom attribute that you specified when you registered the instance. Only instances that match all of the specified key/value pairs will be returned.
(dict) --
An object that represents the Cloud Map attribute information for your virtual node.
Note
AWS Cloud Map is not available in the eu-south-1 Region.
key (string) --
The name of an Cloud Map service instance attribute key. Any Cloud Map service instance that contains the specified key and value is returned.
value (string) --
The value of an Cloud Map service instance attribute key. Any Cloud Map service instance that contains the specified key and value is returned.
namespaceName (string) --
The name of the Cloud Map namespace to use.
serviceName (string) --
The name of the Cloud Map service to use.
dns (dict) --
Specifies the DNS information for the virtual node.
hostname (string) --
Specifies the DNS service discovery hostname for the virtual node.
responseType (string) --
Specifies the DNS response type for the virtual node.
status (dict) --
The current status for the virtual node.
status (string) --
The current status of the virtual node.
virtualNodeName (string) --
The name of the virtual node.
{'spec': {'grpcRoute': {'action': {'rewrite': {'hostname': {'defaultTargetHostname': 'ENABLED '
'| '
'DISABLED'}}},
'match': {'hostname': {'exact': 'string',
'suffix': 'string'},
'metadata': [{'invert': 'boolean',
'match': {'exact': 'string',
'prefix': 'string',
'range': {'end': 'long',
'start': 'long'},
'regex': 'string',
'suffix': 'string'},
'name': 'string'}]}},
'http2Route': {'action': {'rewrite': {'hostname': {'defaultTargetHostname': 'ENABLED '
'| '
'DISABLED'},
'path': {'exact': 'string'},
'prefix': {'defaultPrefix': 'ENABLED '
'| '
'DISABLED',
'value': 'string'}}},
'match': {'headers': [{'invert': 'boolean',
'match': {'exact': 'string',
'prefix': 'string',
'range': {'end': 'long',
'start': 'long'},
'regex': 'string',
'suffix': 'string'},
'name': 'string'}],
'hostname': {'exact': 'string',
'suffix': 'string'},
'method': 'GET | HEAD | POST | PUT | DELETE '
'| CONNECT | OPTIONS | TRACE | '
'PATCH',
'path': {'exact': 'string',
'regex': 'string'},
'queryParameters': [{'match': {'exact': 'string'},
'name': 'string'}]}},
'httpRoute': {'action': {'rewrite': {'hostname': {'defaultTargetHostname': 'ENABLED '
'| '
'DISABLED'},
'path': {'exact': 'string'},
'prefix': {'defaultPrefix': 'ENABLED '
'| '
'DISABLED',
'value': 'string'}}},
'match': {'headers': [{'invert': 'boolean',
'match': {'exact': 'string',
'prefix': 'string',
'range': {'end': 'long',
'start': 'long'},
'regex': 'string',
'suffix': 'string'},
'name': 'string'}],
'hostname': {'exact': 'string',
'suffix': 'string'},
'method': 'GET | HEAD | POST | PUT | DELETE '
'| CONNECT | OPTIONS | TRACE | '
'PATCH',
'path': {'exact': 'string',
'regex': 'string'},
'queryParameters': [{'match': {'exact': 'string'},
'name': 'string'}]}},
'priority': 'integer'}}
Response {'gatewayRoute': {'spec': {'grpcRoute': {'action': {'rewrite': {'hostname': {'defaultTargetHostname': 'ENABLED '
'| '
'DISABLED'}}},
'match': {'hostname': {'exact': 'string',
'suffix': 'string'},
'metadata': [{'invert': 'boolean',
'match': {'exact': 'string',
'prefix': 'string',
'range': {'end': 'long',
'start': 'long'},
'regex': 'string',
'suffix': 'string'},
'name': 'string'}]}},
'http2Route': {'action': {'rewrite': {'hostname': {'defaultTargetHostname': 'ENABLED '
'| '
'DISABLED'},
'path': {'exact': 'string'},
'prefix': {'defaultPrefix': 'ENABLED '
'| '
'DISABLED',
'value': 'string'}}},
'match': {'headers': [{'invert': 'boolean',
'match': {'exact': 'string',
'prefix': 'string',
'range': {'end': 'long',
'start': 'long'},
'regex': 'string',
'suffix': 'string'},
'name': 'string'}],
'hostname': {'exact': 'string',
'suffix': 'string'},
'method': 'GET | HEAD | '
'POST | PUT | '
'DELETE | '
'CONNECT | '
'OPTIONS | TRACE '
'| PATCH',
'path': {'exact': 'string',
'regex': 'string'},
'queryParameters': [{'match': {'exact': 'string'},
'name': 'string'}]}},
'httpRoute': {'action': {'rewrite': {'hostname': {'defaultTargetHostname': 'ENABLED '
'| '
'DISABLED'},
'path': {'exact': 'string'},
'prefix': {'defaultPrefix': 'ENABLED '
'| '
'DISABLED',
'value': 'string'}}},
'match': {'headers': [{'invert': 'boolean',
'match': {'exact': 'string',
'prefix': 'string',
'range': {'end': 'long',
'start': 'long'},
'regex': 'string',
'suffix': 'string'},
'name': 'string'}],
'hostname': {'exact': 'string',
'suffix': 'string'},
'method': 'GET | HEAD | '
'POST | PUT | '
'DELETE | CONNECT '
'| OPTIONS | '
'TRACE | PATCH',
'path': {'exact': 'string',
'regex': 'string'},
'queryParameters': [{'match': {'exact': 'string'},
'name': 'string'}]}},
'priority': 'integer'}}}
Updates an existing gateway route that is associated to a specified virtual gateway in a service mesh.
See also: AWS API Documentation
Request Syntax
client.update_gateway_route(
clientToken='string',
gatewayRouteName='string',
meshName='string',
meshOwner='string',
spec={
'grpcRoute': {
'action': {
'rewrite': {
'hostname': {
'defaultTargetHostname': 'ENABLED'|'DISABLED'
}
},
'target': {
'virtualService': {
'virtualServiceName': 'string'
}
}
},
'match': {
'hostname': {
'exact': 'string',
'suffix': 'string'
},
'metadata': [
{
'invert': True|False,
'match': {
'exact': 'string',
'prefix': 'string',
'range': {
'end': 123,
'start': 123
},
'regex': 'string',
'suffix': 'string'
},
'name': 'string'
},
],
'serviceName': 'string'
}
},
'http2Route': {
'action': {
'rewrite': {
'hostname': {
'defaultTargetHostname': 'ENABLED'|'DISABLED'
},
'path': {
'exact': 'string'
},
'prefix': {
'defaultPrefix': 'ENABLED'|'DISABLED',
'value': 'string'
}
},
'target': {
'virtualService': {
'virtualServiceName': 'string'
}
}
},
'match': {
'headers': [
{
'invert': True|False,
'match': {
'exact': 'string',
'prefix': 'string',
'range': {
'end': 123,
'start': 123
},
'regex': 'string',
'suffix': 'string'
},
'name': 'string'
},
],
'hostname': {
'exact': 'string',
'suffix': 'string'
},
'method': 'GET'|'HEAD'|'POST'|'PUT'|'DELETE'|'CONNECT'|'OPTIONS'|'TRACE'|'PATCH',
'path': {
'exact': 'string',
'regex': 'string'
},
'prefix': 'string',
'queryParameters': [
{
'match': {
'exact': 'string'
},
'name': 'string'
},
]
}
},
'httpRoute': {
'action': {
'rewrite': {
'hostname': {
'defaultTargetHostname': 'ENABLED'|'DISABLED'
},
'path': {
'exact': 'string'
},
'prefix': {
'defaultPrefix': 'ENABLED'|'DISABLED',
'value': 'string'
}
},
'target': {
'virtualService': {
'virtualServiceName': 'string'
}
}
},
'match': {
'headers': [
{
'invert': True|False,
'match': {
'exact': 'string',
'prefix': 'string',
'range': {
'end': 123,
'start': 123
},
'regex': 'string',
'suffix': 'string'
},
'name': 'string'
},
],
'hostname': {
'exact': 'string',
'suffix': 'string'
},
'method': 'GET'|'HEAD'|'POST'|'PUT'|'DELETE'|'CONNECT'|'OPTIONS'|'TRACE'|'PATCH',
'path': {
'exact': 'string',
'regex': 'string'
},
'prefix': 'string',
'queryParameters': [
{
'match': {
'exact': 'string'
},
'name': 'string'
},
]
}
},
'priority': 123
},
virtualGatewayName='string'
)
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.
This field is autopopulated if not provided.
string
[REQUIRED]
The name of the gateway route to update.
string
[REQUIRED]
The name of the service mesh that the gateway route resides in.
string
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
dict
[REQUIRED]
The new gateway route specification to apply. This overwrites the existing data.
grpcRoute (dict) --
An object that represents the specification of a gRPC gateway route.
action (dict) -- [REQUIRED]
An object that represents the action to take if a match is determined.
rewrite (dict) --
The gateway route action to rewrite.
hostname (dict) --
The host name of the gateway route to rewrite.
defaultTargetHostname (string) --
The default target host name to write to.
target (dict) -- [REQUIRED]
An object that represents the target that traffic is routed to when a request matches the gateway route.
virtualService (dict) -- [REQUIRED]
An object that represents a virtual service gateway route target.
virtualServiceName (string) -- [REQUIRED]
The name of the virtual service that traffic is routed to.
match (dict) -- [REQUIRED]
An object that represents the criteria for determining a request match.
hostname (dict) --
The gateway route host name to be matched on.
exact (string) --
The exact host name to match on.
suffix (string) --
The specified ending characters of the host name to match on.
metadata (list) --
The gateway route metadata to be matched on.
(dict) --
An object representing the metadata of the gateway route.
invert (boolean) --
Specify True to match anything except the match criteria. The default value is False .
match (dict) --
The criteria for determining a metadata match.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: exact, prefix, range, regex, suffix.
exact (string) --
The exact method header to be matched on.
prefix (string) --
The specified beginning characters of the method header to be matched on.
range (dict) --
An object that represents the range of values to match on. The first character of the range is included in the range, though the last character is not. For example, if the range specified were 1-100, only values 1-99 would be matched.
end (integer) -- [REQUIRED]
The end of the range.
start (integer) -- [REQUIRED]
The start of the range.
regex (string) --
The regex used to match the method header.
suffix (string) --
The specified ending characters of the method header to match on.
name (string) -- [REQUIRED]
A name for the gateway route metadata.
serviceName (string) --
The fully qualified domain name for the service to match from the request.
http2Route (dict) --
An object that represents the specification of an HTTP/2 gateway route.
action (dict) -- [REQUIRED]
An object that represents the action to take if a match is determined.
rewrite (dict) --
The gateway route action to rewrite.
hostname (dict) --
The host name to rewrite.
defaultTargetHostname (string) --
The default target host name to write to.
path (dict) --
The path to rewrite.
exact (string) --
The exact path to rewrite.
prefix (dict) --
The specified beginning characters to rewrite.
defaultPrefix (string) --
The default prefix used to replace the incoming route prefix when rewritten.
value (string) --
The value used to replace the incoming route prefix when rewritten.
target (dict) -- [REQUIRED]
An object that represents the target that traffic is routed to when a request matches the gateway route.
virtualService (dict) -- [REQUIRED]
An object that represents a virtual service gateway route target.
virtualServiceName (string) -- [REQUIRED]
The name of the virtual service that traffic is routed to.
match (dict) -- [REQUIRED]
An object that represents the criteria for determining a request match.
headers (list) --
The client request headers to match on.
(dict) --
An object that represents the HTTP header in the gateway route.
invert (boolean) --
Specify True to match anything except the match criteria. The default value is False .
match (dict) --
An object that represents the method and value to match with the header value sent in a request. Specify one match method.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: exact, prefix, range, regex, suffix.
exact (string) --
The value sent by the client must match the specified value exactly.
prefix (string) --
The value sent by the client must begin with the specified characters.
range (dict) --
An object that represents the range of values to match on.
end (integer) -- [REQUIRED]
The end of the range.
start (integer) -- [REQUIRED]
The start of the range.
regex (string) --
The value sent by the client must include the specified characters.
suffix (string) --
The value sent by the client must end with the specified characters.
name (string) -- [REQUIRED]
A name for the HTTP header in the gateway route that will be matched on.
hostname (dict) --
The host name to match on.
exact (string) --
The exact host name to match on.
suffix (string) --
The specified ending characters of the host name to match on.
method (string) --
The method to match on.
path (dict) --
The path to match on.
exact (string) --
The exact path to match on.
regex (string) --
The regex used to match the path.
prefix (string) --
Specifies the path to match requests with. This parameter must always start with / , which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics , your prefix should be /metrics .
queryParameters (list) --
The query parameter to match on.
(dict) --
An object that represents the query parameter in the request.
match (dict) --
The query parameter to match on.
exact (string) --
The exact query parameter to match on.
name (string) -- [REQUIRED]
A name for the query parameter that will be matched on.
httpRoute (dict) --
An object that represents the specification of an HTTP gateway route.
action (dict) -- [REQUIRED]
An object that represents the action to take if a match is determined.
rewrite (dict) --
The gateway route action to rewrite.
hostname (dict) --
The host name to rewrite.
defaultTargetHostname (string) --
The default target host name to write to.
path (dict) --
The path to rewrite.
exact (string) --
The exact path to rewrite.
prefix (dict) --
The specified beginning characters to rewrite.
defaultPrefix (string) --
The default prefix used to replace the incoming route prefix when rewritten.
value (string) --
The value used to replace the incoming route prefix when rewritten.
target (dict) -- [REQUIRED]
An object that represents the target that traffic is routed to when a request matches the gateway route.
virtualService (dict) -- [REQUIRED]
An object that represents a virtual service gateway route target.
virtualServiceName (string) -- [REQUIRED]
The name of the virtual service that traffic is routed to.
match (dict) -- [REQUIRED]
An object that represents the criteria for determining a request match.
headers (list) --
The client request headers to match on.
(dict) --
An object that represents the HTTP header in the gateway route.
invert (boolean) --
Specify True to match anything except the match criteria. The default value is False .
match (dict) --
An object that represents the method and value to match with the header value sent in a request. Specify one match method.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: exact, prefix, range, regex, suffix.
exact (string) --
The value sent by the client must match the specified value exactly.
prefix (string) --
The value sent by the client must begin with the specified characters.
range (dict) --
An object that represents the range of values to match on.
end (integer) -- [REQUIRED]
The end of the range.
start (integer) -- [REQUIRED]
The start of the range.
regex (string) --
The value sent by the client must include the specified characters.
suffix (string) --
The value sent by the client must end with the specified characters.
name (string) -- [REQUIRED]
A name for the HTTP header in the gateway route that will be matched on.
hostname (dict) --
The host name to match on.
exact (string) --
The exact host name to match on.
suffix (string) --
The specified ending characters of the host name to match on.
method (string) --
The method to match on.
path (dict) --
The path to match on.
exact (string) --
The exact path to match on.
regex (string) --
The regex used to match the path.
prefix (string) --
Specifies the path to match requests with. This parameter must always start with / , which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics , your prefix should be /metrics .
queryParameters (list) --
The query parameter to match on.
(dict) --
An object that represents the query parameter in the request.
match (dict) --
The query parameter to match on.
exact (string) --
The exact query parameter to match on.
name (string) -- [REQUIRED]
A name for the query parameter that will be matched on.
priority (integer) --
The ordering of the gateway routes spec.
string
[REQUIRED]
The name of the virtual gateway that the gateway route is associated with.
dict
Response Syntax
{
'gatewayRoute': {
'gatewayRouteName': 'string',
'meshName': 'string',
'metadata': {
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'meshOwner': 'string',
'resourceOwner': 'string',
'uid': 'string',
'version': 123
},
'spec': {
'grpcRoute': {
'action': {
'rewrite': {
'hostname': {
'defaultTargetHostname': 'ENABLED'|'DISABLED'
}
},
'target': {
'virtualService': {
'virtualServiceName': 'string'
}
}
},
'match': {
'hostname': {
'exact': 'string',
'suffix': 'string'
},
'metadata': [
{
'invert': True|False,
'match': {
'exact': 'string',
'prefix': 'string',
'range': {
'end': 123,
'start': 123
},
'regex': 'string',
'suffix': 'string'
},
'name': 'string'
},
],
'serviceName': 'string'
}
},
'http2Route': {
'action': {
'rewrite': {
'hostname': {
'defaultTargetHostname': 'ENABLED'|'DISABLED'
},
'path': {
'exact': 'string'
},
'prefix': {
'defaultPrefix': 'ENABLED'|'DISABLED',
'value': 'string'
}
},
'target': {
'virtualService': {
'virtualServiceName': 'string'
}
}
},
'match': {
'headers': [
{
'invert': True|False,
'match': {
'exact': 'string',
'prefix': 'string',
'range': {
'end': 123,
'start': 123
},
'regex': 'string',
'suffix': 'string'
},
'name': 'string'
},
],
'hostname': {
'exact': 'string',
'suffix': 'string'
},
'method': 'GET'|'HEAD'|'POST'|'PUT'|'DELETE'|'CONNECT'|'OPTIONS'|'TRACE'|'PATCH',
'path': {
'exact': 'string',
'regex': 'string'
},
'prefix': 'string',
'queryParameters': [
{
'match': {
'exact': 'string'
},
'name': 'string'
},
]
}
},
'httpRoute': {
'action': {
'rewrite': {
'hostname': {
'defaultTargetHostname': 'ENABLED'|'DISABLED'
},
'path': {
'exact': 'string'
},
'prefix': {
'defaultPrefix': 'ENABLED'|'DISABLED',
'value': 'string'
}
},
'target': {
'virtualService': {
'virtualServiceName': 'string'
}
}
},
'match': {
'headers': [
{
'invert': True|False,
'match': {
'exact': 'string',
'prefix': 'string',
'range': {
'end': 123,
'start': 123
},
'regex': 'string',
'suffix': 'string'
},
'name': 'string'
},
],
'hostname': {
'exact': 'string',
'suffix': 'string'
},
'method': 'GET'|'HEAD'|'POST'|'PUT'|'DELETE'|'CONNECT'|'OPTIONS'|'TRACE'|'PATCH',
'path': {
'exact': 'string',
'regex': 'string'
},
'prefix': 'string',
'queryParameters': [
{
'match': {
'exact': 'string'
},
'name': 'string'
},
]
}
},
'priority': 123
},
'status': {
'status': 'ACTIVE'|'INACTIVE'|'DELETED'
},
'virtualGatewayName': 'string'
}
}
Response Structure
(dict) --
gatewayRoute (dict) --
A full description of the gateway route that was updated.
gatewayRouteName (string) --
The name of the gateway route.
meshName (string) --
The name of the service mesh that the resource resides in.
metadata (dict) --
An object that represents metadata for a resource.
arn (string) --
The full Amazon Resource Name (ARN) for the resource.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was created.
lastUpdatedAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was last updated.
meshOwner (string) --
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
resourceOwner (string) --
The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
uid (string) --
The unique identifier for the resource.
version (integer) --
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
spec (dict) --
The specifications of the gateway route.
grpcRoute (dict) --
An object that represents the specification of a gRPC gateway route.
action (dict) --
An object that represents the action to take if a match is determined.
rewrite (dict) --
The gateway route action to rewrite.
hostname (dict) --
The host name of the gateway route to rewrite.
defaultTargetHostname (string) --
The default target host name to write to.
target (dict) --
An object that represents the target that traffic is routed to when a request matches the gateway route.
virtualService (dict) --
An object that represents a virtual service gateway route target.
virtualServiceName (string) --
The name of the virtual service that traffic is routed to.
match (dict) --
An object that represents the criteria for determining a request match.
hostname (dict) --
The gateway route host name to be matched on.
exact (string) --
The exact host name to match on.
suffix (string) --
The specified ending characters of the host name to match on.
metadata (list) --
The gateway route metadata to be matched on.
(dict) --
An object representing the metadata of the gateway route.
invert (boolean) --
Specify True to match anything except the match criteria. The default value is False .
match (dict) --
The criteria for determining a metadata match.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: exact, prefix, range, regex, suffix. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
exact (string) --
The exact method header to be matched on.
prefix (string) --
The specified beginning characters of the method header to be matched on.
range (dict) --
An object that represents the range of values to match on. The first character of the range is included in the range, though the last character is not. For example, if the range specified were 1-100, only values 1-99 would be matched.
end (integer) --
The end of the range.
start (integer) --
The start of the range.
regex (string) --
The regex used to match the method header.
suffix (string) --
The specified ending characters of the method header to match on.
name (string) --
A name for the gateway route metadata.
serviceName (string) --
The fully qualified domain name for the service to match from the request.
http2Route (dict) --
An object that represents the specification of an HTTP/2 gateway route.
action (dict) --
An object that represents the action to take if a match is determined.
rewrite (dict) --
The gateway route action to rewrite.
hostname (dict) --
The host name to rewrite.
defaultTargetHostname (string) --
The default target host name to write to.
path (dict) --
The path to rewrite.
exact (string) --
The exact path to rewrite.
prefix (dict) --
The specified beginning characters to rewrite.
defaultPrefix (string) --
The default prefix used to replace the incoming route prefix when rewritten.
value (string) --
The value used to replace the incoming route prefix when rewritten.
target (dict) --
An object that represents the target that traffic is routed to when a request matches the gateway route.
virtualService (dict) --
An object that represents a virtual service gateway route target.
virtualServiceName (string) --
The name of the virtual service that traffic is routed to.
match (dict) --
An object that represents the criteria for determining a request match.
headers (list) --
The client request headers to match on.
(dict) --
An object that represents the HTTP header in the gateway route.
invert (boolean) --
Specify True to match anything except the match criteria. The default value is False .
match (dict) --
An object that represents the method and value to match with the header value sent in a request. Specify one match method.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: exact, prefix, range, regex, suffix. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
exact (string) --
The value sent by the client must match the specified value exactly.
prefix (string) --
The value sent by the client must begin with the specified characters.
range (dict) --
An object that represents the range of values to match on.
end (integer) --
The end of the range.
start (integer) --
The start of the range.
regex (string) --
The value sent by the client must include the specified characters.
suffix (string) --
The value sent by the client must end with the specified characters.
name (string) --
A name for the HTTP header in the gateway route that will be matched on.
hostname (dict) --
The host name to match on.
exact (string) --
The exact host name to match on.
suffix (string) --
The specified ending characters of the host name to match on.
method (string) --
The method to match on.
path (dict) --
The path to match on.
exact (string) --
The exact path to match on.
regex (string) --
The regex used to match the path.
prefix (string) --
Specifies the path to match requests with. This parameter must always start with / , which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics , your prefix should be /metrics .
queryParameters (list) --
The query parameter to match on.
(dict) --
An object that represents the query parameter in the request.
match (dict) --
The query parameter to match on.
exact (string) --
The exact query parameter to match on.
name (string) --
A name for the query parameter that will be matched on.
httpRoute (dict) --
An object that represents the specification of an HTTP gateway route.
action (dict) --
An object that represents the action to take if a match is determined.
rewrite (dict) --
The gateway route action to rewrite.
hostname (dict) --
The host name to rewrite.
defaultTargetHostname (string) --
The default target host name to write to.
path (dict) --
The path to rewrite.
exact (string) --
The exact path to rewrite.
prefix (dict) --
The specified beginning characters to rewrite.
defaultPrefix (string) --
The default prefix used to replace the incoming route prefix when rewritten.
value (string) --
The value used to replace the incoming route prefix when rewritten.
target (dict) --
An object that represents the target that traffic is routed to when a request matches the gateway route.
virtualService (dict) --
An object that represents a virtual service gateway route target.
virtualServiceName (string) --
The name of the virtual service that traffic is routed to.
match (dict) --
An object that represents the criteria for determining a request match.
headers (list) --
The client request headers to match on.
(dict) --
An object that represents the HTTP header in the gateway route.
invert (boolean) --
Specify True to match anything except the match criteria. The default value is False .
match (dict) --
An object that represents the method and value to match with the header value sent in a request. Specify one match method.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: exact, prefix, range, regex, suffix. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
exact (string) --
The value sent by the client must match the specified value exactly.
prefix (string) --
The value sent by the client must begin with the specified characters.
range (dict) --
An object that represents the range of values to match on.
end (integer) --
The end of the range.
start (integer) --
The start of the range.
regex (string) --
The value sent by the client must include the specified characters.
suffix (string) --
The value sent by the client must end with the specified characters.
name (string) --
A name for the HTTP header in the gateway route that will be matched on.
hostname (dict) --
The host name to match on.
exact (string) --
The exact host name to match on.
suffix (string) --
The specified ending characters of the host name to match on.
method (string) --
The method to match on.
path (dict) --
The path to match on.
exact (string) --
The exact path to match on.
regex (string) --
The regex used to match the path.
prefix (string) --
Specifies the path to match requests with. This parameter must always start with / , which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics , your prefix should be /metrics .
queryParameters (list) --
The query parameter to match on.
(dict) --
An object that represents the query parameter in the request.
match (dict) --
The query parameter to match on.
exact (string) --
The exact query parameter to match on.
name (string) --
A name for the query parameter that will be matched on.
priority (integer) --
The ordering of the gateway routes spec.
status (dict) --
The status of the gateway route.
status (string) --
The current status for the gateway route.
virtualGatewayName (string) --
The virtual gateway that the gateway route is associated with.
{'spec': {'http2Route': {'match': {'path': {'exact': 'string',
'regex': 'string'},
'queryParameters': [{'match': {'exact': 'string'},
'name': 'string'}]}},
'httpRoute': {'match': {'path': {'exact': 'string',
'regex': 'string'},
'queryParameters': [{'match': {'exact': 'string'},
'name': 'string'}]}}}}
Response {'route': {'spec': {'http2Route': {'match': {'path': {'exact': 'string',
'regex': 'string'},
'queryParameters': [{'match': {'exact': 'string'},
'name': 'string'}]}},
'httpRoute': {'match': {'path': {'exact': 'string',
'regex': 'string'},
'queryParameters': [{'match': {'exact': 'string'},
'name': 'string'}]}}}}}
Updates an existing route for a specified service mesh and virtual router.
See also: AWS API Documentation
Request Syntax
client.update_route(
clientToken='string',
meshName='string',
meshOwner='string',
routeName='string',
spec={
'grpcRoute': {
'action': {
'weightedTargets': [
{
'virtualNode': 'string',
'weight': 123
},
]
},
'match': {
'metadata': [
{
'invert': True|False,
'match': {
'exact': 'string',
'prefix': 'string',
'range': {
'end': 123,
'start': 123
},
'regex': 'string',
'suffix': 'string'
},
'name': 'string'
},
],
'methodName': 'string',
'serviceName': 'string'
},
'retryPolicy': {
'grpcRetryEvents': [
'cancelled'|'deadline-exceeded'|'internal'|'resource-exhausted'|'unavailable',
],
'httpRetryEvents': [
'string',
],
'maxRetries': 123,
'perRetryTimeout': {
'unit': 's'|'ms',
'value': 123
},
'tcpRetryEvents': [
'connection-error',
]
},
'timeout': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
}
},
'http2Route': {
'action': {
'weightedTargets': [
{
'virtualNode': 'string',
'weight': 123
},
]
},
'match': {
'headers': [
{
'invert': True|False,
'match': {
'exact': 'string',
'prefix': 'string',
'range': {
'end': 123,
'start': 123
},
'regex': 'string',
'suffix': 'string'
},
'name': 'string'
},
],
'method': 'GET'|'HEAD'|'POST'|'PUT'|'DELETE'|'CONNECT'|'OPTIONS'|'TRACE'|'PATCH',
'path': {
'exact': 'string',
'regex': 'string'
},
'prefix': 'string',
'queryParameters': [
{
'match': {
'exact': 'string'
},
'name': 'string'
},
],
'scheme': 'http'|'https'
},
'retryPolicy': {
'httpRetryEvents': [
'string',
],
'maxRetries': 123,
'perRetryTimeout': {
'unit': 's'|'ms',
'value': 123
},
'tcpRetryEvents': [
'connection-error',
]
},
'timeout': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
}
},
'httpRoute': {
'action': {
'weightedTargets': [
{
'virtualNode': 'string',
'weight': 123
},
]
},
'match': {
'headers': [
{
'invert': True|False,
'match': {
'exact': 'string',
'prefix': 'string',
'range': {
'end': 123,
'start': 123
},
'regex': 'string',
'suffix': 'string'
},
'name': 'string'
},
],
'method': 'GET'|'HEAD'|'POST'|'PUT'|'DELETE'|'CONNECT'|'OPTIONS'|'TRACE'|'PATCH',
'path': {
'exact': 'string',
'regex': 'string'
},
'prefix': 'string',
'queryParameters': [
{
'match': {
'exact': 'string'
},
'name': 'string'
},
],
'scheme': 'http'|'https'
},
'retryPolicy': {
'httpRetryEvents': [
'string',
],
'maxRetries': 123,
'perRetryTimeout': {
'unit': 's'|'ms',
'value': 123
},
'tcpRetryEvents': [
'connection-error',
]
},
'timeout': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
}
},
'priority': 123,
'tcpRoute': {
'action': {
'weightedTargets': [
{
'virtualNode': 'string',
'weight': 123
},
]
},
'timeout': {
'idle': {
'unit': 's'|'ms',
'value': 123
}
}
}
},
virtualRouterName='string'
)
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.
This field is autopopulated if not provided.
string
[REQUIRED]
The name of the service mesh that the route resides in.
string
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
string
[REQUIRED]
The name of the route to update.
dict
[REQUIRED]
The new route specification to apply. This overwrites the existing data.
grpcRoute (dict) --
An object that represents the specification of a gRPC route.
action (dict) -- [REQUIRED]
An object that represents the action to take if a match is determined.
weightedTargets (list) -- [REQUIRED]
An object that represents the targets that traffic is routed to when a request matches the route.
(dict) --
An object that represents a target and its relative weight. Traffic is distributed across targets according to their relative weight. For example, a weighted target with a relative weight of 50 receives five times as much traffic as one with a relative weight of 10. The total weight for all targets combined must be less than or equal to 100.
virtualNode (string) -- [REQUIRED]
The virtual node to associate with the weighted target.
weight (integer) -- [REQUIRED]
The relative weight of the weighted target.
match (dict) -- [REQUIRED]
An object that represents the criteria for determining a request match.
metadata (list) --
An object that represents the data to match from the request.
(dict) --
An object that represents the match metadata for the route.
invert (boolean) --
Specify True to match anything except the match criteria. The default value is False .
match (dict) --
An object that represents the data to match from the request.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: exact, prefix, range, regex, suffix.
exact (string) --
The value sent by the client must match the specified value exactly.
prefix (string) --
The value sent by the client must begin with the specified characters.
range (dict) --
An object that represents the range of values to match on.
end (integer) -- [REQUIRED]
The end of the range.
start (integer) -- [REQUIRED]
The start of the range.
regex (string) --
The value sent by the client must include the specified characters.
suffix (string) --
The value sent by the client must end with the specified characters.
name (string) -- [REQUIRED]
The name of the route.
methodName (string) --
The method name to match from the request. If you specify a name, you must also specify a serviceName .
serviceName (string) --
The fully qualified domain name for the service to match from the request.
retryPolicy (dict) --
An object that represents a retry policy.
grpcRetryEvents (list) --
Specify at least one of the valid values.
(string) --
httpRetryEvents (list) --
Specify at least one of the following values.
server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511
gateway-error – HTTP status codes 502, 503, and 504
client-error – HTTP status code 409
stream-error – Retry on refused stream
(string) --
maxRetries (integer) -- [REQUIRED]
The maximum number of retry attempts.
perRetryTimeout (dict) -- [REQUIRED]
The timeout for each retry attempt.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
tcpRetryEvents (list) --
Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.
(string) --
timeout (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
http2Route (dict) --
An object that represents the specification of an HTTP/2 route.
action (dict) -- [REQUIRED]
An object that represents the action to take if a match is determined.
weightedTargets (list) -- [REQUIRED]
An object that represents the targets that traffic is routed to when a request matches the route.
(dict) --
An object that represents a target and its relative weight. Traffic is distributed across targets according to their relative weight. For example, a weighted target with a relative weight of 50 receives five times as much traffic as one with a relative weight of 10. The total weight for all targets combined must be less than or equal to 100.
virtualNode (string) -- [REQUIRED]
The virtual node to associate with the weighted target.
weight (integer) -- [REQUIRED]
The relative weight of the weighted target.
match (dict) -- [REQUIRED]
An object that represents the criteria for determining a request match.
headers (list) --
The client request headers to match on.
(dict) --
An object that represents the HTTP header in the request.
invert (boolean) --
Specify True to match anything except the match criteria. The default value is False .
match (dict) --
The HeaderMatchMethod object.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: exact, prefix, range, regex, suffix.
exact (string) --
The value sent by the client must match the specified value exactly.
prefix (string) --
The value sent by the client must begin with the specified characters.
range (dict) --
An object that represents the range of values to match on.
end (integer) -- [REQUIRED]
The end of the range.
start (integer) -- [REQUIRED]
The start of the range.
regex (string) --
The value sent by the client must include the specified characters.
suffix (string) --
The value sent by the client must end with the specified characters.
name (string) -- [REQUIRED]
A name for the HTTP header in the client request that will be matched on.
method (string) --
The client request method to match on. Specify only one.
path (dict) --
The client request path to match on.
exact (string) --
The exact path to match on.
regex (string) --
The regex used to match the path.
prefix (string) --
Specifies the path to match requests with. This parameter must always start with / , which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics , your prefix should be /metrics .
queryParameters (list) --
The client request query parameters to match on.
(dict) --
An object that represents the query parameter in the request.
match (dict) --
The query parameter to match on.
exact (string) --
The exact query parameter to match on.
name (string) -- [REQUIRED]
A name for the query parameter that will be matched on.
scheme (string) --
The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.
retryPolicy (dict) --
An object that represents a retry policy.
httpRetryEvents (list) --
Specify at least one of the following values.
server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511
gateway-error – HTTP status codes 502, 503, and 504
client-error – HTTP status code 409
stream-error – Retry on refused stream
(string) --
maxRetries (integer) -- [REQUIRED]
The maximum number of retry attempts.
perRetryTimeout (dict) -- [REQUIRED]
The timeout for each retry attempt.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
tcpRetryEvents (list) --
Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.
(string) --
timeout (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
httpRoute (dict) --
An object that represents the specification of an HTTP route.
action (dict) -- [REQUIRED]
An object that represents the action to take if a match is determined.
weightedTargets (list) -- [REQUIRED]
An object that represents the targets that traffic is routed to when a request matches the route.
(dict) --
An object that represents a target and its relative weight. Traffic is distributed across targets according to their relative weight. For example, a weighted target with a relative weight of 50 receives five times as much traffic as one with a relative weight of 10. The total weight for all targets combined must be less than or equal to 100.
virtualNode (string) -- [REQUIRED]
The virtual node to associate with the weighted target.
weight (integer) -- [REQUIRED]
The relative weight of the weighted target.
match (dict) -- [REQUIRED]
An object that represents the criteria for determining a request match.
headers (list) --
The client request headers to match on.
(dict) --
An object that represents the HTTP header in the request.
invert (boolean) --
Specify True to match anything except the match criteria. The default value is False .
match (dict) --
The HeaderMatchMethod object.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: exact, prefix, range, regex, suffix.
exact (string) --
The value sent by the client must match the specified value exactly.
prefix (string) --
The value sent by the client must begin with the specified characters.
range (dict) --
An object that represents the range of values to match on.
end (integer) -- [REQUIRED]
The end of the range.
start (integer) -- [REQUIRED]
The start of the range.
regex (string) --
The value sent by the client must include the specified characters.
suffix (string) --
The value sent by the client must end with the specified characters.
name (string) -- [REQUIRED]
A name for the HTTP header in the client request that will be matched on.
method (string) --
The client request method to match on. Specify only one.
path (dict) --
The client request path to match on.
exact (string) --
The exact path to match on.
regex (string) --
The regex used to match the path.
prefix (string) --
Specifies the path to match requests with. This parameter must always start with / , which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics , your prefix should be /metrics .
queryParameters (list) --
The client request query parameters to match on.
(dict) --
An object that represents the query parameter in the request.
match (dict) --
The query parameter to match on.
exact (string) --
The exact query parameter to match on.
name (string) -- [REQUIRED]
A name for the query parameter that will be matched on.
scheme (string) --
The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.
retryPolicy (dict) --
An object that represents a retry policy.
httpRetryEvents (list) --
Specify at least one of the following values.
server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511
gateway-error – HTTP status codes 502, 503, and 504
client-error – HTTP status code 409
stream-error – Retry on refused stream
(string) --
maxRetries (integer) -- [REQUIRED]
The maximum number of retry attempts.
perRetryTimeout (dict) -- [REQUIRED]
The timeout for each retry attempt.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
tcpRetryEvents (list) --
Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.
(string) --
timeout (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
priority (integer) --
The priority for the route. Routes are matched based on the specified value, where 0 is the highest priority.
tcpRoute (dict) --
An object that represents the specification of a TCP route.
action (dict) -- [REQUIRED]
The action to take if a match is determined.
weightedTargets (list) -- [REQUIRED]
An object that represents the targets that traffic is routed to when a request matches the route.
(dict) --
An object that represents a target and its relative weight. Traffic is distributed across targets according to their relative weight. For example, a weighted target with a relative weight of 50 receives five times as much traffic as one with a relative weight of 10. The total weight for all targets combined must be less than or equal to 100.
virtualNode (string) -- [REQUIRED]
The virtual node to associate with the weighted target.
weight (integer) -- [REQUIRED]
The relative weight of the weighted target.
timeout (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
string
[REQUIRED]
The name of the virtual router that the route is associated with.
dict
Response Syntax
{
'route': {
'meshName': 'string',
'metadata': {
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'meshOwner': 'string',
'resourceOwner': 'string',
'uid': 'string',
'version': 123
},
'routeName': 'string',
'spec': {
'grpcRoute': {
'action': {
'weightedTargets': [
{
'virtualNode': 'string',
'weight': 123
},
]
},
'match': {
'metadata': [
{
'invert': True|False,
'match': {
'exact': 'string',
'prefix': 'string',
'range': {
'end': 123,
'start': 123
},
'regex': 'string',
'suffix': 'string'
},
'name': 'string'
},
],
'methodName': 'string',
'serviceName': 'string'
},
'retryPolicy': {
'grpcRetryEvents': [
'cancelled'|'deadline-exceeded'|'internal'|'resource-exhausted'|'unavailable',
],
'httpRetryEvents': [
'string',
],
'maxRetries': 123,
'perRetryTimeout': {
'unit': 's'|'ms',
'value': 123
},
'tcpRetryEvents': [
'connection-error',
]
},
'timeout': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
}
},
'http2Route': {
'action': {
'weightedTargets': [
{
'virtualNode': 'string',
'weight': 123
},
]
},
'match': {
'headers': [
{
'invert': True|False,
'match': {
'exact': 'string',
'prefix': 'string',
'range': {
'end': 123,
'start': 123
},
'regex': 'string',
'suffix': 'string'
},
'name': 'string'
},
],
'method': 'GET'|'HEAD'|'POST'|'PUT'|'DELETE'|'CONNECT'|'OPTIONS'|'TRACE'|'PATCH',
'path': {
'exact': 'string',
'regex': 'string'
},
'prefix': 'string',
'queryParameters': [
{
'match': {
'exact': 'string'
},
'name': 'string'
},
],
'scheme': 'http'|'https'
},
'retryPolicy': {
'httpRetryEvents': [
'string',
],
'maxRetries': 123,
'perRetryTimeout': {
'unit': 's'|'ms',
'value': 123
},
'tcpRetryEvents': [
'connection-error',
]
},
'timeout': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
}
},
'httpRoute': {
'action': {
'weightedTargets': [
{
'virtualNode': 'string',
'weight': 123
},
]
},
'match': {
'headers': [
{
'invert': True|False,
'match': {
'exact': 'string',
'prefix': 'string',
'range': {
'end': 123,
'start': 123
},
'regex': 'string',
'suffix': 'string'
},
'name': 'string'
},
],
'method': 'GET'|'HEAD'|'POST'|'PUT'|'DELETE'|'CONNECT'|'OPTIONS'|'TRACE'|'PATCH',
'path': {
'exact': 'string',
'regex': 'string'
},
'prefix': 'string',
'queryParameters': [
{
'match': {
'exact': 'string'
},
'name': 'string'
},
],
'scheme': 'http'|'https'
},
'retryPolicy': {
'httpRetryEvents': [
'string',
],
'maxRetries': 123,
'perRetryTimeout': {
'unit': 's'|'ms',
'value': 123
},
'tcpRetryEvents': [
'connection-error',
]
},
'timeout': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
}
},
'priority': 123,
'tcpRoute': {
'action': {
'weightedTargets': [
{
'virtualNode': 'string',
'weight': 123
},
]
},
'timeout': {
'idle': {
'unit': 's'|'ms',
'value': 123
}
}
}
},
'status': {
'status': 'ACTIVE'|'INACTIVE'|'DELETED'
},
'virtualRouterName': 'string'
}
}
Response Structure
(dict) --
route (dict) --
A full description of the route that was updated.
meshName (string) --
The name of the service mesh that the route resides in.
metadata (dict) --
The associated metadata for the route.
arn (string) --
The full Amazon Resource Name (ARN) for the resource.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was created.
lastUpdatedAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was last updated.
meshOwner (string) --
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
resourceOwner (string) --
The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
uid (string) --
The unique identifier for the resource.
version (integer) --
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
routeName (string) --
The name of the route.
spec (dict) --
The specifications of the route.
grpcRoute (dict) --
An object that represents the specification of a gRPC route.
action (dict) --
An object that represents the action to take if a match is determined.
weightedTargets (list) --
An object that represents the targets that traffic is routed to when a request matches the route.
(dict) --
An object that represents a target and its relative weight. Traffic is distributed across targets according to their relative weight. For example, a weighted target with a relative weight of 50 receives five times as much traffic as one with a relative weight of 10. The total weight for all targets combined must be less than or equal to 100.
virtualNode (string) --
The virtual node to associate with the weighted target.
weight (integer) --
The relative weight of the weighted target.
match (dict) --
An object that represents the criteria for determining a request match.
metadata (list) --
An object that represents the data to match from the request.
(dict) --
An object that represents the match metadata for the route.
invert (boolean) --
Specify True to match anything except the match criteria. The default value is False .
match (dict) --
An object that represents the data to match from the request.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: exact, prefix, range, regex, suffix. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
exact (string) --
The value sent by the client must match the specified value exactly.
prefix (string) --
The value sent by the client must begin with the specified characters.
range (dict) --
An object that represents the range of values to match on.
end (integer) --
The end of the range.
start (integer) --
The start of the range.
regex (string) --
The value sent by the client must include the specified characters.
suffix (string) --
The value sent by the client must end with the specified characters.
name (string) --
The name of the route.
methodName (string) --
The method name to match from the request. If you specify a name, you must also specify a serviceName .
serviceName (string) --
The fully qualified domain name for the service to match from the request.
retryPolicy (dict) --
An object that represents a retry policy.
grpcRetryEvents (list) --
Specify at least one of the valid values.
(string) --
httpRetryEvents (list) --
Specify at least one of the following values.
server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511
gateway-error – HTTP status codes 502, 503, and 504
client-error – HTTP status code 409
stream-error – Retry on refused stream
(string) --
maxRetries (integer) --
The maximum number of retry attempts.
perRetryTimeout (dict) --
The timeout for each retry attempt.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
tcpRetryEvents (list) --
Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.
(string) --
timeout (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
http2Route (dict) --
An object that represents the specification of an HTTP/2 route.
action (dict) --
An object that represents the action to take if a match is determined.
weightedTargets (list) --
An object that represents the targets that traffic is routed to when a request matches the route.
(dict) --
An object that represents a target and its relative weight. Traffic is distributed across targets according to their relative weight. For example, a weighted target with a relative weight of 50 receives five times as much traffic as one with a relative weight of 10. The total weight for all targets combined must be less than or equal to 100.
virtualNode (string) --
The virtual node to associate with the weighted target.
weight (integer) --
The relative weight of the weighted target.
match (dict) --
An object that represents the criteria for determining a request match.
headers (list) --
The client request headers to match on.
(dict) --
An object that represents the HTTP header in the request.
invert (boolean) --
Specify True to match anything except the match criteria. The default value is False .
match (dict) --
The HeaderMatchMethod object.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: exact, prefix, range, regex, suffix. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
exact (string) --
The value sent by the client must match the specified value exactly.
prefix (string) --
The value sent by the client must begin with the specified characters.
range (dict) --
An object that represents the range of values to match on.
end (integer) --
The end of the range.
start (integer) --
The start of the range.
regex (string) --
The value sent by the client must include the specified characters.
suffix (string) --
The value sent by the client must end with the specified characters.
name (string) --
A name for the HTTP header in the client request that will be matched on.
method (string) --
The client request method to match on. Specify only one.
path (dict) --
The client request path to match on.
exact (string) --
The exact path to match on.
regex (string) --
The regex used to match the path.
prefix (string) --
Specifies the path to match requests with. This parameter must always start with / , which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics , your prefix should be /metrics .
queryParameters (list) --
The client request query parameters to match on.
(dict) --
An object that represents the query parameter in the request.
match (dict) --
The query parameter to match on.
exact (string) --
The exact query parameter to match on.
name (string) --
A name for the query parameter that will be matched on.
scheme (string) --
The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.
retryPolicy (dict) --
An object that represents a retry policy.
httpRetryEvents (list) --
Specify at least one of the following values.
server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511
gateway-error – HTTP status codes 502, 503, and 504
client-error – HTTP status code 409
stream-error – Retry on refused stream
(string) --
maxRetries (integer) --
The maximum number of retry attempts.
perRetryTimeout (dict) --
The timeout for each retry attempt.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
tcpRetryEvents (list) --
Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.
(string) --
timeout (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
httpRoute (dict) --
An object that represents the specification of an HTTP route.
action (dict) --
An object that represents the action to take if a match is determined.
weightedTargets (list) --
An object that represents the targets that traffic is routed to when a request matches the route.
(dict) --
An object that represents a target and its relative weight. Traffic is distributed across targets according to their relative weight. For example, a weighted target with a relative weight of 50 receives five times as much traffic as one with a relative weight of 10. The total weight for all targets combined must be less than or equal to 100.
virtualNode (string) --
The virtual node to associate with the weighted target.
weight (integer) --
The relative weight of the weighted target.
match (dict) --
An object that represents the criteria for determining a request match.
headers (list) --
The client request headers to match on.
(dict) --
An object that represents the HTTP header in the request.
invert (boolean) --
Specify True to match anything except the match criteria. The default value is False .
match (dict) --
The HeaderMatchMethod object.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: exact, prefix, range, regex, suffix. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
exact (string) --
The value sent by the client must match the specified value exactly.
prefix (string) --
The value sent by the client must begin with the specified characters.
range (dict) --
An object that represents the range of values to match on.
end (integer) --
The end of the range.
start (integer) --
The start of the range.
regex (string) --
The value sent by the client must include the specified characters.
suffix (string) --
The value sent by the client must end with the specified characters.
name (string) --
A name for the HTTP header in the client request that will be matched on.
method (string) --
The client request method to match on. Specify only one.
path (dict) --
The client request path to match on.
exact (string) --
The exact path to match on.
regex (string) --
The regex used to match the path.
prefix (string) --
Specifies the path to match requests with. This parameter must always start with / , which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics , your prefix should be /metrics .
queryParameters (list) --
The client request query parameters to match on.
(dict) --
An object that represents the query parameter in the request.
match (dict) --
The query parameter to match on.
exact (string) --
The exact query parameter to match on.
name (string) --
A name for the query parameter that will be matched on.
scheme (string) --
The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.
retryPolicy (dict) --
An object that represents a retry policy.
httpRetryEvents (list) --
Specify at least one of the following values.
server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511
gateway-error – HTTP status codes 502, 503, and 504
client-error – HTTP status code 409
stream-error – Retry on refused stream
(string) --
maxRetries (integer) --
The maximum number of retry attempts.
perRetryTimeout (dict) --
The timeout for each retry attempt.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
tcpRetryEvents (list) --
Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.
(string) --
timeout (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
priority (integer) --
The priority for the route. Routes are matched based on the specified value, where 0 is the highest priority.
tcpRoute (dict) --
An object that represents the specification of a TCP route.
action (dict) --
The action to take if a match is determined.
weightedTargets (list) --
An object that represents the targets that traffic is routed to when a request matches the route.
(dict) --
An object that represents a target and its relative weight. Traffic is distributed across targets according to their relative weight. For example, a weighted target with a relative weight of 50 receives five times as much traffic as one with a relative weight of 10. The total weight for all targets combined must be less than or equal to 100.
virtualNode (string) --
The virtual node to associate with the weighted target.
weight (integer) --
The relative weight of the weighted target.
timeout (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
status (dict) --
The status of the route.
status (string) --
The current status for the route.
virtualRouterName (string) --
The virtual router that the route is associated with.
{'spec': {'serviceDiscovery': {'dns': {'responseType': 'LOADBALANCER | '
'ENDPOINTS'}}}}
Response {'virtualNode': {'spec': {'serviceDiscovery': {'dns': {'responseType': 'LOADBALANCER '
'| '
'ENDPOINTS'}}}}}
Updates an existing virtual node in a specified service mesh.
See also: AWS API Documentation
Request Syntax
client.update_virtual_node(
clientToken='string',
meshName='string',
meshOwner='string',
spec={
'backendDefaults': {
'clientPolicy': {
'tls': {
'certificate': {
'file': {
'certificateChain': 'string',
'privateKey': 'string'
},
'sds': {
'secretName': 'string'
}
},
'enforce': True|False,
'ports': [
123,
],
'validation': {
'subjectAlternativeNames': {
'match': {
'exact': [
'string',
]
}
},
'trust': {
'acm': {
'certificateAuthorityArns': [
'string',
]
},
'file': {
'certificateChain': 'string'
},
'sds': {
'secretName': 'string'
}
}
}
}
}
},
'backends': [
{
'virtualService': {
'clientPolicy': {
'tls': {
'certificate': {
'file': {
'certificateChain': 'string',
'privateKey': 'string'
},
'sds': {
'secretName': 'string'
}
},
'enforce': True|False,
'ports': [
123,
],
'validation': {
'subjectAlternativeNames': {
'match': {
'exact': [
'string',
]
}
},
'trust': {
'acm': {
'certificateAuthorityArns': [
'string',
]
},
'file': {
'certificateChain': 'string'
},
'sds': {
'secretName': 'string'
}
}
}
}
},
'virtualServiceName': 'string'
}
},
],
'listeners': [
{
'connectionPool': {
'grpc': {
'maxRequests': 123
},
'http': {
'maxConnections': 123,
'maxPendingRequests': 123
},
'http2': {
'maxRequests': 123
},
'tcp': {
'maxConnections': 123
}
},
'healthCheck': {
'healthyThreshold': 123,
'intervalMillis': 123,
'path': 'string',
'port': 123,
'protocol': 'http'|'tcp'|'http2'|'grpc',
'timeoutMillis': 123,
'unhealthyThreshold': 123
},
'outlierDetection': {
'baseEjectionDuration': {
'unit': 's'|'ms',
'value': 123
},
'interval': {
'unit': 's'|'ms',
'value': 123
},
'maxEjectionPercent': 123,
'maxServerErrors': 123
},
'portMapping': {
'port': 123,
'protocol': 'http'|'tcp'|'http2'|'grpc'
},
'timeout': {
'grpc': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
},
'http': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
},
'http2': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
},
'tcp': {
'idle': {
'unit': 's'|'ms',
'value': 123
}
}
},
'tls': {
'certificate': {
'acm': {
'certificateArn': 'string'
},
'file': {
'certificateChain': 'string',
'privateKey': 'string'
},
'sds': {
'secretName': 'string'
}
},
'mode': 'STRICT'|'PERMISSIVE'|'DISABLED',
'validation': {
'subjectAlternativeNames': {
'match': {
'exact': [
'string',
]
}
},
'trust': {
'file': {
'certificateChain': 'string'
},
'sds': {
'secretName': 'string'
}
}
}
}
},
],
'logging': {
'accessLog': {
'file': {
'path': 'string'
}
}
},
'serviceDiscovery': {
'awsCloudMap': {
'attributes': [
{
'key': 'string',
'value': 'string'
},
],
'namespaceName': 'string',
'serviceName': 'string'
},
'dns': {
'hostname': 'string',
'responseType': 'LOADBALANCER'|'ENDPOINTS'
}
}
},
virtualNodeName='string'
)
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.
This field is autopopulated if not provided.
string
[REQUIRED]
The name of the service mesh that the virtual node resides in.
string
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
dict
[REQUIRED]
The new virtual node specification to apply. This overwrites the existing data.
backendDefaults (dict) --
A reference to an object that represents the defaults for backends.
clientPolicy (dict) --
A reference to an object that represents a client policy.
tls (dict) --
A reference to an object that represents a Transport Layer Security (TLS) client policy.
certificate (dict) --
A reference to an object that represents a client's TLS certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: file, sds.
file (dict) --
An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
certificateChain (string) -- [REQUIRED]
The certificate chain for the certificate.
privateKey (string) -- [REQUIRED]
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a client's TLS Secret Discovery Service certificate.
secretName (string) -- [REQUIRED]
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.
enforce (boolean) --
Whether the policy is enforced. The default is True , if a value isn't specified.
ports (list) --
One or more ports that the policy is enforced for.
(integer) --
validation (dict) -- [REQUIRED]
A reference to an object that represents a TLS validation context.
subjectAlternativeNames (dict) --
A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context.
match (dict) -- [REQUIRED]
An object that represents the criteria for determining a SANs match.
exact (list) -- [REQUIRED]
The values sent must match the specified values exactly.
(string) --
trust (dict) -- [REQUIRED]
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: acm, file, sds.
acm (dict) --
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.
certificateAuthorityArns (list) -- [REQUIRED]
One or more ACM Amazon Resource Name (ARN)s.
(string) --
file (dict) --
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
certificateChain (string) -- [REQUIRED]
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
secretName (string) -- [REQUIRED]
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
backends (list) --
The backends that the virtual node is expected to send outbound traffic to.
(dict) --
An object that represents the backends that a virtual node is expected to send outbound traffic to.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: virtualService.
virtualService (dict) --
Specifies a virtual service to use as a backend.
clientPolicy (dict) --
A reference to an object that represents the client policy for a backend.
tls (dict) --
A reference to an object that represents a Transport Layer Security (TLS) client policy.
certificate (dict) --
A reference to an object that represents a client's TLS certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: file, sds.
file (dict) --
An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
certificateChain (string) -- [REQUIRED]
The certificate chain for the certificate.
privateKey (string) -- [REQUIRED]
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a client's TLS Secret Discovery Service certificate.
secretName (string) -- [REQUIRED]
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.
enforce (boolean) --
Whether the policy is enforced. The default is True , if a value isn't specified.
ports (list) --
One or more ports that the policy is enforced for.
(integer) --
validation (dict) -- [REQUIRED]
A reference to an object that represents a TLS validation context.
subjectAlternativeNames (dict) --
A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context.
match (dict) -- [REQUIRED]
An object that represents the criteria for determining a SANs match.
exact (list) -- [REQUIRED]
The values sent must match the specified values exactly.
(string) --
trust (dict) -- [REQUIRED]
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: acm, file, sds.
acm (dict) --
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.
certificateAuthorityArns (list) -- [REQUIRED]
One or more ACM Amazon Resource Name (ARN)s.
(string) --
file (dict) --
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
certificateChain (string) -- [REQUIRED]
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
secretName (string) -- [REQUIRED]
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
virtualServiceName (string) -- [REQUIRED]
The name of the virtual service that is acting as a virtual node backend.
listeners (list) --
The listener that the virtual node is expected to receive inbound traffic from. You can specify one listener.
(dict) --
An object that represents a listener for a virtual node.
connectionPool (dict) --
The connection pool information for the listener.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: grpc, http, http2, tcp.
grpc (dict) --
An object that represents a type of connection pool.
maxRequests (integer) -- [REQUIRED]
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.
http (dict) --
An object that represents a type of connection pool.
maxConnections (integer) -- [REQUIRED]
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.
maxPendingRequests (integer) --
Number of overflowing requests after max_connections Envoy will queue to upstream cluster.
http2 (dict) --
An object that represents a type of connection pool.
maxRequests (integer) -- [REQUIRED]
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.
tcp (dict) --
An object that represents a type of connection pool.
maxConnections (integer) -- [REQUIRED]
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.
healthCheck (dict) --
The health check information for the listener.
healthyThreshold (integer) -- [REQUIRED]
The number of consecutive successful health checks that must occur before declaring listener healthy.
intervalMillis (integer) -- [REQUIRED]
The time period in milliseconds between each health check execution.
path (string) --
The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.
port (integer) --
The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.
protocol (string) -- [REQUIRED]
The protocol for the health check request. If you specify grpc , then your service must conform to the GRPC Health Checking Protocol.
timeoutMillis (integer) -- [REQUIRED]
The amount of time to wait when receiving a response from the health check, in milliseconds.
unhealthyThreshold (integer) -- [REQUIRED]
The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.
outlierDetection (dict) --
The outlier detection information for the listener.
baseEjectionDuration (dict) -- [REQUIRED]
The base amount of time for which a host is ejected.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
interval (dict) -- [REQUIRED]
The time interval between ejection sweep analysis.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
maxEjectionPercent (integer) -- [REQUIRED]
Maximum percentage of hosts in load balancing pool for upstream service that can be ejected. Will eject at least one host regardless of the value.
maxServerErrors (integer) -- [REQUIRED]
Number of consecutive 5xx errors required for ejection.
portMapping (dict) -- [REQUIRED]
The port mapping information for the listener.
port (integer) -- [REQUIRED]
The port used for the port mapping.
protocol (string) -- [REQUIRED]
The protocol used for the port mapping. Specify one protocol.
timeout (dict) --
An object that represents timeouts for different protocols.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: grpc, http, http2, tcp.
grpc (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
http (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
http2 (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
tcp (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
tls (dict) --
A reference to an object that represents the Transport Layer Security (TLS) properties for a listener.
certificate (dict) -- [REQUIRED]
A reference to an object that represents a listener's Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: acm, file, sds.
acm (dict) --
A reference to an object that represents an AWS Certicate Manager (ACM) certificate.
certificateArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
file (dict) --
A reference to an object that represents a local file certificate.
certificateChain (string) -- [REQUIRED]
The certificate chain for the certificate.
privateKey (string) -- [REQUIRED]
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a listener's Secret Discovery Service certificate.
secretName (string) -- [REQUIRED]
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.
mode (string) -- [REQUIRED]
Specify one of the following modes.
STRICT – Listener only accepts connections with TLS enabled.
PERMISSIVE – Listener accepts connections with or without TLS enabled.
DISABLED – Listener only accepts connections without TLS.
validation (dict) --
A reference to an object that represents a listener's Transport Layer Security (TLS) validation context.
subjectAlternativeNames (dict) --
A reference to an object that represents the SANs for a listener's Transport Layer Security (TLS) validation context.
match (dict) -- [REQUIRED]
An object that represents the criteria for determining a SANs match.
exact (list) -- [REQUIRED]
The values sent must match the specified values exactly.
(string) --
trust (dict) -- [REQUIRED]
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: file, sds.
file (dict) --
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
certificateChain (string) -- [REQUIRED]
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a listener's Transport Layer Security (TLS) Secret Discovery Service validation context trust.
secretName (string) -- [REQUIRED]
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
logging (dict) --
The inbound and outbound access logging information for the virtual node.
accessLog (dict) --
The access log configuration for a virtual node.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: file.
file (dict) --
The file object to send virtual node access logs to.
path (string) -- [REQUIRED]
The file path to write access logs to. You can use /dev/stdout to send access logs to standard out and configure your Envoy container to use a log driver, such as awslogs , to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk.
Note
The Envoy process must have write permissions to the path that you specify here. Otherwise, Envoy fails to bootstrap properly.
serviceDiscovery (dict) --
The service discovery information for the virtual node. If your virtual node does not expect ingress traffic, you can omit this parameter. If you specify a listener , then you must specify service discovery information.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: awsCloudMap, dns.
awsCloudMap (dict) --
Specifies any Cloud Map information for the virtual node.
attributes (list) --
A string map that contains attributes with values that you can use to filter instances by any custom attribute that you specified when you registered the instance. Only instances that match all of the specified key/value pairs will be returned.
(dict) --
An object that represents the Cloud Map attribute information for your virtual node.
Note
AWS Cloud Map is not available in the eu-south-1 Region.
key (string) -- [REQUIRED]
The name of an Cloud Map service instance attribute key. Any Cloud Map service instance that contains the specified key and value is returned.
value (string) -- [REQUIRED]
The value of an Cloud Map service instance attribute key. Any Cloud Map service instance that contains the specified key and value is returned.
namespaceName (string) -- [REQUIRED]
The name of the Cloud Map namespace to use.
serviceName (string) -- [REQUIRED]
The name of the Cloud Map service to use.
dns (dict) --
Specifies the DNS information for the virtual node.
hostname (string) -- [REQUIRED]
Specifies the DNS service discovery hostname for the virtual node.
responseType (string) --
Specifies the DNS response type for the virtual node.
string
[REQUIRED]
The name of the virtual node to update.
dict
Response Syntax
{
'virtualNode': {
'meshName': 'string',
'metadata': {
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'meshOwner': 'string',
'resourceOwner': 'string',
'uid': 'string',
'version': 123
},
'spec': {
'backendDefaults': {
'clientPolicy': {
'tls': {
'certificate': {
'file': {
'certificateChain': 'string',
'privateKey': 'string'
},
'sds': {
'secretName': 'string'
}
},
'enforce': True|False,
'ports': [
123,
],
'validation': {
'subjectAlternativeNames': {
'match': {
'exact': [
'string',
]
}
},
'trust': {
'acm': {
'certificateAuthorityArns': [
'string',
]
},
'file': {
'certificateChain': 'string'
},
'sds': {
'secretName': 'string'
}
}
}
}
}
},
'backends': [
{
'virtualService': {
'clientPolicy': {
'tls': {
'certificate': {
'file': {
'certificateChain': 'string',
'privateKey': 'string'
},
'sds': {
'secretName': 'string'
}
},
'enforce': True|False,
'ports': [
123,
],
'validation': {
'subjectAlternativeNames': {
'match': {
'exact': [
'string',
]
}
},
'trust': {
'acm': {
'certificateAuthorityArns': [
'string',
]
},
'file': {
'certificateChain': 'string'
},
'sds': {
'secretName': 'string'
}
}
}
}
},
'virtualServiceName': 'string'
}
},
],
'listeners': [
{
'connectionPool': {
'grpc': {
'maxRequests': 123
},
'http': {
'maxConnections': 123,
'maxPendingRequests': 123
},
'http2': {
'maxRequests': 123
},
'tcp': {
'maxConnections': 123
}
},
'healthCheck': {
'healthyThreshold': 123,
'intervalMillis': 123,
'path': 'string',
'port': 123,
'protocol': 'http'|'tcp'|'http2'|'grpc',
'timeoutMillis': 123,
'unhealthyThreshold': 123
},
'outlierDetection': {
'baseEjectionDuration': {
'unit': 's'|'ms',
'value': 123
},
'interval': {
'unit': 's'|'ms',
'value': 123
},
'maxEjectionPercent': 123,
'maxServerErrors': 123
},
'portMapping': {
'port': 123,
'protocol': 'http'|'tcp'|'http2'|'grpc'
},
'timeout': {
'grpc': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
},
'http': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
},
'http2': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
},
'tcp': {
'idle': {
'unit': 's'|'ms',
'value': 123
}
}
},
'tls': {
'certificate': {
'acm': {
'certificateArn': 'string'
},
'file': {
'certificateChain': 'string',
'privateKey': 'string'
},
'sds': {
'secretName': 'string'
}
},
'mode': 'STRICT'|'PERMISSIVE'|'DISABLED',
'validation': {
'subjectAlternativeNames': {
'match': {
'exact': [
'string',
]
}
},
'trust': {
'file': {
'certificateChain': 'string'
},
'sds': {
'secretName': 'string'
}
}
}
}
},
],
'logging': {
'accessLog': {
'file': {
'path': 'string'
}
}
},
'serviceDiscovery': {
'awsCloudMap': {
'attributes': [
{
'key': 'string',
'value': 'string'
},
],
'namespaceName': 'string',
'serviceName': 'string'
},
'dns': {
'hostname': 'string',
'responseType': 'LOADBALANCER'|'ENDPOINTS'
}
}
},
'status': {
'status': 'ACTIVE'|'INACTIVE'|'DELETED'
},
'virtualNodeName': 'string'
}
}
Response Structure
(dict) --
virtualNode (dict) --
A full description of the virtual node that was updated.
meshName (string) --
The name of the service mesh that the virtual node resides in.
metadata (dict) --
The associated metadata for the virtual node.
arn (string) --
The full Amazon Resource Name (ARN) for the resource.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was created.
lastUpdatedAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was last updated.
meshOwner (string) --
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
resourceOwner (string) --
The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
uid (string) --
The unique identifier for the resource.
version (integer) --
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
spec (dict) --
The specifications of the virtual node.
backendDefaults (dict) --
A reference to an object that represents the defaults for backends.
clientPolicy (dict) --
A reference to an object that represents a client policy.
tls (dict) --
A reference to an object that represents a Transport Layer Security (TLS) client policy.
certificate (dict) --
A reference to an object that represents a client's TLS certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
file (dict) --
An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
certificateChain (string) --
The certificate chain for the certificate.
privateKey (string) --
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a client's TLS Secret Discovery Service certificate.
secretName (string) --
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.
enforce (boolean) --
Whether the policy is enforced. The default is True , if a value isn't specified.
ports (list) --
One or more ports that the policy is enforced for.
(integer) --
validation (dict) --
A reference to an object that represents a TLS validation context.
subjectAlternativeNames (dict) --
A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context.
match (dict) --
An object that represents the criteria for determining a SANs match.
exact (list) --
The values sent must match the specified values exactly.
(string) --
trust (dict) --
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: acm, file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
acm (dict) --
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.
certificateAuthorityArns (list) --
One or more ACM Amazon Resource Name (ARN)s.
(string) --
file (dict) --
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
certificateChain (string) --
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
secretName (string) --
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
backends (list) --
The backends that the virtual node is expected to send outbound traffic to.
(dict) --
An object that represents the backends that a virtual node is expected to send outbound traffic to.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: virtualService. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
virtualService (dict) --
Specifies a virtual service to use as a backend.
clientPolicy (dict) --
A reference to an object that represents the client policy for a backend.
tls (dict) --
A reference to an object that represents a Transport Layer Security (TLS) client policy.
certificate (dict) --
A reference to an object that represents a client's TLS certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
file (dict) --
An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
certificateChain (string) --
The certificate chain for the certificate.
privateKey (string) --
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a client's TLS Secret Discovery Service certificate.
secretName (string) --
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.
enforce (boolean) --
Whether the policy is enforced. The default is True , if a value isn't specified.
ports (list) --
One or more ports that the policy is enforced for.
(integer) --
validation (dict) --
A reference to an object that represents a TLS validation context.
subjectAlternativeNames (dict) --
A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context.
match (dict) --
An object that represents the criteria for determining a SANs match.
exact (list) --
The values sent must match the specified values exactly.
(string) --
trust (dict) --
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: acm, file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
acm (dict) --
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.
certificateAuthorityArns (list) --
One or more ACM Amazon Resource Name (ARN)s.
(string) --
file (dict) --
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
certificateChain (string) --
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
secretName (string) --
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
virtualServiceName (string) --
The name of the virtual service that is acting as a virtual node backend.
listeners (list) --
The listener that the virtual node is expected to receive inbound traffic from. You can specify one listener.
(dict) --
An object that represents a listener for a virtual node.
connectionPool (dict) --
The connection pool information for the listener.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: grpc, http, http2, tcp. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
grpc (dict) --
An object that represents a type of connection pool.
maxRequests (integer) --
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.
http (dict) --
An object that represents a type of connection pool.
maxConnections (integer) --
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.
maxPendingRequests (integer) --
Number of overflowing requests after max_connections Envoy will queue to upstream cluster.
http2 (dict) --
An object that represents a type of connection pool.
maxRequests (integer) --
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.
tcp (dict) --
An object that represents a type of connection pool.
maxConnections (integer) --
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.
healthCheck (dict) --
The health check information for the listener.
healthyThreshold (integer) --
The number of consecutive successful health checks that must occur before declaring listener healthy.
intervalMillis (integer) --
The time period in milliseconds between each health check execution.
path (string) --
The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.
port (integer) --
The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.
protocol (string) --
The protocol for the health check request. If you specify grpc , then your service must conform to the GRPC Health Checking Protocol.
timeoutMillis (integer) --
The amount of time to wait when receiving a response from the health check, in milliseconds.
unhealthyThreshold (integer) --
The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.
outlierDetection (dict) --
The outlier detection information for the listener.
baseEjectionDuration (dict) --
The base amount of time for which a host is ejected.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
interval (dict) --
The time interval between ejection sweep analysis.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
maxEjectionPercent (integer) --
Maximum percentage of hosts in load balancing pool for upstream service that can be ejected. Will eject at least one host regardless of the value.
maxServerErrors (integer) --
Number of consecutive 5xx errors required for ejection.
portMapping (dict) --
The port mapping information for the listener.
port (integer) --
The port used for the port mapping.
protocol (string) --
The protocol used for the port mapping. Specify one protocol.
timeout (dict) --
An object that represents timeouts for different protocols.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: grpc, http, http2, tcp. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
grpc (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
http (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
http2 (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
tcp (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
tls (dict) --
A reference to an object that represents the Transport Layer Security (TLS) properties for a listener.
certificate (dict) --
A reference to an object that represents a listener's Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: acm, file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
acm (dict) --
A reference to an object that represents an AWS Certicate Manager (ACM) certificate.
certificateArn (string) --
The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
file (dict) --
A reference to an object that represents a local file certificate.
certificateChain (string) --
The certificate chain for the certificate.
privateKey (string) --
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a listener's Secret Discovery Service certificate.
secretName (string) --
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.
mode (string) --
Specify one of the following modes.
STRICT – Listener only accepts connections with TLS enabled.
PERMISSIVE – Listener accepts connections with or without TLS enabled.
DISABLED – Listener only accepts connections without TLS.
validation (dict) --
A reference to an object that represents a listener's Transport Layer Security (TLS) validation context.
subjectAlternativeNames (dict) --
A reference to an object that represents the SANs for a listener's Transport Layer Security (TLS) validation context.
match (dict) --
An object that represents the criteria for determining a SANs match.
exact (list) --
The values sent must match the specified values exactly.
(string) --
trust (dict) --
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
file (dict) --
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
certificateChain (string) --
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a listener's Transport Layer Security (TLS) Secret Discovery Service validation context trust.
secretName (string) --
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
logging (dict) --
The inbound and outbound access logging information for the virtual node.
accessLog (dict) --
The access log configuration for a virtual node.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: file. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
file (dict) --
The file object to send virtual node access logs to.
path (string) --
The file path to write access logs to. You can use /dev/stdout to send access logs to standard out and configure your Envoy container to use a log driver, such as awslogs , to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk.
Note
The Envoy process must have write permissions to the path that you specify here. Otherwise, Envoy fails to bootstrap properly.
serviceDiscovery (dict) --
The service discovery information for the virtual node. If your virtual node does not expect ingress traffic, you can omit this parameter. If you specify a listener , then you must specify service discovery information.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: awsCloudMap, dns. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
awsCloudMap (dict) --
Specifies any Cloud Map information for the virtual node.
attributes (list) --
A string map that contains attributes with values that you can use to filter instances by any custom attribute that you specified when you registered the instance. Only instances that match all of the specified key/value pairs will be returned.
(dict) --
An object that represents the Cloud Map attribute information for your virtual node.
Note
AWS Cloud Map is not available in the eu-south-1 Region.
key (string) --
The name of an Cloud Map service instance attribute key. Any Cloud Map service instance that contains the specified key and value is returned.
value (string) --
The value of an Cloud Map service instance attribute key. Any Cloud Map service instance that contains the specified key and value is returned.
namespaceName (string) --
The name of the Cloud Map namespace to use.
serviceName (string) --
The name of the Cloud Map service to use.
dns (dict) --
Specifies the DNS information for the virtual node.
hostname (string) --
Specifies the DNS service discovery hostname for the virtual node.
responseType (string) --
Specifies the DNS response type for the virtual node.
status (dict) --
The current status for the virtual node.
status (string) --
The current status of the virtual node.
virtualNodeName (string) --
The name of the virtual node.