2019/06/13 - AWS App Mesh - 4 updated api methods
Changes This release adds support for AWS Cloud Map as a service discovery method for virtual nodes.
{'spec': {'serviceDiscovery': {'awsCloudMap': {'attributes': [{'key': 'string',
'value': 'string'}],
'namespaceName': 'string',
'serviceName': 'string'}}}}
Response {'virtualNode': {'spec': {'serviceDiscovery': {'awsCloudMap': {'attributes': [{'key': 'string',
'value': 'string'}],
'namespaceName': 'string',
'serviceName': '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.
Any inbound traffic that your virtual node expects should be specified as a listener . Any outbound traffic that your virtual node expects to reach should be 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 (either the full ARN or the truncated resource name: for example, mesh/default/virtualNode/simpleapp ) as the APPMESH_VIRTUAL_NODE_NAME 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
If you require your Envoy stats or tracing to use a different name, you can override the node.cluster value that is set by APPMESH_VIRTUAL_NODE_NAME with the APPMESH_VIRTUAL_NODE_CLUSTER environment variable.
See also: AWS API Documentation
Request Syntax
client.create_virtual_node(
clientToken='string',
meshName='string',
spec={
'backends': [
{
'virtualService': {
'virtualServiceName': 'string'
}
},
],
'listeners': [
{
'healthCheck': {
'healthyThreshold': 123,
'intervalMillis': 123,
'path': 'string',
'port': 123,
'protocol': 'http'|'tcp',
'timeoutMillis': 123,
'unhealthyThreshold': 123
},
'portMapping': {
'port': 123,
'protocol': 'http'|'tcp'
}
},
],
'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.
dict
[REQUIRED]
The virtual node specification to apply.
backends (list) --
The backends that the virtual node is expected to send outbound traffic to.
(dict) --
An object representing the backends that a virtual node is expected to send outbound traffic to.
virtualService (dict) --
Specifies a virtual service to use as a backend for a virtual node.
virtualServiceName (string) -- [REQUIRED]
The name of the virtual service that is acting as a virtual node backend.
listeners (list) --
The listeners that the virtual node is expected to receive inbound traffic from. Currently only one listener is supported per virtual node.
(dict) --
An object representing a listener for a virtual node.
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 is required only if the specified protocol is HTTP. If the protocol is TCP, this parameter 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.
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.
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.
logging (dict) --
The inbound and outbound access logging information for the virtual node.
accessLog (dict) --
The access log configuration for a virtual node.
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.
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 representing the AWS Cloud Map attribute information for your virtual node.
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) --
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),
'uid': 'string',
'version': 123
},
'spec': {
'backends': [
{
'virtualService': {
'virtualServiceName': 'string'
}
},
],
'listeners': [
{
'healthCheck': {
'healthyThreshold': 123,
'intervalMillis': 123,
'path': 'string',
'port': 123,
'protocol': 'http'|'tcp',
'timeoutMillis': 123,
'unhealthyThreshold': 123
},
'portMapping': {
'port': 123,
'protocol': 'http'|'tcp'
}
},
],
'logging': {
'accessLog': {
'file': {
'path': 'string'
}
}
},
'serviceDiscovery': {
'awsCloudMap': {
'attributes': [
{
'key': 'string',
'value': 'string'
},
],
'namespaceName': 'string',
'serviceName': 'string'
},
'dns': {
'hostname': 'string'
}
}
},
'status': {
'status': 'ACTIVE'|'DELETED'|'INACTIVE'
},
'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.
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.
backends (list) --
The backends that the virtual node is expected to send outbound traffic to.
(dict) --
An object representing the backends that a virtual node is expected to send outbound traffic to.
virtualService (dict) --
Specifies a virtual service to use as a backend for a virtual node.
virtualServiceName (string) --
The name of the virtual service that is acting as a virtual node backend.
listeners (list) --
The listeners that the virtual node is expected to receive inbound traffic from. Currently only one listener is supported per virtual node.
(dict) --
An object representing a listener for a virtual node.
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 is required only if the specified protocol is HTTP. If the protocol is TCP, this parameter 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.
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.
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.
logging (dict) --
The inbound and outbound access logging information for the virtual node.
accessLog (dict) --
The access log configuration for a virtual node.
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.
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 representing the AWS Cloud Map attribute information for your virtual node.
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.
{'virtualNode': {'spec': {'serviceDiscovery': {'awsCloudMap': {'attributes': [{'key': 'string',
'value': 'string'}],
'namespaceName': 'string',
'serviceName': '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',
virtualNodeName='string'
)
string
[REQUIRED]
The name of the service mesh to delete the virtual node in.
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),
'uid': 'string',
'version': 123
},
'spec': {
'backends': [
{
'virtualService': {
'virtualServiceName': 'string'
}
},
],
'listeners': [
{
'healthCheck': {
'healthyThreshold': 123,
'intervalMillis': 123,
'path': 'string',
'port': 123,
'protocol': 'http'|'tcp',
'timeoutMillis': 123,
'unhealthyThreshold': 123
},
'portMapping': {
'port': 123,
'protocol': 'http'|'tcp'
}
},
],
'logging': {
'accessLog': {
'file': {
'path': 'string'
}
}
},
'serviceDiscovery': {
'awsCloudMap': {
'attributes': [
{
'key': 'string',
'value': 'string'
},
],
'namespaceName': 'string',
'serviceName': 'string'
},
'dns': {
'hostname': 'string'
}
}
},
'status': {
'status': 'ACTIVE'|'DELETED'|'INACTIVE'
},
'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.
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.
backends (list) --
The backends that the virtual node is expected to send outbound traffic to.
(dict) --
An object representing the backends that a virtual node is expected to send outbound traffic to.
virtualService (dict) --
Specifies a virtual service to use as a backend for a virtual node.
virtualServiceName (string) --
The name of the virtual service that is acting as a virtual node backend.
listeners (list) --
The listeners that the virtual node is expected to receive inbound traffic from. Currently only one listener is supported per virtual node.
(dict) --
An object representing a listener for a virtual node.
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 is required only if the specified protocol is HTTP. If the protocol is TCP, this parameter 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.
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.
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.
logging (dict) --
The inbound and outbound access logging information for the virtual node.
accessLog (dict) --
The access log configuration for a virtual node.
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.
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 representing the AWS Cloud Map attribute information for your virtual node.
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.
{'virtualNode': {'spec': {'serviceDiscovery': {'awsCloudMap': {'attributes': [{'key': 'string',
'value': 'string'}],
'namespaceName': 'string',
'serviceName': 'string'}}}}}
Describes an existing virtual node.
See also: AWS API Documentation
Request Syntax
client.describe_virtual_node(
meshName='string',
virtualNodeName='string'
)
string
[REQUIRED]
The name of the service mesh that the virtual node resides in.
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),
'uid': 'string',
'version': 123
},
'spec': {
'backends': [
{
'virtualService': {
'virtualServiceName': 'string'
}
},
],
'listeners': [
{
'healthCheck': {
'healthyThreshold': 123,
'intervalMillis': 123,
'path': 'string',
'port': 123,
'protocol': 'http'|'tcp',
'timeoutMillis': 123,
'unhealthyThreshold': 123
},
'portMapping': {
'port': 123,
'protocol': 'http'|'tcp'
}
},
],
'logging': {
'accessLog': {
'file': {
'path': 'string'
}
}
},
'serviceDiscovery': {
'awsCloudMap': {
'attributes': [
{
'key': 'string',
'value': 'string'
},
],
'namespaceName': 'string',
'serviceName': 'string'
},
'dns': {
'hostname': 'string'
}
}
},
'status': {
'status': 'ACTIVE'|'DELETED'|'INACTIVE'
},
'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.
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.
backends (list) --
The backends that the virtual node is expected to send outbound traffic to.
(dict) --
An object representing the backends that a virtual node is expected to send outbound traffic to.
virtualService (dict) --
Specifies a virtual service to use as a backend for a virtual node.
virtualServiceName (string) --
The name of the virtual service that is acting as a virtual node backend.
listeners (list) --
The listeners that the virtual node is expected to receive inbound traffic from. Currently only one listener is supported per virtual node.
(dict) --
An object representing a listener for a virtual node.
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 is required only if the specified protocol is HTTP. If the protocol is TCP, this parameter 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.
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.
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.
logging (dict) --
The inbound and outbound access logging information for the virtual node.
accessLog (dict) --
The access log configuration for a virtual node.
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.
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 representing the AWS Cloud Map attribute information for your virtual node.
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': {'serviceDiscovery': {'awsCloudMap': {'attributes': [{'key': 'string',
'value': 'string'}],
'namespaceName': 'string',
'serviceName': 'string'}}}}
Response {'virtualNode': {'spec': {'serviceDiscovery': {'awsCloudMap': {'attributes': [{'key': 'string',
'value': 'string'}],
'namespaceName': 'string',
'serviceName': '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',
spec={
'backends': [
{
'virtualService': {
'virtualServiceName': 'string'
}
},
],
'listeners': [
{
'healthCheck': {
'healthyThreshold': 123,
'intervalMillis': 123,
'path': 'string',
'port': 123,
'protocol': 'http'|'tcp',
'timeoutMillis': 123,
'unhealthyThreshold': 123
},
'portMapping': {
'port': 123,
'protocol': 'http'|'tcp'
}
},
],
'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.
dict
[REQUIRED]
The new virtual node specification to apply. This overwrites the existing data.
backends (list) --
The backends that the virtual node is expected to send outbound traffic to.
(dict) --
An object representing the backends that a virtual node is expected to send outbound traffic to.
virtualService (dict) --
Specifies a virtual service to use as a backend for a virtual node.
virtualServiceName (string) -- [REQUIRED]
The name of the virtual service that is acting as a virtual node backend.
listeners (list) --
The listeners that the virtual node is expected to receive inbound traffic from. Currently only one listener is supported per virtual node.
(dict) --
An object representing a listener for a virtual node.
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 is required only if the specified protocol is HTTP. If the protocol is TCP, this parameter 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.
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.
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.
logging (dict) --
The inbound and outbound access logging information for the virtual node.
accessLog (dict) --
The access log configuration for a virtual node.
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.
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 representing the AWS Cloud Map attribute information for your virtual node.
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),
'uid': 'string',
'version': 123
},
'spec': {
'backends': [
{
'virtualService': {
'virtualServiceName': 'string'
}
},
],
'listeners': [
{
'healthCheck': {
'healthyThreshold': 123,
'intervalMillis': 123,
'path': 'string',
'port': 123,
'protocol': 'http'|'tcp',
'timeoutMillis': 123,
'unhealthyThreshold': 123
},
'portMapping': {
'port': 123,
'protocol': 'http'|'tcp'
}
},
],
'logging': {
'accessLog': {
'file': {
'path': 'string'
}
}
},
'serviceDiscovery': {
'awsCloudMap': {
'attributes': [
{
'key': 'string',
'value': 'string'
},
],
'namespaceName': 'string',
'serviceName': 'string'
},
'dns': {
'hostname': 'string'
}
}
},
'status': {
'status': 'ACTIVE'|'DELETED'|'INACTIVE'
},
'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.
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.
backends (list) --
The backends that the virtual node is expected to send outbound traffic to.
(dict) --
An object representing the backends that a virtual node is expected to send outbound traffic to.
virtualService (dict) --
Specifies a virtual service to use as a backend for a virtual node.
virtualServiceName (string) --
The name of the virtual service that is acting as a virtual node backend.
listeners (list) --
The listeners that the virtual node is expected to receive inbound traffic from. Currently only one listener is supported per virtual node.
(dict) --
An object representing a listener for a virtual node.
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 is required only if the specified protocol is HTTP. If the protocol is TCP, this parameter 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.
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.
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.
logging (dict) --
The inbound and outbound access logging information for the virtual node.
accessLog (dict) --
The access log configuration for a virtual node.
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.
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 representing the AWS Cloud Map attribute information for your virtual node.
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.