2021/02/03 - AWS App Mesh - 8 updated api methods
Changes App Mesh now supports mutual TLS with two-way peer authentication. You can specify client certificates, server-side TLS validation, and matching of Subject Alternative Names.
{'spec': {'backendDefaults': {'clientPolicy': {'tls': {'certificate': {'file': {'certificateChain': 'string',
'privateKey': 'string'},
'sds': {'secretName': 'string'}},
'validation': {'subjectAlternativeNames': {'match': {'exact': ['string']}},
'trust': {'sds': {'secretName': 'string'}}}}}},
'listeners': {'tls': {'certificate': {'sds': {'secretName': 'string'}},
'validation': {'subjectAlternativeNames': {'match': {'exact': ['string']}},
'trust': {'file': {'certificateChain': 'string'},
'sds': {'secretName': 'string'}}}}}}}
Response {'virtualGateway': {'spec': {'backendDefaults': {'clientPolicy': {'tls': {'certificate': {'file': {'certificateChain': 'string',
'privateKey': 'string'},
'sds': {'secretName': 'string'}},
'validation': {'subjectAlternativeNames': {'match': {'exact': ['string']}},
'trust': {'sds': {'secretName': 'string'}}}}}},
'listeners': {'tls': {'certificate': {'sds': {'secretName': 'string'}},
'validation': {'subjectAlternativeNames': {'match': {'exact': ['string']}},
'trust': {'file': {'certificateChain': 'string'},
'sds': {'secretName': 'string'}}}}}}}}
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
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': {
'path': 'string'
}
}
}
},
tags=[
{
'key': 'string',
'value': 'string'
},
],
virtualGatewayName='string'
)
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
This field is autopopulated if not provided.
string
[REQUIRED]
The name of the service mesh to create the virtual gateway in.
string
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes.
dict
[REQUIRED]
The virtual gateway specification to apply.
backendDefaults (dict) --
A reference to an object that represents the defaults for backends.
clientPolicy (dict) --
A reference to an object that represents a client policy.
tls (dict) --
A reference to an object that represents a Transport Layer Security (TLS) client policy.
certificate (dict) --
A reference to an object that represents a 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.
file (dict) --
An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
certificateChain (string) -- [REQUIRED]
The certificate chain for the certificate.
privateKey (string) -- [REQUIRED]
The private key for a certificate stored on the file system of the 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) -- [REQUIRED]
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.
(integer) --
validation (dict) -- [REQUIRED]
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) -- [REQUIRED]
An object that represents the criteria for determining a SANs match.
exact (list) -- [REQUIRED]
The values sent must match the specified values exactly.
(string) --
trust (dict) -- [REQUIRED]
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: acm, file, sds.
acm (dict) --
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an AWS Certicate Manager (ACM) certificate.
certificateAuthorityArns (list) -- [REQUIRED]
One or more ACM Amazon Resource Name (ARN)s.
(string) --
file (dict) --
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
certificateChain (string) -- [REQUIRED]
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a virtual gateway's Transport Layer Security (TLS) Secret Discovery Service validation context trust.
secretName (string) -- [REQUIRED]
A reference to an object that represents the name of the secret for a virtual gateway's Transport Layer Security (TLS) Secret Discovery Service validation context trust.
listeners (list) -- [REQUIRED]
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 can be set: grpc, http, http2.
grpc (dict) --
An object that represents a type of connection pool.
maxRequests (integer) -- [REQUIRED]
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.
http (dict) --
An object that represents a type of connection pool.
maxConnections (integer) -- [REQUIRED]
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.
maxPendingRequests (integer) --
Number of overflowing requests after max_connections Envoy will queue to upstream cluster.
http2 (dict) --
An object that represents a type of connection pool.
maxRequests (integer) -- [REQUIRED]
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.
healthCheck (dict) --
The health check information for the listener.
healthyThreshold (integer) -- [REQUIRED]
The number of consecutive successful health checks that must occur before declaring the listener healthy.
intervalMillis (integer) -- [REQUIRED]
The time period in milliseconds between each health check execution.
path (string) --
The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.
port (integer) --
The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.
protocol (string) -- [REQUIRED]
The protocol for the health check request. If you specify grpc , then your service must conform to the GRPC Health Checking Protocol.
timeoutMillis (integer) -- [REQUIRED]
The amount of time to wait when receiving a response from the health check, in milliseconds.
unhealthyThreshold (integer) -- [REQUIRED]
The number of consecutive failed health checks that must occur before declaring a virtual gateway unhealthy.
portMapping (dict) -- [REQUIRED]
The port mapping information for the listener.
port (integer) -- [REQUIRED]
The port used for the port mapping. Specify one protocol.
protocol (string) -- [REQUIRED]
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) -- [REQUIRED]
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.
acm (dict) --
A reference to an object that represents an AWS Certicate Manager (ACM) certificate.
certificateArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
file (dict) --
A reference to an object that represents a local file certificate.
certificateChain (string) -- [REQUIRED]
The certificate chain for the certificate.
privateKey (string) -- [REQUIRED]
The private key for a certificate stored on the file system of the 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) -- [REQUIRED]
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) -- [REQUIRED]
Specify one of the following modes.
STRICT – Listener only accepts connections with TLS enabled.
PERMISSIVE – Listener accepts connections with or without TLS enabled.
DISABLED – Listener only accepts connections without TLS.
validation (dict) --
A reference to an object that represents a 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) -- [REQUIRED]
An object that represents the criteria for determining a SANs match.
exact (list) -- [REQUIRED]
The values sent must match the specified values exactly.
(string) --
trust (dict) -- [REQUIRED]
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: file, sds.
file (dict) --
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
certificateChain (string) -- [REQUIRED]
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a virtual gateway's listener's Transport Layer Security (TLS) Secret Discovery Service validation context trust.
secretName (string) -- [REQUIRED]
A reference to an object that represents the name of the secret for a 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 can be set: file.
file (dict) --
The file object to send virtual gateway access logs to.
path (string) -- [REQUIRED]
The file path to write access logs to. You can use /dev/stdout to send access logs to standard out and configure your Envoy container to use a log driver, such as awslogs , to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk.
list
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.
(dict) --
Optional metadata that you apply to a resource to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
key (string) -- [REQUIRED]
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
value (string) -- [REQUIRED]
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
string
[REQUIRED]
The name to use for the virtual 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': {
'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 AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
resourceOwner (string) --
The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
uid (string) --
The unique identifier for the resource.
version (integer) --
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
spec (dict) --
The specifications of the virtual 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.
(integer) --
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.
(string) --
trust (dict) --
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: acm, file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
acm (dict) --
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an AWS Certicate Manager (ACM) certificate.
certificateAuthorityArns (list) --
One or more ACM Amazon Resource Name (ARN)s.
(string) --
file (dict) --
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
certificateChain (string) --
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a 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 AWS Certicate Manager (ACM) certificate.
certificateArn (string) --
The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
file (dict) --
A reference to an object that represents a local file certificate.
certificateChain (string) --
The certificate chain for the certificate.
privateKey (string) --
The private key for a certificate stored on the file system of the 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.
STRICT – Listener only accepts connections with TLS enabled.
PERMISSIVE – Listener accepts connections with or without TLS enabled.
DISABLED – Listener only accepts connections without TLS.
validation (dict) --
A reference to an object that represents a 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.
(string) --
trust (dict) --
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
file (dict) --
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
certificateChain (string) --
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a 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.
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.
{'spec': {'backendDefaults': {'clientPolicy': {'tls': {'certificate': {'file': {'certificateChain': 'string',
'privateKey': 'string'},
'sds': {'secretName': 'string'}},
'validation': {'subjectAlternativeNames': {'match': {'exact': ['string']}},
'trust': {'sds': {'secretName': 'string'}}}}}},
'backends': {'virtualService': {'clientPolicy': {'tls': {'certificate': {'file': {'certificateChain': 'string',
'privateKey': 'string'},
'sds': {'secretName': 'string'}},
'validation': {'subjectAlternativeNames': {'match': {'exact': ['string']}},
'trust': {'sds': {'secretName': 'string'}}}}}}},
'listeners': {'tls': {'certificate': {'sds': {'secretName': 'string'}},
'validation': {'subjectAlternativeNames': {'match': {'exact': ['string']}},
'trust': {'file': {'certificateChain': 'string'},
'sds': {'secretName': 'string'}}}}}}}
Response {'virtualNode': {'spec': {'backendDefaults': {'clientPolicy': {'tls': {'certificate': {'file': {'certificateChain': 'string',
'privateKey': 'string'},
'sds': {'secretName': 'string'}},
'validation': {'subjectAlternativeNames': {'match': {'exact': ['string']}},
'trust': {'sds': {'secretName': 'string'}}}}}},
'backends': {'virtualService': {'clientPolicy': {'tls': {'certificate': {'file': {'certificateChain': 'string',
'privateKey': 'string'},
'sds': {'secretName': 'string'}},
'validation': {'subjectAlternativeNames': {'match': {'exact': ['string']}},
'trust': {'sds': {'secretName': 'string'}}}}}}},
'listeners': {'tls': {'certificate': {'sds': {'secretName': 'string'}},
'validation': {'subjectAlternativeNames': {'match': {'exact': ['string']}},
'trust': {'file': {'certificateChain': 'string'},
'sds': {'secretName': 'string'}}}}}}}}
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.
AWS Cloud Map is not available in the eu-south-1 Region.
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 about App Mesh Envoy variables, see Envoy image in the AWS App Mesh User Guide.
See also: AWS API Documentation
Request Syntax
client.create_virtual_node(
clientToken='string',
meshName='string',
meshOwner='string',
spec={
'backendDefaults': {
'clientPolicy': {
'tls': {
'certificate': {
'file': {
'certificateChain': 'string',
'privateKey': 'string'
},
'sds': {
'secretName': 'string'
}
},
'enforce': True|False,
'ports': [
123,
],
'validation': {
'subjectAlternativeNames': {
'match': {
'exact': [
'string',
]
}
},
'trust': {
'acm': {
'certificateAuthorityArns': [
'string',
]
},
'file': {
'certificateChain': 'string'
},
'sds': {
'secretName': 'string'
}
}
}
}
}
},
'backends': [
{
'virtualService': {
'clientPolicy': {
'tls': {
'certificate': {
'file': {
'certificateChain': 'string',
'privateKey': 'string'
},
'sds': {
'secretName': 'string'
}
},
'enforce': True|False,
'ports': [
123,
],
'validation': {
'subjectAlternativeNames': {
'match': {
'exact': [
'string',
]
}
},
'trust': {
'acm': {
'certificateAuthorityArns': [
'string',
]
},
'file': {
'certificateChain': 'string'
},
'sds': {
'secretName': 'string'
}
}
}
}
},
'virtualServiceName': 'string'
}
},
],
'listeners': [
{
'connectionPool': {
'grpc': {
'maxRequests': 123
},
'http': {
'maxConnections': 123,
'maxPendingRequests': 123
},
'http2': {
'maxRequests': 123
},
'tcp': {
'maxConnections': 123
}
},
'healthCheck': {
'healthyThreshold': 123,
'intervalMillis': 123,
'path': 'string',
'port': 123,
'protocol': 'http'|'tcp'|'http2'|'grpc',
'timeoutMillis': 123,
'unhealthyThreshold': 123
},
'outlierDetection': {
'baseEjectionDuration': {
'unit': 's'|'ms',
'value': 123
},
'interval': {
'unit': 's'|'ms',
'value': 123
},
'maxEjectionPercent': 123,
'maxServerErrors': 123
},
'portMapping': {
'port': 123,
'protocol': 'http'|'tcp'|'http2'|'grpc'
},
'timeout': {
'grpc': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
},
'http': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
},
'http2': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
},
'tcp': {
'idle': {
'unit': 's'|'ms',
'value': 123
}
}
},
'tls': {
'certificate': {
'acm': {
'certificateArn': 'string'
},
'file': {
'certificateChain': 'string',
'privateKey': 'string'
},
'sds': {
'secretName': 'string'
}
},
'mode': 'STRICT'|'PERMISSIVE'|'DISABLED',
'validation': {
'subjectAlternativeNames': {
'match': {
'exact': [
'string',
]
}
},
'trust': {
'file': {
'certificateChain': 'string'
},
'sds': {
'secretName': 'string'
}
}
}
}
},
],
'logging': {
'accessLog': {
'file': {
'path': 'string'
}
}
},
'serviceDiscovery': {
'awsCloudMap': {
'attributes': [
{
'key': 'string',
'value': 'string'
},
],
'namespaceName': 'string',
'serviceName': 'string'
},
'dns': {
'hostname': 'string'
}
}
},
tags=[
{
'key': 'string',
'value': 'string'
},
],
virtualNodeName='string'
)
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
This field is autopopulated if not provided.
string
[REQUIRED]
The name of the service mesh to create the virtual node in.
string
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes.
dict
[REQUIRED]
The virtual node specification to apply.
backendDefaults (dict) --
A reference to an object that represents the defaults for backends.
clientPolicy (dict) --
A reference to an object that represents a client policy.
tls (dict) --
A reference to an object that represents a Transport Layer Security (TLS) client policy.
certificate (dict) --
A reference to an object that represents a client's TLS certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: file, sds.
file (dict) --
An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
certificateChain (string) -- [REQUIRED]
The certificate chain for the certificate.
privateKey (string) -- [REQUIRED]
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a client's TLS Secret Discovery Service certificate.
secretName (string) -- [REQUIRED]
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.
enforce (boolean) --
Whether the policy is enforced. The default is True , if a value isn't specified.
ports (list) --
One or more ports that the policy is enforced for.
(integer) --
validation (dict) -- [REQUIRED]
A reference to an object that represents a TLS validation context.
subjectAlternativeNames (dict) --
A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context.
match (dict) -- [REQUIRED]
An object that represents the criteria for determining a SANs match.
exact (list) -- [REQUIRED]
The values sent must match the specified values exactly.
(string) --
trust (dict) -- [REQUIRED]
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: acm, file, sds.
acm (dict) --
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an AWS Certicate Manager (ACM) certificate.
certificateAuthorityArns (list) -- [REQUIRED]
One or more ACM Amazon Resource Name (ARN)s.
(string) --
file (dict) --
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
certificateChain (string) -- [REQUIRED]
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
secretName (string) -- [REQUIRED]
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
backends (list) --
The backends that the virtual node is expected to send outbound traffic to.
(dict) --
An object that represents the backends that a virtual node is expected to send outbound traffic to.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: virtualService.
virtualService (dict) --
Specifies a virtual service to use as a backend.
clientPolicy (dict) --
A reference to an object that represents the client policy for a backend.
tls (dict) --
A reference to an object that represents a Transport Layer Security (TLS) client policy.
certificate (dict) --
A reference to an object that represents a client's TLS certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: file, sds.
file (dict) --
An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
certificateChain (string) -- [REQUIRED]
The certificate chain for the certificate.
privateKey (string) -- [REQUIRED]
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a client's TLS Secret Discovery Service certificate.
secretName (string) -- [REQUIRED]
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.
enforce (boolean) --
Whether the policy is enforced. The default is True , if a value isn't specified.
ports (list) --
One or more ports that the policy is enforced for.
(integer) --
validation (dict) -- [REQUIRED]
A reference to an object that represents a TLS validation context.
subjectAlternativeNames (dict) --
A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context.
match (dict) -- [REQUIRED]
An object that represents the criteria for determining a SANs match.
exact (list) -- [REQUIRED]
The values sent must match the specified values exactly.
(string) --
trust (dict) -- [REQUIRED]
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: acm, file, sds.
acm (dict) --
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an AWS Certicate Manager (ACM) certificate.
certificateAuthorityArns (list) -- [REQUIRED]
One or more ACM Amazon Resource Name (ARN)s.
(string) --
file (dict) --
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
certificateChain (string) -- [REQUIRED]
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
secretName (string) -- [REQUIRED]
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
virtualServiceName (string) -- [REQUIRED]
The name of the virtual service that is acting as a virtual node backend.
listeners (list) --
The listener that the virtual node is expected to receive inbound traffic from. You can specify one listener.
(dict) --
An object that represents a listener for a virtual node.
connectionPool (dict) --
The connection pool information for the listener.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: grpc, http, http2, tcp.
grpc (dict) --
An object that represents a type of connection pool.
maxRequests (integer) -- [REQUIRED]
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.
http (dict) --
An object that represents a type of connection pool.
maxConnections (integer) -- [REQUIRED]
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.
maxPendingRequests (integer) --
Number of overflowing requests after max_connections Envoy will queue to upstream cluster.
http2 (dict) --
An object that represents a type of connection pool.
maxRequests (integer) -- [REQUIRED]
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.
tcp (dict) --
An object that represents a type of connection pool.
maxConnections (integer) -- [REQUIRED]
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.
healthCheck (dict) --
The health check information for the listener.
healthyThreshold (integer) -- [REQUIRED]
The number of consecutive successful health checks that must occur before declaring listener healthy.
intervalMillis (integer) -- [REQUIRED]
The time period in milliseconds between each health check execution.
path (string) --
The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.
port (integer) --
The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.
protocol (string) -- [REQUIRED]
The protocol for the health check request. If you specify grpc , then your service must conform to the GRPC Health Checking Protocol.
timeoutMillis (integer) -- [REQUIRED]
The amount of time to wait when receiving a response from the health check, in milliseconds.
unhealthyThreshold (integer) -- [REQUIRED]
The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.
outlierDetection (dict) --
The outlier detection information for the listener.
baseEjectionDuration (dict) -- [REQUIRED]
The base amount of time for which a host is ejected.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
interval (dict) -- [REQUIRED]
The time interval between ejection sweep analysis.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
maxEjectionPercent (integer) -- [REQUIRED]
Maximum percentage of hosts in load balancing pool for upstream service that can be ejected. Will eject at least one host regardless of the value.
maxServerErrors (integer) -- [REQUIRED]
Number of consecutive 5xx errors required for ejection.
portMapping (dict) -- [REQUIRED]
The port mapping information for the listener.
port (integer) -- [REQUIRED]
The port used for the port mapping.
protocol (string) -- [REQUIRED]
The protocol used for the port mapping. Specify one protocol.
timeout (dict) --
An object that represents timeouts for different protocols.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: grpc, http, http2, tcp.
grpc (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
http (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
http2 (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
tcp (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
tls (dict) --
A reference to an object that represents the Transport Layer Security (TLS) properties for a listener.
certificate (dict) -- [REQUIRED]
A reference to an object that represents a listener's Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: acm, file, sds.
acm (dict) --
A reference to an object that represents an AWS Certicate Manager (ACM) certificate.
certificateArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
file (dict) --
A reference to an object that represents a local file certificate.
certificateChain (string) -- [REQUIRED]
The certificate chain for the certificate.
privateKey (string) -- [REQUIRED]
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a listener's Secret Discovery Service certificate.
secretName (string) -- [REQUIRED]
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.
mode (string) -- [REQUIRED]
Specify one of the following modes.
STRICT – Listener only accepts connections with TLS enabled.
PERMISSIVE – Listener accepts connections with or without TLS enabled.
DISABLED – Listener only accepts connections without TLS.
validation (dict) --
A reference to an object that represents a listener's Transport Layer Security (TLS) validation context.
subjectAlternativeNames (dict) --
A reference to an object that represents the SANs for a listener's Transport Layer Security (TLS) validation context.
match (dict) -- [REQUIRED]
An object that represents the criteria for determining a SANs match.
exact (list) -- [REQUIRED]
The values sent must match the specified values exactly.
(string) --
trust (dict) -- [REQUIRED]
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: file, sds.
file (dict) --
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
certificateChain (string) -- [REQUIRED]
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a listener's Transport Layer Security (TLS) Secret Discovery Service validation context trust.
secretName (string) -- [REQUIRED]
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
logging (dict) --
The inbound and outbound access logging information for the virtual node.
accessLog (dict) --
The access log configuration for a virtual node.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: file.
file (dict) --
The file object to send virtual node access logs to.
path (string) -- [REQUIRED]
The file path to write access logs to. You can use /dev/stdout to send access logs to standard out and configure your Envoy container to use a log driver, such as awslogs , to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk.
Note
The Envoy process must have write permissions to the path that you specify here. Otherwise, Envoy fails to bootstrap properly.
serviceDiscovery (dict) --
The service discovery information for the virtual node. If your virtual node does not expect ingress traffic, you can omit this parameter. If you specify a listener , then you must specify service discovery information.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: awsCloudMap, dns.
awsCloudMap (dict) --
Specifies any AWS 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 AWS Cloud Map attribute information for your virtual node.
Note
AWS Cloud Map is not available in the eu-south-1 Region.
key (string) -- [REQUIRED]
The name of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service instance that contains the specified key and value is returned.
value (string) -- [REQUIRED]
The value of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service instance that contains the specified key and value is returned.
namespaceName (string) -- [REQUIRED]
The name of the AWS Cloud Map namespace to use.
serviceName (string) -- [REQUIRED]
The name of the AWS Cloud Map service to use.
dns (dict) --
Specifies the DNS information for the virtual node.
hostname (string) -- [REQUIRED]
Specifies the DNS service discovery hostname for the virtual node.
list
Optional metadata that you can apply to the virtual node to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
(dict) --
Optional metadata that you apply to a resource to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
key (string) -- [REQUIRED]
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
value (string) -- [REQUIRED]
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
string
[REQUIRED]
The name to use for the virtual node.
dict
Response Syntax
{
'virtualNode': {
'meshName': 'string',
'metadata': {
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'meshOwner': 'string',
'resourceOwner': 'string',
'uid': 'string',
'version': 123
},
'spec': {
'backendDefaults': {
'clientPolicy': {
'tls': {
'certificate': {
'file': {
'certificateChain': 'string',
'privateKey': 'string'
},
'sds': {
'secretName': 'string'
}
},
'enforce': True|False,
'ports': [
123,
],
'validation': {
'subjectAlternativeNames': {
'match': {
'exact': [
'string',
]
}
},
'trust': {
'acm': {
'certificateAuthorityArns': [
'string',
]
},
'file': {
'certificateChain': 'string'
},
'sds': {
'secretName': 'string'
}
}
}
}
}
},
'backends': [
{
'virtualService': {
'clientPolicy': {
'tls': {
'certificate': {
'file': {
'certificateChain': 'string',
'privateKey': 'string'
},
'sds': {
'secretName': 'string'
}
},
'enforce': True|False,
'ports': [
123,
],
'validation': {
'subjectAlternativeNames': {
'match': {
'exact': [
'string',
]
}
},
'trust': {
'acm': {
'certificateAuthorityArns': [
'string',
]
},
'file': {
'certificateChain': 'string'
},
'sds': {
'secretName': 'string'
}
}
}
}
},
'virtualServiceName': 'string'
}
},
],
'listeners': [
{
'connectionPool': {
'grpc': {
'maxRequests': 123
},
'http': {
'maxConnections': 123,
'maxPendingRequests': 123
},
'http2': {
'maxRequests': 123
},
'tcp': {
'maxConnections': 123
}
},
'healthCheck': {
'healthyThreshold': 123,
'intervalMillis': 123,
'path': 'string',
'port': 123,
'protocol': 'http'|'tcp'|'http2'|'grpc',
'timeoutMillis': 123,
'unhealthyThreshold': 123
},
'outlierDetection': {
'baseEjectionDuration': {
'unit': 's'|'ms',
'value': 123
},
'interval': {
'unit': 's'|'ms',
'value': 123
},
'maxEjectionPercent': 123,
'maxServerErrors': 123
},
'portMapping': {
'port': 123,
'protocol': 'http'|'tcp'|'http2'|'grpc'
},
'timeout': {
'grpc': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
},
'http': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
},
'http2': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
},
'tcp': {
'idle': {
'unit': 's'|'ms',
'value': 123
}
}
},
'tls': {
'certificate': {
'acm': {
'certificateArn': 'string'
},
'file': {
'certificateChain': 'string',
'privateKey': 'string'
},
'sds': {
'secretName': 'string'
}
},
'mode': 'STRICT'|'PERMISSIVE'|'DISABLED',
'validation': {
'subjectAlternativeNames': {
'match': {
'exact': [
'string',
]
}
},
'trust': {
'file': {
'certificateChain': 'string'
},
'sds': {
'secretName': 'string'
}
}
}
}
},
],
'logging': {
'accessLog': {
'file': {
'path': 'string'
}
}
},
'serviceDiscovery': {
'awsCloudMap': {
'attributes': [
{
'key': 'string',
'value': 'string'
},
],
'namespaceName': 'string',
'serviceName': 'string'
},
'dns': {
'hostname': 'string'
}
}
},
'status': {
'status': 'ACTIVE'|'INACTIVE'|'DELETED'
},
'virtualNodeName': 'string'
}
}
Response Structure
(dict) --
virtualNode (dict) --
The full description of your virtual node following the create call.
meshName (string) --
The name of the service mesh that the virtual node resides in.
metadata (dict) --
The associated metadata for the virtual node.
arn (string) --
The full Amazon Resource Name (ARN) for the resource.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was created.
lastUpdatedAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was last updated.
meshOwner (string) --
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
resourceOwner (string) --
The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
uid (string) --
The unique identifier for the resource.
version (integer) --
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
spec (dict) --
The specifications of the virtual node.
backendDefaults (dict) --
A reference to an object that represents the defaults for backends.
clientPolicy (dict) --
A reference to an object that represents a client policy.
tls (dict) --
A reference to an object that represents a Transport Layer Security (TLS) client policy.
certificate (dict) --
A reference to an object that represents a client's TLS certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
file (dict) --
An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
certificateChain (string) --
The certificate chain for the certificate.
privateKey (string) --
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a client's TLS Secret Discovery Service certificate.
secretName (string) --
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.
enforce (boolean) --
Whether the policy is enforced. The default is True , if a value isn't specified.
ports (list) --
One or more ports that the policy is enforced for.
(integer) --
validation (dict) --
A reference to an object that represents a TLS validation context.
subjectAlternativeNames (dict) --
A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context.
match (dict) --
An object that represents the criteria for determining a SANs match.
exact (list) --
The values sent must match the specified values exactly.
(string) --
trust (dict) --
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: acm, file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
acm (dict) --
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an AWS Certicate Manager (ACM) certificate.
certificateAuthorityArns (list) --
One or more ACM Amazon Resource Name (ARN)s.
(string) --
file (dict) --
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
certificateChain (string) --
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
secretName (string) --
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
backends (list) --
The backends that the virtual node is expected to send outbound traffic to.
(dict) --
An object that represents the backends that a virtual node is expected to send outbound traffic to.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: virtualService. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
virtualService (dict) --
Specifies a virtual service to use as a backend.
clientPolicy (dict) --
A reference to an object that represents the client policy for a backend.
tls (dict) --
A reference to an object that represents a Transport Layer Security (TLS) client policy.
certificate (dict) --
A reference to an object that represents a client's TLS certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
file (dict) --
An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
certificateChain (string) --
The certificate chain for the certificate.
privateKey (string) --
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a client's TLS Secret Discovery Service certificate.
secretName (string) --
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.
enforce (boolean) --
Whether the policy is enforced. The default is True , if a value isn't specified.
ports (list) --
One or more ports that the policy is enforced for.
(integer) --
validation (dict) --
A reference to an object that represents a TLS validation context.
subjectAlternativeNames (dict) --
A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context.
match (dict) --
An object that represents the criteria for determining a SANs match.
exact (list) --
The values sent must match the specified values exactly.
(string) --
trust (dict) --
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: acm, file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
acm (dict) --
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an AWS Certicate Manager (ACM) certificate.
certificateAuthorityArns (list) --
One or more ACM Amazon Resource Name (ARN)s.
(string) --
file (dict) --
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
certificateChain (string) --
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
secretName (string) --
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
virtualServiceName (string) --
The name of the virtual service that is acting as a virtual node backend.
listeners (list) --
The listener that the virtual node is expected to receive inbound traffic from. You can specify one listener.
(dict) --
An object that represents a listener for a virtual node.
connectionPool (dict) --
The connection pool information for the listener.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: grpc, http, http2, tcp. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
grpc (dict) --
An object that represents a type of connection pool.
maxRequests (integer) --
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.
http (dict) --
An object that represents a type of connection pool.
maxConnections (integer) --
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.
maxPendingRequests (integer) --
Number of overflowing requests after max_connections Envoy will queue to upstream cluster.
http2 (dict) --
An object that represents a type of connection pool.
maxRequests (integer) --
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.
tcp (dict) --
An object that represents a type of connection pool.
maxConnections (integer) --
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.
healthCheck (dict) --
The health check information for the listener.
healthyThreshold (integer) --
The number of consecutive successful health checks that must occur before declaring listener healthy.
intervalMillis (integer) --
The time period in milliseconds between each health check execution.
path (string) --
The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.
port (integer) --
The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.
protocol (string) --
The protocol for the health check request. If you specify grpc , then your service must conform to the GRPC Health Checking Protocol.
timeoutMillis (integer) --
The amount of time to wait when receiving a response from the health check, in milliseconds.
unhealthyThreshold (integer) --
The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.
outlierDetection (dict) --
The outlier detection information for the listener.
baseEjectionDuration (dict) --
The base amount of time for which a host is ejected.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
interval (dict) --
The time interval between ejection sweep analysis.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
maxEjectionPercent (integer) --
Maximum percentage of hosts in load balancing pool for upstream service that can be ejected. Will eject at least one host regardless of the value.
maxServerErrors (integer) --
Number of consecutive 5xx errors required for ejection.
portMapping (dict) --
The port mapping information for the listener.
port (integer) --
The port used for the port mapping.
protocol (string) --
The protocol used for the port mapping. Specify one protocol.
timeout (dict) --
An object that represents timeouts for different protocols.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: grpc, http, http2, tcp. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
grpc (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
http (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
http2 (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
tcp (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
tls (dict) --
A reference to an object that represents the Transport Layer Security (TLS) properties for a listener.
certificate (dict) --
A reference to an object that represents a listener's Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: acm, file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
acm (dict) --
A reference to an object that represents an AWS Certicate Manager (ACM) certificate.
certificateArn (string) --
The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
file (dict) --
A reference to an object that represents a local file certificate.
certificateChain (string) --
The certificate chain for the certificate.
privateKey (string) --
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a listener's Secret Discovery Service certificate.
secretName (string) --
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.
mode (string) --
Specify one of the following modes.
STRICT – Listener only accepts connections with TLS enabled.
PERMISSIVE – Listener accepts connections with or without TLS enabled.
DISABLED – Listener only accepts connections without TLS.
validation (dict) --
A reference to an object that represents a listener's Transport Layer Security (TLS) validation context.
subjectAlternativeNames (dict) --
A reference to an object that represents the SANs for a listener's Transport Layer Security (TLS) validation context.
match (dict) --
An object that represents the criteria for determining a SANs match.
exact (list) --
The values sent must match the specified values exactly.
(string) --
trust (dict) --
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
file (dict) --
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
certificateChain (string) --
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a listener's Transport Layer Security (TLS) Secret Discovery Service validation context trust.
secretName (string) --
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
logging (dict) --
The inbound and outbound access logging information for the virtual node.
accessLog (dict) --
The access log configuration for a virtual node.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: file. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
file (dict) --
The file object to send virtual node access logs to.
path (string) --
The file path to write access logs to. You can use /dev/stdout to send access logs to standard out and configure your Envoy container to use a log driver, such as awslogs , to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk.
Note
The Envoy process must have write permissions to the path that you specify here. Otherwise, Envoy fails to bootstrap properly.
serviceDiscovery (dict) --
The service discovery information for the virtual node. If your virtual node does not expect ingress traffic, you can omit this parameter. If you specify a listener , then you must specify service discovery information.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: awsCloudMap, dns. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
awsCloudMap (dict) --
Specifies any AWS 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 AWS Cloud Map attribute information for your virtual node.
Note
AWS Cloud Map is not available in the eu-south-1 Region.
key (string) --
The name of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service instance that contains the specified key and value is returned.
value (string) --
The value of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service instance that contains the specified key and value is returned.
namespaceName (string) --
The name of the AWS Cloud Map namespace to use.
serviceName (string) --
The name of the AWS 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.
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.
{'virtualGateway': {'spec': {'backendDefaults': {'clientPolicy': {'tls': {'certificate': {'file': {'certificateChain': 'string',
'privateKey': 'string'},
'sds': {'secretName': 'string'}},
'validation': {'subjectAlternativeNames': {'match': {'exact': ['string']}},
'trust': {'sds': {'secretName': 'string'}}}}}},
'listeners': {'tls': {'certificate': {'sds': {'secretName': 'string'}},
'validation': {'subjectAlternativeNames': {'match': {'exact': ['string']}},
'trust': {'file': {'certificateChain': 'string'},
'sds': {'secretName': 'string'}}}}}}}}
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
client.delete_virtual_gateway(
meshName='string',
meshOwner='string',
virtualGatewayName='string'
)
string
[REQUIRED]
The name of the service mesh to delete the virtual gateway from.
string
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
string
[REQUIRED]
The name of the virtual gateway to delete.
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': {
'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 AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
resourceOwner (string) --
The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
uid (string) --
The unique identifier for the resource.
version (integer) --
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
spec (dict) --
The specifications of the virtual 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.
(integer) --
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.
(string) --
trust (dict) --
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: acm, file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
acm (dict) --
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an AWS Certicate Manager (ACM) certificate.
certificateAuthorityArns (list) --
One or more ACM Amazon Resource Name (ARN)s.
(string) --
file (dict) --
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
certificateChain (string) --
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a 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 AWS Certicate Manager (ACM) certificate.
certificateArn (string) --
The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
file (dict) --
A reference to an object that represents a local file certificate.
certificateChain (string) --
The certificate chain for the certificate.
privateKey (string) --
The private key for a certificate stored on the file system of the 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.
STRICT – Listener only accepts connections with TLS enabled.
PERMISSIVE – Listener accepts connections with or without TLS enabled.
DISABLED – Listener only accepts connections without TLS.
validation (dict) --
A reference to an object that represents a 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.
(string) --
trust (dict) --
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
file (dict) --
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
certificateChain (string) --
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a 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.
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.
{'virtualNode': {'spec': {'backendDefaults': {'clientPolicy': {'tls': {'certificate': {'file': {'certificateChain': 'string',
'privateKey': 'string'},
'sds': {'secretName': 'string'}},
'validation': {'subjectAlternativeNames': {'match': {'exact': ['string']}},
'trust': {'sds': {'secretName': 'string'}}}}}},
'backends': {'virtualService': {'clientPolicy': {'tls': {'certificate': {'file': {'certificateChain': 'string',
'privateKey': 'string'},
'sds': {'secretName': 'string'}},
'validation': {'subjectAlternativeNames': {'match': {'exact': ['string']}},
'trust': {'sds': {'secretName': 'string'}}}}}}},
'listeners': {'tls': {'certificate': {'sds': {'secretName': 'string'}},
'validation': {'subjectAlternativeNames': {'match': {'exact': ['string']}},
'trust': {'file': {'certificateChain': 'string'},
'sds': {'secretName': 'string'}}}}}}}}
Deletes an existing virtual node.
You must delete any virtual services that list a virtual node as a service provider before you can delete the virtual node itself.
See also: AWS API Documentation
Request Syntax
client.delete_virtual_node(
meshName='string',
meshOwner='string',
virtualNodeName='string'
)
string
[REQUIRED]
The name of the service mesh to delete the virtual node in.
string
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
string
[REQUIRED]
The name of the virtual node to delete.
dict
Response Syntax
{
'virtualNode': {
'meshName': 'string',
'metadata': {
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'meshOwner': 'string',
'resourceOwner': 'string',
'uid': 'string',
'version': 123
},
'spec': {
'backendDefaults': {
'clientPolicy': {
'tls': {
'certificate': {
'file': {
'certificateChain': 'string',
'privateKey': 'string'
},
'sds': {
'secretName': 'string'
}
},
'enforce': True|False,
'ports': [
123,
],
'validation': {
'subjectAlternativeNames': {
'match': {
'exact': [
'string',
]
}
},
'trust': {
'acm': {
'certificateAuthorityArns': [
'string',
]
},
'file': {
'certificateChain': 'string'
},
'sds': {
'secretName': 'string'
}
}
}
}
}
},
'backends': [
{
'virtualService': {
'clientPolicy': {
'tls': {
'certificate': {
'file': {
'certificateChain': 'string',
'privateKey': 'string'
},
'sds': {
'secretName': 'string'
}
},
'enforce': True|False,
'ports': [
123,
],
'validation': {
'subjectAlternativeNames': {
'match': {
'exact': [
'string',
]
}
},
'trust': {
'acm': {
'certificateAuthorityArns': [
'string',
]
},
'file': {
'certificateChain': 'string'
},
'sds': {
'secretName': 'string'
}
}
}
}
},
'virtualServiceName': 'string'
}
},
],
'listeners': [
{
'connectionPool': {
'grpc': {
'maxRequests': 123
},
'http': {
'maxConnections': 123,
'maxPendingRequests': 123
},
'http2': {
'maxRequests': 123
},
'tcp': {
'maxConnections': 123
}
},
'healthCheck': {
'healthyThreshold': 123,
'intervalMillis': 123,
'path': 'string',
'port': 123,
'protocol': 'http'|'tcp'|'http2'|'grpc',
'timeoutMillis': 123,
'unhealthyThreshold': 123
},
'outlierDetection': {
'baseEjectionDuration': {
'unit': 's'|'ms',
'value': 123
},
'interval': {
'unit': 's'|'ms',
'value': 123
},
'maxEjectionPercent': 123,
'maxServerErrors': 123
},
'portMapping': {
'port': 123,
'protocol': 'http'|'tcp'|'http2'|'grpc'
},
'timeout': {
'grpc': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
},
'http': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
},
'http2': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
},
'tcp': {
'idle': {
'unit': 's'|'ms',
'value': 123
}
}
},
'tls': {
'certificate': {
'acm': {
'certificateArn': 'string'
},
'file': {
'certificateChain': 'string',
'privateKey': 'string'
},
'sds': {
'secretName': 'string'
}
},
'mode': 'STRICT'|'PERMISSIVE'|'DISABLED',
'validation': {
'subjectAlternativeNames': {
'match': {
'exact': [
'string',
]
}
},
'trust': {
'file': {
'certificateChain': 'string'
},
'sds': {
'secretName': 'string'
}
}
}
}
},
],
'logging': {
'accessLog': {
'file': {
'path': 'string'
}
}
},
'serviceDiscovery': {
'awsCloudMap': {
'attributes': [
{
'key': 'string',
'value': 'string'
},
],
'namespaceName': 'string',
'serviceName': 'string'
},
'dns': {
'hostname': 'string'
}
}
},
'status': {
'status': 'ACTIVE'|'INACTIVE'|'DELETED'
},
'virtualNodeName': 'string'
}
}
Response Structure
(dict) --
virtualNode (dict) --
The virtual node that was deleted.
meshName (string) --
The name of the service mesh that the virtual node resides in.
metadata (dict) --
The associated metadata for the virtual node.
arn (string) --
The full Amazon Resource Name (ARN) for the resource.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was created.
lastUpdatedAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was last updated.
meshOwner (string) --
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
resourceOwner (string) --
The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
uid (string) --
The unique identifier for the resource.
version (integer) --
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
spec (dict) --
The specifications of the virtual node.
backendDefaults (dict) --
A reference to an object that represents the defaults for backends.
clientPolicy (dict) --
A reference to an object that represents a client policy.
tls (dict) --
A reference to an object that represents a Transport Layer Security (TLS) client policy.
certificate (dict) --
A reference to an object that represents a client's TLS certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
file (dict) --
An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
certificateChain (string) --
The certificate chain for the certificate.
privateKey (string) --
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a client's TLS Secret Discovery Service certificate.
secretName (string) --
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.
enforce (boolean) --
Whether the policy is enforced. The default is True , if a value isn't specified.
ports (list) --
One or more ports that the policy is enforced for.
(integer) --
validation (dict) --
A reference to an object that represents a TLS validation context.
subjectAlternativeNames (dict) --
A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context.
match (dict) --
An object that represents the criteria for determining a SANs match.
exact (list) --
The values sent must match the specified values exactly.
(string) --
trust (dict) --
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: acm, file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
acm (dict) --
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an AWS Certicate Manager (ACM) certificate.
certificateAuthorityArns (list) --
One or more ACM Amazon Resource Name (ARN)s.
(string) --
file (dict) --
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
certificateChain (string) --
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
secretName (string) --
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
backends (list) --
The backends that the virtual node is expected to send outbound traffic to.
(dict) --
An object that represents the backends that a virtual node is expected to send outbound traffic to.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: virtualService. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
virtualService (dict) --
Specifies a virtual service to use as a backend.
clientPolicy (dict) --
A reference to an object that represents the client policy for a backend.
tls (dict) --
A reference to an object that represents a Transport Layer Security (TLS) client policy.
certificate (dict) --
A reference to an object that represents a client's TLS certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
file (dict) --
An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
certificateChain (string) --
The certificate chain for the certificate.
privateKey (string) --
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a client's TLS Secret Discovery Service certificate.
secretName (string) --
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.
enforce (boolean) --
Whether the policy is enforced. The default is True , if a value isn't specified.
ports (list) --
One or more ports that the policy is enforced for.
(integer) --
validation (dict) --
A reference to an object that represents a TLS validation context.
subjectAlternativeNames (dict) --
A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context.
match (dict) --
An object that represents the criteria for determining a SANs match.
exact (list) --
The values sent must match the specified values exactly.
(string) --
trust (dict) --
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: acm, file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
acm (dict) --
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an AWS Certicate Manager (ACM) certificate.
certificateAuthorityArns (list) --
One or more ACM Amazon Resource Name (ARN)s.
(string) --
file (dict) --
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
certificateChain (string) --
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
secretName (string) --
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
virtualServiceName (string) --
The name of the virtual service that is acting as a virtual node backend.
listeners (list) --
The listener that the virtual node is expected to receive inbound traffic from. You can specify one listener.
(dict) --
An object that represents a listener for a virtual node.
connectionPool (dict) --
The connection pool information for the listener.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: grpc, http, http2, tcp. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
grpc (dict) --
An object that represents a type of connection pool.
maxRequests (integer) --
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.
http (dict) --
An object that represents a type of connection pool.
maxConnections (integer) --
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.
maxPendingRequests (integer) --
Number of overflowing requests after max_connections Envoy will queue to upstream cluster.
http2 (dict) --
An object that represents a type of connection pool.
maxRequests (integer) --
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.
tcp (dict) --
An object that represents a type of connection pool.
maxConnections (integer) --
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.
healthCheck (dict) --
The health check information for the listener.
healthyThreshold (integer) --
The number of consecutive successful health checks that must occur before declaring listener healthy.
intervalMillis (integer) --
The time period in milliseconds between each health check execution.
path (string) --
The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.
port (integer) --
The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.
protocol (string) --
The protocol for the health check request. If you specify grpc , then your service must conform to the GRPC Health Checking Protocol.
timeoutMillis (integer) --
The amount of time to wait when receiving a response from the health check, in milliseconds.
unhealthyThreshold (integer) --
The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.
outlierDetection (dict) --
The outlier detection information for the listener.
baseEjectionDuration (dict) --
The base amount of time for which a host is ejected.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
interval (dict) --
The time interval between ejection sweep analysis.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
maxEjectionPercent (integer) --
Maximum percentage of hosts in load balancing pool for upstream service that can be ejected. Will eject at least one host regardless of the value.
maxServerErrors (integer) --
Number of consecutive 5xx errors required for ejection.
portMapping (dict) --
The port mapping information for the listener.
port (integer) --
The port used for the port mapping.
protocol (string) --
The protocol used for the port mapping. Specify one protocol.
timeout (dict) --
An object that represents timeouts for different protocols.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: grpc, http, http2, tcp. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
grpc (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
http (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
http2 (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
tcp (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
tls (dict) --
A reference to an object that represents the Transport Layer Security (TLS) properties for a listener.
certificate (dict) --
A reference to an object that represents a listener's Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: acm, file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
acm (dict) --
A reference to an object that represents an AWS Certicate Manager (ACM) certificate.
certificateArn (string) --
The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
file (dict) --
A reference to an object that represents a local file certificate.
certificateChain (string) --
The certificate chain for the certificate.
privateKey (string) --
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a listener's Secret Discovery Service certificate.
secretName (string) --
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.
mode (string) --
Specify one of the following modes.
STRICT – Listener only accepts connections with TLS enabled.
PERMISSIVE – Listener accepts connections with or without TLS enabled.
DISABLED – Listener only accepts connections without TLS.
validation (dict) --
A reference to an object that represents a listener's Transport Layer Security (TLS) validation context.
subjectAlternativeNames (dict) --
A reference to an object that represents the SANs for a listener's Transport Layer Security (TLS) validation context.
match (dict) --
An object that represents the criteria for determining a SANs match.
exact (list) --
The values sent must match the specified values exactly.
(string) --
trust (dict) --
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
file (dict) --
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
certificateChain (string) --
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a listener's Transport Layer Security (TLS) Secret Discovery Service validation context trust.
secretName (string) --
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
logging (dict) --
The inbound and outbound access logging information for the virtual node.
accessLog (dict) --
The access log configuration for a virtual node.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: file. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
file (dict) --
The file object to send virtual node access logs to.
path (string) --
The file path to write access logs to. You can use /dev/stdout to send access logs to standard out and configure your Envoy container to use a log driver, such as awslogs , to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk.
Note
The Envoy process must have write permissions to the path that you specify here. Otherwise, Envoy fails to bootstrap properly.
serviceDiscovery (dict) --
The service discovery information for the virtual node. If your virtual node does not expect ingress traffic, you can omit this parameter. If you specify a listener , then you must specify service discovery information.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: awsCloudMap, dns. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
awsCloudMap (dict) --
Specifies any AWS 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 AWS Cloud Map attribute information for your virtual node.
Note
AWS Cloud Map is not available in the eu-south-1 Region.
key (string) --
The name of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service instance that contains the specified key and value is returned.
value (string) --
The value of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service instance that contains the specified key and value is returned.
namespaceName (string) --
The name of the AWS Cloud Map namespace to use.
serviceName (string) --
The name of the AWS 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.
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.
{'virtualGateway': {'spec': {'backendDefaults': {'clientPolicy': {'tls': {'certificate': {'file': {'certificateChain': 'string',
'privateKey': 'string'},
'sds': {'secretName': 'string'}},
'validation': {'subjectAlternativeNames': {'match': {'exact': ['string']}},
'trust': {'sds': {'secretName': 'string'}}}}}},
'listeners': {'tls': {'certificate': {'sds': {'secretName': 'string'}},
'validation': {'subjectAlternativeNames': {'match': {'exact': ['string']}},
'trust': {'file': {'certificateChain': 'string'},
'sds': {'secretName': 'string'}}}}}}}}
Describes an existing virtual gateway.
See also: AWS API Documentation
Request Syntax
client.describe_virtual_gateway(
meshName='string',
meshOwner='string',
virtualGatewayName='string'
)
string
[REQUIRED]
The name of the service mesh that the gateway route resides in.
string
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
string
[REQUIRED]
The name of the virtual gateway 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': {
'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 AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
resourceOwner (string) --
The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
uid (string) --
The unique identifier for the resource.
version (integer) --
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
spec (dict) --
The specifications of the virtual 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.
(integer) --
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.
(string) --
trust (dict) --
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: acm, file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
acm (dict) --
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an AWS Certicate Manager (ACM) certificate.
certificateAuthorityArns (list) --
One or more ACM Amazon Resource Name (ARN)s.
(string) --
file (dict) --
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
certificateChain (string) --
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a 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 AWS Certicate Manager (ACM) certificate.
certificateArn (string) --
The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
file (dict) --
A reference to an object that represents a local file certificate.
certificateChain (string) --
The certificate chain for the certificate.
privateKey (string) --
The private key for a certificate stored on the file system of the 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.
STRICT – Listener only accepts connections with TLS enabled.
PERMISSIVE – Listener accepts connections with or without TLS enabled.
DISABLED – Listener only accepts connections without TLS.
validation (dict) --
A reference to an object that represents a 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.
(string) --
trust (dict) --
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
file (dict) --
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
certificateChain (string) --
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a 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.
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.
{'virtualNode': {'spec': {'backendDefaults': {'clientPolicy': {'tls': {'certificate': {'file': {'certificateChain': 'string',
'privateKey': 'string'},
'sds': {'secretName': 'string'}},
'validation': {'subjectAlternativeNames': {'match': {'exact': ['string']}},
'trust': {'sds': {'secretName': 'string'}}}}}},
'backends': {'virtualService': {'clientPolicy': {'tls': {'certificate': {'file': {'certificateChain': 'string',
'privateKey': 'string'},
'sds': {'secretName': 'string'}},
'validation': {'subjectAlternativeNames': {'match': {'exact': ['string']}},
'trust': {'sds': {'secretName': 'string'}}}}}}},
'listeners': {'tls': {'certificate': {'sds': {'secretName': 'string'}},
'validation': {'subjectAlternativeNames': {'match': {'exact': ['string']}},
'trust': {'file': {'certificateChain': 'string'},
'sds': {'secretName': 'string'}}}}}}}}
Describes an existing virtual node.
See also: AWS API Documentation
Request Syntax
client.describe_virtual_node(
meshName='string',
meshOwner='string',
virtualNodeName='string'
)
string
[REQUIRED]
The name of the service mesh that the virtual node resides in.
string
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
string
[REQUIRED]
The name of the virtual node to describe.
dict
Response Syntax
{
'virtualNode': {
'meshName': 'string',
'metadata': {
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'meshOwner': 'string',
'resourceOwner': 'string',
'uid': 'string',
'version': 123
},
'spec': {
'backendDefaults': {
'clientPolicy': {
'tls': {
'certificate': {
'file': {
'certificateChain': 'string',
'privateKey': 'string'
},
'sds': {
'secretName': 'string'
}
},
'enforce': True|False,
'ports': [
123,
],
'validation': {
'subjectAlternativeNames': {
'match': {
'exact': [
'string',
]
}
},
'trust': {
'acm': {
'certificateAuthorityArns': [
'string',
]
},
'file': {
'certificateChain': 'string'
},
'sds': {
'secretName': 'string'
}
}
}
}
}
},
'backends': [
{
'virtualService': {
'clientPolicy': {
'tls': {
'certificate': {
'file': {
'certificateChain': 'string',
'privateKey': 'string'
},
'sds': {
'secretName': 'string'
}
},
'enforce': True|False,
'ports': [
123,
],
'validation': {
'subjectAlternativeNames': {
'match': {
'exact': [
'string',
]
}
},
'trust': {
'acm': {
'certificateAuthorityArns': [
'string',
]
},
'file': {
'certificateChain': 'string'
},
'sds': {
'secretName': 'string'
}
}
}
}
},
'virtualServiceName': 'string'
}
},
],
'listeners': [
{
'connectionPool': {
'grpc': {
'maxRequests': 123
},
'http': {
'maxConnections': 123,
'maxPendingRequests': 123
},
'http2': {
'maxRequests': 123
},
'tcp': {
'maxConnections': 123
}
},
'healthCheck': {
'healthyThreshold': 123,
'intervalMillis': 123,
'path': 'string',
'port': 123,
'protocol': 'http'|'tcp'|'http2'|'grpc',
'timeoutMillis': 123,
'unhealthyThreshold': 123
},
'outlierDetection': {
'baseEjectionDuration': {
'unit': 's'|'ms',
'value': 123
},
'interval': {
'unit': 's'|'ms',
'value': 123
},
'maxEjectionPercent': 123,
'maxServerErrors': 123
},
'portMapping': {
'port': 123,
'protocol': 'http'|'tcp'|'http2'|'grpc'
},
'timeout': {
'grpc': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
},
'http': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
},
'http2': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
},
'tcp': {
'idle': {
'unit': 's'|'ms',
'value': 123
}
}
},
'tls': {
'certificate': {
'acm': {
'certificateArn': 'string'
},
'file': {
'certificateChain': 'string',
'privateKey': 'string'
},
'sds': {
'secretName': 'string'
}
},
'mode': 'STRICT'|'PERMISSIVE'|'DISABLED',
'validation': {
'subjectAlternativeNames': {
'match': {
'exact': [
'string',
]
}
},
'trust': {
'file': {
'certificateChain': 'string'
},
'sds': {
'secretName': 'string'
}
}
}
}
},
],
'logging': {
'accessLog': {
'file': {
'path': 'string'
}
}
},
'serviceDiscovery': {
'awsCloudMap': {
'attributes': [
{
'key': 'string',
'value': 'string'
},
],
'namespaceName': 'string',
'serviceName': 'string'
},
'dns': {
'hostname': 'string'
}
}
},
'status': {
'status': 'ACTIVE'|'INACTIVE'|'DELETED'
},
'virtualNodeName': 'string'
}
}
Response Structure
(dict) --
virtualNode (dict) --
The full description of your virtual node.
meshName (string) --
The name of the service mesh that the virtual node resides in.
metadata (dict) --
The associated metadata for the virtual node.
arn (string) --
The full Amazon Resource Name (ARN) for the resource.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was created.
lastUpdatedAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was last updated.
meshOwner (string) --
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
resourceOwner (string) --
The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
uid (string) --
The unique identifier for the resource.
version (integer) --
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
spec (dict) --
The specifications of the virtual node.
backendDefaults (dict) --
A reference to an object that represents the defaults for backends.
clientPolicy (dict) --
A reference to an object that represents a client policy.
tls (dict) --
A reference to an object that represents a Transport Layer Security (TLS) client policy.
certificate (dict) --
A reference to an object that represents a client's TLS certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
file (dict) --
An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
certificateChain (string) --
The certificate chain for the certificate.
privateKey (string) --
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a client's TLS Secret Discovery Service certificate.
secretName (string) --
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.
enforce (boolean) --
Whether the policy is enforced. The default is True , if a value isn't specified.
ports (list) --
One or more ports that the policy is enforced for.
(integer) --
validation (dict) --
A reference to an object that represents a TLS validation context.
subjectAlternativeNames (dict) --
A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context.
match (dict) --
An object that represents the criteria for determining a SANs match.
exact (list) --
The values sent must match the specified values exactly.
(string) --
trust (dict) --
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: acm, file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
acm (dict) --
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an AWS Certicate Manager (ACM) certificate.
certificateAuthorityArns (list) --
One or more ACM Amazon Resource Name (ARN)s.
(string) --
file (dict) --
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
certificateChain (string) --
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
secretName (string) --
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
backends (list) --
The backends that the virtual node is expected to send outbound traffic to.
(dict) --
An object that represents the backends that a virtual node is expected to send outbound traffic to.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: virtualService. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
virtualService (dict) --
Specifies a virtual service to use as a backend.
clientPolicy (dict) --
A reference to an object that represents the client policy for a backend.
tls (dict) --
A reference to an object that represents a Transport Layer Security (TLS) client policy.
certificate (dict) --
A reference to an object that represents a client's TLS certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
file (dict) --
An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
certificateChain (string) --
The certificate chain for the certificate.
privateKey (string) --
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a client's TLS Secret Discovery Service certificate.
secretName (string) --
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.
enforce (boolean) --
Whether the policy is enforced. The default is True , if a value isn't specified.
ports (list) --
One or more ports that the policy is enforced for.
(integer) --
validation (dict) --
A reference to an object that represents a TLS validation context.
subjectAlternativeNames (dict) --
A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context.
match (dict) --
An object that represents the criteria for determining a SANs match.
exact (list) --
The values sent must match the specified values exactly.
(string) --
trust (dict) --
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: acm, file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
acm (dict) --
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an AWS Certicate Manager (ACM) certificate.
certificateAuthorityArns (list) --
One or more ACM Amazon Resource Name (ARN)s.
(string) --
file (dict) --
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
certificateChain (string) --
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
secretName (string) --
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
virtualServiceName (string) --
The name of the virtual service that is acting as a virtual node backend.
listeners (list) --
The listener that the virtual node is expected to receive inbound traffic from. You can specify one listener.
(dict) --
An object that represents a listener for a virtual node.
connectionPool (dict) --
The connection pool information for the listener.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: grpc, http, http2, tcp. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
grpc (dict) --
An object that represents a type of connection pool.
maxRequests (integer) --
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.
http (dict) --
An object that represents a type of connection pool.
maxConnections (integer) --
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.
maxPendingRequests (integer) --
Number of overflowing requests after max_connections Envoy will queue to upstream cluster.
http2 (dict) --
An object that represents a type of connection pool.
maxRequests (integer) --
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.
tcp (dict) --
An object that represents a type of connection pool.
maxConnections (integer) --
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.
healthCheck (dict) --
The health check information for the listener.
healthyThreshold (integer) --
The number of consecutive successful health checks that must occur before declaring listener healthy.
intervalMillis (integer) --
The time period in milliseconds between each health check execution.
path (string) --
The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.
port (integer) --
The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.
protocol (string) --
The protocol for the health check request. If you specify grpc , then your service must conform to the GRPC Health Checking Protocol.
timeoutMillis (integer) --
The amount of time to wait when receiving a response from the health check, in milliseconds.
unhealthyThreshold (integer) --
The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.
outlierDetection (dict) --
The outlier detection information for the listener.
baseEjectionDuration (dict) --
The base amount of time for which a host is ejected.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
interval (dict) --
The time interval between ejection sweep analysis.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
maxEjectionPercent (integer) --
Maximum percentage of hosts in load balancing pool for upstream service that can be ejected. Will eject at least one host regardless of the value.
maxServerErrors (integer) --
Number of consecutive 5xx errors required for ejection.
portMapping (dict) --
The port mapping information for the listener.
port (integer) --
The port used for the port mapping.
protocol (string) --
The protocol used for the port mapping. Specify one protocol.
timeout (dict) --
An object that represents timeouts for different protocols.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: grpc, http, http2, tcp. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
grpc (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
http (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
http2 (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
tcp (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
tls (dict) --
A reference to an object that represents the Transport Layer Security (TLS) properties for a listener.
certificate (dict) --
A reference to an object that represents a listener's Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: acm, file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
acm (dict) --
A reference to an object that represents an AWS Certicate Manager (ACM) certificate.
certificateArn (string) --
The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
file (dict) --
A reference to an object that represents a local file certificate.
certificateChain (string) --
The certificate chain for the certificate.
privateKey (string) --
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a listener's Secret Discovery Service certificate.
secretName (string) --
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.
mode (string) --
Specify one of the following modes.
STRICT – Listener only accepts connections with TLS enabled.
PERMISSIVE – Listener accepts connections with or without TLS enabled.
DISABLED – Listener only accepts connections without TLS.
validation (dict) --
A reference to an object that represents a listener's Transport Layer Security (TLS) validation context.
subjectAlternativeNames (dict) --
A reference to an object that represents the SANs for a listener's Transport Layer Security (TLS) validation context.
match (dict) --
An object that represents the criteria for determining a SANs match.
exact (list) --
The values sent must match the specified values exactly.
(string) --
trust (dict) --
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
file (dict) --
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
certificateChain (string) --
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a listener's Transport Layer Security (TLS) Secret Discovery Service validation context trust.
secretName (string) --
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
logging (dict) --
The inbound and outbound access logging information for the virtual node.
accessLog (dict) --
The access log configuration for a virtual node.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: file. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
file (dict) --
The file object to send virtual node access logs to.
path (string) --
The file path to write access logs to. You can use /dev/stdout to send access logs to standard out and configure your Envoy container to use a log driver, such as awslogs , to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk.
Note
The Envoy process must have write permissions to the path that you specify here. Otherwise, Envoy fails to bootstrap properly.
serviceDiscovery (dict) --
The service discovery information for the virtual node. If your virtual node does not expect ingress traffic, you can omit this parameter. If you specify a listener , then you must specify service discovery information.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: awsCloudMap, dns. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
awsCloudMap (dict) --
Specifies any AWS 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 AWS Cloud Map attribute information for your virtual node.
Note
AWS Cloud Map is not available in the eu-south-1 Region.
key (string) --
The name of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service instance that contains the specified key and value is returned.
value (string) --
The value of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service instance that contains the specified key and value is returned.
namespaceName (string) --
The name of the AWS Cloud Map namespace to use.
serviceName (string) --
The name of the AWS 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.
status (dict) --
The current status for the virtual node.
status (string) --
The current status of the virtual node.
virtualNodeName (string) --
The name of the virtual node.
{'spec': {'backendDefaults': {'clientPolicy': {'tls': {'certificate': {'file': {'certificateChain': 'string',
'privateKey': 'string'},
'sds': {'secretName': 'string'}},
'validation': {'subjectAlternativeNames': {'match': {'exact': ['string']}},
'trust': {'sds': {'secretName': 'string'}}}}}},
'listeners': {'tls': {'certificate': {'sds': {'secretName': 'string'}},
'validation': {'subjectAlternativeNames': {'match': {'exact': ['string']}},
'trust': {'file': {'certificateChain': 'string'},
'sds': {'secretName': 'string'}}}}}}}
Response {'virtualGateway': {'spec': {'backendDefaults': {'clientPolicy': {'tls': {'certificate': {'file': {'certificateChain': 'string',
'privateKey': 'string'},
'sds': {'secretName': 'string'}},
'validation': {'subjectAlternativeNames': {'match': {'exact': ['string']}},
'trust': {'sds': {'secretName': 'string'}}}}}},
'listeners': {'tls': {'certificate': {'sds': {'secretName': 'string'}},
'validation': {'subjectAlternativeNames': {'match': {'exact': ['string']}},
'trust': {'file': {'certificateChain': 'string'},
'sds': {'secretName': 'string'}}}}}}}}
Updates an existing virtual gateway in a specified service mesh.
See also: AWS API Documentation
Request Syntax
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': {
'path': 'string'
}
}
}
},
virtualGatewayName='string'
)
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
This field is autopopulated if not provided.
string
[REQUIRED]
The name of the service mesh that the virtual gateway resides in.
string
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
dict
[REQUIRED]
The new virtual gateway specification to apply. This overwrites the existing data.
backendDefaults (dict) --
A reference to an object that represents the defaults for backends.
clientPolicy (dict) --
A reference to an object that represents a client policy.
tls (dict) --
A reference to an object that represents a Transport Layer Security (TLS) client policy.
certificate (dict) --
A reference to an object that represents a 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.
file (dict) --
An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
certificateChain (string) -- [REQUIRED]
The certificate chain for the certificate.
privateKey (string) -- [REQUIRED]
The private key for a certificate stored on the file system of the 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) -- [REQUIRED]
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.
(integer) --
validation (dict) -- [REQUIRED]
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) -- [REQUIRED]
An object that represents the criteria for determining a SANs match.
exact (list) -- [REQUIRED]
The values sent must match the specified values exactly.
(string) --
trust (dict) -- [REQUIRED]
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: acm, file, sds.
acm (dict) --
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an AWS Certicate Manager (ACM) certificate.
certificateAuthorityArns (list) -- [REQUIRED]
One or more ACM Amazon Resource Name (ARN)s.
(string) --
file (dict) --
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
certificateChain (string) -- [REQUIRED]
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a virtual gateway's Transport Layer Security (TLS) Secret Discovery Service validation context trust.
secretName (string) -- [REQUIRED]
A reference to an object that represents the name of the secret for a virtual gateway's Transport Layer Security (TLS) Secret Discovery Service validation context trust.
listeners (list) -- [REQUIRED]
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 can be set: grpc, http, http2.
grpc (dict) --
An object that represents a type of connection pool.
maxRequests (integer) -- [REQUIRED]
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.
http (dict) --
An object that represents a type of connection pool.
maxConnections (integer) -- [REQUIRED]
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.
maxPendingRequests (integer) --
Number of overflowing requests after max_connections Envoy will queue to upstream cluster.
http2 (dict) --
An object that represents a type of connection pool.
maxRequests (integer) -- [REQUIRED]
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.
healthCheck (dict) --
The health check information for the listener.
healthyThreshold (integer) -- [REQUIRED]
The number of consecutive successful health checks that must occur before declaring the listener healthy.
intervalMillis (integer) -- [REQUIRED]
The time period in milliseconds between each health check execution.
path (string) --
The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.
port (integer) --
The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.
protocol (string) -- [REQUIRED]
The protocol for the health check request. If you specify grpc , then your service must conform to the GRPC Health Checking Protocol.
timeoutMillis (integer) -- [REQUIRED]
The amount of time to wait when receiving a response from the health check, in milliseconds.
unhealthyThreshold (integer) -- [REQUIRED]
The number of consecutive failed health checks that must occur before declaring a virtual gateway unhealthy.
portMapping (dict) -- [REQUIRED]
The port mapping information for the listener.
port (integer) -- [REQUIRED]
The port used for the port mapping. Specify one protocol.
protocol (string) -- [REQUIRED]
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) -- [REQUIRED]
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.
acm (dict) --
A reference to an object that represents an AWS Certicate Manager (ACM) certificate.
certificateArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
file (dict) --
A reference to an object that represents a local file certificate.
certificateChain (string) -- [REQUIRED]
The certificate chain for the certificate.
privateKey (string) -- [REQUIRED]
The private key for a certificate stored on the file system of the 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) -- [REQUIRED]
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) -- [REQUIRED]
Specify one of the following modes.
STRICT – Listener only accepts connections with TLS enabled.
PERMISSIVE – Listener accepts connections with or without TLS enabled.
DISABLED – Listener only accepts connections without TLS.
validation (dict) --
A reference to an object that represents a 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) -- [REQUIRED]
An object that represents the criteria for determining a SANs match.
exact (list) -- [REQUIRED]
The values sent must match the specified values exactly.
(string) --
trust (dict) -- [REQUIRED]
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: file, sds.
file (dict) --
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
certificateChain (string) -- [REQUIRED]
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a virtual gateway's listener's Transport Layer Security (TLS) Secret Discovery Service validation context trust.
secretName (string) -- [REQUIRED]
A reference to an object that represents the name of the secret for a 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 can be set: file.
file (dict) --
The file object to send virtual gateway access logs to.
path (string) -- [REQUIRED]
The file path to write access logs to. You can use /dev/stdout to send access logs to standard out and configure your Envoy container to use a log driver, such as awslogs , to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk.
string
[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': {
'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 AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
resourceOwner (string) --
The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
uid (string) --
The unique identifier for the resource.
version (integer) --
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
spec (dict) --
The specifications of the virtual 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.
(integer) --
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.
(string) --
trust (dict) --
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: acm, file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
acm (dict) --
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an AWS Certicate Manager (ACM) certificate.
certificateAuthorityArns (list) --
One or more ACM Amazon Resource Name (ARN)s.
(string) --
file (dict) --
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
certificateChain (string) --
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a 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 AWS Certicate Manager (ACM) certificate.
certificateArn (string) --
The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
file (dict) --
A reference to an object that represents a local file certificate.
certificateChain (string) --
The certificate chain for the certificate.
privateKey (string) --
The private key for a certificate stored on the file system of the 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.
STRICT – Listener only accepts connections with TLS enabled.
PERMISSIVE – Listener accepts connections with or without TLS enabled.
DISABLED – Listener only accepts connections without TLS.
validation (dict) --
A reference to an object that represents a 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.
(string) --
trust (dict) --
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
file (dict) --
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
certificateChain (string) --
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a 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.
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.
{'spec': {'backendDefaults': {'clientPolicy': {'tls': {'certificate': {'file': {'certificateChain': 'string',
'privateKey': 'string'},
'sds': {'secretName': 'string'}},
'validation': {'subjectAlternativeNames': {'match': {'exact': ['string']}},
'trust': {'sds': {'secretName': 'string'}}}}}},
'backends': {'virtualService': {'clientPolicy': {'tls': {'certificate': {'file': {'certificateChain': 'string',
'privateKey': 'string'},
'sds': {'secretName': 'string'}},
'validation': {'subjectAlternativeNames': {'match': {'exact': ['string']}},
'trust': {'sds': {'secretName': 'string'}}}}}}},
'listeners': {'tls': {'certificate': {'sds': {'secretName': 'string'}},
'validation': {'subjectAlternativeNames': {'match': {'exact': ['string']}},
'trust': {'file': {'certificateChain': 'string'},
'sds': {'secretName': 'string'}}}}}}}
Response {'virtualNode': {'spec': {'backendDefaults': {'clientPolicy': {'tls': {'certificate': {'file': {'certificateChain': 'string',
'privateKey': 'string'},
'sds': {'secretName': 'string'}},
'validation': {'subjectAlternativeNames': {'match': {'exact': ['string']}},
'trust': {'sds': {'secretName': 'string'}}}}}},
'backends': {'virtualService': {'clientPolicy': {'tls': {'certificate': {'file': {'certificateChain': 'string',
'privateKey': 'string'},
'sds': {'secretName': 'string'}},
'validation': {'subjectAlternativeNames': {'match': {'exact': ['string']}},
'trust': {'sds': {'secretName': 'string'}}}}}}},
'listeners': {'tls': {'certificate': {'sds': {'secretName': 'string'}},
'validation': {'subjectAlternativeNames': {'match': {'exact': ['string']}},
'trust': {'file': {'certificateChain': 'string'},
'sds': {'secretName': 'string'}}}}}}}}
Updates an existing virtual node in a specified service mesh.
See also: AWS API Documentation
Request Syntax
client.update_virtual_node(
clientToken='string',
meshName='string',
meshOwner='string',
spec={
'backendDefaults': {
'clientPolicy': {
'tls': {
'certificate': {
'file': {
'certificateChain': 'string',
'privateKey': 'string'
},
'sds': {
'secretName': 'string'
}
},
'enforce': True|False,
'ports': [
123,
],
'validation': {
'subjectAlternativeNames': {
'match': {
'exact': [
'string',
]
}
},
'trust': {
'acm': {
'certificateAuthorityArns': [
'string',
]
},
'file': {
'certificateChain': 'string'
},
'sds': {
'secretName': 'string'
}
}
}
}
}
},
'backends': [
{
'virtualService': {
'clientPolicy': {
'tls': {
'certificate': {
'file': {
'certificateChain': 'string',
'privateKey': 'string'
},
'sds': {
'secretName': 'string'
}
},
'enforce': True|False,
'ports': [
123,
],
'validation': {
'subjectAlternativeNames': {
'match': {
'exact': [
'string',
]
}
},
'trust': {
'acm': {
'certificateAuthorityArns': [
'string',
]
},
'file': {
'certificateChain': 'string'
},
'sds': {
'secretName': 'string'
}
}
}
}
},
'virtualServiceName': 'string'
}
},
],
'listeners': [
{
'connectionPool': {
'grpc': {
'maxRequests': 123
},
'http': {
'maxConnections': 123,
'maxPendingRequests': 123
},
'http2': {
'maxRequests': 123
},
'tcp': {
'maxConnections': 123
}
},
'healthCheck': {
'healthyThreshold': 123,
'intervalMillis': 123,
'path': 'string',
'port': 123,
'protocol': 'http'|'tcp'|'http2'|'grpc',
'timeoutMillis': 123,
'unhealthyThreshold': 123
},
'outlierDetection': {
'baseEjectionDuration': {
'unit': 's'|'ms',
'value': 123
},
'interval': {
'unit': 's'|'ms',
'value': 123
},
'maxEjectionPercent': 123,
'maxServerErrors': 123
},
'portMapping': {
'port': 123,
'protocol': 'http'|'tcp'|'http2'|'grpc'
},
'timeout': {
'grpc': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
},
'http': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
},
'http2': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
},
'tcp': {
'idle': {
'unit': 's'|'ms',
'value': 123
}
}
},
'tls': {
'certificate': {
'acm': {
'certificateArn': 'string'
},
'file': {
'certificateChain': 'string',
'privateKey': 'string'
},
'sds': {
'secretName': 'string'
}
},
'mode': 'STRICT'|'PERMISSIVE'|'DISABLED',
'validation': {
'subjectAlternativeNames': {
'match': {
'exact': [
'string',
]
}
},
'trust': {
'file': {
'certificateChain': 'string'
},
'sds': {
'secretName': 'string'
}
}
}
}
},
],
'logging': {
'accessLog': {
'file': {
'path': 'string'
}
}
},
'serviceDiscovery': {
'awsCloudMap': {
'attributes': [
{
'key': 'string',
'value': 'string'
},
],
'namespaceName': 'string',
'serviceName': 'string'
},
'dns': {
'hostname': 'string'
}
}
},
virtualNodeName='string'
)
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
This field is autopopulated if not provided.
string
[REQUIRED]
The name of the service mesh that the virtual node resides in.
string
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
dict
[REQUIRED]
The new virtual node specification to apply. This overwrites the existing data.
backendDefaults (dict) --
A reference to an object that represents the defaults for backends.
clientPolicy (dict) --
A reference to an object that represents a client policy.
tls (dict) --
A reference to an object that represents a Transport Layer Security (TLS) client policy.
certificate (dict) --
A reference to an object that represents a client's TLS certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: file, sds.
file (dict) --
An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
certificateChain (string) -- [REQUIRED]
The certificate chain for the certificate.
privateKey (string) -- [REQUIRED]
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a client's TLS Secret Discovery Service certificate.
secretName (string) -- [REQUIRED]
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.
enforce (boolean) --
Whether the policy is enforced. The default is True , if a value isn't specified.
ports (list) --
One or more ports that the policy is enforced for.
(integer) --
validation (dict) -- [REQUIRED]
A reference to an object that represents a TLS validation context.
subjectAlternativeNames (dict) --
A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context.
match (dict) -- [REQUIRED]
An object that represents the criteria for determining a SANs match.
exact (list) -- [REQUIRED]
The values sent must match the specified values exactly.
(string) --
trust (dict) -- [REQUIRED]
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: acm, file, sds.
acm (dict) --
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an AWS Certicate Manager (ACM) certificate.
certificateAuthorityArns (list) -- [REQUIRED]
One or more ACM Amazon Resource Name (ARN)s.
(string) --
file (dict) --
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
certificateChain (string) -- [REQUIRED]
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
secretName (string) -- [REQUIRED]
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
backends (list) --
The backends that the virtual node is expected to send outbound traffic to.
(dict) --
An object that represents the backends that a virtual node is expected to send outbound traffic to.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: virtualService.
virtualService (dict) --
Specifies a virtual service to use as a backend.
clientPolicy (dict) --
A reference to an object that represents the client policy for a backend.
tls (dict) --
A reference to an object that represents a Transport Layer Security (TLS) client policy.
certificate (dict) --
A reference to an object that represents a client's TLS certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: file, sds.
file (dict) --
An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
certificateChain (string) -- [REQUIRED]
The certificate chain for the certificate.
privateKey (string) -- [REQUIRED]
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a client's TLS Secret Discovery Service certificate.
secretName (string) -- [REQUIRED]
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.
enforce (boolean) --
Whether the policy is enforced. The default is True , if a value isn't specified.
ports (list) --
One or more ports that the policy is enforced for.
(integer) --
validation (dict) -- [REQUIRED]
A reference to an object that represents a TLS validation context.
subjectAlternativeNames (dict) --
A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context.
match (dict) -- [REQUIRED]
An object that represents the criteria for determining a SANs match.
exact (list) -- [REQUIRED]
The values sent must match the specified values exactly.
(string) --
trust (dict) -- [REQUIRED]
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: acm, file, sds.
acm (dict) --
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an AWS Certicate Manager (ACM) certificate.
certificateAuthorityArns (list) -- [REQUIRED]
One or more ACM Amazon Resource Name (ARN)s.
(string) --
file (dict) --
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
certificateChain (string) -- [REQUIRED]
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
secretName (string) -- [REQUIRED]
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
virtualServiceName (string) -- [REQUIRED]
The name of the virtual service that is acting as a virtual node backend.
listeners (list) --
The listener that the virtual node is expected to receive inbound traffic from. You can specify one listener.
(dict) --
An object that represents a listener for a virtual node.
connectionPool (dict) --
The connection pool information for the listener.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: grpc, http, http2, tcp.
grpc (dict) --
An object that represents a type of connection pool.
maxRequests (integer) -- [REQUIRED]
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.
http (dict) --
An object that represents a type of connection pool.
maxConnections (integer) -- [REQUIRED]
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.
maxPendingRequests (integer) --
Number of overflowing requests after max_connections Envoy will queue to upstream cluster.
http2 (dict) --
An object that represents a type of connection pool.
maxRequests (integer) -- [REQUIRED]
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.
tcp (dict) --
An object that represents a type of connection pool.
maxConnections (integer) -- [REQUIRED]
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.
healthCheck (dict) --
The health check information for the listener.
healthyThreshold (integer) -- [REQUIRED]
The number of consecutive successful health checks that must occur before declaring listener healthy.
intervalMillis (integer) -- [REQUIRED]
The time period in milliseconds between each health check execution.
path (string) --
The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.
port (integer) --
The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.
protocol (string) -- [REQUIRED]
The protocol for the health check request. If you specify grpc , then your service must conform to the GRPC Health Checking Protocol.
timeoutMillis (integer) -- [REQUIRED]
The amount of time to wait when receiving a response from the health check, in milliseconds.
unhealthyThreshold (integer) -- [REQUIRED]
The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.
outlierDetection (dict) --
The outlier detection information for the listener.
baseEjectionDuration (dict) -- [REQUIRED]
The base amount of time for which a host is ejected.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
interval (dict) -- [REQUIRED]
The time interval between ejection sweep analysis.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
maxEjectionPercent (integer) -- [REQUIRED]
Maximum percentage of hosts in load balancing pool for upstream service that can be ejected. Will eject at least one host regardless of the value.
maxServerErrors (integer) -- [REQUIRED]
Number of consecutive 5xx errors required for ejection.
portMapping (dict) -- [REQUIRED]
The port mapping information for the listener.
port (integer) -- [REQUIRED]
The port used for the port mapping.
protocol (string) -- [REQUIRED]
The protocol used for the port mapping. Specify one protocol.
timeout (dict) --
An object that represents timeouts for different protocols.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: grpc, http, http2, tcp.
grpc (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
http (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
http2 (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
tcp (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
tls (dict) --
A reference to an object that represents the Transport Layer Security (TLS) properties for a listener.
certificate (dict) -- [REQUIRED]
A reference to an object that represents a listener's Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: acm, file, sds.
acm (dict) --
A reference to an object that represents an AWS Certicate Manager (ACM) certificate.
certificateArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
file (dict) --
A reference to an object that represents a local file certificate.
certificateChain (string) -- [REQUIRED]
The certificate chain for the certificate.
privateKey (string) -- [REQUIRED]
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a listener's Secret Discovery Service certificate.
secretName (string) -- [REQUIRED]
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.
mode (string) -- [REQUIRED]
Specify one of the following modes.
STRICT – Listener only accepts connections with TLS enabled.
PERMISSIVE – Listener accepts connections with or without TLS enabled.
DISABLED – Listener only accepts connections without TLS.
validation (dict) --
A reference to an object that represents a listener's Transport Layer Security (TLS) validation context.
subjectAlternativeNames (dict) --
A reference to an object that represents the SANs for a listener's Transport Layer Security (TLS) validation context.
match (dict) -- [REQUIRED]
An object that represents the criteria for determining a SANs match.
exact (list) -- [REQUIRED]
The values sent must match the specified values exactly.
(string) --
trust (dict) -- [REQUIRED]
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: file, sds.
file (dict) --
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
certificateChain (string) -- [REQUIRED]
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a listener's Transport Layer Security (TLS) Secret Discovery Service validation context trust.
secretName (string) -- [REQUIRED]
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
logging (dict) --
The inbound and outbound access logging information for the virtual node.
accessLog (dict) --
The access log configuration for a virtual node.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: file.
file (dict) --
The file object to send virtual node access logs to.
path (string) -- [REQUIRED]
The file path to write access logs to. You can use /dev/stdout to send access logs to standard out and configure your Envoy container to use a log driver, such as awslogs , to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk.
Note
The Envoy process must have write permissions to the path that you specify here. Otherwise, Envoy fails to bootstrap properly.
serviceDiscovery (dict) --
The service discovery information for the virtual node. If your virtual node does not expect ingress traffic, you can omit this parameter. If you specify a listener , then you must specify service discovery information.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: awsCloudMap, dns.
awsCloudMap (dict) --
Specifies any AWS 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 AWS Cloud Map attribute information for your virtual node.
Note
AWS Cloud Map is not available in the eu-south-1 Region.
key (string) -- [REQUIRED]
The name of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service instance that contains the specified key and value is returned.
value (string) -- [REQUIRED]
The value of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service instance that contains the specified key and value is returned.
namespaceName (string) -- [REQUIRED]
The name of the AWS Cloud Map namespace to use.
serviceName (string) -- [REQUIRED]
The name of the AWS Cloud Map service to use.
dns (dict) --
Specifies the DNS information for the virtual node.
hostname (string) -- [REQUIRED]
Specifies the DNS service discovery hostname for the virtual node.
string
[REQUIRED]
The name of the virtual node to update.
dict
Response Syntax
{
'virtualNode': {
'meshName': 'string',
'metadata': {
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'meshOwner': 'string',
'resourceOwner': 'string',
'uid': 'string',
'version': 123
},
'spec': {
'backendDefaults': {
'clientPolicy': {
'tls': {
'certificate': {
'file': {
'certificateChain': 'string',
'privateKey': 'string'
},
'sds': {
'secretName': 'string'
}
},
'enforce': True|False,
'ports': [
123,
],
'validation': {
'subjectAlternativeNames': {
'match': {
'exact': [
'string',
]
}
},
'trust': {
'acm': {
'certificateAuthorityArns': [
'string',
]
},
'file': {
'certificateChain': 'string'
},
'sds': {
'secretName': 'string'
}
}
}
}
}
},
'backends': [
{
'virtualService': {
'clientPolicy': {
'tls': {
'certificate': {
'file': {
'certificateChain': 'string',
'privateKey': 'string'
},
'sds': {
'secretName': 'string'
}
},
'enforce': True|False,
'ports': [
123,
],
'validation': {
'subjectAlternativeNames': {
'match': {
'exact': [
'string',
]
}
},
'trust': {
'acm': {
'certificateAuthorityArns': [
'string',
]
},
'file': {
'certificateChain': 'string'
},
'sds': {
'secretName': 'string'
}
}
}
}
},
'virtualServiceName': 'string'
}
},
],
'listeners': [
{
'connectionPool': {
'grpc': {
'maxRequests': 123
},
'http': {
'maxConnections': 123,
'maxPendingRequests': 123
},
'http2': {
'maxRequests': 123
},
'tcp': {
'maxConnections': 123
}
},
'healthCheck': {
'healthyThreshold': 123,
'intervalMillis': 123,
'path': 'string',
'port': 123,
'protocol': 'http'|'tcp'|'http2'|'grpc',
'timeoutMillis': 123,
'unhealthyThreshold': 123
},
'outlierDetection': {
'baseEjectionDuration': {
'unit': 's'|'ms',
'value': 123
},
'interval': {
'unit': 's'|'ms',
'value': 123
},
'maxEjectionPercent': 123,
'maxServerErrors': 123
},
'portMapping': {
'port': 123,
'protocol': 'http'|'tcp'|'http2'|'grpc'
},
'timeout': {
'grpc': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
},
'http': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
},
'http2': {
'idle': {
'unit': 's'|'ms',
'value': 123
},
'perRequest': {
'unit': 's'|'ms',
'value': 123
}
},
'tcp': {
'idle': {
'unit': 's'|'ms',
'value': 123
}
}
},
'tls': {
'certificate': {
'acm': {
'certificateArn': 'string'
},
'file': {
'certificateChain': 'string',
'privateKey': 'string'
},
'sds': {
'secretName': 'string'
}
},
'mode': 'STRICT'|'PERMISSIVE'|'DISABLED',
'validation': {
'subjectAlternativeNames': {
'match': {
'exact': [
'string',
]
}
},
'trust': {
'file': {
'certificateChain': 'string'
},
'sds': {
'secretName': 'string'
}
}
}
}
},
],
'logging': {
'accessLog': {
'file': {
'path': 'string'
}
}
},
'serviceDiscovery': {
'awsCloudMap': {
'attributes': [
{
'key': 'string',
'value': 'string'
},
],
'namespaceName': 'string',
'serviceName': 'string'
},
'dns': {
'hostname': 'string'
}
}
},
'status': {
'status': 'ACTIVE'|'INACTIVE'|'DELETED'
},
'virtualNodeName': 'string'
}
}
Response Structure
(dict) --
virtualNode (dict) --
A full description of the virtual node that was updated.
meshName (string) --
The name of the service mesh that the virtual node resides in.
metadata (dict) --
The associated metadata for the virtual node.
arn (string) --
The full Amazon Resource Name (ARN) for the resource.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was created.
lastUpdatedAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was last updated.
meshOwner (string) --
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
resourceOwner (string) --
The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
uid (string) --
The unique identifier for the resource.
version (integer) --
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
spec (dict) --
The specifications of the virtual node.
backendDefaults (dict) --
A reference to an object that represents the defaults for backends.
clientPolicy (dict) --
A reference to an object that represents a client policy.
tls (dict) --
A reference to an object that represents a Transport Layer Security (TLS) client policy.
certificate (dict) --
A reference to an object that represents a client's TLS certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
file (dict) --
An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
certificateChain (string) --
The certificate chain for the certificate.
privateKey (string) --
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a client's TLS Secret Discovery Service certificate.
secretName (string) --
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.
enforce (boolean) --
Whether the policy is enforced. The default is True , if a value isn't specified.
ports (list) --
One or more ports that the policy is enforced for.
(integer) --
validation (dict) --
A reference to an object that represents a TLS validation context.
subjectAlternativeNames (dict) --
A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context.
match (dict) --
An object that represents the criteria for determining a SANs match.
exact (list) --
The values sent must match the specified values exactly.
(string) --
trust (dict) --
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: acm, file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
acm (dict) --
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an AWS Certicate Manager (ACM) certificate.
certificateAuthorityArns (list) --
One or more ACM Amazon Resource Name (ARN)s.
(string) --
file (dict) --
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
certificateChain (string) --
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
secretName (string) --
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
backends (list) --
The backends that the virtual node is expected to send outbound traffic to.
(dict) --
An object that represents the backends that a virtual node is expected to send outbound traffic to.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: virtualService. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
virtualService (dict) --
Specifies a virtual service to use as a backend.
clientPolicy (dict) --
A reference to an object that represents the client policy for a backend.
tls (dict) --
A reference to an object that represents a Transport Layer Security (TLS) client policy.
certificate (dict) --
A reference to an object that represents a client's TLS certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
file (dict) --
An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
certificateChain (string) --
The certificate chain for the certificate.
privateKey (string) --
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a client's TLS Secret Discovery Service certificate.
secretName (string) --
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.
enforce (boolean) --
Whether the policy is enforced. The default is True , if a value isn't specified.
ports (list) --
One or more ports that the policy is enforced for.
(integer) --
validation (dict) --
A reference to an object that represents a TLS validation context.
subjectAlternativeNames (dict) --
A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context.
match (dict) --
An object that represents the criteria for determining a SANs match.
exact (list) --
The values sent must match the specified values exactly.
(string) --
trust (dict) --
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: acm, file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
acm (dict) --
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an AWS Certicate Manager (ACM) certificate.
certificateAuthorityArns (list) --
One or more ACM Amazon Resource Name (ARN)s.
(string) --
file (dict) --
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
certificateChain (string) --
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
secretName (string) --
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
virtualServiceName (string) --
The name of the virtual service that is acting as a virtual node backend.
listeners (list) --
The listener that the virtual node is expected to receive inbound traffic from. You can specify one listener.
(dict) --
An object that represents a listener for a virtual node.
connectionPool (dict) --
The connection pool information for the listener.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: grpc, http, http2, tcp. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
grpc (dict) --
An object that represents a type of connection pool.
maxRequests (integer) --
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.
http (dict) --
An object that represents a type of connection pool.
maxConnections (integer) --
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.
maxPendingRequests (integer) --
Number of overflowing requests after max_connections Envoy will queue to upstream cluster.
http2 (dict) --
An object that represents a type of connection pool.
maxRequests (integer) --
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.
tcp (dict) --
An object that represents a type of connection pool.
maxConnections (integer) --
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.
healthCheck (dict) --
The health check information for the listener.
healthyThreshold (integer) --
The number of consecutive successful health checks that must occur before declaring listener healthy.
intervalMillis (integer) --
The time period in milliseconds between each health check execution.
path (string) --
The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.
port (integer) --
The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.
protocol (string) --
The protocol for the health check request. If you specify grpc , then your service must conform to the GRPC Health Checking Protocol.
timeoutMillis (integer) --
The amount of time to wait when receiving a response from the health check, in milliseconds.
unhealthyThreshold (integer) --
The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.
outlierDetection (dict) --
The outlier detection information for the listener.
baseEjectionDuration (dict) --
The base amount of time for which a host is ejected.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
interval (dict) --
The time interval between ejection sweep analysis.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
maxEjectionPercent (integer) --
Maximum percentage of hosts in load balancing pool for upstream service that can be ejected. Will eject at least one host regardless of the value.
maxServerErrors (integer) --
Number of consecutive 5xx errors required for ejection.
portMapping (dict) --
The port mapping information for the listener.
port (integer) --
The port used for the port mapping.
protocol (string) --
The protocol used for the port mapping. Specify one protocol.
timeout (dict) --
An object that represents timeouts for different protocols.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: grpc, http, http2, tcp. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
grpc (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
http (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
http2 (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
perRequest (dict) --
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
tcp (dict) --
An object that represents types of timeouts.
idle (dict) --
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
unit (string) --
A unit of time.
value (integer) --
A number of time units.
tls (dict) --
A reference to an object that represents the Transport Layer Security (TLS) properties for a listener.
certificate (dict) --
A reference to an object that represents a listener's Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: acm, file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
acm (dict) --
A reference to an object that represents an AWS Certicate Manager (ACM) certificate.
certificateArn (string) --
The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
file (dict) --
A reference to an object that represents a local file certificate.
certificateChain (string) --
The certificate chain for the certificate.
privateKey (string) --
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a listener's Secret Discovery Service certificate.
secretName (string) --
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.
mode (string) --
Specify one of the following modes.
STRICT – Listener only accepts connections with TLS enabled.
PERMISSIVE – Listener accepts connections with or without TLS enabled.
DISABLED – Listener only accepts connections without TLS.
validation (dict) --
A reference to an object that represents a listener's Transport Layer Security (TLS) validation context.
subjectAlternativeNames (dict) --
A reference to an object that represents the SANs for a listener's Transport Layer Security (TLS) validation context.
match (dict) --
An object that represents the criteria for determining a SANs match.
exact (list) --
The values sent must match the specified values exactly.
(string) --
trust (dict) --
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: file, sds. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
file (dict) --
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
certificateChain (string) --
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
sds (dict) --
A reference to an object that represents a listener's Transport Layer Security (TLS) Secret Discovery Service validation context trust.
secretName (string) --
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
logging (dict) --
The inbound and outbound access logging information for the virtual node.
accessLog (dict) --
The access log configuration for a virtual node.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: file. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
file (dict) --
The file object to send virtual node access logs to.
path (string) --
The file path to write access logs to. You can use /dev/stdout to send access logs to standard out and configure your Envoy container to use a log driver, such as awslogs , to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk.
Note
The Envoy process must have write permissions to the path that you specify here. Otherwise, Envoy fails to bootstrap properly.
serviceDiscovery (dict) --
The service discovery information for the virtual node. If your virtual node does not expect ingress traffic, you can omit this parameter. If you specify a listener , then you must specify service discovery information.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: awsCloudMap, dns. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
awsCloudMap (dict) --
Specifies any AWS 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 AWS Cloud Map attribute information for your virtual node.
Note
AWS Cloud Map is not available in the eu-south-1 Region.
key (string) --
The name of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service instance that contains the specified key and value is returned.
value (string) --
The value of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service instance that contains the specified key and value is returned.
namespaceName (string) --
The name of the AWS Cloud Map namespace to use.
serviceName (string) --
The name of the AWS 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.
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.