Table of Contents
AppMesh.Client¶A low-level client representing AWS App Mesh
App Mesh is a service mesh based on the Envoy proxy that makes it easy to monitor and control microservices. App Mesh standardizes how your microservices communicate, giving you end-to-end visibility and helping to ensure high availability for your applications.
App Mesh gives you consistent visibility and network traffic controls for every microservice in an application. You can use App Mesh with Amazon Web Services Fargate, Amazon ECS, Amazon EKS, Kubernetes on Amazon Web Services, and Amazon EC2.
Note
App Mesh supports microservice applications that use service discovery naming for their components. For more information about service discovery on Amazon ECS, see Service Discovery in the Amazon Elastic Container Service Developer Guide . Kubernetes kube-dns and coredns are supported. For more information, see DNS for Services and Pods in the Kubernetes documentation.
import boto3
client = boto3.client('appmesh')
These are the available methods:
can_paginate()close()create_gateway_route()create_mesh()create_route()create_virtual_gateway()create_virtual_node()create_virtual_router()create_virtual_service()delete_gateway_route()delete_mesh()delete_route()delete_virtual_gateway()delete_virtual_node()delete_virtual_router()delete_virtual_service()describe_gateway_route()describe_mesh()describe_route()describe_virtual_gateway()describe_virtual_node()describe_virtual_router()describe_virtual_service()get_paginator()get_waiter()list_gateway_routes()list_meshes()list_routes()list_tags_for_resource()list_virtual_gateways()list_virtual_nodes()list_virtual_routers()list_virtual_services()tag_resource()untag_resource()update_gateway_route()update_mesh()update_route()update_virtual_gateway()update_virtual_node()update_virtual_router()update_virtual_service()can_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
create_gateway_route(**kwargs)¶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
response = client.create_gateway_route(
clientToken='string',
gatewayRouteName='string',
meshName='string',
meshOwner='string',
spec={
'grpcRoute': {
'action': {
'rewrite': {
'hostname': {
'defaultTargetHostname': 'ENABLED'|'DISABLED'
}
},
'target': {
'port': 123,
'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'
},
],
'port': 123,
'serviceName': 'string'
}
},
'http2Route': {
'action': {
'rewrite': {
'hostname': {
'defaultTargetHostname': 'ENABLED'|'DISABLED'
},
'path': {
'exact': 'string'
},
'prefix': {
'defaultPrefix': 'ENABLED'|'DISABLED',
'value': 'string'
}
},
'target': {
'port': 123,
'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'
},
'port': 123,
'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': {
'port': 123,
'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'
},
'port': 123,
'prefix': 'string',
'queryParameters': [
{
'match': {
'exact': 'string'
},
'name': 'string'
},
]
}
},
'priority': 123
},
tags=[
{
'key': 'string',
'value': 'string'
},
],
virtualGatewayName='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.
[REQUIRED]
The name to use for the gateway route.
[REQUIRED]
The name of the service mesh to create the gateway route in.
[REQUIRED]
The gateway route specification to apply.
An object that represents the specification of a gRPC gateway route.
An object that represents the action to take if a match is determined.
The gateway route action to rewrite.
The host name of the gateway route to rewrite.
The default target host name to write to.
An object that represents the target that traffic is routed to when a request matches the gateway route.
The port number of the gateway route target.
An object that represents a virtual service gateway route target.
The name of the virtual service that traffic is routed to.
An object that represents the criteria for determining a request match.
The gateway route host name to be matched on.
The exact host name to match on.
The specified ending characters of the host name to match on.
The gateway route metadata to be matched on.
An object representing the metadata of the gateway route.
Specify True to match anything except the match criteria. The default value is False .
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.
The exact method header to be matched on.
The specified beginning characters of the method header to be matched on.
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.
The end of the range.
The start of the range.
The regex used to match the method header.
The specified ending characters of the method header to match on.
A name for the gateway route metadata.
The port number to match from the request.
The fully qualified domain name for the service to match from the request.
An object that represents the specification of an HTTP/2 gateway route.
An object that represents the action to take if a match is determined.
The gateway route action to rewrite.
The host name to rewrite.
The default target host name to write to.
The path to rewrite.
The exact path to rewrite.
The specified beginning characters to rewrite.
The default prefix used to replace the incoming route prefix when rewritten.
The value used to replace the incoming route prefix when rewritten.
An object that represents the target that traffic is routed to when a request matches the gateway route.
The port number of the gateway route target.
An object that represents a virtual service gateway route target.
The name of the virtual service that traffic is routed to.
An object that represents the criteria for determining a request match.
The client request headers to match on.
An object that represents the HTTP header in the gateway route.
Specify True to match anything except the match criteria. The default value is False .
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.
The value sent by the client must match the specified value exactly.
The value sent by the client must begin with the specified characters.
An object that represents the range of values to match on.
The end of the range.
The start of the range.
The value sent by the client must include the specified characters.
The value sent by the client must end with the specified characters.
A name for the HTTP header in the gateway route that will be matched on.
The host name to match on.
The exact host name to match on.
The specified ending characters of the host name to match on.
The method to match on.
The path to match on.
The exact path to match on.
The regex used to match the path.
The port number to match on.
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 .
The query parameter to match on.
An object that represents the query parameter in the request.
The query parameter to match on.
The exact query parameter to match on.
A name for the query parameter that will be matched on.
An object that represents the specification of an HTTP gateway route.
An object that represents the action to take if a match is determined.
The gateway route action to rewrite.
The host name to rewrite.
The default target host name to write to.
The path to rewrite.
The exact path to rewrite.
The specified beginning characters to rewrite.
The default prefix used to replace the incoming route prefix when rewritten.
The value used to replace the incoming route prefix when rewritten.
An object that represents the target that traffic is routed to when a request matches the gateway route.
The port number of the gateway route target.
An object that represents a virtual service gateway route target.
The name of the virtual service that traffic is routed to.
An object that represents the criteria for determining a request match.
The client request headers to match on.
An object that represents the HTTP header in the gateway route.
Specify True to match anything except the match criteria. The default value is False .
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.
The value sent by the client must match the specified value exactly.
The value sent by the client must begin with the specified characters.
An object that represents the range of values to match on.
The end of the range.
The start of the range.
The value sent by the client must include the specified characters.
The value sent by the client must end with the specified characters.
A name for the HTTP header in the gateway route that will be matched on.
The host name to match on.
The exact host name to match on.
The specified ending characters of the host name to match on.
The method to match on.
The path to match on.
The exact path to match on.
The regex used to match the path.
The port number to match on.
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 .
The query parameter to match on.
An object that represents the query parameter in the request.
The query parameter to match on.
The exact query parameter to match on.
A name for the query parameter that will be matched on.
The ordering of the gateway routes spec.
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.
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.
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.
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
[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': {
'port': 123,
'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'
},
],
'port': 123,
'serviceName': 'string'
}
},
'http2Route': {
'action': {
'rewrite': {
'hostname': {
'defaultTargetHostname': 'ENABLED'|'DISABLED'
},
'path': {
'exact': 'string'
},
'prefix': {
'defaultPrefix': 'ENABLED'|'DISABLED',
'value': 'string'
}
},
'target': {
'port': 123,
'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'
},
'port': 123,
'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': {
'port': 123,
'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'
},
'port': 123,
'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 Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes .
resourceOwner (string) --
The Amazon Web Services 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.
port (integer) --
The port number of the gateway route target.
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.
port (integer) --
The port number to match from the request.
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.
port (integer) --
The port number of the gateway route target.
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.
port (integer) --
The port number to match on.
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.
port (integer) --
The port number of the gateway route target.
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.
port (integer) --
The port number to match on.
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.
Exceptions
AppMesh.Client.exceptions.NotFoundExceptionAppMesh.Client.exceptions.BadRequestExceptionAppMesh.Client.exceptions.ConflictExceptionAppMesh.Client.exceptions.TooManyRequestsExceptionAppMesh.Client.exceptions.ForbiddenExceptionAppMesh.Client.exceptions.ServiceUnavailableExceptionAppMesh.Client.exceptions.InternalServerErrorExceptionAppMesh.Client.exceptions.LimitExceededExceptioncreate_mesh(**kwargs)¶Creates a service mesh.
A service mesh is a logical boundary for network traffic between services that are represented by resources within the mesh. After you create your service mesh, you can create virtual services, virtual nodes, virtual routers, and routes to distribute traffic between the applications in your mesh.
For more information about service meshes, see Service meshes .
See also: AWS API Documentation
Request Syntax
response = client.create_mesh(
clientToken='string',
meshName='string',
spec={
'egressFilter': {
'type': 'ALLOW_ALL'|'DROP_ALL'
},
'serviceDiscovery': {
'ipPreference': 'IPv6_PREFERRED'|'IPv4_PREFERRED'|'IPv4_ONLY'|'IPv6_ONLY'
}
},
tags=[
{
'key': 'string',
'value': '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.
[REQUIRED]
The name to use for the service mesh.
The service mesh specification to apply.
The egress filter rules for the service mesh.
The egress filter type. By default, the type is DROP_ALL , which allows egress only from virtual nodes to other defined resources in the service mesh (and any traffic to *.amazonaws.com for Amazon Web Services API calls). You can set the egress filter type to ALLOW_ALL to allow egress to any endpoint inside or outside of the service mesh.
An object that represents the service discovery information for a service mesh.
The IP version to use to control traffic within the mesh.
Optional metadata that you can apply to the service mesh to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
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.
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.
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
dict
Response Syntax
{
'mesh': {
'meshName': 'string',
'metadata': {
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'meshOwner': 'string',
'resourceOwner': 'string',
'uid': 'string',
'version': 123
},
'spec': {
'egressFilter': {
'type': 'ALLOW_ALL'|'DROP_ALL'
},
'serviceDiscovery': {
'ipPreference': 'IPv6_PREFERRED'|'IPv4_PREFERRED'|'IPv4_ONLY'|'IPv6_ONLY'
}
},
'status': {
'status': 'ACTIVE'|'INACTIVE'|'DELETED'
}
}
}
Response Structure
(dict) --
mesh (dict) --
The full description of your service mesh following the create call.
meshName (string) --
The name of the service mesh.
metadata (dict) --
The associated metadata for the service mesh.
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 Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes .
resourceOwner (string) --
The Amazon Web Services 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 associated specification for the service mesh.
egressFilter (dict) --
The egress filter rules for the service mesh.
type (string) --
The egress filter type. By default, the type is DROP_ALL , which allows egress only from virtual nodes to other defined resources in the service mesh (and any traffic to *.amazonaws.com for Amazon Web Services API calls). You can set the egress filter type to ALLOW_ALL to allow egress to any endpoint inside or outside of the service mesh.
serviceDiscovery (dict) --
An object that represents the service discovery information for a service mesh.
ipPreference (string) --
The IP version to use to control traffic within the mesh.
status (dict) --
The status of the service mesh.
status (string) --
The current mesh status.
Exceptions
AppMesh.Client.exceptions.NotFoundExceptionAppMesh.Client.exceptions.BadRequestExceptionAppMesh.Client.exceptions.ConflictExceptionAppMesh.Client.exceptions.TooManyRequestsExceptionAppMesh.Client.exceptions.ForbiddenExceptionAppMesh.Client.exceptions.ServiceUnavailableExceptionAppMesh.Client.exceptions.InternalServerErrorExceptionAppMesh.Client.exceptions.LimitExceededExceptioncreate_route(**kwargs)¶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
response = client.create_route(
clientToken='string',
meshName='string',
meshOwner='string',
routeName='string',
spec={
'grpcRoute': {
'action': {
'weightedTargets': [
{
'port': 123,
'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',
'port': 123,
'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': [
{
'port': 123,
'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'
},
'port': 123,
'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': [
{
'port': 123,
'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'
},
'port': 123,
'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': [
{
'port': 123,
'virtualNode': 'string',
'weight': 123
},
]
},
'match': {
'port': 123
},
'timeout': {
'idle': {
'unit': 's'|'ms',
'value': 123
}
}
}
},
tags=[
{
'key': 'string',
'value': 'string'
},
],
virtualRouterName='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.
[REQUIRED]
The name of the service mesh to create the route in.
[REQUIRED]
The name to use for the route.
[REQUIRED]
The route specification to apply.
An object that represents the specification of a gRPC route.
An object that represents the action to take if a match is determined.
An object that represents the targets that traffic is routed to when a request matches the route.
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.
The targeted port of the weighted object.
The virtual node to associate with the weighted target.
The relative weight of the weighted target.
An object that represents the criteria for determining a request match.
An object that represents the data to match from the request.
An object that represents the match metadata for the route.
Specify True to match anything except the match criteria. The default value is False .
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.
The value sent by the client must match the specified value exactly.
The value sent by the client must begin with the specified characters.
An object that represents the range of values to match on.
The end of the range.
The start of the range.
The value sent by the client must include the specified characters.
The value sent by the client must end with the specified characters.
The name of the route.
The method name to match from the request. If you specify a name, you must also specify a serviceName .
The port number to match on.
The fully qualified domain name for the service to match from the request.
An object that represents a retry policy.
Specify at least one of the valid values.
Specify at least one of the following values.
The maximum number of retry attempts.
The timeout for each retry attempt.
A unit of time.
A number of time units.
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.
An object that represents types of timeouts.
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.
A unit of time.
A number of time units.
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.
A unit of time.
A number of time units.
An object that represents the specification of an HTTP/2 route.
An object that represents the action to take if a match is determined.
An object that represents the targets that traffic is routed to when a request matches the route.
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.
The targeted port of the weighted object.
The virtual node to associate with the weighted target.
The relative weight of the weighted target.
An object that represents the criteria for determining a request match.
The client request headers to match on.
An object that represents the HTTP header in the request.
Specify True to match anything except the match criteria. The default value is False .
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.
The value sent by the client must match the specified value exactly.
The value sent by the client must begin with the specified characters.
An object that represents the range of values to match on.
The end of the range.
The start of the range.
The value sent by the client must include the specified characters.
The value sent by the client must end with the specified characters.
A name for the HTTP header in the client request that will be matched on.
The client request method to match on. Specify only one.
The client request path to match on.
The exact path to match on.
The regex used to match the path.
The port number to match on.
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 .
The client request query parameters to match on.
An object that represents the query parameter in the request.
The query parameter to match on.
The exact query parameter to match on.
A name for the query parameter that will be matched on.
The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.
An object that represents a retry policy.
Specify at least one of the following values.
The maximum number of retry attempts.
The timeout for each retry attempt.
A unit of time.
A number of time units.
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.
An object that represents types of timeouts.
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.
A unit of time.
A number of time units.
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.
A unit of time.
A number of time units.
An object that represents the specification of an HTTP route.
An object that represents the action to take if a match is determined.
An object that represents the targets that traffic is routed to when a request matches the route.
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.
The targeted port of the weighted object.
The virtual node to associate with the weighted target.
The relative weight of the weighted target.
An object that represents the criteria for determining a request match.
The client request headers to match on.
An object that represents the HTTP header in the request.
Specify True to match anything except the match criteria. The default value is False .
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.
The value sent by the client must match the specified value exactly.
The value sent by the client must begin with the specified characters.
An object that represents the range of values to match on.
The end of the range.
The start of the range.
The value sent by the client must include the specified characters.
The value sent by the client must end with the specified characters.
A name for the HTTP header in the client request that will be matched on.
The client request method to match on. Specify only one.
The client request path to match on.
The exact path to match on.
The regex used to match the path.
The port number to match on.
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 .
The client request query parameters to match on.
An object that represents the query parameter in the request.
The query parameter to match on.
The exact query parameter to match on.
A name for the query parameter that will be matched on.
The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.
An object that represents a retry policy.
Specify at least one of the following values.
The maximum number of retry attempts.
The timeout for each retry attempt.
A unit of time.
A number of time units.
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.
An object that represents types of timeouts.
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.
A unit of time.
A number of time units.
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.
A unit of time.
A number of time units.
The priority for the route. Routes are matched based on the specified value, where 0 is the highest priority.
An object that represents the specification of a TCP route.
The action to take if a match is determined.
An object that represents the targets that traffic is routed to when a request matches the route.
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.
The targeted port of the weighted object.
The virtual node to associate with the weighted target.
The relative weight of the weighted target.
An object that represents the criteria for determining a request match.
The port number to match on.
An object that represents types of timeouts.
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.
A unit of time.
A number of time units.
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.
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.
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.
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
[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': [
{
'port': 123,
'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',
'port': 123,
'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': [
{
'port': 123,
'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'
},
'port': 123,
'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': [
{
'port': 123,
'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'
},
'port': 123,
'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': [
{
'port': 123,
'virtualNode': 'string',
'weight': 123
},
]
},
'match': {
'port': 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 Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes .
resourceOwner (string) --
The Amazon Web Services 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.
port (integer) --
The targeted port of the weighted object.
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 .
port (integer) --
The port number to match on.
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.
httpRetryEvents (list) --
Specify at least one of the following values.
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.
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.
port (integer) --
The targeted port of the weighted object.
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.
port (integer) --
The port number to match on.
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.
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.
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.
port (integer) --
The targeted port of the weighted object.
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.
port (integer) --
The port number to match on.
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.
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.
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.
port (integer) --
The targeted port of the weighted object.
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.
port (integer) --
The port number to match on.
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.
Exceptions
AppMesh.Client.exceptions.NotFoundExceptionAppMesh.Client.exceptions.BadRequestExceptionAppMesh.Client.exceptions.ConflictExceptionAppMesh.Client.exceptions.TooManyRequestsExceptionAppMesh.Client.exceptions.ForbiddenExceptionAppMesh.Client.exceptions.ServiceUnavailableExceptionAppMesh.Client.exceptions.InternalServerErrorExceptionAppMesh.Client.exceptions.LimitExceededExceptioncreate_virtual_gateway(**kwargs)¶Creates a virtual gateway.
A virtual gateway allows resources outside your mesh to communicate to resources that are inside your mesh. The virtual gateway represents an Envoy proxy running in an Amazon ECS task, in a Kubernetes service, or on an Amazon EC2 instance. Unlike a virtual node, which represents an Envoy running with an application, a virtual gateway represents Envoy deployed by itself.
For more information about virtual gateways, see Virtual gateways .
See also: AWS API Documentation
Request Syntax
response = client.create_virtual_gateway(
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'
}
}
}
}
}
},
'listeners': [
{
'connectionPool': {
'grpc': {
'maxRequests': 123
},
'http': {
'maxConnections': 123,
'maxPendingRequests': 123
},
'http2': {
'maxRequests': 123
}
},
'healthCheck': {
'healthyThreshold': 123,
'intervalMillis': 123,
'path': 'string',
'port': 123,
'protocol': 'http'|'http2'|'grpc',
'timeoutMillis': 123,
'unhealthyThreshold': 123
},
'portMapping': {
'port': 123,
'protocol': 'http'|'http2'|'grpc'
},
'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': {
'format': {
'json': [
{
'key': 'string',
'value': 'string'
},
],
'text': 'string'
},
'path': 'string'
}
}
}
},
tags=[
{
'key': 'string',
'value': 'string'
},
],
virtualGatewayName='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.
[REQUIRED]
The name of the service mesh to create the virtual gateway in.
[REQUIRED]
The virtual gateway specification to apply.
A reference to an object that represents the defaults for backends.
A reference to an object that represents a client policy.
A reference to an object that represents a Transport Layer Security (TLS) client policy.
A reference to an object that represents a virtual gateway's client'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.
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) .
The certificate chain for the certificate.
The private key for a certificate stored on the file system of the mesh endpoint that the proxy is running on.
A reference to an object that represents a virtual gateway's client's Secret Discovery Service certificate.
A reference to an object that represents the name of the secret secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.
Whether the policy is enforced. The default is True , if a value isn't specified.
One or more ports that the policy is enforced for.
A reference to an object that represents a Transport Layer Security (TLS) validation context.
A reference to an object that represents the SANs for a virtual gateway's listener's Transport Layer Security (TLS) validation context.
An object that represents the criteria for determining a SANs match.
The values sent must match the specified values exactly.
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.
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.
One or more ACM Amazon Resource Name (ARN)s.
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
A reference to an object that represents a virtual gateway's Transport Layer Security (TLS) Secret Discovery Service validation context trust.
A reference to an object that represents the name of the secret for a virtual gateway's Transport Layer Security (TLS) Secret Discovery Service validation context trust.
The listeners that the mesh endpoint is expected to receive inbound traffic from. You can specify one listener.
An object that represents a listener for a virtual gateway.
The connection pool information for the virtual gateway listener.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: grpc, http, http2.
An object that represents a type of connection pool.
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.
An object that represents a type of connection pool.
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.
Number of overflowing requests after max_connections Envoy will queue to upstream cluster.
An object that represents a type of connection pool.
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.
The health check information for the listener.
The number of consecutive successful health checks that must occur before declaring the listener healthy.
The time period in milliseconds between each health check execution.
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.
The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.
The protocol for the health check request. If you specify grpc , then your service must conform to the GRPC Health Checking Protocol .
The amount of time to wait when receiving a response from the health check, in milliseconds.
The number of consecutive failed health checks that must occur before declaring a virtual gateway unhealthy.
The port mapping information for the listener.
The port used for the port mapping. Specify one protocol.
The protocol used for the port mapping.
A reference to an object that represents the Transport Layer Security (TLS) properties for the listener.
An object that represents a 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.
A reference to an object that represents an Certificate Manager certificate.
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) .
A reference to an object that represents a local file certificate.
The certificate chain for the certificate.
The private key for a certificate stored on the file system of the mesh endpoint that the proxy is running on.
A reference to an object that represents a virtual gateway's listener's Secret Discovery Service certificate.
A reference to an object that represents the name of the secret secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.
Specify one of the following modes.
A reference to an object that represents a virtual gateway's listener's Transport Layer Security (TLS) validation context.
A reference to an object that represents the SANs for a virtual gateway listener's Transport Layer Security (TLS) validation context.
An object that represents the criteria for determining a SANs match.
The values sent must match the specified values exactly.
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.
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
A reference to an object that represents a virtual gateway's listener's Transport Layer Security (TLS) Secret Discovery Service validation context trust.
A reference to an object that represents the name of the secret for a virtual gateway's Transport Layer Security (TLS) Secret Discovery Service validation context trust.
An object that represents logging information.
The access log configuration.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: file.
The file object to send virtual gateway access logs to.
The specified format for the virtual gateway access logs. It can be either json_format or text_format .
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: json, text.
An object that represents the key value pairs for the JSON.
The specified key for the JSON.
The specified value for the JSON.
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.
Optional metadata that you can apply to the virtual gateway to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
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.
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.
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
[REQUIRED]
The name to use for the virtual gateway.
dict
Response Syntax
{
'virtualGateway': {
'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'
}
}
}
}
}
},
'listeners': [
{
'connectionPool': {
'grpc': {
'maxRequests': 123
},
'http': {
'maxConnections': 123,
'maxPendingRequests': 123
},
'http2': {
'maxRequests': 123
}
},
'healthCheck': {
'healthyThreshold': 123,
'intervalMillis': 123,
'path': 'string',
'port': 123,
'protocol': 'http'|'http2'|'grpc',
'timeoutMillis': 123,
'unhealthyThreshold': 123
},
'portMapping': {
'port': 123,
'protocol': 'http'|'http2'|'grpc'
},
'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': {
'format': {
'json': [
{
'key': 'string',
'value': 'string'
},
],
'text': 'string'
},
'path': 'string'
}
}
}
},
'status': {
'status': 'ACTIVE'|'INACTIVE'|'DELETED'
},
'virtualGatewayName': 'string'
}
}
Response Structure
(dict) --
virtualGateway (dict) --
The full description of your virtual gateway following the create call.
meshName (string) --
The name of the service mesh that the virtual gateway 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 Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes .
resourceOwner (string) --
The Amazon Web Services 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 gateway.
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 virtual gateway's client'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 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 mesh endpoint that the proxy is running on.
sds (dict) --
A reference to an object that represents a virtual gateway's client's Secret Discovery Service certificate.
secretName (string) --
A reference to an object that represents the name of the secret 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.
validation (dict) --
A reference to an object that represents a Transport Layer Security (TLS) validation context.
subjectAlternativeNames (dict) --
A reference to an object that represents the SANs for a virtual gateway's 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.
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.
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 virtual gateway'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 virtual gateway's Transport Layer Security (TLS) Secret Discovery Service validation context trust.
listeners (list) --
The listeners that the mesh endpoint is expected to receive inbound traffic from. You can specify one listener.
(dict) --
An object that represents a listener for a virtual gateway.
connectionPool (dict) --
The connection pool information for the virtual gateway listener.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: grpc, http, http2. 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.
healthCheck (dict) --
The health check information for the listener.
healthyThreshold (integer) --
The number of consecutive successful health checks that must occur before declaring the 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 gateway unhealthy.
portMapping (dict) --
The port mapping information for the listener.
port (integer) --
The port used for the port mapping. Specify one protocol.
protocol (string) --
The protocol used for the port mapping.
tls (dict) --
A reference to an object that represents the Transport Layer Security (TLS) properties for the listener.
certificate (dict) --
An object that represents a 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 Certificate Manager 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 mesh endpoint that the proxy is running on.
sds (dict) --
A reference to an object that represents a virtual gateway's listener's Secret Discovery Service certificate.
secretName (string) --
A reference to an object that represents the name of the secret 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.
validation (dict) --
A reference to an object that represents a virtual gateway's listener's Transport Layer Security (TLS) validation context.
subjectAlternativeNames (dict) --
A reference to an object that represents the SANs for a virtual gateway 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.
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 virtual gateway's 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 virtual gateway's Transport Layer Security (TLS) Secret Discovery Service validation context trust.
logging (dict) --
An object that represents logging information.
accessLog (dict) --
The access log configuration.
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 gateway access logs to.
format (dict) --
The specified format for the virtual gateway access logs. It can be either json_format or text_format .
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: json, text. 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'}
json (list) --
(dict) --
An object that represents the key value pairs for the JSON.
key (string) --
The specified key for the JSON.
value (string) --
The specified value for the JSON.
text (string) --
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.
status (dict) --
The current status of the virtual gateway.
status (string) --
The current status.
virtualGatewayName (string) --
The name of the virtual gateway.
Exceptions
AppMesh.Client.exceptions.NotFoundExceptionAppMesh.Client.exceptions.BadRequestExceptionAppMesh.Client.exceptions.ConflictExceptionAppMesh.Client.exceptions.TooManyRequestsExceptionAppMesh.Client.exceptions.ForbiddenExceptionAppMesh.Client.exceptions.ServiceUnavailableExceptionAppMesh.Client.exceptions.InternalServerErrorExceptionAppMesh.Client.exceptions.LimitExceededExceptioncreate_virtual_node(**kwargs)¶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 App Mesh User Guide.
See also: AWS API Documentation
Request Syntax
response = 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': {
'format': {
'json': [
{
'key': 'string',
'value': 'string'
},
],
'text': 'string'
},
'path': 'string'
}
}
},
'serviceDiscovery': {
'awsCloudMap': {
'attributes': [
{
'key': 'string',
'value': 'string'
},
],
'ipPreference': 'IPv6_PREFERRED'|'IPv4_PREFERRED'|'IPv4_ONLY'|'IPv6_ONLY',
'namespaceName': 'string',
'serviceName': 'string'
},
'dns': {
'hostname': 'string',
'ipPreference': 'IPv6_PREFERRED'|'IPv4_PREFERRED'|'IPv4_ONLY'|'IPv6_ONLY',
'responseType': 'LOADBALANCER'|'ENDPOINTS'
}
}
},
tags=[
{
'key': 'string',
'value': 'string'
},
],
virtualNodeName='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.
[REQUIRED]
The name of the service mesh to create the virtual node in.
[REQUIRED]
The virtual node specification to apply.
A reference to an object that represents the defaults for backends.
A reference to an object that represents a client policy.
A reference to an object that represents a Transport Layer Security (TLS) client policy.
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.
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) .
The certificate chain for the certificate.
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.
A reference to an object that represents a client's TLS Secret Discovery Service certificate.
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.
Whether the policy is enforced. The default is True , if a value isn't specified.
One or more ports that the policy is enforced for.
A reference to an object that represents a TLS validation context.
A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context. If you don't specify SANs on the terminating mesh endpoint, the Envoy proxy for that node doesn't verify the SAN on a peer client certificate. If you don't specify SANs on the originating mesh endpoint, the SAN on the certificate provided by the terminating endpoint must match the mesh endpoint service discovery configuration. Since SPIRE vended certificates have a SPIFFE ID as a name, you must set the SAN since the name doesn't match the service discovery name.
An object that represents the criteria for determining a SANs match.
The values sent must match the specified values exactly.
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.
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.
One or more ACM Amazon Resource Name (ARN)s.
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
A reference to an object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
The backends that the virtual node is expected to send outbound traffic to.
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.
Specifies a virtual service to use as a backend.
A reference to an object that represents the client policy for a backend.
A reference to an object that represents a Transport Layer Security (TLS) client policy.
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.
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) .
The certificate chain for the certificate.
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.
A reference to an object that represents a client's TLS Secret Discovery Service certificate.
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.
Whether the policy is enforced. The default is True , if a value isn't specified.
One or more ports that the policy is enforced for.
A reference to an object that represents a TLS validation context.
A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context. If you don't specify SANs on the terminating mesh endpoint, the Envoy proxy for that node doesn't verify the SAN on a peer client certificate. If you don't specify SANs on the originating mesh endpoint, the SAN on the certificate provided by the terminating endpoint must match the mesh endpoint service discovery configuration. Since SPIRE vended certificates have a SPIFFE ID as a name, you must set the SAN since the name doesn't match the service discovery name.
An object that represents the criteria for determining a SANs match.
The values sent must match the specified values exactly.
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.
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.
One or more ACM Amazon Resource Name (ARN)s.
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
A reference to an object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
The name of the virtual service that is acting as a virtual node backend.
The listener that the virtual node is expected to receive inbound traffic from. You can specify one listener.
An object that represents a listener for a virtual node.
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.
An object that represents a type of connection pool.
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.
An object that represents a type of connection pool.
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.
Number of overflowing requests after max_connections Envoy will queue to upstream cluster.
An object that represents a type of connection pool.
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.
An object that represents a type of connection pool.
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.
The health check information for the listener.
The number of consecutive successful health checks that must occur before declaring listener healthy.
The time period in milliseconds between each health check execution.
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.
The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.
The protocol for the health check request. If you specify grpc , then your service must conform to the GRPC Health Checking Protocol .
The amount of time to wait when receiving a response from the health check, in milliseconds.
The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.
The outlier detection information for the listener.
The base amount of time for which a host is ejected.
A unit of time.
A number of time units.
The time interval between ejection sweep analysis.
A unit of time.
A number of time units.
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.
Number of consecutive 5xx errors required for ejection.
The port mapping information for the listener.
The port used for the port mapping.
The protocol used for the port mapping. Specify one protocol.
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.
An object that represents types of timeouts.
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.
A unit of time.
A number of time units.
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.
A unit of time.
A number of time units.
An object that represents types of timeouts.
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.
A unit of time.
A number of time units.
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.
A unit of time.
A number of time units.
An object that represents types of timeouts.
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.
A unit of time.
A number of time units.
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.
A unit of time.
A number of time units.
An object that represents types of timeouts.
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.
A unit of time.
A number of time units.
A reference to an object that represents the Transport Layer Security (TLS) properties for a listener.
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.
A reference to an object that represents an Certificate Manager certificate.
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) .
A reference to an object that represents a local file certificate.
The certificate chain for the certificate.
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.
A reference to an object that represents a listener's Secret Discovery Service certificate.
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.
Specify one of the following modes.
A reference to an object that represents a listener's Transport Layer Security (TLS) validation context.
A reference to an object that represents the SANs for a listener's Transport Layer Security (TLS) validation context.
An object that represents the criteria for determining a SANs match.
The values sent must match the specified values exactly.
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.
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
A reference to an object that represents a listener's Transport Layer Security (TLS) Secret Discovery Service validation context trust.
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
The inbound and outbound access logging information for the virtual node.
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.
The file object to send virtual node access logs to.
The specified format for the logs. The format is either json_format or text_format .
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: json, text.
An object that represents the key value pairs for the JSON.
The specified key for the JSON.
The specified value for the JSON.
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> <p>The Envoy process must have write permissions to the path that you specify here. Otherwise, Envoy fails to bootstrap properly.</p> </note>
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.
Specifies any Cloud Map information for the virtual node.
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.
An object that represents the Cloud Map attribute information for your virtual node.
Note
Cloud Map is not available in the eu-south-1 Region.
The name of an Cloud Map service instance attribute key. Any Cloud Map service instance that contains the specified key and value is returned.
The value of an Cloud Map service instance attribute key. Any Cloud Map service instance that contains the specified key and value is returned.
The preferred IP version that this virtual node uses. Setting the IP preference on the virtual node only overrides the IP preference set for the mesh on this specific node.
The name of the Cloud Map namespace to use.
The name of the Cloud Map service to use.
Specifies the DNS information for the virtual node.
Specifies the DNS service discovery hostname for the virtual node.
The preferred IP version that this virtual node uses. Setting the IP preference on the virtual node only overrides the IP preference set for the mesh on this specific node.
Specifies the DNS response type for the virtual node.
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.
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.
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.
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
[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': {
'format': {
'json': [
{
'key': 'string',
'value': 'string'
},
],
'text': 'string'
},
'path': 'string'
}
}
},
'serviceDiscovery': {
'awsCloudMap': {
'attributes': [
{
'key': 'string',
'value': 'string'
},
],
'ipPreference': 'IPv6_PREFERRED'|'IPv4_PREFERRED'|'IPv4_ONLY'|'IPv6_ONLY',
'namespaceName': 'string',
'serviceName': 'string'
},
'dns': {
'hostname': 'string',
'ipPreference': 'IPv6_PREFERRED'|'IPv4_PREFERRED'|'IPv4_ONLY'|'IPv6_ONLY',
'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 Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes .
resourceOwner (string) --
The Amazon Web Services 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.
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. If you don't specify SANs on the terminating mesh endpoint, the Envoy proxy for that node doesn't verify the SAN on a peer client certificate. If you don't specify SANs on the originating mesh endpoint, the SAN on the certificate provided by the terminating endpoint must match the mesh endpoint service discovery configuration. Since SPIRE vended certificates have a SPIFFE ID as a name, you must set the SAN since the name doesn't match the service discovery name.
match (dict) --
An object that represents the criteria for determining a SANs match.
exact (list) --
The values sent must match the specified values exactly.
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.
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.
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. If you don't specify SANs on the terminating mesh endpoint, the Envoy proxy for that node doesn't verify the SAN on a peer client certificate. If you don't specify SANs on the originating mesh endpoint, the SAN on the certificate provided by the terminating endpoint must match the mesh endpoint service discovery configuration. Since SPIRE vended certificates have a SPIFFE ID as a name, you must set the SAN since the name doesn't match the service discovery name.
match (dict) --
An object that represents the criteria for determining a SANs match.
exact (list) --
The values sent must match the specified values exactly.
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.
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 Certificate Manager 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.
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.
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.
format (dict) --
The specified format for the logs. The format is either json_format or text_format .
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: json, text. 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'}
json (list) --
(dict) --
An object that represents the key value pairs for the JSON.
key (string) --
The specified key for the JSON.
value (string) --
The specified value for the JSON.
text (string) --
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> <p>The Envoy process must have write permissions to the path that you specify here. Otherwise, Envoy fails to bootstrap properly.</p> </note>
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
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.
ipPreference (string) --
The preferred IP version that this virtual node uses. Setting the IP preference on the virtual node only overrides the IP preference set for the mesh on this specific node.
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.
ipPreference (string) --
The preferred IP version that this virtual node uses. Setting the IP preference on the virtual node only overrides the IP preference set for the mesh on this specific 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.
Exceptions
AppMesh.Client.exceptions.NotFoundExceptionAppMesh.Client.exceptions.BadRequestExceptionAppMesh.Client.exceptions.ConflictExceptionAppMesh.Client.exceptions.TooManyRequestsExceptionAppMesh.Client.exceptions.ForbiddenExceptionAppMesh.Client.exceptions.ServiceUnavailableExceptionAppMesh.Client.exceptions.InternalServerErrorExceptionAppMesh.Client.exceptions.LimitExceededExceptioncreate_virtual_router(**kwargs)¶Creates a virtual router within a service mesh.
Specify a listener for any inbound traffic that your virtual router receives. Create a virtual router for each protocol and port that you need to route. Virtual routers handle traffic for one or more virtual services within your mesh. After you create your virtual router, create and associate routes for your virtual router that direct incoming requests to different virtual nodes.
For more information about virtual routers, see Virtual routers .
See also: AWS API Documentation
Request Syntax
response = client.create_virtual_router(
clientToken='string',
meshName='string',
meshOwner='string',
spec={
'listeners': [
{
'portMapping': {
'port': 123,
'protocol': 'http'|'tcp'|'http2'|'grpc'
}
},
]
},
tags=[
{
'key': 'string',
'value': 'string'
},
],
virtualRouterName='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.
[REQUIRED]
The name of the service mesh to create the virtual router in.
[REQUIRED]
The virtual router specification to apply.
The listeners that the virtual router is expected to receive inbound traffic from. You can specify one listener.
An object that represents a virtual router listener.
An object that represents a port mapping.
The port used for the port mapping.
The protocol used for the port mapping. Specify one protocol.
Optional metadata that you can apply to the virtual router to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
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.
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.
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
[REQUIRED]
The name to use for the virtual router.
dict
Response Syntax
{
'virtualRouter': {
'meshName': 'string',
'metadata': {
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'meshOwner': 'string',
'resourceOwner': 'string',
'uid': 'string',
'version': 123
},
'spec': {
'listeners': [
{
'portMapping': {
'port': 123,
'protocol': 'http'|'tcp'|'http2'|'grpc'
}
},
]
},
'status': {
'status': 'ACTIVE'|'INACTIVE'|'DELETED'
},
'virtualRouterName': 'string'
}
}
Response Structure
(dict) --
virtualRouter (dict) --
The full description of your virtual router following the create call.
meshName (string) --
The name of the service mesh that the virtual router resides in.
metadata (dict) --
The associated metadata for the virtual router.
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 Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes .
resourceOwner (string) --
The Amazon Web Services 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 router.
listeners (list) --
The listeners that the virtual router is expected to receive inbound traffic from. You can specify one listener.
(dict) --
An object that represents a virtual router listener.
portMapping (dict) --
An object that represents a port mapping.
port (integer) --
The port used for the port mapping.
protocol (string) --
The protocol used for the port mapping. Specify one protocol.
status (dict) --
The current status of the virtual router.
status (string) --
The current status of the virtual router.
virtualRouterName (string) --
The name of the virtual router.
Exceptions
AppMesh.Client.exceptions.NotFoundExceptionAppMesh.Client.exceptions.BadRequestExceptionAppMesh.Client.exceptions.ConflictExceptionAppMesh.Client.exceptions.TooManyRequestsExceptionAppMesh.Client.exceptions.ForbiddenExceptionAppMesh.Client.exceptions.ServiceUnavailableExceptionAppMesh.Client.exceptions.InternalServerErrorExceptionAppMesh.Client.exceptions.LimitExceededExceptioncreate_virtual_service(**kwargs)¶Creates a virtual service within a service mesh.
A virtual service is an abstraction of a real service that is provided by a virtual node directly or indirectly by means of a virtual router. Dependent services call your virtual service by its virtualServiceName , and those requests are routed to the virtual node or virtual router that is specified as the provider for the virtual service.
For more information about virtual services, see Virtual services .
See also: AWS API Documentation
Request Syntax
response = client.create_virtual_service(
clientToken='string',
meshName='string',
meshOwner='string',
spec={
'provider': {
'virtualNode': {
'virtualNodeName': 'string'
},
'virtualRouter': {
'virtualRouterName': 'string'
}
}
},
tags=[
{
'key': 'string',
'value': 'string'
},
],
virtualServiceName='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.
[REQUIRED]
The name of the service mesh to create the virtual service in.
[REQUIRED]
The virtual service specification to apply.
The App Mesh object that is acting as the provider for a virtual service. You can specify a single virtual node or virtual router.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: virtualNode, virtualRouter.
The virtual node associated with a virtual service.
The name of the virtual node that is acting as a service provider.
The virtual router associated with a virtual service.
The name of the virtual router that is acting as a service provider.
Optional metadata that you can apply to the virtual service to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
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.
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.
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
[REQUIRED]
The name to use for the virtual service.
dict
Response Syntax
{
'virtualService': {
'meshName': 'string',
'metadata': {
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'meshOwner': 'string',
'resourceOwner': 'string',
'uid': 'string',
'version': 123
},
'spec': {
'provider': {
'virtualNode': {
'virtualNodeName': 'string'
},
'virtualRouter': {
'virtualRouterName': 'string'
}
}
},
'status': {
'status': 'ACTIVE'|'INACTIVE'|'DELETED'
},
'virtualServiceName': 'string'
}
}
Response Structure
(dict) --
virtualService (dict) --
The full description of your virtual service following the create call.
meshName (string) --
The name of the service mesh that the virtual service 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 Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes .
resourceOwner (string) --
The Amazon Web Services 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 service.
provider (dict) --
The App Mesh object that is acting as the provider for a virtual service. You can specify a single virtual node or virtual router.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: virtualNode, virtualRouter. 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'}
virtualNode (dict) --
The virtual node associated with a virtual service.
virtualNodeName (string) --
The name of the virtual node that is acting as a service provider.
virtualRouter (dict) --
The virtual router associated with a virtual service.
virtualRouterName (string) --
The name of the virtual router that is acting as a service provider.
status (dict) --
The current status of the virtual service.
status (string) --
The current status of the virtual service.
virtualServiceName (string) --
The name of the virtual service.
Exceptions
AppMesh.Client.exceptions.NotFoundExceptionAppMesh.Client.exceptions.BadRequestExceptionAppMesh.Client.exceptions.ConflictExceptionAppMesh.Client.exceptions.TooManyRequestsExceptionAppMesh.Client.exceptions.ForbiddenExceptionAppMesh.Client.exceptions.ServiceUnavailableExceptionAppMesh.Client.exceptions.InternalServerErrorExceptionAppMesh.Client.exceptions.LimitExceededExceptiondelete_gateway_route(**kwargs)¶Deletes an existing gateway route.
See also: AWS API Documentation
Request Syntax
response = client.delete_gateway_route(
gatewayRouteName='string',
meshName='string',
meshOwner='string',
virtualGatewayName='string'
)
[REQUIRED]
The name of the gateway route to delete.
[REQUIRED]
The name of the service mesh to delete the gateway route from.
[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': {
'port': 123,
'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'
},
],
'port': 123,
'serviceName': 'string'
}
},
'http2Route': {
'action': {
'rewrite': {
'hostname': {
'defaultTargetHostname': 'ENABLED'|'DISABLED'
},
'path': {
'exact': 'string'
},
'prefix': {
'defaultPrefix': 'ENABLED'|'DISABLED',
'value': 'string'
}
},
'target': {
'port': 123,
'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'
},
'port': 123,
'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': {
'port': 123,
'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'
},
'port': 123,
'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 Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes .
resourceOwner (string) --
The Amazon Web Services 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.
port (integer) --
The port number of the gateway route target.
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.
port (integer) --
The port number to match from the request.
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.
port (integer) --
The port number of the gateway route target.
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.
port (integer) --
The port number to match on.
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.
port (integer) --
The port number of the gateway route target.
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.
port (integer) --
The port number to match on.
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.
Exceptions
AppMesh.Client.exceptions.NotFoundExceptionAppMesh.Client.exceptions.BadRequestExceptionAppMesh.Client.exceptions.TooManyRequestsExceptionAppMesh.Client.exceptions.ForbiddenExceptionAppMesh.Client.exceptions.ResourceInUseExceptionAppMesh.Client.exceptions.ServiceUnavailableExceptionAppMesh.Client.exceptions.InternalServerErrorExceptiondelete_mesh(**kwargs)¶Deletes an existing service mesh.
You must delete all resources (virtual services, routes, virtual routers, and virtual nodes) in the service mesh before you can delete the mesh itself.
See also: AWS API Documentation
Request Syntax
response = client.delete_mesh(
meshName='string'
)
[REQUIRED]
The name of the service mesh to delete.
{
'mesh': {
'meshName': 'string',
'metadata': {
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'meshOwner': 'string',
'resourceOwner': 'string',
'uid': 'string',
'version': 123
},
'spec': {
'egressFilter': {
'type': 'ALLOW_ALL'|'DROP_ALL'
},
'serviceDiscovery': {
'ipPreference': 'IPv6_PREFERRED'|'IPv4_PREFERRED'|'IPv4_ONLY'|'IPv6_ONLY'
}
},
'status': {
'status': 'ACTIVE'|'INACTIVE'|'DELETED'
}
}
}
Response Structure
The service mesh that was deleted.
The name of the service mesh.
The associated metadata for the service mesh.
The full Amazon Resource Name (ARN) for the resource.
The Unix epoch timestamp in seconds for when the resource was created.
The Unix epoch timestamp in seconds for when the resource was last updated.
The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes .
The Amazon Web Services 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 .
The unique identifier for the resource.
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
The associated specification for the service mesh.
The egress filter rules for the service mesh.
The egress filter type. By default, the type is DROP_ALL , which allows egress only from virtual nodes to other defined resources in the service mesh (and any traffic to *.amazonaws.com for Amazon Web Services API calls). You can set the egress filter type to ALLOW_ALL to allow egress to any endpoint inside or outside of the service mesh.
An object that represents the service discovery information for a service mesh.
The IP version to use to control traffic within the mesh.
The status of the service mesh.
The current mesh status.
Exceptions
AppMesh.Client.exceptions.NotFoundExceptionAppMesh.Client.exceptions.BadRequestExceptionAppMesh.Client.exceptions.TooManyRequestsExceptionAppMesh.Client.exceptions.ForbiddenExceptionAppMesh.Client.exceptions.ResourceInUseExceptionAppMesh.Client.exceptions.ServiceUnavailableExceptionAppMesh.Client.exceptions.InternalServerErrorExceptiondelete_route(**kwargs)¶Deletes an existing route.
See also: AWS API Documentation
Request Syntax
response = client.delete_route(
meshName='string',
meshOwner='string',
routeName='string',
virtualRouterName='string'
)
[REQUIRED]
The name of the service mesh to delete the route in.
[REQUIRED]
The name of the route to delete.
[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': [
{
'port': 123,
'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',
'port': 123,
'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': [
{
'port': 123,
'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'
},
'port': 123,
'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': [
{
'port': 123,
'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'
},
'port': 123,
'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': [
{
'port': 123,
'virtualNode': 'string',
'weight': 123
},
]
},
'match': {
'port': 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 Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes .
resourceOwner (string) --
The Amazon Web Services 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.
port (integer) --
The targeted port of the weighted object.
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 .
port (integer) --
The port number to match on.
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.
httpRetryEvents (list) --
Specify at least one of the following values.
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.
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.
port (integer) --
The targeted port of the weighted object.
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.
port (integer) --
The port number to match on.
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.
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.
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.
port (integer) --
The targeted port of the weighted object.
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.
port (integer) --
The port number to match on.
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.
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.
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.
port (integer) --
The targeted port of the weighted object.
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.
port (integer) --
The port number to match on.
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.
Exceptions
AppMesh.Client.exceptions.NotFoundExceptionAppMesh.Client.exceptions.BadRequestExceptionAppMesh.Client.exceptions.TooManyRequestsExceptionAppMesh.Client.exceptions.ForbiddenExceptionAppMesh.Client.exceptions.ResourceInUseExceptionAppMesh.Client.exceptions.ServiceUnavailableExceptionAppMesh.Client.exceptions.InternalServerErrorExceptiondelete_virtual_gateway(**kwargs)¶Deletes an existing virtual gateway. You cannot delete a virtual gateway if any gateway routes are associated to it.
See also: AWS API Documentation
Request Syntax
response = client.delete_virtual_gateway(
meshName='string',
meshOwner='string',
virtualGatewayName='string'
)
[REQUIRED]
The name of the service mesh to delete the virtual gateway from.
[REQUIRED]
The name of the virtual gateway to delete.
dict
Response Syntax
{
'virtualGateway': {
'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'
}
}
}
}
}
},
'listeners': [
{
'connectionPool': {
'grpc': {
'maxRequests': 123
},
'http': {
'maxConnections': 123,
'maxPendingRequests': 123
},
'http2': {
'maxRequests': 123
}
},
'healthCheck': {
'healthyThreshold': 123,
'intervalMillis': 123,
'path': 'string',
'port': 123,
'protocol': 'http'|'http2'|'grpc',
'timeoutMillis': 123,
'unhealthyThreshold': 123
},
'portMapping': {
'port': 123,
'protocol': 'http'|'http2'|'grpc'
},
'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': {
'format': {
'json': [
{
'key': 'string',
'value': 'string'
},
],
'text': 'string'
},
'path': 'string'
}
}
}
},
'status': {
'status': 'ACTIVE'|'INACTIVE'|'DELETED'
},
'virtualGatewayName': 'string'
}
}
Response Structure
(dict) --
virtualGateway (dict) --
The virtual gateway that was deleted.
meshName (string) --
The name of the service mesh that the virtual gateway 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 Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes .
resourceOwner (string) --
The Amazon Web Services 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 gateway.
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 virtual gateway's client'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 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 mesh endpoint that the proxy is running on.
sds (dict) --
A reference to an object that represents a virtual gateway's client's Secret Discovery Service certificate.
secretName (string) --
A reference to an object that represents the name of the secret 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.
validation (dict) --
A reference to an object that represents a Transport Layer Security (TLS) validation context.
subjectAlternativeNames (dict) --
A reference to an object that represents the SANs for a virtual gateway's 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.
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.
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 virtual gateway'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 virtual gateway's Transport Layer Security (TLS) Secret Discovery Service validation context trust.
listeners (list) --
The listeners that the mesh endpoint is expected to receive inbound traffic from. You can specify one listener.
(dict) --
An object that represents a listener for a virtual gateway.
connectionPool (dict) --
The connection pool information for the virtual gateway listener.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: grpc, http, http2. 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.
healthCheck (dict) --
The health check information for the listener.
healthyThreshold (integer) --
The number of consecutive successful health checks that must occur before declaring the 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 gateway unhealthy.
portMapping (dict) --
The port mapping information for the listener.
port (integer) --
The port used for the port mapping. Specify one protocol.
protocol (string) --
The protocol used for the port mapping.
tls (dict) --
A reference to an object that represents the Transport Layer Security (TLS) properties for the listener.
certificate (dict) --
An object that represents a 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 Certificate Manager 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 mesh endpoint that the proxy is running on.
sds (dict) --
A reference to an object that represents a virtual gateway's listener's Secret Discovery Service certificate.
secretName (string) --
A reference to an object that represents the name of the secret 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.
validation (dict) --
A reference to an object that represents a virtual gateway's listener's Transport Layer Security (TLS) validation context.
subjectAlternativeNames (dict) --
A reference to an object that represents the SANs for a virtual gateway 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.
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 virtual gateway's 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 virtual gateway's Transport Layer Security (TLS) Secret Discovery Service validation context trust.
logging (dict) --
An object that represents logging information.
accessLog (dict) --
The access log configuration.
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 gateway access logs to.
format (dict) --
The specified format for the virtual gateway access logs. It can be either json_format or text_format .
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: json, text. 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'}
json (list) --
(dict) --
An object that represents the key value pairs for the JSON.
key (string) --
The specified key for the JSON.
value (string) --
The specified value for the JSON.
text (string) --
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.
status (dict) --
The current status of the virtual gateway.
status (string) --
The current status.
virtualGatewayName (string) --
The name of the virtual gateway.
Exceptions
AppMesh.Client.exceptions.NotFoundExceptionAppMesh.Client.exceptions.BadRequestExceptionAppMesh.Client.exceptions.TooManyRequestsExceptionAppMesh.Client.exceptions.ForbiddenExceptionAppMesh.Client.exceptions.ResourceInUseExceptionAppMesh.Client.exceptions.ServiceUnavailableExceptionAppMesh.Client.exceptions.InternalServerErrorExceptiondelete_virtual_node(**kwargs)¶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
response = client.delete_virtual_node(
meshName='string',
meshOwner='string',
virtualNodeName='string'
)
[REQUIRED]
The name of the service mesh to delete the virtual node in.
[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': {
'format': {
'json': [
{
'key': 'string',
'value': 'string'
},
],
'text': 'string'
},
'path': 'string'
}
}
},
'serviceDiscovery': {
'awsCloudMap': {
'attributes': [
{
'key': 'string',
'value': 'string'
},
],
'ipPreference': 'IPv6_PREFERRED'|'IPv4_PREFERRED'|'IPv4_ONLY'|'IPv6_ONLY',
'namespaceName': 'string',
'serviceName': 'string'
},
'dns': {
'hostname': 'string',
'ipPreference': 'IPv6_PREFERRED'|'IPv4_PREFERRED'|'IPv4_ONLY'|'IPv6_ONLY',
'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 Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes .
resourceOwner (string) --
The Amazon Web Services 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.
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. If you don't specify SANs on the terminating mesh endpoint, the Envoy proxy for that node doesn't verify the SAN on a peer client certificate. If you don't specify SANs on the originating mesh endpoint, the SAN on the certificate provided by the terminating endpoint must match the mesh endpoint service discovery configuration. Since SPIRE vended certificates have a SPIFFE ID as a name, you must set the SAN since the name doesn't match the service discovery name.
match (dict) --
An object that represents the criteria for determining a SANs match.
exact (list) --
The values sent must match the specified values exactly.
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.
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.
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. If you don't specify SANs on the terminating mesh endpoint, the Envoy proxy for that node doesn't verify the SAN on a peer client certificate. If you don't specify SANs on the originating mesh endpoint, the SAN on the certificate provided by the terminating endpoint must match the mesh endpoint service discovery configuration. Since SPIRE vended certificates have a SPIFFE ID as a name, you must set the SAN since the name doesn't match the service discovery name.
match (dict) --
An object that represents the criteria for determining a SANs match.
exact (list) --
The values sent must match the specified values exactly.
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.
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 Certificate Manager 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.
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.
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.
format (dict) --
The specified format for the logs. The format is either json_format or text_format .
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: json, text. 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'}
json (list) --
(dict) --
An object that represents the key value pairs for the JSON.
key (string) --
The specified key for the JSON.
value (string) --
The specified value for the JSON.
text (string) --
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> <p>The Envoy process must have write permissions to the path that you specify here. Otherwise, Envoy fails to bootstrap properly.</p> </note>
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
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.
ipPreference (string) --
The preferred IP version that this virtual node uses. Setting the IP preference on the virtual node only overrides the IP preference set for the mesh on this specific node.
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.
ipPreference (string) --
The preferred IP version that this virtual node uses. Setting the IP preference on the virtual node only overrides the IP preference set for the mesh on this specific 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.
Exceptions
AppMesh.Client.exceptions.NotFoundExceptionAppMesh.Client.exceptions.BadRequestExceptionAppMesh.Client.exceptions.TooManyRequestsExceptionAppMesh.Client.exceptions.ForbiddenExceptionAppMesh.Client.exceptions.ResourceInUseExceptionAppMesh.Client.exceptions.ServiceUnavailableExceptionAppMesh.Client.exceptions.InternalServerErrorExceptiondelete_virtual_router(**kwargs)¶Deletes an existing virtual router.
You must delete any routes associated with the virtual router before you can delete the router itself.
See also: AWS API Documentation
Request Syntax
response = client.delete_virtual_router(
meshName='string',
meshOwner='string',
virtualRouterName='string'
)
[REQUIRED]
The name of the service mesh to delete the virtual router in.
[REQUIRED]
The name of the virtual router to delete.
dict
Response Syntax
{
'virtualRouter': {
'meshName': 'string',
'metadata': {
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'meshOwner': 'string',
'resourceOwner': 'string',
'uid': 'string',
'version': 123
},
'spec': {
'listeners': [
{
'portMapping': {
'port': 123,
'protocol': 'http'|'tcp'|'http2'|'grpc'
}
},
]
},
'status': {
'status': 'ACTIVE'|'INACTIVE'|'DELETED'
},
'virtualRouterName': 'string'
}
}
Response Structure
(dict) --
virtualRouter (dict) --
The virtual router that was deleted.
meshName (string) --
The name of the service mesh that the virtual router resides in.
metadata (dict) --
The associated metadata for the virtual router.
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 Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes .
resourceOwner (string) --
The Amazon Web Services 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 router.
listeners (list) --
The listeners that the virtual router is expected to receive inbound traffic from. You can specify one listener.
(dict) --
An object that represents a virtual router listener.
portMapping (dict) --
An object that represents a port mapping.
port (integer) --
The port used for the port mapping.
protocol (string) --
The protocol used for the port mapping. Specify one protocol.
status (dict) --
The current status of the virtual router.
status (string) --
The current status of the virtual router.
virtualRouterName (string) --
The name of the virtual router.
Exceptions
AppMesh.Client.exceptions.NotFoundExceptionAppMesh.Client.exceptions.BadRequestExceptionAppMesh.Client.exceptions.TooManyRequestsExceptionAppMesh.Client.exceptions.ForbiddenExceptionAppMesh.Client.exceptions.ResourceInUseExceptionAppMesh.Client.exceptions.ServiceUnavailableExceptionAppMesh.Client.exceptions.InternalServerErrorExceptiondelete_virtual_service(**kwargs)¶Deletes an existing virtual service.
See also: AWS API Documentation
Request Syntax
response = client.delete_virtual_service(
meshName='string',
meshOwner='string',
virtualServiceName='string'
)
[REQUIRED]
The name of the service mesh to delete the virtual service in.
[REQUIRED]
The name of the virtual service to delete.
dict
Response Syntax
{
'virtualService': {
'meshName': 'string',
'metadata': {
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'meshOwner': 'string',
'resourceOwner': 'string',
'uid': 'string',
'version': 123
},
'spec': {
'provider': {
'virtualNode': {
'virtualNodeName': 'string'
},
'virtualRouter': {
'virtualRouterName': 'string'
}
}
},
'status': {
'status': 'ACTIVE'|'INACTIVE'|'DELETED'
},
'virtualServiceName': 'string'
}
}
Response Structure
(dict) --
virtualService (dict) --
The virtual service that was deleted.
meshName (string) --
The name of the service mesh that the virtual service 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 Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes .
resourceOwner (string) --
The Amazon Web Services 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 service.
provider (dict) --
The App Mesh object that is acting as the provider for a virtual service. You can specify a single virtual node or virtual router.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: virtualNode, virtualRouter. 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'}
virtualNode (dict) --
The virtual node associated with a virtual service.
virtualNodeName (string) --
The name of the virtual node that is acting as a service provider.
virtualRouter (dict) --
The virtual router associated with a virtual service.
virtualRouterName (string) --
The name of the virtual router that is acting as a service provider.
status (dict) --
The current status of the virtual service.
status (string) --
The current status of the virtual service.
virtualServiceName (string) --
The name of the virtual service.
Exceptions
AppMesh.Client.exceptions.NotFoundExceptionAppMesh.Client.exceptions.BadRequestExceptionAppMesh.Client.exceptions.TooManyRequestsExceptionAppMesh.Client.exceptions.ForbiddenExceptionAppMesh.Client.exceptions.ResourceInUseExceptionAppMesh.Client.exceptions.ServiceUnavailableExceptionAppMesh.Client.exceptions.InternalServerErrorExceptiondescribe_gateway_route(**kwargs)¶Describes an existing gateway route.
See also: AWS API Documentation
Request Syntax
response = client.describe_gateway_route(
gatewayRouteName='string',
meshName='string',
meshOwner='string',
virtualGatewayName='string'
)
[REQUIRED]
The name of the gateway route to describe.
[REQUIRED]
The name of the service mesh that the gateway route resides in.
[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': {
'port': 123,
'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'
},
],
'port': 123,
'serviceName': 'string'
}
},
'http2Route': {
'action': {
'rewrite': {
'hostname': {
'defaultTargetHostname': 'ENABLED'|'DISABLED'
},
'path': {
'exact': 'string'
},
'prefix': {
'defaultPrefix': 'ENABLED'|'DISABLED',
'value': 'string'
}
},
'target': {
'port': 123,
'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'
},
'port': 123,
'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': {
'port': 123,
'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'
},
'port': 123,
'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 Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes .
resourceOwner (string) --
The Amazon Web Services 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.
port (integer) --
The port number of the gateway route target.
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.
port (integer) --
The port number to match from the request.
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.
port (integer) --
The port number of the gateway route target.
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.
port (integer) --
The port number to match on.
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.
port (integer) --
The port number of the gateway route target.
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.
port (integer) --
The port number to match on.
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.
Exceptions
AppMesh.Client.exceptions.NotFoundExceptionAppMesh.Client.exceptions.BadRequestExceptionAppMesh.Client.exceptions.TooManyRequestsExceptionAppMesh.Client.exceptions.ForbiddenExceptionAppMesh.Client.exceptions.ServiceUnavailableExceptionAppMesh.Client.exceptions.InternalServerErrorExceptiondescribe_mesh(**kwargs)¶Describes an existing service mesh.
See also: AWS API Documentation
Request Syntax
response = client.describe_mesh(
meshName='string',
meshOwner='string'
)
[REQUIRED]
The name of the service mesh to describe.
dict
Response Syntax
{
'mesh': {
'meshName': 'string',
'metadata': {
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'meshOwner': 'string',
'resourceOwner': 'string',
'uid': 'string',
'version': 123
},
'spec': {
'egressFilter': {
'type': 'ALLOW_ALL'|'DROP_ALL'
},
'serviceDiscovery': {
'ipPreference': 'IPv6_PREFERRED'|'IPv4_PREFERRED'|'IPv4_ONLY'|'IPv6_ONLY'
}
},
'status': {
'status': 'ACTIVE'|'INACTIVE'|'DELETED'
}
}
}
Response Structure
(dict) --
mesh (dict) --
The full description of your service mesh.
meshName (string) --
The name of the service mesh.
metadata (dict) --
The associated metadata for the service mesh.
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 Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes .
resourceOwner (string) --
The Amazon Web Services 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 associated specification for the service mesh.
egressFilter (dict) --
The egress filter rules for the service mesh.
type (string) --
The egress filter type. By default, the type is DROP_ALL , which allows egress only from virtual nodes to other defined resources in the service mesh (and any traffic to *.amazonaws.com for Amazon Web Services API calls). You can set the egress filter type to ALLOW_ALL to allow egress to any endpoint inside or outside of the service mesh.
serviceDiscovery (dict) --
An object that represents the service discovery information for a service mesh.
ipPreference (string) --
The IP version to use to control traffic within the mesh.
status (dict) --
The status of the service mesh.
status (string) --
The current mesh status.
Exceptions
AppMesh.Client.exceptions.NotFoundExceptionAppMesh.Client.exceptions.BadRequestExceptionAppMesh.Client.exceptions.TooManyRequestsExceptionAppMesh.Client.exceptions.ForbiddenExceptionAppMesh.Client.exceptions.ServiceUnavailableExceptionAppMesh.Client.exceptions.InternalServerErrorExceptiondescribe_route(**kwargs)¶Describes an existing route.
See also: AWS API Documentation
Request Syntax
response = client.describe_route(
meshName='string',
meshOwner='string',
routeName='string',
virtualRouterName='string'
)
[REQUIRED]
The name of the service mesh that the route resides in.
[REQUIRED]
The name of the route to describe.
[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': [
{
'port': 123,
'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',
'port': 123,
'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': [
{
'port': 123,
'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'
},
'port': 123,
'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': [
{
'port': 123,
'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'
},
'port': 123,
'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': [
{
'port': 123,
'virtualNode': 'string',
'weight': 123
},
]
},
'match': {
'port': 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 Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes .
resourceOwner (string) --
The Amazon Web Services 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.
port (integer) --
The targeted port of the weighted object.
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 .
port (integer) --
The port number to match on.
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.
httpRetryEvents (list) --
Specify at least one of the following values.
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.
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.
port (integer) --
The targeted port of the weighted object.
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.
port (integer) --
The port number to match on.
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.
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.
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.
port (integer) --
The targeted port of the weighted object.
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.
port (integer) --
The port number to match on.
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.
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.
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.
port (integer) --
The targeted port of the weighted object.
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.
port (integer) --
The port number to match on.
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.
Exceptions
AppMesh.Client.exceptions.NotFoundExceptionAppMesh.Client.exceptions.BadRequestExceptionAppMesh.Client.exceptions.TooManyRequestsExceptionAppMesh.Client.exceptions.ForbiddenExceptionAppMesh.Client.exceptions.ServiceUnavailableExceptionAppMesh.Client.exceptions.InternalServerErrorExceptiondescribe_virtual_gateway(**kwargs)¶Describes an existing virtual gateway.
See also: AWS API Documentation
Request Syntax
response = client.describe_virtual_gateway(
meshName='string',
meshOwner='string',
virtualGatewayName='string'
)
[REQUIRED]
The name of the service mesh that the gateway route resides in.
[REQUIRED]
The name of the virtual gateway to describe.
dict
Response Syntax
{
'virtualGateway': {
'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'
}
}
}
}
}
},
'listeners': [
{
'connectionPool': {
'grpc': {
'maxRequests': 123
},
'http': {
'maxConnections': 123,
'maxPendingRequests': 123
},
'http2': {
'maxRequests': 123
}
},
'healthCheck': {
'healthyThreshold': 123,
'intervalMillis': 123,
'path': 'string',
'port': 123,
'protocol': 'http'|'http2'|'grpc',
'timeoutMillis': 123,
'unhealthyThreshold': 123
},
'portMapping': {
'port': 123,
'protocol': 'http'|'http2'|'grpc'
},
'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': {
'format': {
'json': [
{
'key': 'string',
'value': 'string'
},
],
'text': 'string'
},
'path': 'string'
}
}
}
},
'status': {
'status': 'ACTIVE'|'INACTIVE'|'DELETED'
},
'virtualGatewayName': 'string'
}
}
Response Structure
(dict) --
virtualGateway (dict) --
The full description of your virtual gateway.
meshName (string) --
The name of the service mesh that the virtual gateway 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 Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes .
resourceOwner (string) --
The Amazon Web Services 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 gateway.
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 virtual gateway's client'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 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 mesh endpoint that the proxy is running on.
sds (dict) --
A reference to an object that represents a virtual gateway's client's Secret Discovery Service certificate.
secretName (string) --
A reference to an object that represents the name of the secret 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.
validation (dict) --
A reference to an object that represents a Transport Layer Security (TLS) validation context.
subjectAlternativeNames (dict) --
A reference to an object that represents the SANs for a virtual gateway's 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.
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.
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 virtual gateway'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 virtual gateway's Transport Layer Security (TLS) Secret Discovery Service validation context trust.
listeners (list) --
The listeners that the mesh endpoint is expected to receive inbound traffic from. You can specify one listener.
(dict) --
An object that represents a listener for a virtual gateway.
connectionPool (dict) --
The connection pool information for the virtual gateway listener.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: grpc, http, http2. 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.
healthCheck (dict) --
The health check information for the listener.
healthyThreshold (integer) --
The number of consecutive successful health checks that must occur before declaring the 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 gateway unhealthy.
portMapping (dict) --
The port mapping information for the listener.
port (integer) --
The port used for the port mapping. Specify one protocol.
protocol (string) --
The protocol used for the port mapping.
tls (dict) --
A reference to an object that represents the Transport Layer Security (TLS) properties for the listener.
certificate (dict) --
An object that represents a 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 Certificate Manager 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 mesh endpoint that the proxy is running on.
sds (dict) --
A reference to an object that represents a virtual gateway's listener's Secret Discovery Service certificate.
secretName (string) --
A reference to an object that represents the name of the secret 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.
validation (dict) --
A reference to an object that represents a virtual gateway's listener's Transport Layer Security (TLS) validation context.
subjectAlternativeNames (dict) --
A reference to an object that represents the SANs for a virtual gateway 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.
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 virtual gateway's 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 virtual gateway's Transport Layer Security (TLS) Secret Discovery Service validation context trust.
logging (dict) --
An object that represents logging information.
accessLog (dict) --
The access log configuration.
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 gateway access logs to.
format (dict) --
The specified format for the virtual gateway access logs. It can be either json_format or text_format .
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: json, text. 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'}
json (list) --
(dict) --
An object that represents the key value pairs for the JSON.
key (string) --
The specified key for the JSON.
value (string) --
The specified value for the JSON.
text (string) --
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.
status (dict) --
The current status of the virtual gateway.
status (string) --
The current status.
virtualGatewayName (string) --
The name of the virtual gateway.
Exceptions
AppMesh.Client.exceptions.NotFoundExceptionAppMesh.Client.exceptions.BadRequestExceptionAppMesh.Client.exceptions.TooManyRequestsExceptionAppMesh.Client.exceptions.ForbiddenExceptionAppMesh.Client.exceptions.ServiceUnavailableExceptionAppMesh.Client.exceptions.InternalServerErrorExceptiondescribe_virtual_node(**kwargs)¶Describes an existing virtual node.
See also: AWS API Documentation
Request Syntax
response = client.describe_virtual_node(
meshName='string',
meshOwner='string',
virtualNodeName='string'
)
[REQUIRED]
The name of the service mesh that the virtual node resides in.
[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': {
'format': {
'json': [
{
'key': 'string',
'value': 'string'
},
],
'text': 'string'
},
'path': 'string'
}
}
},
'serviceDiscovery': {
'awsCloudMap': {
'attributes': [
{
'key': 'string',
'value': 'string'
},
],
'ipPreference': 'IPv6_PREFERRED'|'IPv4_PREFERRED'|'IPv4_ONLY'|'IPv6_ONLY',
'namespaceName': 'string',
'serviceName': 'string'
},
'dns': {
'hostname': 'string',
'ipPreference': 'IPv6_PREFERRED'|'IPv4_PREFERRED'|'IPv4_ONLY'|'IPv6_ONLY',
'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 Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes .
resourceOwner (string) --
The Amazon Web Services 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.
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. If you don't specify SANs on the terminating mesh endpoint, the Envoy proxy for that node doesn't verify the SAN on a peer client certificate. If you don't specify SANs on the originating mesh endpoint, the SAN on the certificate provided by the terminating endpoint must match the mesh endpoint service discovery configuration. Since SPIRE vended certificates have a SPIFFE ID as a name, you must set the SAN since the name doesn't match the service discovery name.
match (dict) --
An object that represents the criteria for determining a SANs match.
exact (list) --
The values sent must match the specified values exactly.
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.
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.
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. If you don't specify SANs on the terminating mesh endpoint, the Envoy proxy for that node doesn't verify the SAN on a peer client certificate. If you don't specify SANs on the originating mesh endpoint, the SAN on the certificate provided by the terminating endpoint must match the mesh endpoint service discovery configuration. Since SPIRE vended certificates have a SPIFFE ID as a name, you must set the SAN since the name doesn't match the service discovery name.
match (dict) --
An object that represents the criteria for determining a SANs match.
exact (list) --
The values sent must match the specified values exactly.
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.
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 Certificate Manager 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.
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.
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.
format (dict) --
The specified format for the logs. The format is either json_format or text_format .
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: json, text. 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'}
json (list) --
(dict) --
An object that represents the key value pairs for the JSON.
key (string) --
The specified key for the JSON.
value (string) --
The specified value for the JSON.
text (string) --
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> <p>The Envoy process must have write permissions to the path that you specify here. Otherwise, Envoy fails to bootstrap properly.</p> </note>
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
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.
ipPreference (string) --
The preferred IP version that this virtual node uses. Setting the IP preference on the virtual node only overrides the IP preference set for the mesh on this specific node.
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.
ipPreference (string) --
The preferred IP version that this virtual node uses. Setting the IP preference on the virtual node only overrides the IP preference set for the mesh on this specific 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.
Exceptions
AppMesh.Client.exceptions.NotFoundExceptionAppMesh.Client.exceptions.BadRequestExceptionAppMesh.Client.exceptions.TooManyRequestsExceptionAppMesh.Client.exceptions.ForbiddenExceptionAppMesh.Client.exceptions.ServiceUnavailableExceptionAppMesh.Client.exceptions.InternalServerErrorExceptiondescribe_virtual_router(**kwargs)¶Describes an existing virtual router.
See also: AWS API Documentation
Request Syntax
response = client.describe_virtual_router(
meshName='string',
meshOwner='string',
virtualRouterName='string'
)
[REQUIRED]
The name of the service mesh that the virtual router resides in.
[REQUIRED]
The name of the virtual router to describe.
dict
Response Syntax
{
'virtualRouter': {
'meshName': 'string',
'metadata': {
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'meshOwner': 'string',
'resourceOwner': 'string',
'uid': 'string',
'version': 123
},
'spec': {
'listeners': [
{
'portMapping': {
'port': 123,
'protocol': 'http'|'tcp'|'http2'|'grpc'
}
},
]
},
'status': {
'status': 'ACTIVE'|'INACTIVE'|'DELETED'
},
'virtualRouterName': 'string'
}
}
Response Structure
(dict) --
virtualRouter (dict) --
The full description of your virtual router.
meshName (string) --
The name of the service mesh that the virtual router resides in.
metadata (dict) --
The associated metadata for the virtual router.
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 Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes .
resourceOwner (string) --
The Amazon Web Services 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 router.
listeners (list) --
The listeners that the virtual router is expected to receive inbound traffic from. You can specify one listener.
(dict) --
An object that represents a virtual router listener.
portMapping (dict) --
An object that represents a port mapping.
port (integer) --
The port used for the port mapping.
protocol (string) --
The protocol used for the port mapping. Specify one protocol.
status (dict) --
The current status of the virtual router.
status (string) --
The current status of the virtual router.
virtualRouterName (string) --
The name of the virtual router.
Exceptions
AppMesh.Client.exceptions.NotFoundExceptionAppMesh.Client.exceptions.BadRequestExceptionAppMesh.Client.exceptions.TooManyRequestsExceptionAppMesh.Client.exceptions.ForbiddenExceptionAppMesh.Client.exceptions.ServiceUnavailableExceptionAppMesh.Client.exceptions.InternalServerErrorExceptiondescribe_virtual_service(**kwargs)¶Describes an existing virtual service.
See also: AWS API Documentation
Request Syntax
response = client.describe_virtual_service(
meshName='string',
meshOwner='string',
virtualServiceName='string'
)
[REQUIRED]
The name of the service mesh that the virtual service resides in.
[REQUIRED]
The name of the virtual service to describe.
dict
Response Syntax
{
'virtualService': {
'meshName': 'string',
'metadata': {
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'meshOwner': 'string',
'resourceOwner': 'string',
'uid': 'string',
'version': 123
},
'spec': {
'provider': {
'virtualNode': {
'virtualNodeName': 'string'
},
'virtualRouter': {
'virtualRouterName': 'string'
}
}
},
'status': {
'status': 'ACTIVE'|'INACTIVE'|'DELETED'
},
'virtualServiceName': 'string'
}
}
Response Structure
(dict) --
virtualService (dict) --
The full description of your virtual service.
meshName (string) --
The name of the service mesh that the virtual service 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 Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes .
resourceOwner (string) --
The Amazon Web Services 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 service.
provider (dict) --
The App Mesh object that is acting as the provider for a virtual service. You can specify a single virtual node or virtual router.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: virtualNode, virtualRouter. 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'}
virtualNode (dict) --
The virtual node associated with a virtual service.
virtualNodeName (string) --
The name of the virtual node that is acting as a service provider.
virtualRouter (dict) --
The virtual router associated with a virtual service.
virtualRouterName (string) --
The name of the virtual router that is acting as a service provider.
status (dict) --
The current status of the virtual service.
status (string) --
The current status of the virtual service.
virtualServiceName (string) --
The name of the virtual service.
Exceptions
AppMesh.Client.exceptions.NotFoundExceptionAppMesh.Client.exceptions.BadRequestExceptionAppMesh.Client.exceptions.TooManyRequestsExceptionAppMesh.Client.exceptions.ForbiddenExceptionAppMesh.Client.exceptions.ServiceUnavailableExceptionAppMesh.Client.exceptions.InternalServerErrorExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_gateway_routes(**kwargs)¶Returns a list of existing gateway routes that are associated to a virtual gateway.
See also: AWS API Documentation
Request Syntax
response = client.list_gateway_routes(
limit=123,
meshName='string',
meshOwner='string',
nextToken='string',
virtualGatewayName='string'
)
ListGatewayRoutes in paginated output. When you use this parameter, ListGatewayRoutes returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListGatewayRoutes request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListGatewayRoutes returns up to 100 results and a nextToken value if applicable.[REQUIRED]
The name of the service mesh to list gateway routes in.
nextToken value returned from a previous paginated ListGatewayRoutes request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.[REQUIRED]
The name of the virtual gateway to list gateway routes in.
dict
Response Syntax
{
'gatewayRoutes': [
{
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'gatewayRouteName': 'string',
'lastUpdatedAt': datetime(2015, 1, 1),
'meshName': 'string',
'meshOwner': 'string',
'resourceOwner': 'string',
'version': 123,
'virtualGatewayName': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
gatewayRoutes (list) --
The list of existing gateway routes for the specified service mesh and virtual gateway.
(dict) --
An object that represents a gateway route returned by a list operation.
arn (string) --
The full Amazon Resource Name (ARN) for the gateway route.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was created.
gatewayRouteName (string) --
The name of the gateway route.
lastUpdatedAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was last updated.
meshName (string) --
The name of the service mesh that the resource resides in.
meshOwner (string) --
The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes .
resourceOwner (string) --
The Amazon Web Services 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 .
version (integer) --
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
virtualGatewayName (string) --
The virtual gateway that the gateway route is associated with.
nextToken (string) --
The nextToken value to include in a future ListGatewayRoutes request. When the results of a ListGatewayRoutes request exceed limit , you can use this value to retrieve the next page of results. This value is null when there are no more results to return.
Exceptions
AppMesh.Client.exceptions.NotFoundExceptionAppMesh.Client.exceptions.BadRequestExceptionAppMesh.Client.exceptions.TooManyRequestsExceptionAppMesh.Client.exceptions.ForbiddenExceptionAppMesh.Client.exceptions.ServiceUnavailableExceptionAppMesh.Client.exceptions.InternalServerErrorExceptionlist_meshes(**kwargs)¶Returns a list of existing service meshes.
See also: AWS API Documentation
Request Syntax
response = client.list_meshes(
limit=123,
nextToken='string'
)
ListMeshes in paginated output. When you use this parameter, ListMeshes returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListMeshes request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListMeshes returns up to 100 results and a nextToken value if applicable.The nextToken value returned from a previous paginated ListMeshes request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
Note
This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.
dict
Response Syntax
{
'meshes': [
{
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'meshName': 'string',
'meshOwner': 'string',
'resourceOwner': 'string',
'version': 123
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
meshes (list) --
The list of existing service meshes.
(dict) --
An object that represents a service mesh returned by a list operation.
arn (string) --
The full Amazon Resource Name (ARN) of the service mesh.
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.
meshName (string) --
The name of the service mesh.
meshOwner (string) --
The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes .
resourceOwner (string) --
The Amazon Web Services 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 .
version (integer) --
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
nextToken (string) --
The nextToken value to include in a future ListMeshes request. When the results of a ListMeshes request exceed limit , you can use this value to retrieve the next page of results. This value is null when there are no more results to return.
Exceptions
AppMesh.Client.exceptions.NotFoundExceptionAppMesh.Client.exceptions.BadRequestExceptionAppMesh.Client.exceptions.TooManyRequestsExceptionAppMesh.Client.exceptions.ForbiddenExceptionAppMesh.Client.exceptions.ServiceUnavailableExceptionAppMesh.Client.exceptions.InternalServerErrorExceptionlist_routes(**kwargs)¶Returns a list of existing routes in a service mesh.
See also: AWS API Documentation
Request Syntax
response = client.list_routes(
limit=123,
meshName='string',
meshOwner='string',
nextToken='string',
virtualRouterName='string'
)
ListRoutes in paginated output. When you use this parameter, ListRoutes returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListRoutes request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListRoutes returns up to 100 results and a nextToken value if applicable.[REQUIRED]
The name of the service mesh to list routes in.
nextToken value returned from a previous paginated ListRoutes request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.[REQUIRED]
The name of the virtual router to list routes in.
dict
Response Syntax
{
'nextToken': 'string',
'routes': [
{
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'meshName': 'string',
'meshOwner': 'string',
'resourceOwner': 'string',
'routeName': 'string',
'version': 123,
'virtualRouterName': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
The nextToken value to include in a future ListRoutes request. When the results of a ListRoutes request exceed limit , you can use this value to retrieve the next page of results. This value is null when there are no more results to return.
routes (list) --
The list of existing routes for the specified service mesh and virtual router.
(dict) --
An object that represents a route returned by a list operation.
arn (string) --
The full Amazon Resource Name (ARN) for the route.
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.
meshName (string) --
The name of the service mesh that the route resides in.
meshOwner (string) --
The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes .
resourceOwner (string) --
The Amazon Web Services 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 .
routeName (string) --
The name of the route.
version (integer) --
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
virtualRouterName (string) --
The virtual router that the route is associated with.
Exceptions
AppMesh.Client.exceptions.NotFoundExceptionAppMesh.Client.exceptions.BadRequestExceptionAppMesh.Client.exceptions.TooManyRequestsExceptionAppMesh.Client.exceptions.ForbiddenExceptionAppMesh.Client.exceptions.ServiceUnavailableExceptionAppMesh.Client.exceptions.InternalServerErrorExceptionList the tags for an App Mesh resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
limit=123,
nextToken='string',
resourceArn='string'
)
ListTagsForResource in paginated output. When this parameter is used, ListTagsForResource returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListTagsForResource request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListTagsForResource returns up to 100 results and a nextToken value if applicable.nextToken value returned from a previous paginated ListTagsForResource request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.[REQUIRED]
The Amazon Resource Name (ARN) that identifies the resource to list the tags for.
dict
Response Syntax
{
'nextToken': 'string',
'tags': [
{
'key': 'string',
'value': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
The nextToken value to include in a future ListTagsForResource request. When the results of a ListTagsForResource request exceed limit , you can use this value to retrieve the next page of results. This value is null when there are no more results to return.
tags (list) --
The tags for the resource.
(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) --
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) --
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
Exceptions
AppMesh.Client.exceptions.NotFoundExceptionAppMesh.Client.exceptions.BadRequestExceptionAppMesh.Client.exceptions.TooManyRequestsExceptionAppMesh.Client.exceptions.ForbiddenExceptionAppMesh.Client.exceptions.ServiceUnavailableExceptionAppMesh.Client.exceptions.InternalServerErrorExceptionlist_virtual_gateways(**kwargs)¶Returns a list of existing virtual gateways in a service mesh.
See also: AWS API Documentation
Request Syntax
response = client.list_virtual_gateways(
limit=123,
meshName='string',
meshOwner='string',
nextToken='string'
)
ListVirtualGateways in paginated output. When you use this parameter, ListVirtualGateways returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListVirtualGateways request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListVirtualGateways returns up to 100 results and a nextToken value if applicable.[REQUIRED]
The name of the service mesh to list virtual gateways in.
nextToken value returned from a previous paginated ListVirtualGateways request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.dict
Response Syntax
{
'nextToken': 'string',
'virtualGateways': [
{
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'meshName': 'string',
'meshOwner': 'string',
'resourceOwner': 'string',
'version': 123,
'virtualGatewayName': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
The nextToken value to include in a future ListVirtualGateways request. When the results of a ListVirtualGateways request exceed limit , you can use this value to retrieve the next page of results. This value is null when there are no more results to return.
virtualGateways (list) --
The list of existing virtual gateways for the specified service mesh.
(dict) --
An object that represents a virtual gateway returned by a list operation.
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.
meshName (string) --
The name of the service mesh that the resource resides in.
meshOwner (string) --
The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes .
resourceOwner (string) --
The Amazon Web Services 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 .
version (integer) --
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
virtualGatewayName (string) --
The name of the resource.
Exceptions
AppMesh.Client.exceptions.NotFoundExceptionAppMesh.Client.exceptions.BadRequestExceptionAppMesh.Client.exceptions.TooManyRequestsExceptionAppMesh.Client.exceptions.ForbiddenExceptionAppMesh.Client.exceptions.ServiceUnavailableExceptionAppMesh.Client.exceptions.InternalServerErrorExceptionlist_virtual_nodes(**kwargs)¶Returns a list of existing virtual nodes.
See also: AWS API Documentation
Request Syntax
response = client.list_virtual_nodes(
limit=123,
meshName='string',
meshOwner='string',
nextToken='string'
)
ListVirtualNodes in paginated output. When you use this parameter, ListVirtualNodes returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListVirtualNodes request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListVirtualNodes returns up to 100 results and a nextToken value if applicable.[REQUIRED]
The name of the service mesh to list virtual nodes in.
nextToken value returned from a previous paginated ListVirtualNodes request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.dict
Response Syntax
{
'nextToken': 'string',
'virtualNodes': [
{
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'meshName': 'string',
'meshOwner': 'string',
'resourceOwner': 'string',
'version': 123,
'virtualNodeName': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
The nextToken value to include in a future ListVirtualNodes request. When the results of a ListVirtualNodes request exceed limit , you can use this value to retrieve the next page of results. This value is null when there are no more results to return.
virtualNodes (list) --
The list of existing virtual nodes for the specified service mesh.
(dict) --
An object that represents a virtual node returned by a list operation.
arn (string) --
The full Amazon Resource Name (ARN) for the virtual node.
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.
meshName (string) --
The name of the service mesh that the virtual node resides in.
meshOwner (string) --
The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes .
resourceOwner (string) --
The Amazon Web Services 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 .
version (integer) --
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
virtualNodeName (string) --
The name of the virtual node.
Exceptions
AppMesh.Client.exceptions.NotFoundExceptionAppMesh.Client.exceptions.BadRequestExceptionAppMesh.Client.exceptions.TooManyRequestsExceptionAppMesh.Client.exceptions.ForbiddenExceptionAppMesh.Client.exceptions.ServiceUnavailableExceptionAppMesh.Client.exceptions.InternalServerErrorExceptionlist_virtual_routers(**kwargs)¶Returns a list of existing virtual routers in a service mesh.
See also: AWS API Documentation
Request Syntax
response = client.list_virtual_routers(
limit=123,
meshName='string',
meshOwner='string',
nextToken='string'
)
ListVirtualRouters in paginated output. When you use this parameter, ListVirtualRouters returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListVirtualRouters request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListVirtualRouters returns up to 100 results and a nextToken value if applicable.[REQUIRED]
The name of the service mesh to list virtual routers in.
nextToken value returned from a previous paginated ListVirtualRouters request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.dict
Response Syntax
{
'nextToken': 'string',
'virtualRouters': [
{
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'meshName': 'string',
'meshOwner': 'string',
'resourceOwner': 'string',
'version': 123,
'virtualRouterName': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
The nextToken value to include in a future ListVirtualRouters request. When the results of a ListVirtualRouters request exceed limit , you can use this value to retrieve the next page of results. This value is null when there are no more results to return.
virtualRouters (list) --
The list of existing virtual routers for the specified service mesh.
(dict) --
An object that represents a virtual router returned by a list operation.
arn (string) --
The full Amazon Resource Name (ARN) for the virtual router.
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.
meshName (string) --
The name of the service mesh that the virtual router resides in.
meshOwner (string) --
The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes .
resourceOwner (string) --
The Amazon Web Services 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 .
version (integer) --
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
virtualRouterName (string) --
The name of the virtual router.
Exceptions
AppMesh.Client.exceptions.NotFoundExceptionAppMesh.Client.exceptions.BadRequestExceptionAppMesh.Client.exceptions.TooManyRequestsExceptionAppMesh.Client.exceptions.ForbiddenExceptionAppMesh.Client.exceptions.ServiceUnavailableExceptionAppMesh.Client.exceptions.InternalServerErrorExceptionlist_virtual_services(**kwargs)¶Returns a list of existing virtual services in a service mesh.
See also: AWS API Documentation
Request Syntax
response = client.list_virtual_services(
limit=123,
meshName='string',
meshOwner='string',
nextToken='string'
)
ListVirtualServices in paginated output. When you use this parameter, ListVirtualServices returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListVirtualServices request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListVirtualServices returns up to 100 results and a nextToken value if applicable.[REQUIRED]
The name of the service mesh to list virtual services in.
nextToken value returned from a previous paginated ListVirtualServices request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.dict
Response Syntax
{
'nextToken': 'string',
'virtualServices': [
{
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'meshName': 'string',
'meshOwner': 'string',
'resourceOwner': 'string',
'version': 123,
'virtualServiceName': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
The nextToken value to include in a future ListVirtualServices request. When the results of a ListVirtualServices request exceed limit , you can use this value to retrieve the next page of results. This value is null when there are no more results to return.
virtualServices (list) --
The list of existing virtual services for the specified service mesh.
(dict) --
An object that represents a virtual service returned by a list operation.
arn (string) --
The full Amazon Resource Name (ARN) for the virtual service.
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.
meshName (string) --
The name of the service mesh that the virtual service resides in.
meshOwner (string) --
The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes .
resourceOwner (string) --
The Amazon Web Services 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 .
version (integer) --
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
virtualServiceName (string) --
The name of the virtual service.
Exceptions
AppMesh.Client.exceptions.NotFoundExceptionAppMesh.Client.exceptions.BadRequestExceptionAppMesh.Client.exceptions.TooManyRequestsExceptionAppMesh.Client.exceptions.ForbiddenExceptionAppMesh.Client.exceptions.ServiceUnavailableExceptionAppMesh.Client.exceptions.InternalServerErrorExceptiontag_resource(**kwargs)¶Associates the specified tags to a resource with the specified resourceArn . If existing tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are also deleted.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
resourceArn='string',
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource to add tags to.
[REQUIRED]
The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
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.
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.
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
dict
Response Syntax
{}
Response Structure
Exceptions
AppMesh.Client.exceptions.NotFoundExceptionAppMesh.Client.exceptions.BadRequestExceptionAppMesh.Client.exceptions.TooManyTagsExceptionAppMesh.Client.exceptions.TooManyRequestsExceptionAppMesh.Client.exceptions.ForbiddenExceptionAppMesh.Client.exceptions.ServiceUnavailableExceptionAppMesh.Client.exceptions.InternalServerErrorExceptionuntag_resource(**kwargs)¶Deletes specified tags from a resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource to delete tags from.
[REQUIRED]
The keys of the tags to be removed.
dict
Response Syntax
{}
Response Structure
Exceptions
AppMesh.Client.exceptions.NotFoundExceptionAppMesh.Client.exceptions.BadRequestExceptionAppMesh.Client.exceptions.TooManyRequestsExceptionAppMesh.Client.exceptions.ForbiddenExceptionAppMesh.Client.exceptions.ServiceUnavailableExceptionAppMesh.Client.exceptions.InternalServerErrorExceptionupdate_gateway_route(**kwargs)¶Updates an existing gateway route that is associated to a specified virtual gateway in a service mesh.
See also: AWS API Documentation
Request Syntax
response = client.update_gateway_route(
clientToken='string',
gatewayRouteName='string',
meshName='string',
meshOwner='string',
spec={
'grpcRoute': {
'action': {
'rewrite': {
'hostname': {
'defaultTargetHostname': 'ENABLED'|'DISABLED'
}
},
'target': {
'port': 123,
'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'
},
],
'port': 123,
'serviceName': 'string'
}
},
'http2Route': {
'action': {
'rewrite': {
'hostname': {
'defaultTargetHostname': 'ENABLED'|'DISABLED'
},
'path': {
'exact': 'string'
},
'prefix': {
'defaultPrefix': 'ENABLED'|'DISABLED',
'value': 'string'
}
},
'target': {
'port': 123,
'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'
},
'port': 123,
'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': {
'port': 123,
'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'
},
'port': 123,
'prefix': 'string',
'queryParameters': [
{
'match': {
'exact': 'string'
},
'name': 'string'
},
]
}
},
'priority': 123
},
virtualGatewayName='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.
[REQUIRED]
The name of the gateway route to update.
[REQUIRED]
The name of the service mesh that the gateway route resides in.
[REQUIRED]
The new gateway route specification to apply. This overwrites the existing data.
An object that represents the specification of a gRPC gateway route.
An object that represents the action to take if a match is determined.
The gateway route action to rewrite.
The host name of the gateway route to rewrite.
The default target host name to write to.
An object that represents the target that traffic is routed to when a request matches the gateway route.
The port number of the gateway route target.
An object that represents a virtual service gateway route target.
The name of the virtual service that traffic is routed to.
An object that represents the criteria for determining a request match.
The gateway route host name to be matched on.
The exact host name to match on.
The specified ending characters of the host name to match on.
The gateway route metadata to be matched on.
An object representing the metadata of the gateway route.
Specify True to match anything except the match criteria. The default value is False .
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.
The exact method header to be matched on.
The specified beginning characters of the method header to be matched on.
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.
The end of the range.
The start of the range.
The regex used to match the method header.
The specified ending characters of the method header to match on.
A name for the gateway route metadata.
The port number to match from the request.
The fully qualified domain name for the service to match from the request.
An object that represents the specification of an HTTP/2 gateway route.
An object that represents the action to take if a match is determined.
The gateway route action to rewrite.
The host name to rewrite.
The default target host name to write to.
The path to rewrite.
The exact path to rewrite.
The specified beginning characters to rewrite.
The default prefix used to replace the incoming route prefix when rewritten.
The value used to replace the incoming route prefix when rewritten.
An object that represents the target that traffic is routed to when a request matches the gateway route.
The port number of the gateway route target.
An object that represents a virtual service gateway route target.
The name of the virtual service that traffic is routed to.
An object that represents the criteria for determining a request match.
The client request headers to match on.
An object that represents the HTTP header in the gateway route.
Specify True to match anything except the match criteria. The default value is False .
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.
The value sent by the client must match the specified value exactly.
The value sent by the client must begin with the specified characters.
An object that represents the range of values to match on.
The end of the range.
The start of the range.
The value sent by the client must include the specified characters.
The value sent by the client must end with the specified characters.
A name for the HTTP header in the gateway route that will be matched on.
The host name to match on.
The exact host name to match on.
The specified ending characters of the host name to match on.
The method to match on.
The path to match on.
The exact path to match on.
The regex used to match the path.
The port number to match on.
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 .
The query parameter to match on.
An object that represents the query parameter in the request.
The query parameter to match on.
The exact query parameter to match on.
A name for the query parameter that will be matched on.
An object that represents the specification of an HTTP gateway route.
An object that represents the action to take if a match is determined.
The gateway route action to rewrite.
The host name to rewrite.
The default target host name to write to.
The path to rewrite.
The exact path to rewrite.
The specified beginning characters to rewrite.
The default prefix used to replace the incoming route prefix when rewritten.
The value used to replace the incoming route prefix when rewritten.
An object that represents the target that traffic is routed to when a request matches the gateway route.
The port number of the gateway route target.
An object that represents a virtual service gateway route target.
The name of the virtual service that traffic is routed to.
An object that represents the criteria for determining a request match.
The client request headers to match on.
An object that represents the HTTP header in the gateway route.
Specify True to match anything except the match criteria. The default value is False .
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.
The value sent by the client must match the specified value exactly.
The value sent by the client must begin with the specified characters.
An object that represents the range of values to match on.
The end of the range.
The start of the range.
The value sent by the client must include the specified characters.
The value sent by the client must end with the specified characters.
A name for the HTTP header in the gateway route that will be matched on.
The host name to match on.
The exact host name to match on.
The specified ending characters of the host name to match on.
The method to match on.
The path to match on.
The exact path to match on.
The regex used to match the path.
The port number to match on.
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 .
The query parameter to match on.
An object that represents the query parameter in the request.
The query parameter to match on.
The exact query parameter to match on.
A name for the query parameter that will be matched on.
The ordering of the gateway routes spec.
[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': {
'port': 123,
'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'
},
],
'port': 123,
'serviceName': 'string'
}
},
'http2Route': {
'action': {
'rewrite': {
'hostname': {
'defaultTargetHostname': 'ENABLED'|'DISABLED'
},
'path': {
'exact': 'string'
},
'prefix': {
'defaultPrefix': 'ENABLED'|'DISABLED',
'value': 'string'
}
},
'target': {
'port': 123,
'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'
},
'port': 123,
'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': {
'port': 123,
'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'
},
'port': 123,
'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 Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes .
resourceOwner (string) --
The Amazon Web Services 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.
port (integer) --
The port number of the gateway route target.
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.
port (integer) --
The port number to match from the request.
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.
port (integer) --
The port number of the gateway route target.
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.
port (integer) --
The port number to match on.
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.
port (integer) --
The port number of the gateway route target.
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.
port (integer) --
The port number to match on.
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.
Exceptions
AppMesh.Client.exceptions.NotFoundExceptionAppMesh.Client.exceptions.BadRequestExceptionAppMesh.Client.exceptions.ConflictExceptionAppMesh.Client.exceptions.TooManyRequestsExceptionAppMesh.Client.exceptions.ForbiddenExceptionAppMesh.Client.exceptions.ServiceUnavailableExceptionAppMesh.Client.exceptions.InternalServerErrorExceptionAppMesh.Client.exceptions.LimitExceededExceptionupdate_mesh(**kwargs)¶Updates an existing service mesh.
See also: AWS API Documentation
Request Syntax
response = client.update_mesh(
clientToken='string',
meshName='string',
spec={
'egressFilter': {
'type': 'ALLOW_ALL'|'DROP_ALL'
},
'serviceDiscovery': {
'ipPreference': 'IPv6_PREFERRED'|'IPv4_PREFERRED'|'IPv4_ONLY'|'IPv6_ONLY'
}
}
)
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.
[REQUIRED]
The name of the service mesh to update.
The service mesh specification to apply.
The egress filter rules for the service mesh.
The egress filter type. By default, the type is DROP_ALL , which allows egress only from virtual nodes to other defined resources in the service mesh (and any traffic to *.amazonaws.com for Amazon Web Services API calls). You can set the egress filter type to ALLOW_ALL to allow egress to any endpoint inside or outside of the service mesh.
An object that represents the service discovery information for a service mesh.
The IP version to use to control traffic within the mesh.
dict
Response Syntax
{
'mesh': {
'meshName': 'string',
'metadata': {
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'meshOwner': 'string',
'resourceOwner': 'string',
'uid': 'string',
'version': 123
},
'spec': {
'egressFilter': {
'type': 'ALLOW_ALL'|'DROP_ALL'
},
'serviceDiscovery': {
'ipPreference': 'IPv6_PREFERRED'|'IPv4_PREFERRED'|'IPv4_ONLY'|'IPv6_ONLY'
}
},
'status': {
'status': 'ACTIVE'|'INACTIVE'|'DELETED'
}
}
}
Response Structure
(dict) --
mesh (dict) --
An object that represents a service mesh returned by a describe operation.
meshName (string) --
The name of the service mesh.
metadata (dict) --
The associated metadata for the service mesh.
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 Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes .
resourceOwner (string) --
The Amazon Web Services 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 associated specification for the service mesh.
egressFilter (dict) --
The egress filter rules for the service mesh.
type (string) --
The egress filter type. By default, the type is DROP_ALL , which allows egress only from virtual nodes to other defined resources in the service mesh (and any traffic to *.amazonaws.com for Amazon Web Services API calls). You can set the egress filter type to ALLOW_ALL to allow egress to any endpoint inside or outside of the service mesh.
serviceDiscovery (dict) --
An object that represents the service discovery information for a service mesh.
ipPreference (string) --
The IP version to use to control traffic within the mesh.
status (dict) --
The status of the service mesh.
status (string) --
The current mesh status.
Exceptions
AppMesh.Client.exceptions.NotFoundExceptionAppMesh.Client.exceptions.BadRequestExceptionAppMesh.Client.exceptions.ConflictExceptionAppMesh.Client.exceptions.TooManyRequestsExceptionAppMesh.Client.exceptions.ForbiddenExceptionAppMesh.Client.exceptions.ServiceUnavailableExceptionAppMesh.Client.exceptions.InternalServerErrorExceptionupdate_route(**kwargs)¶Updates an existing route for a specified service mesh and virtual router.
See also: AWS API Documentation
Request Syntax
response = client.update_route(
clientToken='string',
meshName='string',
meshOwner='string',
routeName='string',
spec={
'grpcRoute': {
'action': {
'weightedTargets': [
{
'port': 123,
'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',
'port': 123,
'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': [
{
'port': 123,
'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'
},
'port': 123,
'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': [
{
'port': 123,
'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'
},
'port': 123,
'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': [
{
'port': 123,
'virtualNode': 'string',
'weight': 123
},
]
},
'match': {
'port': 123
},
'timeout': {
'idle': {
'unit': 's'|'ms',
'value': 123
}
}
}
},
virtualRouterName='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.
[REQUIRED]
The name of the service mesh that the route resides in.
[REQUIRED]
The name of the route to update.
[REQUIRED]
The new route specification to apply. This overwrites the existing data.
An object that represents the specification of a gRPC route.
An object that represents the action to take if a match is determined.
An object that represents the targets that traffic is routed to when a request matches the route.
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.
The targeted port of the weighted object.
The virtual node to associate with the weighted target.
The relative weight of the weighted target.
An object that represents the criteria for determining a request match.
An object that represents the data to match from the request.
An object that represents the match metadata for the route.
Specify True to match anything except the match criteria. The default value is False .
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.
The value sent by the client must match the specified value exactly.
The value sent by the client must begin with the specified characters.
An object that represents the range of values to match on.
The end of the range.
The start of the range.
The value sent by the client must include the specified characters.
The value sent by the client must end with the specified characters.
The name of the route.
The method name to match from the request. If you specify a name, you must also specify a serviceName .
The port number to match on.
The fully qualified domain name for the service to match from the request.
An object that represents a retry policy.
Specify at least one of the valid values.
Specify at least one of the following values.
The maximum number of retry attempts.
The timeout for each retry attempt.
A unit of time.
A number of time units.
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.
An object that represents types of timeouts.
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.
A unit of time.
A number of time units.
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.
A unit of time.
A number of time units.
An object that represents the specification of an HTTP/2 route.
An object that represents the action to take if a match is determined.
An object that represents the targets that traffic is routed to when a request matches the route.
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.
The targeted port of the weighted object.
The virtual node to associate with the weighted target.
The relative weight of the weighted target.
An object that represents the criteria for determining a request match.
The client request headers to match on.
An object that represents the HTTP header in the request.
Specify True to match anything except the match criteria. The default value is False .
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.
The value sent by the client must match the specified value exactly.
The value sent by the client must begin with the specified characters.
An object that represents the range of values to match on.
The end of the range.
The start of the range.
The value sent by the client must include the specified characters.
The value sent by the client must end with the specified characters.
A name for the HTTP header in the client request that will be matched on.
The client request method to match on. Specify only one.
The client request path to match on.
The exact path to match on.
The regex used to match the path.
The port number to match on.
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 .
The client request query parameters to match on.
An object that represents the query parameter in the request.
The query parameter to match on.
The exact query parameter to match on.
A name for the query parameter that will be matched on.
The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.
An object that represents a retry policy.
Specify at least one of the following values.
The maximum number of retry attempts.
The timeout for each retry attempt.
A unit of time.
A number of time units.
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.
An object that represents types of timeouts.
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.
A unit of time.
A number of time units.
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.
A unit of time.
A number of time units.
An object that represents the specification of an HTTP route.
An object that represents the action to take if a match is determined.
An object that represents the targets that traffic is routed to when a request matches the route.
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.
The targeted port of the weighted object.
The virtual node to associate with the weighted target.
The relative weight of the weighted target.
An object that represents the criteria for determining a request match.
The client request headers to match on.
An object that represents the HTTP header in the request.
Specify True to match anything except the match criteria. The default value is False .
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.
The value sent by the client must match the specified value exactly.
The value sent by the client must begin with the specified characters.
An object that represents the range of values to match on.
The end of the range.
The start of the range.
The value sent by the client must include the specified characters.
The value sent by the client must end with the specified characters.
A name for the HTTP header in the client request that will be matched on.
The client request method to match on. Specify only one.
The client request path to match on.
The exact path to match on.
The regex used to match the path.
The port number to match on.
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 .
The client request query parameters to match on.
An object that represents the query parameter in the request.
The query parameter to match on.
The exact query parameter to match on.
A name for the query parameter that will be matched on.
The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.
An object that represents a retry policy.
Specify at least one of the following values.
The maximum number of retry attempts.
The timeout for each retry attempt.
A unit of time.
A number of time units.
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.
An object that represents types of timeouts.
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.
A unit of time.
A number of time units.
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.
A unit of time.
A number of time units.
The priority for the route. Routes are matched based on the specified value, where 0 is the highest priority.
An object that represents the specification of a TCP route.
The action to take if a match is determined.
An object that represents the targets that traffic is routed to when a request matches the route.
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.
The targeted port of the weighted object.
The virtual node to associate with the weighted target.
The relative weight of the weighted target.
An object that represents the criteria for determining a request match.
The port number to match on.
An object that represents types of timeouts.
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.
A unit of time.
A number of time units.
[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': [
{
'port': 123,
'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',
'port': 123,
'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': [
{
'port': 123,
'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'
},
'port': 123,
'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': [
{
'port': 123,
'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'
},
'port': 123,
'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': [
{
'port': 123,
'virtualNode': 'string',
'weight': 123
},
]
},
'match': {
'port': 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 Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes .
resourceOwner (string) --
The Amazon Web Services 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.
port (integer) --
The targeted port of the weighted object.
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 .
port (integer) --
The port number to match on.
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.
httpRetryEvents (list) --
Specify at least one of the following values.
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.
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.
port (integer) --
The targeted port of the weighted object.
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.
port (integer) --
The port number to match on.
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.
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.
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.
port (integer) --
The targeted port of the weighted object.
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.
port (integer) --
The port number to match on.
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.
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.
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.
port (integer) --
The targeted port of the weighted object.
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.
port (integer) --
The port number to match on.
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.
Exceptions
AppMesh.Client.exceptions.NotFoundExceptionAppMesh.Client.exceptions.BadRequestExceptionAppMesh.Client.exceptions.ConflictExceptionAppMesh.Client.exceptions.TooManyRequestsExceptionAppMesh.Client.exceptions.ForbiddenExceptionAppMesh.Client.exceptions.ServiceUnavailableExceptionAppMesh.Client.exceptions.InternalServerErrorExceptionAppMesh.Client.exceptions.LimitExceededExceptionupdate_virtual_gateway(**kwargs)¶Updates an existing virtual gateway in a specified service mesh.
See also: AWS API Documentation
Request Syntax
response = client.update_virtual_gateway(
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'
}
}
}
}
}
},
'listeners': [
{
'connectionPool': {
'grpc': {
'maxRequests': 123
},
'http': {
'maxConnections': 123,
'maxPendingRequests': 123
},
'http2': {
'maxRequests': 123
}
},
'healthCheck': {
'healthyThreshold': 123,
'intervalMillis': 123,
'path': 'string',
'port': 123,
'protocol': 'http'|'http2'|'grpc',
'timeoutMillis': 123,
'unhealthyThreshold': 123
},
'portMapping': {
'port': 123,
'protocol': 'http'|'http2'|'grpc'
},
'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': {
'format': {
'json': [
{
'key': 'string',
'value': 'string'
},
],
'text': 'string'
},
'path': 'string'
}
}
}
},
virtualGatewayName='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.
[REQUIRED]
The name of the service mesh that the virtual gateway resides in.
[REQUIRED]
The new virtual gateway specification to apply. This overwrites the existing data.
A reference to an object that represents the defaults for backends.
A reference to an object that represents a client policy.
A reference to an object that represents a Transport Layer Security (TLS) client policy.
A reference to an object that represents a virtual gateway's client'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.
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) .
The certificate chain for the certificate.
The private key for a certificate stored on the file system of the mesh endpoint that the proxy is running on.
A reference to an object that represents a virtual gateway's client's Secret Discovery Service certificate.
A reference to an object that represents the name of the secret secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.
Whether the policy is enforced. The default is True , if a value isn't specified.
One or more ports that the policy is enforced for.
A reference to an object that represents a Transport Layer Security (TLS) validation context.
A reference to an object that represents the SANs for a virtual gateway's listener's Transport Layer Security (TLS) validation context.
An object that represents the criteria for determining a SANs match.
The values sent must match the specified values exactly.
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.
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.
One or more ACM Amazon Resource Name (ARN)s.
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
A reference to an object that represents a virtual gateway's Transport Layer Security (TLS) Secret Discovery Service validation context trust.
A reference to an object that represents the name of the secret for a virtual gateway's Transport Layer Security (TLS) Secret Discovery Service validation context trust.
The listeners that the mesh endpoint is expected to receive inbound traffic from. You can specify one listener.
An object that represents a listener for a virtual gateway.
The connection pool information for the virtual gateway listener.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: grpc, http, http2.
An object that represents a type of connection pool.
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.
An object that represents a type of connection pool.
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.
Number of overflowing requests after max_connections Envoy will queue to upstream cluster.
An object that represents a type of connection pool.
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.
The health check information for the listener.
The number of consecutive successful health checks that must occur before declaring the listener healthy.
The time period in milliseconds between each health check execution.
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.
The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.
The protocol for the health check request. If you specify grpc , then your service must conform to the GRPC Health Checking Protocol .
The amount of time to wait when receiving a response from the health check, in milliseconds.
The number of consecutive failed health checks that must occur before declaring a virtual gateway unhealthy.
The port mapping information for the listener.
The port used for the port mapping. Specify one protocol.
The protocol used for the port mapping.
A reference to an object that represents the Transport Layer Security (TLS) properties for the listener.
An object that represents a 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.
A reference to an object that represents an Certificate Manager certificate.
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) .
A reference to an object that represents a local file certificate.
The certificate chain for the certificate.
The private key for a certificate stored on the file system of the mesh endpoint that the proxy is running on.
A reference to an object that represents a virtual gateway's listener's Secret Discovery Service certificate.
A reference to an object that represents the name of the secret secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.
Specify one of the following modes.
A reference to an object that represents a virtual gateway's listener's Transport Layer Security (TLS) validation context.
A reference to an object that represents the SANs for a virtual gateway listener's Transport Layer Security (TLS) validation context.
An object that represents the criteria for determining a SANs match.
The values sent must match the specified values exactly.
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.
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
A reference to an object that represents a virtual gateway's listener's Transport Layer Security (TLS) Secret Discovery Service validation context trust.
A reference to an object that represents the name of the secret for a virtual gateway's Transport Layer Security (TLS) Secret Discovery Service validation context trust.
An object that represents logging information.
The access log configuration.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: file.
The file object to send virtual gateway access logs to.
The specified format for the virtual gateway access logs. It can be either json_format or text_format .
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: json, text.
An object that represents the key value pairs for the JSON.
The specified key for the JSON.
The specified value for the JSON.
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.
[REQUIRED]
The name of the virtual gateway to update.
dict
Response Syntax
{
'virtualGateway': {
'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'
}
}
}
}
}
},
'listeners': [
{
'connectionPool': {
'grpc': {
'maxRequests': 123
},
'http': {
'maxConnections': 123,
'maxPendingRequests': 123
},
'http2': {
'maxRequests': 123
}
},
'healthCheck': {
'healthyThreshold': 123,
'intervalMillis': 123,
'path': 'string',
'port': 123,
'protocol': 'http'|'http2'|'grpc',
'timeoutMillis': 123,
'unhealthyThreshold': 123
},
'portMapping': {
'port': 123,
'protocol': 'http'|'http2'|'grpc'
},
'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': {
'format': {
'json': [
{
'key': 'string',
'value': 'string'
},
],
'text': 'string'
},
'path': 'string'
}
}
}
},
'status': {
'status': 'ACTIVE'|'INACTIVE'|'DELETED'
},
'virtualGatewayName': 'string'
}
}
Response Structure
(dict) --
virtualGateway (dict) --
A full description of the virtual gateway that was updated.
meshName (string) --
The name of the service mesh that the virtual gateway 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 Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes .
resourceOwner (string) --
The Amazon Web Services 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 gateway.
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 virtual gateway's client'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 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 mesh endpoint that the proxy is running on.
sds (dict) --
A reference to an object that represents a virtual gateway's client's Secret Discovery Service certificate.
secretName (string) --
A reference to an object that represents the name of the secret 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.
validation (dict) --
A reference to an object that represents a Transport Layer Security (TLS) validation context.
subjectAlternativeNames (dict) --
A reference to an object that represents the SANs for a virtual gateway's 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.
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.
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 virtual gateway'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 virtual gateway's Transport Layer Security (TLS) Secret Discovery Service validation context trust.
listeners (list) --
The listeners that the mesh endpoint is expected to receive inbound traffic from. You can specify one listener.
(dict) --
An object that represents a listener for a virtual gateway.
connectionPool (dict) --
The connection pool information for the virtual gateway listener.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: grpc, http, http2. 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.
healthCheck (dict) --
The health check information for the listener.
healthyThreshold (integer) --
The number of consecutive successful health checks that must occur before declaring the 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 gateway unhealthy.
portMapping (dict) --
The port mapping information for the listener.
port (integer) --
The port used for the port mapping. Specify one protocol.
protocol (string) --
The protocol used for the port mapping.
tls (dict) --
A reference to an object that represents the Transport Layer Security (TLS) properties for the listener.
certificate (dict) --
An object that represents a 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 Certificate Manager 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 mesh endpoint that the proxy is running on.
sds (dict) --
A reference to an object that represents a virtual gateway's listener's Secret Discovery Service certificate.
secretName (string) --
A reference to an object that represents the name of the secret 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.
validation (dict) --
A reference to an object that represents a virtual gateway's listener's Transport Layer Security (TLS) validation context.
subjectAlternativeNames (dict) --
A reference to an object that represents the SANs for a virtual gateway 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.
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 virtual gateway's 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 virtual gateway's Transport Layer Security (TLS) Secret Discovery Service validation context trust.
logging (dict) --
An object that represents logging information.
accessLog (dict) --
The access log configuration.
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 gateway access logs to.
format (dict) --
The specified format for the virtual gateway access logs. It can be either json_format or text_format .
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: json, text. 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'}
json (list) --
(dict) --
An object that represents the key value pairs for the JSON.
key (string) --
The specified key for the JSON.
value (string) --
The specified value for the JSON.
text (string) --
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.
status (dict) --
The current status of the virtual gateway.
status (string) --
The current status.
virtualGatewayName (string) --
The name of the virtual gateway.
Exceptions
AppMesh.Client.exceptions.NotFoundExceptionAppMesh.Client.exceptions.BadRequestExceptionAppMesh.Client.exceptions.ConflictExceptionAppMesh.Client.exceptions.TooManyRequestsExceptionAppMesh.Client.exceptions.ForbiddenExceptionAppMesh.Client.exceptions.ServiceUnavailableExceptionAppMesh.Client.exceptions.InternalServerErrorExceptionAppMesh.Client.exceptions.LimitExceededExceptionupdate_virtual_node(**kwargs)¶Updates an existing virtual node in a specified service mesh.
See also: AWS API Documentation
Request Syntax
response = 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': {
'format': {
'json': [
{
'key': 'string',
'value': 'string'
},
],
'text': 'string'
},
'path': 'string'
}
}
},
'serviceDiscovery': {
'awsCloudMap': {
'attributes': [
{
'key': 'string',
'value': 'string'
},
],
'ipPreference': 'IPv6_PREFERRED'|'IPv4_PREFERRED'|'IPv4_ONLY'|'IPv6_ONLY',
'namespaceName': 'string',
'serviceName': 'string'
},
'dns': {
'hostname': 'string',
'ipPreference': 'IPv6_PREFERRED'|'IPv4_PREFERRED'|'IPv4_ONLY'|'IPv6_ONLY',
'responseType': 'LOADBALANCER'|'ENDPOINTS'
}
}
},
virtualNodeName='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.
[REQUIRED]
The name of the service mesh that the virtual node resides in.
[REQUIRED]
The new virtual node specification to apply. This overwrites the existing data.
A reference to an object that represents the defaults for backends.
A reference to an object that represents a client policy.
A reference to an object that represents a Transport Layer Security (TLS) client policy.
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.
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) .
The certificate chain for the certificate.
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.
A reference to an object that represents a client's TLS Secret Discovery Service certificate.
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.
Whether the policy is enforced. The default is True , if a value isn't specified.
One or more ports that the policy is enforced for.
A reference to an object that represents a TLS validation context.
A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context. If you don't specify SANs on the terminating mesh endpoint, the Envoy proxy for that node doesn't verify the SAN on a peer client certificate. If you don't specify SANs on the originating mesh endpoint, the SAN on the certificate provided by the terminating endpoint must match the mesh endpoint service discovery configuration. Since SPIRE vended certificates have a SPIFFE ID as a name, you must set the SAN since the name doesn't match the service discovery name.
An object that represents the criteria for determining a SANs match.
The values sent must match the specified values exactly.
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.
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.
One or more ACM Amazon Resource Name (ARN)s.
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
A reference to an object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
The backends that the virtual node is expected to send outbound traffic to.
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.
Specifies a virtual service to use as a backend.
A reference to an object that represents the client policy for a backend.
A reference to an object that represents a Transport Layer Security (TLS) client policy.
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.
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) .
The certificate chain for the certificate.
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.
A reference to an object that represents a client's TLS Secret Discovery Service certificate.
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.
Whether the policy is enforced. The default is True , if a value isn't specified.
One or more ports that the policy is enforced for.
A reference to an object that represents a TLS validation context.
A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context. If you don't specify SANs on the terminating mesh endpoint, the Envoy proxy for that node doesn't verify the SAN on a peer client certificate. If you don't specify SANs on the originating mesh endpoint, the SAN on the certificate provided by the terminating endpoint must match the mesh endpoint service discovery configuration. Since SPIRE vended certificates have a SPIFFE ID as a name, you must set the SAN since the name doesn't match the service discovery name.
An object that represents the criteria for determining a SANs match.
The values sent must match the specified values exactly.
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.
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.
One or more ACM Amazon Resource Name (ARN)s.
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
A reference to an object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
The name of the virtual service that is acting as a virtual node backend.
The listener that the virtual node is expected to receive inbound traffic from. You can specify one listener.
An object that represents a listener for a virtual node.
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.
An object that represents a type of connection pool.
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.
An object that represents a type of connection pool.
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.
Number of overflowing requests after max_connections Envoy will queue to upstream cluster.
An object that represents a type of connection pool.
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.
An object that represents a type of connection pool.
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.
The health check information for the listener.
The number of consecutive successful health checks that must occur before declaring listener healthy.
The time period in milliseconds between each health check execution.
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.
The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.
The protocol for the health check request. If you specify grpc , then your service must conform to the GRPC Health Checking Protocol .
The amount of time to wait when receiving a response from the health check, in milliseconds.
The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.
The outlier detection information for the listener.
The base amount of time for which a host is ejected.
A unit of time.
A number of time units.
The time interval between ejection sweep analysis.
A unit of time.
A number of time units.
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.
Number of consecutive 5xx errors required for ejection.
The port mapping information for the listener.
The port used for the port mapping.
The protocol used for the port mapping. Specify one protocol.
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.
An object that represents types of timeouts.
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.
A unit of time.
A number of time units.
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.
A unit of time.
A number of time units.
An object that represents types of timeouts.
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.
A unit of time.
A number of time units.
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.
A unit of time.
A number of time units.
An object that represents types of timeouts.
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.
A unit of time.
A number of time units.
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.
A unit of time.
A number of time units.
An object that represents types of timeouts.
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.
A unit of time.
A number of time units.
A reference to an object that represents the Transport Layer Security (TLS) properties for a listener.
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.
A reference to an object that represents an Certificate Manager certificate.
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) .
A reference to an object that represents a local file certificate.
The certificate chain for the certificate.
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.
A reference to an object that represents a listener's Secret Discovery Service certificate.
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.
Specify one of the following modes.
A reference to an object that represents a listener's Transport Layer Security (TLS) validation context.
A reference to an object that represents the SANs for a listener's Transport Layer Security (TLS) validation context.
An object that represents the criteria for determining a SANs match.
The values sent must match the specified values exactly.
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.
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
A reference to an object that represents a listener's Transport Layer Security (TLS) Secret Discovery Service validation context trust.
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
The inbound and outbound access logging information for the virtual node.
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.
The file object to send virtual node access logs to.
The specified format for the logs. The format is either json_format or text_format .
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: json, text.
An object that represents the key value pairs for the JSON.
The specified key for the JSON.
The specified value for the JSON.
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> <p>The Envoy process must have write permissions to the path that you specify here. Otherwise, Envoy fails to bootstrap properly.</p> </note>
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.
Specifies any Cloud Map information for the virtual node.
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.
An object that represents the Cloud Map attribute information for your virtual node.
Note
Cloud Map is not available in the eu-south-1 Region.
The name of an Cloud Map service instance attribute key. Any Cloud Map service instance that contains the specified key and value is returned.
The value of an Cloud Map service instance attribute key. Any Cloud Map service instance that contains the specified key and value is returned.
The preferred IP version that this virtual node uses. Setting the IP preference on the virtual node only overrides the IP preference set for the mesh on this specific node.
The name of the Cloud Map namespace to use.
The name of the Cloud Map service to use.
Specifies the DNS information for the virtual node.
Specifies the DNS service discovery hostname for the virtual node.
The preferred IP version that this virtual node uses. Setting the IP preference on the virtual node only overrides the IP preference set for the mesh on this specific node.
Specifies the DNS response type for the virtual node.
[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': {
'format': {
'json': [
{
'key': 'string',
'value': 'string'
},
],
'text': 'string'
},
'path': 'string'
}
}
},
'serviceDiscovery': {
'awsCloudMap': {
'attributes': [
{
'key': 'string',
'value': 'string'
},
],
'ipPreference': 'IPv6_PREFERRED'|'IPv4_PREFERRED'|'IPv4_ONLY'|'IPv6_ONLY',
'namespaceName': 'string',
'serviceName': 'string'
},
'dns': {
'hostname': 'string',
'ipPreference': 'IPv6_PREFERRED'|'IPv4_PREFERRED'|'IPv4_ONLY'|'IPv6_ONLY',
'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 Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes .
resourceOwner (string) --
The Amazon Web Services 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.
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. If you don't specify SANs on the terminating mesh endpoint, the Envoy proxy for that node doesn't verify the SAN on a peer client certificate. If you don't specify SANs on the originating mesh endpoint, the SAN on the certificate provided by the terminating endpoint must match the mesh endpoint service discovery configuration. Since SPIRE vended certificates have a SPIFFE ID as a name, you must set the SAN since the name doesn't match the service discovery name.
match (dict) --
An object that represents the criteria for determining a SANs match.
exact (list) --
The values sent must match the specified values exactly.
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.
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.
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. If you don't specify SANs on the terminating mesh endpoint, the Envoy proxy for that node doesn't verify the SAN on a peer client certificate. If you don't specify SANs on the originating mesh endpoint, the SAN on the certificate provided by the terminating endpoint must match the mesh endpoint service discovery configuration. Since SPIRE vended certificates have a SPIFFE ID as a name, you must set the SAN since the name doesn't match the service discovery name.
match (dict) --
An object that represents the criteria for determining a SANs match.
exact (list) --
The values sent must match the specified values exactly.
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.
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 Certificate Manager 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.
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.
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.
format (dict) --
The specified format for the logs. The format is either json_format or text_format .
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: json, text. 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'}
json (list) --
(dict) --
An object that represents the key value pairs for the JSON.
key (string) --
The specified key for the JSON.
value (string) --
The specified value for the JSON.
text (string) --
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> <p>The Envoy process must have write permissions to the path that you specify here. Otherwise, Envoy fails to bootstrap properly.</p> </note>
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
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.
ipPreference (string) --
The preferred IP version that this virtual node uses. Setting the IP preference on the virtual node only overrides the IP preference set for the mesh on this specific node.
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.
ipPreference (string) --
The preferred IP version that this virtual node uses. Setting the IP preference on the virtual node only overrides the IP preference set for the mesh on this specific 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.
Exceptions
AppMesh.Client.exceptions.NotFoundExceptionAppMesh.Client.exceptions.BadRequestExceptionAppMesh.Client.exceptions.ConflictExceptionAppMesh.Client.exceptions.TooManyRequestsExceptionAppMesh.Client.exceptions.ForbiddenExceptionAppMesh.Client.exceptions.ServiceUnavailableExceptionAppMesh.Client.exceptions.InternalServerErrorExceptionAppMesh.Client.exceptions.LimitExceededExceptionupdate_virtual_router(**kwargs)¶Updates an existing virtual router in a specified service mesh.
See also: AWS API Documentation
Request Syntax
response = client.update_virtual_router(
clientToken='string',
meshName='string',
meshOwner='string',
spec={
'listeners': [
{
'portMapping': {
'port': 123,
'protocol': 'http'|'tcp'|'http2'|'grpc'
}
},
]
},
virtualRouterName='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.
[REQUIRED]
The name of the service mesh that the virtual router resides in.
[REQUIRED]
The new virtual router specification to apply. This overwrites the existing data.
The listeners that the virtual router is expected to receive inbound traffic from. You can specify one listener.
An object that represents a virtual router listener.
An object that represents a port mapping.
The port used for the port mapping.
The protocol used for the port mapping. Specify one protocol.
[REQUIRED]
The name of the virtual router to update.
dict
Response Syntax
{
'virtualRouter': {
'meshName': 'string',
'metadata': {
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'meshOwner': 'string',
'resourceOwner': 'string',
'uid': 'string',
'version': 123
},
'spec': {
'listeners': [
{
'portMapping': {
'port': 123,
'protocol': 'http'|'tcp'|'http2'|'grpc'
}
},
]
},
'status': {
'status': 'ACTIVE'|'INACTIVE'|'DELETED'
},
'virtualRouterName': 'string'
}
}
Response Structure
(dict) --
virtualRouter (dict) --
A full description of the virtual router that was updated.
meshName (string) --
The name of the service mesh that the virtual router resides in.
metadata (dict) --
The associated metadata for the virtual router.
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 Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes .
resourceOwner (string) --
The Amazon Web Services 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 router.
listeners (list) --
The listeners that the virtual router is expected to receive inbound traffic from. You can specify one listener.
(dict) --
An object that represents a virtual router listener.
portMapping (dict) --
An object that represents a port mapping.
port (integer) --
The port used for the port mapping.
protocol (string) --
The protocol used for the port mapping. Specify one protocol.
status (dict) --
The current status of the virtual router.
status (string) --
The current status of the virtual router.
virtualRouterName (string) --
The name of the virtual router.
Exceptions
AppMesh.Client.exceptions.NotFoundExceptionAppMesh.Client.exceptions.BadRequestExceptionAppMesh.Client.exceptions.ConflictExceptionAppMesh.Client.exceptions.TooManyRequestsExceptionAppMesh.Client.exceptions.ForbiddenExceptionAppMesh.Client.exceptions.ServiceUnavailableExceptionAppMesh.Client.exceptions.InternalServerErrorExceptionAppMesh.Client.exceptions.LimitExceededExceptionupdate_virtual_service(**kwargs)¶Updates an existing virtual service in a specified service mesh.
See also: AWS API Documentation
Request Syntax
response = client.update_virtual_service(
clientToken='string',
meshName='string',
meshOwner='string',
spec={
'provider': {
'virtualNode': {
'virtualNodeName': 'string'
},
'virtualRouter': {
'virtualRouterName': 'string'
}
}
},
virtualServiceName='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.
[REQUIRED]
The name of the service mesh that the virtual service resides in.
[REQUIRED]
The new virtual service specification to apply. This overwrites the existing data.
The App Mesh object that is acting as the provider for a virtual service. You can specify a single virtual node or virtual router.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: virtualNode, virtualRouter.
The virtual node associated with a virtual service.
The name of the virtual node that is acting as a service provider.
The virtual router associated with a virtual service.
The name of the virtual router that is acting as a service provider.
[REQUIRED]
The name of the virtual service to update.
dict
Response Syntax
{
'virtualService': {
'meshName': 'string',
'metadata': {
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'meshOwner': 'string',
'resourceOwner': 'string',
'uid': 'string',
'version': 123
},
'spec': {
'provider': {
'virtualNode': {
'virtualNodeName': 'string'
},
'virtualRouter': {
'virtualRouterName': 'string'
}
}
},
'status': {
'status': 'ACTIVE'|'INACTIVE'|'DELETED'
},
'virtualServiceName': 'string'
}
}
Response Structure
(dict) --
virtualService (dict) --
A full description of the virtual service that was updated.
meshName (string) --
The name of the service mesh that the virtual service 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 Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes .
resourceOwner (string) --
The Amazon Web Services 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 service.
provider (dict) --
The App Mesh object that is acting as the provider for a virtual service. You can specify a single virtual node or virtual router.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: virtualNode, virtualRouter. 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'}
virtualNode (dict) --
The virtual node associated with a virtual service.
virtualNodeName (string) --
The name of the virtual node that is acting as a service provider.
virtualRouter (dict) --
The virtual router associated with a virtual service.
virtualRouterName (string) --
The name of the virtual router that is acting as a service provider.
status (dict) --
The current status of the virtual service.
status (string) --
The current status of the virtual service.
virtualServiceName (string) --
The name of the virtual service.
Exceptions
AppMesh.Client.exceptions.NotFoundExceptionAppMesh.Client.exceptions.BadRequestExceptionAppMesh.Client.exceptions.ConflictExceptionAppMesh.Client.exceptions.TooManyRequestsExceptionAppMesh.Client.exceptions.ForbiddenExceptionAppMesh.Client.exceptions.ServiceUnavailableExceptionAppMesh.Client.exceptions.InternalServerErrorExceptionAppMesh.Client.exceptions.LimitExceededExceptionThe available paginators are:
AppMesh.Paginator.ListGatewayRoutesAppMesh.Paginator.ListMeshesAppMesh.Paginator.ListRoutesAppMesh.Paginator.ListTagsForResourceAppMesh.Paginator.ListVirtualGatewaysAppMesh.Paginator.ListVirtualNodesAppMesh.Paginator.ListVirtualRoutersAppMesh.Paginator.ListVirtualServicesAppMesh.Paginator.ListGatewayRoutes¶paginator = client.get_paginator('list_gateway_routes')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from AppMesh.Client.list_gateway_routes().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
meshName='string',
meshOwner='string',
virtualGatewayName='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the service mesh to list gateway routes in.
[REQUIRED]
The name of the virtual gateway to list gateway routes in.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'gatewayRoutes': [
{
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'gatewayRouteName': 'string',
'lastUpdatedAt': datetime(2015, 1, 1),
'meshName': 'string',
'meshOwner': 'string',
'resourceOwner': 'string',
'version': 123,
'virtualGatewayName': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
gatewayRoutes (list) --
The list of existing gateway routes for the specified service mesh and virtual gateway.
(dict) --
An object that represents a gateway route returned by a list operation.
arn (string) --
The full Amazon Resource Name (ARN) for the gateway route.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was created.
gatewayRouteName (string) --
The name of the gateway route.
lastUpdatedAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was last updated.
meshName (string) --
The name of the service mesh that the resource resides in.
meshOwner (string) --
The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes .
resourceOwner (string) --
The Amazon Web Services 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 .
version (integer) --
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
virtualGatewayName (string) --
The virtual gateway that the gateway route is associated with.
NextToken (string) --
A token to resume pagination.
AppMesh.Paginator.ListMeshes¶paginator = client.get_paginator('list_meshes')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from AppMesh.Client.list_meshes().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'meshes': [
{
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'meshName': 'string',
'meshOwner': 'string',
'resourceOwner': 'string',
'version': 123
},
],
'NextToken': 'string'
}
Response Structure
The list of existing service meshes.
An object that represents a service mesh returned by a list operation.
The full Amazon Resource Name (ARN) of the service mesh.
The Unix epoch timestamp in seconds for when the resource was created.
The Unix epoch timestamp in seconds for when the resource was last updated.
The name of the service mesh.
The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes .
The Amazon Web Services 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 .
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
A token to resume pagination.
AppMesh.Paginator.ListRoutes¶paginator = client.get_paginator('list_routes')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from AppMesh.Client.list_routes().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
meshName='string',
meshOwner='string',
virtualRouterName='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the service mesh to list routes in.
[REQUIRED]
The name of the virtual router to list routes in.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'routes': [
{
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'meshName': 'string',
'meshOwner': 'string',
'resourceOwner': 'string',
'routeName': 'string',
'version': 123,
'virtualRouterName': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
routes (list) --
The list of existing routes for the specified service mesh and virtual router.
(dict) --
An object that represents a route returned by a list operation.
arn (string) --
The full Amazon Resource Name (ARN) for the route.
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.
meshName (string) --
The name of the service mesh that the route resides in.
meshOwner (string) --
The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes .
resourceOwner (string) --
The Amazon Web Services 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 .
routeName (string) --
The name of the route.
version (integer) --
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
virtualRouterName (string) --
The virtual router that the route is associated with.
NextToken (string) --
A token to resume pagination.
AppMesh.Paginator.ListTagsForResource¶paginator = client.get_paginator('list_tags_for_resource')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from AppMesh.Client.list_tags_for_resource().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
resourceArn='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) that identifies the resource to list the tags for.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
tags (list) --
The tags for the resource.
(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) --
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) --
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
NextToken (string) --
A token to resume pagination.
AppMesh.Paginator.ListVirtualGateways¶paginator = client.get_paginator('list_virtual_gateways')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from AppMesh.Client.list_virtual_gateways().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
meshName='string',
meshOwner='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the service mesh to list virtual gateways in.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'virtualGateways': [
{
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'meshName': 'string',
'meshOwner': 'string',
'resourceOwner': 'string',
'version': 123,
'virtualGatewayName': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
virtualGateways (list) --
The list of existing virtual gateways for the specified service mesh.
(dict) --
An object that represents a virtual gateway returned by a list operation.
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.
meshName (string) --
The name of the service mesh that the resource resides in.
meshOwner (string) --
The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes .
resourceOwner (string) --
The Amazon Web Services 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 .
version (integer) --
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
virtualGatewayName (string) --
The name of the resource.
NextToken (string) --
A token to resume pagination.
AppMesh.Paginator.ListVirtualNodes¶paginator = client.get_paginator('list_virtual_nodes')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from AppMesh.Client.list_virtual_nodes().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
meshName='string',
meshOwner='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the service mesh to list virtual nodes in.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'virtualNodes': [
{
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'meshName': 'string',
'meshOwner': 'string',
'resourceOwner': 'string',
'version': 123,
'virtualNodeName': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
virtualNodes (list) --
The list of existing virtual nodes for the specified service mesh.
(dict) --
An object that represents a virtual node returned by a list operation.
arn (string) --
The full Amazon Resource Name (ARN) for the virtual node.
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.
meshName (string) --
The name of the service mesh that the virtual node resides in.
meshOwner (string) --
The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes .
resourceOwner (string) --
The Amazon Web Services 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 .
version (integer) --
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
virtualNodeName (string) --
The name of the virtual node.
NextToken (string) --
A token to resume pagination.
AppMesh.Paginator.ListVirtualRouters¶paginator = client.get_paginator('list_virtual_routers')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from AppMesh.Client.list_virtual_routers().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
meshName='string',
meshOwner='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the service mesh to list virtual routers in.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'virtualRouters': [
{
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'meshName': 'string',
'meshOwner': 'string',
'resourceOwner': 'string',
'version': 123,
'virtualRouterName': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
virtualRouters (list) --
The list of existing virtual routers for the specified service mesh.
(dict) --
An object that represents a virtual router returned by a list operation.
arn (string) --
The full Amazon Resource Name (ARN) for the virtual router.
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.
meshName (string) --
The name of the service mesh that the virtual router resides in.
meshOwner (string) --
The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes .
resourceOwner (string) --
The Amazon Web Services 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 .
version (integer) --
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
virtualRouterName (string) --
The name of the virtual router.
NextToken (string) --
A token to resume pagination.
AppMesh.Paginator.ListVirtualServices¶paginator = client.get_paginator('list_virtual_services')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from AppMesh.Client.list_virtual_services().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
meshName='string',
meshOwner='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the service mesh to list virtual services in.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'virtualServices': [
{
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'meshName': 'string',
'meshOwner': 'string',
'resourceOwner': 'string',
'version': 123,
'virtualServiceName': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
virtualServices (list) --
The list of existing virtual services for the specified service mesh.
(dict) --
An object that represents a virtual service returned by a list operation.
arn (string) --
The full Amazon Resource Name (ARN) for the virtual service.
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.
meshName (string) --
The name of the service mesh that the virtual service resides in.
meshOwner (string) --
The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes .
resourceOwner (string) --
The Amazon Web Services 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 .
version (integer) --
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
virtualServiceName (string) --
The name of the virtual service.
NextToken (string) --
A token to resume pagination.