Class: AWS.AppMesh
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.AppMesh
- Identifier:
- appmesh
- API Version:
- 2019-01-25
- Defined in:
- (unknown)
Overview
Constructs a service interface object. Each API operation is exposed as a function on service.
Service Description
AWS App Mesh is a service mesh based on the Envoy proxy that makes it easy to monitor and control microservices. App Mesh standardizes how your microservices communicate, giving you end-to-end visibility and helping to ensure high availability for your applications.
App Mesh gives you consistent visibility and network traffic controls for every microservice in an application. You can use App Mesh with AWS Fargate, Amazon ECS, Amazon EKS, and Kubernetes on AWS.
kube-dns
and coredns
are supported. For more information, see DNS for Services and Pods in the Kubernetes documentation. Sending a Request Using AppMesh
var appmesh = new AWS.AppMesh();
appmesh.createMesh(params, function (err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Locking the API Version
In order to ensure that the AppMesh object uses this specific API, you can
construct the object by passing the apiVersion
option to the constructor:
var appmesh = new AWS.AppMesh({apiVersion: '2019-01-25'});
You can also set the API version globally in AWS.config.apiVersions
using
the appmesh service identifier:
AWS.config.apiVersions = {
appmesh: '2019-01-25',
// other service API versions
};
var appmesh = new AWS.AppMesh();
Version:
-
2019-01-25
Constructor Summary
-
new AWS.AppMesh(options = {}) ⇒ Object
constructor
Constructs a service object.
Property Summary
-
endpoint ⇒ AWS.Endpoint
readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summary
-
createMesh(params = {}, callback) ⇒ AWS.Request
Creates a service mesh.
-
createRoute(params = {}, callback) ⇒ AWS.Request
Creates a route that is associated with a virtual router.
-
createVirtualNode(params = {}, callback) ⇒ AWS.Request
Creates a virtual node within a service mesh.
-
createVirtualRouter(params = {}, callback) ⇒ AWS.Request
Creates a virtual router within a service mesh.
-
createVirtualService(params = {}, callback) ⇒ AWS.Request
Creates a virtual service within a service mesh.
-
deleteMesh(params = {}, callback) ⇒ AWS.Request
Deletes an existing service mesh.
-
deleteRoute(params = {}, callback) ⇒ AWS.Request
Deletes an existing route.
-
deleteVirtualNode(params = {}, callback) ⇒ AWS.Request
Deletes an existing virtual node.
-
deleteVirtualRouter(params = {}, callback) ⇒ AWS.Request
Deletes an existing virtual router.
-
deleteVirtualService(params = {}, callback) ⇒ AWS.Request
Deletes an existing virtual service.
-
describeMesh(params = {}, callback) ⇒ AWS.Request
Describes an existing service mesh.
-
describeRoute(params = {}, callback) ⇒ AWS.Request
Describes an existing route.
-
describeVirtualNode(params = {}, callback) ⇒ AWS.Request
Describes an existing virtual node.
-
describeVirtualRouter(params = {}, callback) ⇒ AWS.Request
Describes an existing virtual router.
-
describeVirtualService(params = {}, callback) ⇒ AWS.Request
Describes an existing virtual service.
-
listMeshes(params = {}, callback) ⇒ AWS.Request
Returns a list of existing service meshes.
-
listRoutes(params = {}, callback) ⇒ AWS.Request
Returns a list of existing routes in a service mesh.
-
listTagsForResource(params = {}, callback) ⇒ AWS.Request
List the tags for an App Mesh resource.
-
listVirtualNodes(params = {}, callback) ⇒ AWS.Request
Returns a list of existing virtual nodes.
-
listVirtualRouters(params = {}, callback) ⇒ AWS.Request
Returns a list of existing virtual routers in a service mesh.
-
listVirtualServices(params = {}, callback) ⇒ AWS.Request
Returns a list of existing virtual services in a service mesh.
-
tagResource(params = {}, callback) ⇒ AWS.Request
Associates the specified tags to a resource with the specified resourceArn.
-
untagResource(params = {}, callback) ⇒ AWS.Request
Deletes specified tags from a resource.
-
updateMesh(params = {}, callback) ⇒ AWS.Request
Updates an existing service mesh.
-
updateRoute(params = {}, callback) ⇒ AWS.Request
Updates an existing route for a specified service mesh and virtual router.
-
updateVirtualNode(params = {}, callback) ⇒ AWS.Request
Updates an existing virtual node in a specified service mesh.
-
updateVirtualRouter(params = {}, callback) ⇒ AWS.Request
Updates an existing virtual router in a specified service mesh.
-
updateVirtualService(params = {}, callback) ⇒ AWS.Request
Updates an existing virtual service in a specified service mesh.
Methods inherited from AWS.Service
makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService
Constructor Details
new AWS.AppMesh(options = {}) ⇒ Object
Constructs a service object. This object has one method for each API operation.
Examples:
Constructing a AppMesh object
var appmesh = new AWS.AppMesh({apiVersion: '2019-01-25'});
Options Hash (options):
-
params
(map)
—
An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.
-
endpoint
(String)
—
The endpoint URI to send requests to. The default endpoint is built from the configured
region
. The endpoint should be a string like'https://{service}.{region}.amazonaws.com'
. -
accessKeyId
(String)
—
your AWS access key ID.
-
secretAccessKey
(String)
—
your AWS secret access key.
-
sessionToken
(AWS.Credentials)
—
the optional AWS session token to sign requests with.
-
credentials
(AWS.Credentials)
—
the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.
-
credentialProvider
(AWS.CredentialProviderChain)
—
the provider chain used to resolve credentials if no static
credentials
property is set. -
region
(String)
—
the region to send service requests to. See AWS.AppMesh.region for more information.
-
maxRetries
(Integer)
—
the maximum amount of retries to attempt with a request. See AWS.AppMesh.maxRetries for more information.
-
maxRedirects
(Integer)
—
the maximum amount of redirects to follow with a request. See AWS.AppMesh.maxRedirects for more information.
-
sslEnabled
(Boolean)
—
whether to enable SSL for requests.
-
paramValidation
(Boolean|map)
—
whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:
- min [Boolean] — Validates that a value meets the min
constraint. This is enabled by default when paramValidation is set
to
true
. - max [Boolean] — Validates that a value meets the max constraint.
- pattern [Boolean] — Validates that a string value matches a regular expression.
- enum [Boolean] — Validates that a string value matches one of the allowable enum values.
- min [Boolean] — Validates that a value meets the min
constraint. This is enabled by default when paramValidation is set
to
-
computeChecksums
(Boolean)
—
whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)
-
convertResponseTypes
(Boolean)
—
whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to
true
. -
correctClockSkew
(Boolean)
—
whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to
false
. -
s3ForcePathStyle
(Boolean)
—
whether to force path style URLs for S3 objects.
-
s3BucketEndpoint
(Boolean)
—
whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an
endpoint
to be provided explicitly to the service constructor. -
s3DisableBodySigning
(Boolean)
—
whether S3 body signing should be disabled when using signature version
v4
. Body signing can only be disabled when using https. Defaults totrue
. -
retryDelayOptions
(map)
—
A set of options to configure the retry delay on retryable errors. Currently supported options are:
- base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
- customBackoff [function] — A custom function that accepts a retry count
and returns the amount of time to delay in milliseconds. The
base
option will be ignored if this option is supplied.
-
httpOptions
(map)
—
A set of options to pass to the low-level HTTP request. Currently supported options are:
- proxy [String] — the URL to proxy requests through
- agent [http.Agent, https.Agent] — the Agent object to perform
HTTP requests with. Used for connection pooling. Defaults to the global
agent (
http.globalAgent
) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment. - connectTimeout [Integer] — Sets the socket to timeout after
failing to establish a connection with the server after
connectTimeout
milliseconds. This timeout has no effect once a socket connection has been established. - timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
- xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
- xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
-
apiVersion
(String, Date)
—
a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by
apiVersions
). Specify 'latest' to use the latest possible version. -
apiVersions
(map<String, String|Date>)
—
a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.
-
logger
(#write, #log)
—
an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests
-
systemClockOffset
(Number)
—
an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global
AWS.config
object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds. -
signatureVersion
(String)
—
the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.
-
signatureCache
(Boolean)
—
whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to
true
. -
dynamoDbCrc32
(Boolean)
—
whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default:
true
. -
useAccelerateEndpoint
(Boolean)
—
Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default:
false
. -
clientSideMonitoring
(Boolean)
—
whether to collect and publish this client's performance metrics of all its API requests.
-
endpointDiscoveryEnabled
(Boolean)
—
whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'
-
endpointCacheSize
(Number)
—
the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000
-
hostPrefixEnabled
(Boolean)
—
whether to marshal request parameters to the prefix of hostname. Defaults to
true
.
Property Details
Method Details
createMesh(params = {}, callback) ⇒ AWS.Request
Creates a service mesh. A service mesh is a logical boundary for network traffic between the services that reside within it.
After you create your service mesh, you can create virtual services, virtual nodes, virtual routers, and routes to distribute traffic between the applications in your mesh.
Service Reference:
Examples:
Calling the createMesh operation
var params = {
meshName: 'STRING_VALUE', /* required */
clientToken: 'STRING_VALUE',
spec: {
egressFilter: {
type: ALLOW_ALL | DROP_ALL /* required */
}
},
tags: [
{
key: 'STRING_VALUE', /* required */
value: 'STRING_VALUE'
},
/* more items */
]
};
appmesh.createMesh(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
clientToken
— (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.
If a token is not provided, the SDK will use a version 4 UUID.meshName
— (String
)The name to use for the service mesh.
spec
— (map
)The service mesh specification to apply.
egressFilter
— (map
)The egress filter rules for the service mesh.
type
— required — (String
)The egress filter type. By default, the type is
Possible values include:DROP_ALL
, which allows egress only from virtual nodes to other defined resources in the service mesh (and any traffic to*.amazonaws.com
for AWS API calls). You can set the egress filter type toALLOW_ALL
to allow egress to any endpoint inside or outside of the service mesh."ALLOW_ALL"
"DROP_ALL"
tags
— (Array<map>
)Optional metadata that you can apply to the service mesh to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
key
— required — (String
)One part of a key-value pair that make up a tag. A
key
is a general label that acts like a category for more specific tag values.value
— (String
)The optional part of a key-value pair that make up a tag. A
value
acts as a descriptor within a tag category (key).
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:mesh
— (map
)The full description of your service mesh following the create call.
meshName
— required — (String
)The name of the service mesh.
metadata
— required — (map
)The associated metadata for the service mesh.
arn
— required — (String
)The full Amazon Resource Name (ARN) for the resource.
createdAt
— required — (Date
)The Unix epoch timestamp in seconds for when the resource was created.
lastUpdatedAt
— required — (Date
)The Unix epoch timestamp in seconds for when the resource was last updated.
uid
— required — (String
)The unique identifier for the resource.
version
— required — (Integer
)The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
spec
— required — (map
)The associated specification for the service mesh.
egressFilter
— (map
)The egress filter rules for the service mesh.
type
— required — (String
)The egress filter type. By default, the type is
Possible values include:DROP_ALL
, which allows egress only from virtual nodes to other defined resources in the service mesh (and any traffic to*.amazonaws.com
for AWS API calls). You can set the egress filter type toALLOW_ALL
to allow egress to any endpoint inside or outside of the service mesh."ALLOW_ALL"
"DROP_ALL"
status
— required — (map
)The status of the service mesh.
status
— (String
)The current mesh status.
Possible values include:"ACTIVE"
"DELETED"
"INACTIVE"
-
(AWS.Response)
—
Returns:
createRoute(params = {}, callback) ⇒ AWS.Request
Creates a route that is associated with a virtual router.
You can use the prefix
parameter in your route specification for path-based routing of requests. For example, if your virtual service name is my-service.local
and you want the route to match requests to my-service.local/metrics
, your prefix should be /metrics
.
If your route matches a request, you can distribute traffic to one or more target virtual nodes with relative weighting.
Service Reference:
Examples:
Calling the createRoute operation
var params = {
meshName: 'STRING_VALUE', /* required */
routeName: 'STRING_VALUE', /* required */
spec: { /* required */
httpRoute: {
action: { /* required */
weightedTargets: [ /* required */
{
virtualNode: 'STRING_VALUE', /* required */
weight: 'NUMBER_VALUE' /* required */
},
/* more items */
]
},
match: { /* required */
prefix: 'STRING_VALUE' /* required */
}
},
tcpRoute: {
action: { /* required */
weightedTargets: [ /* required */
{
virtualNode: 'STRING_VALUE', /* required */
weight: 'NUMBER_VALUE' /* required */
},
/* more items */
]
}
}
},
virtualRouterName: 'STRING_VALUE', /* required */
clientToken: 'STRING_VALUE',
tags: [
{
key: 'STRING_VALUE', /* required */
value: 'STRING_VALUE'
},
/* more items */
]
};
appmesh.createRoute(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
clientToken
— (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.
If a token is not provided, the SDK will use a version 4 UUID.meshName
— (String
)The name of the service mesh to create the route in.
routeName
— (String
)The name to use for the route.
spec
— (map
)The route specification to apply.
httpRoute
— (map
)The HTTP routing information for the route.
action
— required — (map
)The action to take if a match is determined.
weightedTargets
— required — (Array<map>
)The targets that traffic is routed to when a request matches the route. You can specify one or more targets and their relative weights to distribute traffic with.
virtualNode
— required — (String
)The virtual node to associate with the weighted target.
weight
— required — (Integer
)The relative weight of the weighted target.
match
— required — (map
)The criteria for determining an HTTP request match.
prefix
— required — (String
)Specifies the path to match requests with. This parameter must always start with
/
, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name ismy-service.local
and you want the route to match requests tomy-service.local/metrics
, your prefix should be/metrics
.
tcpRoute
— (map
)The TCP routing information for the route.
action
— required — (map
)The action to take if a match is determined.
weightedTargets
— required — (Array<map>
)The targets that traffic is routed to when a request matches the route. You can specify one or more targets and their relative weights to distribute traffic with.
virtualNode
— required — (String
)The virtual node to associate with the weighted target.
weight
— required — (Integer
)The relative weight of the weighted target.
tags
— (Array<map>
)Optional metadata that you can apply to the route to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
key
— required — (String
)One part of a key-value pair that make up a tag. A
key
is a general label that acts like a category for more specific tag values.value
— (String
)The optional part of a key-value pair that make up a tag. A
value
acts as a descriptor within a tag category (key).
virtualRouterName
— (String
)The name of the virtual router in which to create the route.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:route
— (map
)The full description of your mesh following the create call.
meshName
— required — (String
)The name of the service mesh that the route resides in.
metadata
— required — (map
)The associated metadata for the route.
arn
— required — (String
)The full Amazon Resource Name (ARN) for the resource.
createdAt
— required — (Date
)The Unix epoch timestamp in seconds for when the resource was created.
lastUpdatedAt
— required — (Date
)The Unix epoch timestamp in seconds for when the resource was last updated.
uid
— required — (String
)The unique identifier for the resource.
version
— required — (Integer
)The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
routeName
— required — (String
)The name of the route.
spec
— required — (map
)The specifications of the route.
httpRoute
— (map
)The HTTP routing information for the route.
action
— required — (map
)The action to take if a match is determined.
weightedTargets
— required — (Array<map>
)The targets that traffic is routed to when a request matches the route. You can specify one or more targets and their relative weights to distribute traffic with.
virtualNode
— required — (String
)The virtual node to associate with the weighted target.
weight
— required — (Integer
)The relative weight of the weighted target.
match
— required — (map
)The criteria for determining an HTTP request match.
prefix
— required — (String
)Specifies the path to match requests with. This parameter must always start with
/
, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name ismy-service.local
and you want the route to match requests tomy-service.local/metrics
, your prefix should be/metrics
.
tcpRoute
— (map
)The TCP routing information for the route.
action
— required — (map
)The action to take if a match is determined.
weightedTargets
— required — (Array<map>
)The targets that traffic is routed to when a request matches the route. You can specify one or more targets and their relative weights to distribute traffic with.
virtualNode
— required — (String
)The virtual node to associate with the weighted target.
weight
— required — (Integer
)The relative weight of the weighted target.
status
— required — (map
)The status of the route.
status
— required — (String
)The current status for the route.
Possible values include:"ACTIVE"
"DELETED"
"INACTIVE"
virtualRouterName
— required — (String
)The virtual router that the route is associated with.
-
(AWS.Response)
—
Returns:
createVirtualNode(params = {}, callback) ⇒ AWS.Request
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 must specify the DNS service discovery hostname 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.
node.cluster
value that is set by APPMESH_VIRTUAL_NODE_NAME
with the APPMESH_VIRTUAL_NODE_CLUSTER
environment variable. Service Reference:
Examples:
Calling the createVirtualNode operation
var params = {
meshName: 'STRING_VALUE', /* required */
spec: { /* required */
backends: [
{
virtualService: {
virtualServiceName: 'STRING_VALUE' /* required */
}
},
/* more items */
],
listeners: [
{
portMapping: { /* required */
port: 'NUMBER_VALUE', /* required */
protocol: http | tcp /* required */
},
healthCheck: {
healthyThreshold: 'NUMBER_VALUE', /* required */
intervalMillis: 'NUMBER_VALUE', /* required */
protocol: http | tcp, /* required */
timeoutMillis: 'NUMBER_VALUE', /* required */
unhealthyThreshold: 'NUMBER_VALUE', /* required */
path: 'STRING_VALUE',
port: 'NUMBER_VALUE'
}
},
/* more items */
],
logging: {
accessLog: {
file: {
path: 'STRING_VALUE' /* required */
}
}
},
serviceDiscovery: {
dns: {
hostname: 'STRING_VALUE' /* required */
}
}
},
virtualNodeName: 'STRING_VALUE', /* required */
clientToken: 'STRING_VALUE',
tags: [
{
key: 'STRING_VALUE', /* required */
value: 'STRING_VALUE'
},
/* more items */
]
};
appmesh.createVirtualNode(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
clientToken
— (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.
If a token is not provided, the SDK will use a version 4 UUID.meshName
— (String
)The name of the service mesh to create the virtual node in.
spec
— (map
)The virtual node specification to apply.
backends
— (Array<map>
)The backends that the virtual node is expected to send outbound traffic to.
virtualService
— (map
)Specifies a virtual service to use as a backend for a virtual node.
virtualServiceName
— required — (String
)The name of the virtual service that is acting as a virtual node backend.
listeners
— (Array<map>
)The listeners that the virtual node is expected to receive inbound traffic from. Currently only one listener is supported per virtual node.
healthCheck
— (map
)The health check information for the listener.
healthyThreshold
— required — (Integer
)The number of consecutive successful health checks that must occur before declaring listener healthy.
intervalMillis
— required — (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
— required — (String
)The protocol for the health check request.
Possible values include:"http"
"tcp"
timeoutMillis
— required — (Integer
)The amount of time to wait when receiving a response from the health check, in milliseconds.
unhealthyThreshold
— required — (Integer
)The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.
portMapping
— required — (map
)The port mapping information for the listener.
port
— required — (Integer
)The port used for the port mapping.
protocol
— required — (String
)The protocol used for the port mapping.
Possible values include:"http"
"tcp"
logging
— (map
)The inbound and outbound access logging information for the virtual node.
accessLog
— (map
)The access log configuration for a virtual node.
file
— (map
)The file object to send virtual node access logs to.
path
— required — (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 asawslogs
, 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
— (map
)The service discovery information for the virtual node. If your virtual node does not expect ingress traffic, you can omit this parameter.
dns
— (map
)Specifies the DNS information for the virtual node.
hostname
— required — (String
)Specifies the DNS service discovery hostname for the virtual node.
tags
— (Array<map>
)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.
key
— required — (String
)One part of a key-value pair that make up a tag. A
key
is a general label that acts like a category for more specific tag values.value
— (String
)The optional part of a key-value pair that make up a tag. A
value
acts as a descriptor within a tag category (key).
virtualNodeName
— (String
)The name to use for the virtual node.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:virtualNode
— (map
)The full description of your virtual node following the create call.
meshName
— required — (String
)The name of the service mesh that the virtual node resides in.
metadata
— required — (map
)The associated metadata for the virtual node.
arn
— required — (String
)The full Amazon Resource Name (ARN) for the resource.
createdAt
— required — (Date
)The Unix epoch timestamp in seconds for when the resource was created.
lastUpdatedAt
— required — (Date
)The Unix epoch timestamp in seconds for when the resource was last updated.
uid
— required — (String
)The unique identifier for the resource.
version
— required — (Integer
)The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
spec
— required — (map
)The specifications of the virtual node.
backends
— (Array<map>
)The backends that the virtual node is expected to send outbound traffic to.
virtualService
— (map
)Specifies a virtual service to use as a backend for a virtual node.
virtualServiceName
— required — (String
)The name of the virtual service that is acting as a virtual node backend.
listeners
— (Array<map>
)The listeners that the virtual node is expected to receive inbound traffic from. Currently only one listener is supported per virtual node.
healthCheck
— (map
)The health check information for the listener.
healthyThreshold
— required — (Integer
)The number of consecutive successful health checks that must occur before declaring listener healthy.
intervalMillis
— required — (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
— required — (String
)The protocol for the health check request.
Possible values include:"http"
"tcp"
timeoutMillis
— required — (Integer
)The amount of time to wait when receiving a response from the health check, in milliseconds.
unhealthyThreshold
— required — (Integer
)The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.
portMapping
— required — (map
)The port mapping information for the listener.
port
— required — (Integer
)The port used for the port mapping.
protocol
— required — (String
)The protocol used for the port mapping.
Possible values include:"http"
"tcp"
logging
— (map
)The inbound and outbound access logging information for the virtual node.
accessLog
— (map
)The access log configuration for a virtual node.
file
— (map
)The file object to send virtual node access logs to.
path
— required — (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 asawslogs
, 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
— (map
)The service discovery information for the virtual node. If your virtual node does not expect ingress traffic, you can omit this parameter.
dns
— (map
)Specifies the DNS information for the virtual node.
hostname
— required — (String
)Specifies the DNS service discovery hostname for the virtual node.
status
— required — (map
)The current status for the virtual node.
status
— required — (String
)The current status of the virtual node.
Possible values include:"ACTIVE"
"DELETED"
"INACTIVE"
virtualNodeName
— required — (String
)The name of the virtual node.
-
(AWS.Response)
—
Returns:
createVirtualRouter(params = {}, callback) ⇒ AWS.Request
Creates a virtual router within a service mesh.
Any inbound traffic that your virtual router expects should be specified as a listener
.
Virtual routers handle traffic for one or more virtual services within your mesh. After you create your virtual router, create and associate routes for your virtual router that direct incoming requests to different virtual nodes.
Service Reference:
Examples:
Calling the createVirtualRouter operation
var params = {
meshName: 'STRING_VALUE', /* required */
spec: { /* required */
listeners: [ /* required */
{
portMapping: { /* required */
port: 'NUMBER_VALUE', /* required */
protocol: http | tcp /* required */
}
},
/* more items */
]
},
virtualRouterName: 'STRING_VALUE', /* required */
clientToken: 'STRING_VALUE',
tags: [
{
key: 'STRING_VALUE', /* required */
value: 'STRING_VALUE'
},
/* more items */
]
};
appmesh.createVirtualRouter(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
clientToken
— (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.
If a token is not provided, the SDK will use a version 4 UUID.meshName
— (String
)The name of the service mesh to create the virtual router in.
spec
— (map
)The virtual router specification to apply.
listeners
— required — (Array<map>
)The listeners that the virtual router is expected to receive inbound traffic from. Currently only one listener is supported per virtual router.
portMapping
— required — (map
)An object representing a virtual node or virtual router listener port mapping.
port
— required — (Integer
)The port used for the port mapping.
protocol
— required — (String
)The protocol used for the port mapping.
Possible values include:"http"
"tcp"
tags
— (Array<map>
)Optional metadata that you can apply to the virtual router to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
key
— required — (String
)One part of a key-value pair that make up a tag. A
key
is a general label that acts like a category for more specific tag values.value
— (String
)The optional part of a key-value pair that make up a tag. A
value
acts as a descriptor within a tag category (key).
virtualRouterName
— (String
)The name to use for the virtual router.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:virtualRouter
— (map
)The full description of your virtual router following the create call.
meshName
— required — (String
)The name of the service mesh that the virtual router resides in.
metadata
— required — (map
)The associated metadata for the virtual router.
arn
— required — (String
)The full Amazon Resource Name (ARN) for the resource.
createdAt
— required — (Date
)The Unix epoch timestamp in seconds for when the resource was created.
lastUpdatedAt
— required — (Date
)The Unix epoch timestamp in seconds for when the resource was last updated.
uid
— required — (String
)The unique identifier for the resource.
version
— required — (Integer
)The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
spec
— required — (map
)The specifications of the virtual router.
listeners
— required — (Array<map>
)The listeners that the virtual router is expected to receive inbound traffic from. Currently only one listener is supported per virtual router.
portMapping
— required — (map
)An object representing a virtual node or virtual router listener port mapping.
port
— required — (Integer
)The port used for the port mapping.
protocol
— required — (String
)The protocol used for the port mapping.
Possible values include:"http"
"tcp"
status
— required — (map
)The current status of the virtual router.
status
— required — (String
)The current status of the virtual router.
Possible values include:"ACTIVE"
"DELETED"
"INACTIVE"
virtualRouterName
— required — (String
)The name of the virtual router.
-
(AWS.Response)
—
Returns:
createVirtualService(params = {}, callback) ⇒ AWS.Request
Creates a virtual service within a service mesh.
A virtual service is an abstraction of a real service that is provided by a virtual node directly or indirectly by means of a virtual router. Dependent services call your virtual service by its virtualServiceName
, and those requests are routed to the virtual node or virtual router that is specified as the provider for the virtual service.
Service Reference:
Examples:
Calling the createVirtualService operation
var params = {
meshName: 'STRING_VALUE', /* required */
spec: { /* required */
provider: {
virtualNode: {
virtualNodeName: 'STRING_VALUE' /* required */
},
virtualRouter: {
virtualRouterName: 'STRING_VALUE' /* required */
}
}
},
virtualServiceName: 'STRING_VALUE', /* required */
clientToken: 'STRING_VALUE',
tags: [
{
key: 'STRING_VALUE', /* required */
value: 'STRING_VALUE'
},
/* more items */
]
};
appmesh.createVirtualService(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
clientToken
— (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.
If a token is not provided, the SDK will use a version 4 UUID.meshName
— (String
)The name of the service mesh to create the virtual service in.
spec
— (map
)The virtual service specification to apply.
provider
— (map
)The App Mesh object that is acting as the provider for a virtual service. You can specify a single virtual node or virtual router.
virtualNode
— (map
)The virtual node associated with a virtual service.
virtualNodeName
— required — (String
)The name of the virtual node that is acting as a service provider.
virtualRouter
— (map
)The virtual router associated with a virtual service.
virtualRouterName
— required — (String
)The name of the virtual router that is acting as a service provider.
tags
— (Array<map>
)Optional metadata that you can apply to the virtual service to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
key
— required — (String
)One part of a key-value pair that make up a tag. A
key
is a general label that acts like a category for more specific tag values.value
— (String
)The optional part of a key-value pair that make up a tag. A
value
acts as a descriptor within a tag category (key).
virtualServiceName
— (String
)The name to use for the virtual service.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:virtualService
— (map
)The full description of your virtual service following the create call.
meshName
— required — (String
)The name of the service mesh that the virtual service resides in.
metadata
— required — (map
)An object representing metadata for a resource.
arn
— required — (String
)The full Amazon Resource Name (ARN) for the resource.
createdAt
— required — (Date
)The Unix epoch timestamp in seconds for when the resource was created.
lastUpdatedAt
— required — (Date
)The Unix epoch timestamp in seconds for when the resource was last updated.
uid
— required — (String
)The unique identifier for the resource.
version
— required — (Integer
)The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
spec
— required — (map
)The specifications of the virtual service.
provider
— (map
)The App Mesh object that is acting as the provider for a virtual service. You can specify a single virtual node or virtual router.
virtualNode
— (map
)The virtual node associated with a virtual service.
virtualNodeName
— required — (String
)The name of the virtual node that is acting as a service provider.
virtualRouter
— (map
)The virtual router associated with a virtual service.
virtualRouterName
— required — (String
)The name of the virtual router that is acting as a service provider.
status
— required — (map
)The current status of the virtual service.
status
— required — (String
)The current status of the virtual service.
Possible values include:"ACTIVE"
"DELETED"
"INACTIVE"
virtualServiceName
— required — (String
)The name of the virtual service.
-
(AWS.Response)
—
Returns:
deleteMesh(params = {}, callback) ⇒ AWS.Request
Deletes an existing service mesh.
You must delete all resources (virtual services, routes, virtual routers, and virtual nodes) in the service mesh before you can delete the mesh itself.
Service Reference:
Examples:
Calling the deleteMesh operation
var params = {
meshName: 'STRING_VALUE' /* required */
};
appmesh.deleteMesh(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
meshName
— (String
)The name of the service mesh to delete.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:mesh
— (map
)The service mesh that was deleted.
meshName
— required — (String
)The name of the service mesh.
metadata
— required — (map
)The associated metadata for the service mesh.
arn
— required — (String
)The full Amazon Resource Name (ARN) for the resource.
createdAt
— required — (Date
)The Unix epoch timestamp in seconds for when the resource was created.
lastUpdatedAt
— required — (Date
)The Unix epoch timestamp in seconds for when the resource was last updated.
uid
— required — (String
)The unique identifier for the resource.
version
— required — (Integer
)The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
spec
— required — (map
)The associated specification for the service mesh.
egressFilter
— (map
)The egress filter rules for the service mesh.
type
— required — (String
)The egress filter type. By default, the type is
Possible values include:DROP_ALL
, which allows egress only from virtual nodes to other defined resources in the service mesh (and any traffic to*.amazonaws.com
for AWS API calls). You can set the egress filter type toALLOW_ALL
to allow egress to any endpoint inside or outside of the service mesh."ALLOW_ALL"
"DROP_ALL"
status
— required — (map
)The status of the service mesh.
status
— (String
)The current mesh status.
Possible values include:"ACTIVE"
"DELETED"
"INACTIVE"
-
(AWS.Response)
—
Returns:
deleteRoute(params = {}, callback) ⇒ AWS.Request
Deletes an existing route.
Service Reference:
Examples:
Calling the deleteRoute operation
var params = {
meshName: 'STRING_VALUE', /* required */
routeName: 'STRING_VALUE', /* required */
virtualRouterName: 'STRING_VALUE' /* required */
};
appmesh.deleteRoute(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
meshName
— (String
)The name of the service mesh to delete the route in.
routeName
— (String
)The name of the route to delete.
virtualRouterName
— (String
)The name of the virtual router to delete the route in.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:route
— (map
)The route that was deleted.
meshName
— required — (String
)The name of the service mesh that the route resides in.
metadata
— required — (map
)The associated metadata for the route.
arn
— required — (String
)The full Amazon Resource Name (ARN) for the resource.
createdAt
— required — (Date
)The Unix epoch timestamp in seconds for when the resource was created.
lastUpdatedAt
— required — (Date
)The Unix epoch timestamp in seconds for when the resource was last updated.
uid
— required — (String
)The unique identifier for the resource.
version
— required — (Integer
)The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
routeName
— required — (String
)The name of the route.
spec
— required — (map
)The specifications of the route.
httpRoute
— (map
)The HTTP routing information for the route.
action
— required — (map
)The action to take if a match is determined.
weightedTargets
— required — (Array<map>
)The targets that traffic is routed to when a request matches the route. You can specify one or more targets and their relative weights to distribute traffic with.
virtualNode
— required — (String
)The virtual node to associate with the weighted target.
weight
— required — (Integer
)The relative weight of the weighted target.
match
— required — (map
)The criteria for determining an HTTP request match.
prefix
— required — (String
)Specifies the path to match requests with. This parameter must always start with
/
, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name ismy-service.local
and you want the route to match requests tomy-service.local/metrics
, your prefix should be/metrics
.
tcpRoute
— (map
)The TCP routing information for the route.
action
— required — (map
)The action to take if a match is determined.
weightedTargets
— required — (Array<map>
)The targets that traffic is routed to when a request matches the route. You can specify one or more targets and their relative weights to distribute traffic with.
virtualNode
— required — (String
)The virtual node to associate with the weighted target.
weight
— required — (Integer
)The relative weight of the weighted target.
status
— required — (map
)The status of the route.
status
— required — (String
)The current status for the route.
Possible values include:"ACTIVE"
"DELETED"
"INACTIVE"
virtualRouterName
— required — (String
)The virtual router that the route is associated with.
-
(AWS.Response)
—
Returns:
deleteVirtualNode(params = {}, callback) ⇒ AWS.Request
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.
Service Reference:
Examples:
Calling the deleteVirtualNode operation
var params = {
meshName: 'STRING_VALUE', /* required */
virtualNodeName: 'STRING_VALUE' /* required */
};
appmesh.deleteVirtualNode(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
meshName
— (String
)The name of the service mesh to delete the virtual node in.
virtualNodeName
— (String
)The name of the virtual node to delete.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:virtualNode
— (map
)The virtual node that was deleted.
meshName
— required — (String
)The name of the service mesh that the virtual node resides in.
metadata
— required — (map
)The associated metadata for the virtual node.
arn
— required — (String
)The full Amazon Resource Name (ARN) for the resource.
createdAt
— required — (Date
)The Unix epoch timestamp in seconds for when the resource was created.
lastUpdatedAt
— required — (Date
)The Unix epoch timestamp in seconds for when the resource was last updated.
uid
— required — (String
)The unique identifier for the resource.
version
— required — (Integer
)The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
spec
— required — (map
)The specifications of the virtual node.
backends
— (Array<map>
)The backends that the virtual node is expected to send outbound traffic to.
virtualService
— (map
)Specifies a virtual service to use as a backend for a virtual node.
virtualServiceName
— required — (String
)The name of the virtual service that is acting as a virtual node backend.
listeners
— (Array<map>
)The listeners that the virtual node is expected to receive inbound traffic from. Currently only one listener is supported per virtual node.
healthCheck
— (map
)The health check information for the listener.
healthyThreshold
— required — (Integer
)The number of consecutive successful health checks that must occur before declaring listener healthy.
intervalMillis
— required — (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
— required — (String
)The protocol for the health check request.
Possible values include:"http"
"tcp"
timeoutMillis
— required — (Integer
)The amount of time to wait when receiving a response from the health check, in milliseconds.
unhealthyThreshold
— required — (Integer
)The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.
portMapping
— required — (map
)The port mapping information for the listener.
port
— required — (Integer
)The port used for the port mapping.
protocol
— required — (String
)The protocol used for the port mapping.
Possible values include:"http"
"tcp"
logging
— (map
)The inbound and outbound access logging information for the virtual node.
accessLog
— (map
)The access log configuration for a virtual node.
file
— (map
)The file object to send virtual node access logs to.
path
— required — (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 asawslogs
, 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
— (map
)The service discovery information for the virtual node. If your virtual node does not expect ingress traffic, you can omit this parameter.
dns
— (map
)Specifies the DNS information for the virtual node.
hostname
— required — (String
)Specifies the DNS service discovery hostname for the virtual node.
status
— required — (map
)The current status for the virtual node.
status
— required — (String
)The current status of the virtual node.
Possible values include:"ACTIVE"
"DELETED"
"INACTIVE"
virtualNodeName
— required — (String
)The name of the virtual node.
-
(AWS.Response)
—
Returns:
deleteVirtualRouter(params = {}, callback) ⇒ AWS.Request
Deletes an existing virtual router.
You must delete any routes associated with the virtual router before you can delete the router itself.
Service Reference:
Examples:
Calling the deleteVirtualRouter operation
var params = {
meshName: 'STRING_VALUE', /* required */
virtualRouterName: 'STRING_VALUE' /* required */
};
appmesh.deleteVirtualRouter(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
meshName
— (String
)The name of the service mesh to delete the virtual router in.
virtualRouterName
— (String
)The name of the virtual router to delete.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:virtualRouter
— (map
)The virtual router that was deleted.
meshName
— required — (String
)The name of the service mesh that the virtual router resides in.
metadata
— required — (map
)The associated metadata for the virtual router.
arn
— required — (String
)The full Amazon Resource Name (ARN) for the resource.
createdAt
— required — (Date
)The Unix epoch timestamp in seconds for when the resource was created.
lastUpdatedAt
— required — (Date
)The Unix epoch timestamp in seconds for when the resource was last updated.
uid
— required — (String
)The unique identifier for the resource.
version
— required — (Integer
)The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
spec
— required — (map
)The specifications of the virtual router.
listeners
— required — (Array<map>
)The listeners that the virtual router is expected to receive inbound traffic from. Currently only one listener is supported per virtual router.
portMapping
— required — (map
)An object representing a virtual node or virtual router listener port mapping.
port
— required — (Integer
)The port used for the port mapping.
protocol
— required — (String
)The protocol used for the port mapping.
Possible values include:"http"
"tcp"
status
— required — (map
)The current status of the virtual router.
status
— required — (String
)The current status of the virtual router.
Possible values include:"ACTIVE"
"DELETED"
"INACTIVE"
virtualRouterName
— required — (String
)The name of the virtual router.
-
(AWS.Response)
—
Returns:
deleteVirtualService(params = {}, callback) ⇒ AWS.Request
Deletes an existing virtual service.
Service Reference:
Examples:
Calling the deleteVirtualService operation
var params = {
meshName: 'STRING_VALUE', /* required */
virtualServiceName: 'STRING_VALUE' /* required */
};
appmesh.deleteVirtualService(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
meshName
— (String
)The name of the service mesh to delete the virtual service in.
virtualServiceName
— (String
)The name of the virtual service to delete.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:virtualService
— (map
)The virtual service that was deleted.
meshName
— required — (String
)The name of the service mesh that the virtual service resides in.
metadata
— required — (map
)An object representing metadata for a resource.
arn
— required — (String
)The full Amazon Resource Name (ARN) for the resource.
createdAt
— required — (Date
)The Unix epoch timestamp in seconds for when the resource was created.
lastUpdatedAt
— required — (Date
)The Unix epoch timestamp in seconds for when the resource was last updated.
uid
— required — (String
)The unique identifier for the resource.
version
— required — (Integer
)The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
spec
— required — (map
)The specifications of the virtual service.
provider
— (map
)The App Mesh object that is acting as the provider for a virtual service. You can specify a single virtual node or virtual router.
virtualNode
— (map
)The virtual node associated with a virtual service.
virtualNodeName
— required — (String
)The name of the virtual node that is acting as a service provider.
virtualRouter
— (map
)The virtual router associated with a virtual service.
virtualRouterName
— required — (String
)The name of the virtual router that is acting as a service provider.
status
— required — (map
)The current status of the virtual service.
status
— required — (String
)The current status of the virtual service.
Possible values include:"ACTIVE"
"DELETED"
"INACTIVE"
virtualServiceName
— required — (String
)The name of the virtual service.
-
(AWS.Response)
—
Returns:
describeMesh(params = {}, callback) ⇒ AWS.Request
Describes an existing service mesh.
Service Reference:
Examples:
Calling the describeMesh operation
var params = {
meshName: 'STRING_VALUE' /* required */
};
appmesh.describeMesh(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
meshName
— (String
)The name of the service mesh to describe.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:mesh
— (map
)The full description of your service mesh.
meshName
— required — (String
)The name of the service mesh.
metadata
— required — (map
)The associated metadata for the service mesh.
arn
— required — (String
)The full Amazon Resource Name (ARN) for the resource.
createdAt
— required — (Date
)The Unix epoch timestamp in seconds for when the resource was created.
lastUpdatedAt
— required — (Date
)The Unix epoch timestamp in seconds for when the resource was last updated.
uid
— required — (String
)The unique identifier for the resource.
version
— required — (Integer
)The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
spec
— required — (map
)The associated specification for the service mesh.
egressFilter
— (map
)The egress filter rules for the service mesh.
type
— required — (String
)The egress filter type. By default, the type is
Possible values include:DROP_ALL
, which allows egress only from virtual nodes to other defined resources in the service mesh (and any traffic to*.amazonaws.com
for AWS API calls). You can set the egress filter type toALLOW_ALL
to allow egress to any endpoint inside or outside of the service mesh."ALLOW_ALL"
"DROP_ALL"
status
— required — (map
)The status of the service mesh.
status
— (String
)The current mesh status.
Possible values include:"ACTIVE"
"DELETED"
"INACTIVE"
-
(AWS.Response)
—
Returns:
describeRoute(params = {}, callback) ⇒ AWS.Request
Describes an existing route.
Service Reference:
Examples:
Calling the describeRoute operation
var params = {
meshName: 'STRING_VALUE', /* required */
routeName: 'STRING_VALUE', /* required */
virtualRouterName: 'STRING_VALUE' /* required */
};
appmesh.describeRoute(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
meshName
— (String
)The name of the service mesh that the route resides in.
routeName
— (String
)The name of the route to describe.
virtualRouterName
— (String
)The name of the virtual router that the route is associated with.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:route
— (map
)The full description of your route.
meshName
— required — (String
)The name of the service mesh that the route resides in.
metadata
— required — (map
)The associated metadata for the route.
arn
— required — (String
)The full Amazon Resource Name (ARN) for the resource.
createdAt
— required — (Date
)The Unix epoch timestamp in seconds for when the resource was created.
lastUpdatedAt
— required — (Date
)The Unix epoch timestamp in seconds for when the resource was last updated.
uid
— required — (String
)The unique identifier for the resource.
version
— required — (Integer
)The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
routeName
— required — (String
)The name of the route.
spec
— required — (map
)The specifications of the route.
httpRoute
— (map
)The HTTP routing information for the route.
action
— required — (map
)The action to take if a match is determined.
weightedTargets
— required — (Array<map>
)The targets that traffic is routed to when a request matches the route. You can specify one or more targets and their relative weights to distribute traffic with.
virtualNode
— required — (String
)The virtual node to associate with the weighted target.
weight
— required — (Integer
)The relative weight of the weighted target.
match
— required — (map
)The criteria for determining an HTTP request match.
prefix
— required — (String
)Specifies the path to match requests with. This parameter must always start with
/
, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name ismy-service.local
and you want the route to match requests tomy-service.local/metrics
, your prefix should be/metrics
.
tcpRoute
— (map
)The TCP routing information for the route.
action
— required — (map
)The action to take if a match is determined.
weightedTargets
— required — (Array<map>
)The targets that traffic is routed to when a request matches the route. You can specify one or more targets and their relative weights to distribute traffic with.
virtualNode
— required — (String
)The virtual node to associate with the weighted target.
weight
— required — (Integer
)The relative weight of the weighted target.
status
— required — (map
)The status of the route.
status
— required — (String
)The current status for the route.
Possible values include:"ACTIVE"
"DELETED"
"INACTIVE"
virtualRouterName
— required — (String
)The virtual router that the route is associated with.
-
(AWS.Response)
—
Returns:
describeVirtualNode(params = {}, callback) ⇒ AWS.Request
Describes an existing virtual node.
Service Reference:
Examples:
Calling the describeVirtualNode operation
var params = {
meshName: 'STRING_VALUE', /* required */
virtualNodeName: 'STRING_VALUE' /* required */
};
appmesh.describeVirtualNode(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
meshName
— (String
)The name of the service mesh that the virtual node resides in.
virtualNodeName
— (String
)The name of the virtual node to describe.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:virtualNode
— (map
)The full description of your virtual node.
meshName
— required — (String
)The name of the service mesh that the virtual node resides in.
metadata
— required — (map
)The associated metadata for the virtual node.
arn
— required — (String
)The full Amazon Resource Name (ARN) for the resource.
createdAt
— required — (Date
)The Unix epoch timestamp in seconds for when the resource was created.
lastUpdatedAt
— required — (Date
)The Unix epoch timestamp in seconds for when the resource was last updated.
uid
— required — (String
)The unique identifier for the resource.
version
— required — (Integer
)The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
spec
— required — (map
)The specifications of the virtual node.
backends
— (Array<map>
)The backends that the virtual node is expected to send outbound traffic to.
virtualService
— (map
)Specifies a virtual service to use as a backend for a virtual node.
virtualServiceName
— required — (String
)The name of the virtual service that is acting as a virtual node backend.
listeners
— (Array<map>
)The listeners that the virtual node is expected to receive inbound traffic from. Currently only one listener is supported per virtual node.
healthCheck
— (map
)The health check information for the listener.
healthyThreshold
— required — (Integer
)The number of consecutive successful health checks that must occur before declaring listener healthy.
intervalMillis
— required — (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
— required — (String
)The protocol for the health check request.
Possible values include:"http"
"tcp"
timeoutMillis
— required — (Integer
)The amount of time to wait when receiving a response from the health check, in milliseconds.
unhealthyThreshold
— required — (Integer
)The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.
portMapping
— required — (map
)The port mapping information for the listener.
port
— required — (Integer
)The port used for the port mapping.
protocol
— required — (String
)The protocol used for the port mapping.
Possible values include:"http"
"tcp"
logging
— (map
)The inbound and outbound access logging information for the virtual node.
accessLog
— (map
)The access log configuration for a virtual node.
file
— (map
)The file object to send virtual node access logs to.
path
— required — (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 asawslogs
, 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
— (map
)The service discovery information for the virtual node. If your virtual node does not expect ingress traffic, you can omit this parameter.
dns
— (map
)Specifies the DNS information for the virtual node.
hostname
— required — (String
)Specifies the DNS service discovery hostname for the virtual node.
status
— required — (map
)The current status for the virtual node.
status
— required — (String
)The current status of the virtual node.
Possible values include:"ACTIVE"
"DELETED"
"INACTIVE"
virtualNodeName
— required — (String
)The name of the virtual node.
-
(AWS.Response)
—
Returns:
describeVirtualRouter(params = {}, callback) ⇒ AWS.Request
Describes an existing virtual router.
Service Reference:
Examples:
Calling the describeVirtualRouter operation
var params = {
meshName: 'STRING_VALUE', /* required */
virtualRouterName: 'STRING_VALUE' /* required */
};
appmesh.describeVirtualRouter(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
meshName
— (String
)The name of the service mesh that the virtual router resides in.
virtualRouterName
— (String
)The name of the virtual router to describe.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:virtualRouter
— (map
)The full description of your virtual router.
meshName
— required — (String
)The name of the service mesh that the virtual router resides in.
metadata
— required — (map
)The associated metadata for the virtual router.
arn
— required — (String
)The full Amazon Resource Name (ARN) for the resource.
createdAt
— required — (Date
)The Unix epoch timestamp in seconds for when the resource was created.
lastUpdatedAt
— required — (Date
)The Unix epoch timestamp in seconds for when the resource was last updated.
uid
— required — (String
)The unique identifier for the resource.
version
— required — (Integer
)The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
spec
— required — (map
)The specifications of the virtual router.
listeners
— required — (Array<map>
)The listeners that the virtual router is expected to receive inbound traffic from. Currently only one listener is supported per virtual router.
portMapping
— required — (map
)An object representing a virtual node or virtual router listener port mapping.
port
— required — (Integer
)The port used for the port mapping.
protocol
— required — (String
)The protocol used for the port mapping.
Possible values include:"http"
"tcp"
status
— required — (map
)The current status of the virtual router.
status
— required — (String
)The current status of the virtual router.
Possible values include:"ACTIVE"
"DELETED"
"INACTIVE"
virtualRouterName
— required — (String
)The name of the virtual router.
-
(AWS.Response)
—
Returns:
describeVirtualService(params = {}, callback) ⇒ AWS.Request
Describes an existing virtual service.
Service Reference:
Examples:
Calling the describeVirtualService operation
var params = {
meshName: 'STRING_VALUE', /* required */
virtualServiceName: 'STRING_VALUE' /* required */
};
appmesh.describeVirtualService(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
meshName
— (String
)The name of the service mesh that the virtual service resides in.
virtualServiceName
— (String
)The name of the virtual service to describe.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:virtualService
— (map
)The full description of your virtual service.
meshName
— required — (String
)The name of the service mesh that the virtual service resides in.
metadata
— required — (map
)An object representing metadata for a resource.
arn
— required — (String
)The full Amazon Resource Name (ARN) for the resource.
createdAt
— required — (Date
)The Unix epoch timestamp in seconds for when the resource was created.
lastUpdatedAt
— required — (Date
)The Unix epoch timestamp in seconds for when the resource was last updated.
uid
— required — (String
)The unique identifier for the resource.
version
— required — (Integer
)The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
spec
— required — (map
)The specifications of the virtual service.
provider
— (map
)The App Mesh object that is acting as the provider for a virtual service. You can specify a single virtual node or virtual router.
virtualNode
— (map
)The virtual node associated with a virtual service.
virtualNodeName
— required — (String
)The name of the virtual node that is acting as a service provider.
virtualRouter
— (map
)The virtual router associated with a virtual service.
virtualRouterName
— required — (String
)The name of the virtual router that is acting as a service provider.
status
— required — (map
)The current status of the virtual service.
status
— required — (String
)The current status of the virtual service.
Possible values include:"ACTIVE"
"DELETED"
"INACTIVE"
virtualServiceName
— required — (String
)The name of the virtual service.
-
(AWS.Response)
—
Returns:
listMeshes(params = {}, callback) ⇒ AWS.Request
Returns a list of existing service meshes.
Service Reference:
Examples:
Calling the listMeshes operation
var params = {
limit: 'NUMBER_VALUE',
nextToken: 'STRING_VALUE'
};
appmesh.listMeshes(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
limit
— (Integer
)The maximum number of results returned by
ListMeshes
in paginated output. When you use this parameter,ListMeshes
returns onlylimit
results in a single page along with anextToken
response element. You can see the remaining results of the initial request by sending anotherListMeshes
request with the returnednextToken
value. This value can be between 1 and 100. If you don't use this parameter,ListMeshes
returns up to 100 results and anextToken
value if applicable.nextToken
— (String
)The
nextToken
value returned from a previous paginatedListMeshes
request wherelimit
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value.Note: This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:meshes
— (Array<map>
)The list of existing service meshes.
arn
— required — (String
)The full Amazon Resource Name (ARN) of the service mesh.
meshName
— required — (String
)The name of the service mesh.
nextToken
— (String
)The
nextToken
value to include in a futureListMeshes
request. When the results of aListMeshes
request exceedlimit
, you can use this value to retrieve the next page of results. This value isnull
when there are no more results to return.
-
(AWS.Response)
—
Returns:
listRoutes(params = {}, callback) ⇒ AWS.Request
Returns a list of existing routes in a service mesh.
Service Reference:
Examples:
Calling the listRoutes operation
var params = {
meshName: 'STRING_VALUE', /* required */
virtualRouterName: 'STRING_VALUE', /* required */
limit: 'NUMBER_VALUE',
nextToken: 'STRING_VALUE'
};
appmesh.listRoutes(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
limit
— (Integer
)The maximum number of results returned by
ListRoutes
in paginated output. When you use this parameter,ListRoutes
returns onlylimit
results in a single page along with anextToken
response element. You can see the remaining results of the initial request by sending anotherListRoutes
request with the returnednextToken
value. This value can be between 1 and 100. If you don't use this parameter,ListRoutes
returns up to 100 results and anextToken
value if applicable.meshName
— (String
)The name of the service mesh to list routes in.
nextToken
— (String
)The
nextToken
value returned from a previous paginatedListRoutes
request wherelimit
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value.virtualRouterName
— (String
)The name of the virtual router to list routes in.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:nextToken
— (String
)The
nextToken
value to include in a futureListRoutes
request. When the results of aListRoutes
request exceedlimit
, you can use this value to retrieve the next page of results. This value isnull
when there are no more results to return.routes
— (Array<map>
)The list of existing routes for the specified service mesh and virtual router.
arn
— required — (String
)The full Amazon Resource Name (ARN) for the route.
meshName
— required — (String
)The name of the service mesh that the route resides in.
routeName
— required — (String
)The name of the route.
virtualRouterName
— required — (String
)The virtual router that the route is associated with.
-
(AWS.Response)
—
Returns:
listTagsForResource(params = {}, callback) ⇒ AWS.Request
List the tags for an App Mesh resource.
Service Reference:
Examples:
Calling the listTagsForResource operation
var params = {
resourceArn: 'STRING_VALUE', /* required */
limit: 'NUMBER_VALUE',
nextToken: 'STRING_VALUE'
};
appmesh.listTagsForResource(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
limit
— (Integer
)The maximum number of tag results returned by
ListTagsForResource
in paginated output. When this parameter is used,ListTagsForResource
returns onlylimit
results in a single page along with anextToken
response element. You can see the remaining results of the initial request by sending anotherListTagsForResource
request with the returnednextToken
value. This value can be between 1 and 100. If you don't use this parameter,ListTagsForResource
returns up to 100 results and anextToken
value if applicable.nextToken
— (String
)The
nextToken
value returned from a previous paginatedListTagsForResource
request wherelimit
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value.resourceArn
— (String
)The Amazon Resource Name (ARN) that identifies the resource to list the tags for.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:nextToken
— (String
)The
nextToken
value to include in a futureListTagsForResource
request. When the results of aListTagsForResource
request exceedlimit
, you can use this value to retrieve the next page of results. This value isnull
when there are no more results to return.tags
— (Array<map>
)The tags for the resource.
key
— required — (String
)One part of a key-value pair that make up a tag. A
key
is a general label that acts like a category for more specific tag values.value
— (String
)The optional part of a key-value pair that make up a tag. A
value
acts as a descriptor within a tag category (key).
-
(AWS.Response)
—
Returns:
listVirtualNodes(params = {}, callback) ⇒ AWS.Request
Returns a list of existing virtual nodes.
Service Reference:
Examples:
Calling the listVirtualNodes operation
var params = {
meshName: 'STRING_VALUE', /* required */
limit: 'NUMBER_VALUE',
nextToken: 'STRING_VALUE'
};
appmesh.listVirtualNodes(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
limit
— (Integer
)The maximum number of results returned by
ListVirtualNodes
in paginated output. When you use this parameter,ListVirtualNodes
returns onlylimit
results in a single page along with anextToken
response element. You can see the remaining results of the initial request by sending anotherListVirtualNodes
request with the returnednextToken
value. This value can be between 1 and 100. If you don't use this parameter,ListVirtualNodes
returns up to 100 results and anextToken
value if applicable.meshName
— (String
)The name of the service mesh to list virtual nodes in.
nextToken
— (String
)The
nextToken
value returned from a previous paginatedListVirtualNodes
request wherelimit
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:nextToken
— (String
)The
nextToken
value to include in a futureListVirtualNodes
request. When the results of aListVirtualNodes
request exceedlimit
, you can use this value to retrieve the next page of results. This value isnull
when there are no more results to return.virtualNodes
— (Array<map>
)The list of existing virtual nodes for the specified service mesh.
arn
— required — (String
)The full Amazon Resource Name (ARN) for the virtual node.
meshName
— required — (String
)The name of the service mesh that the virtual node resides in.
virtualNodeName
— required — (String
)The name of the virtual node.
-
(AWS.Response)
—
Returns:
listVirtualRouters(params = {}, callback) ⇒ AWS.Request
Returns a list of existing virtual routers in a service mesh.
Service Reference:
Examples:
Calling the listVirtualRouters operation
var params = {
meshName: 'STRING_VALUE', /* required */
limit: 'NUMBER_VALUE',
nextToken: 'STRING_VALUE'
};
appmesh.listVirtualRouters(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
limit
— (Integer
)The maximum number of results returned by
ListVirtualRouters
in paginated output. When you use this parameter,ListVirtualRouters
returns onlylimit
results in a single page along with anextToken
response element. You can see the remaining results of the initial request by sending anotherListVirtualRouters
request with the returnednextToken
value. This value can be between 1 and 100. If you don't use this parameter,ListVirtualRouters
returns up to 100 results and anextToken
value if applicable.meshName
— (String
)The name of the service mesh to list virtual routers in.
nextToken
— (String
)The
nextToken
value returned from a previous paginatedListVirtualRouters
request wherelimit
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:nextToken
— (String
)The
nextToken
value to include in a futureListVirtualRouters
request. When the results of aListVirtualRouters
request exceedlimit
, you can use this value to retrieve the next page of results. This value isnull
when there are no more results to return.virtualRouters
— (Array<map>
)The list of existing virtual routers for the specified service mesh.
arn
— required — (String
)The full Amazon Resource Name (ARN) for the virtual router.
meshName
— required — (String
)The name of the service mesh that the virtual router resides in.
virtualRouterName
— required — (String
)The name of the virtual router.
-
(AWS.Response)
—
Returns:
listVirtualServices(params = {}, callback) ⇒ AWS.Request
Returns a list of existing virtual services in a service mesh.
Service Reference:
Examples:
Calling the listVirtualServices operation
var params = {
meshName: 'STRING_VALUE', /* required */
limit: 'NUMBER_VALUE',
nextToken: 'STRING_VALUE'
};
appmesh.listVirtualServices(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
limit
— (Integer
)The maximum number of results returned by
ListVirtualServices
in paginated output. When you use this parameter,ListVirtualServices
returns onlylimit
results in a single page along with anextToken
response element. You can see the remaining results of the initial request by sending anotherListVirtualServices
request with the returnednextToken
value. This value can be between 1 and 100. If you don't use this parameter,ListVirtualServices
returns up to 100 results and anextToken
value if applicable.meshName
— (String
)The name of the service mesh to list virtual services in.
nextToken
— (String
)The
nextToken
value returned from a previous paginatedListVirtualServices
request wherelimit
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:nextToken
— (String
)The
nextToken
value to include in a futureListVirtualServices
request. When the results of aListVirtualServices
request exceedlimit
, you can use this value to retrieve the next page of results. This value isnull
when there are no more results to return.virtualServices
— (Array<map>
)The list of existing virtual services for the specified service mesh.
arn
— required — (String
)The full Amazon Resource Name (ARN) for the virtual service.
meshName
— required — (String
)The name of the service mesh that the virtual service resides in.
virtualServiceName
— required — (String
)The name of the virtual service.
-
(AWS.Response)
—
Returns:
tagResource(params = {}, callback) ⇒ AWS.Request
Associates the specified tags to a resource with the specified resourceArn
. If existing tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are also deleted.
Service Reference:
Examples:
Calling the tagResource operation
var params = {
resourceArn: 'STRING_VALUE', /* required */
tags: [ /* required */
{
key: 'STRING_VALUE', /* required */
value: 'STRING_VALUE'
},
/* more items */
]
};
appmesh.tagResource(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
resourceArn
— (String
)The Amazon Resource Name (ARN) of the resource to add tags to.
tags
— (Array<map>
)The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
key
— required — (String
)One part of a key-value pair that make up a tag. A
key
is a general label that acts like a category for more specific tag values.value
— (String
)The optional part of a key-value pair that make up a tag. A
value
acts as a descriptor within a tag category (key).
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
untagResource(params = {}, callback) ⇒ AWS.Request
Deletes specified tags from a resource.
Service Reference:
Examples:
Calling the untagResource operation
var params = {
resourceArn: 'STRING_VALUE', /* required */
tagKeys: [ /* required */
'STRING_VALUE',
/* more items */
]
};
appmesh.untagResource(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
resourceArn
— (String
)The Amazon Resource Name (ARN) of the resource to delete tags from.
tagKeys
— (Array<String>
)The keys of the tags to be removed.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
updateMesh(params = {}, callback) ⇒ AWS.Request
Updates an existing service mesh.
Service Reference:
Examples:
Calling the updateMesh operation
var params = {
meshName: 'STRING_VALUE', /* required */
clientToken: 'STRING_VALUE',
spec: {
egressFilter: {
type: ALLOW_ALL | DROP_ALL /* required */
}
}
};
appmesh.updateMesh(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
clientToken
— (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.
If a token is not provided, the SDK will use a version 4 UUID.meshName
— (String
)The name of the service mesh to update.
spec
— (map
)The service mesh specification to apply.
egressFilter
— (map
)The egress filter rules for the service mesh.
type
— required — (String
)The egress filter type. By default, the type is
Possible values include:DROP_ALL
, which allows egress only from virtual nodes to other defined resources in the service mesh (and any traffic to*.amazonaws.com
for AWS API calls). You can set the egress filter type toALLOW_ALL
to allow egress to any endpoint inside or outside of the service mesh."ALLOW_ALL"
"DROP_ALL"
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:mesh
— (map
)An object representing a service mesh returned by a describe operation.
meshName
— required — (String
)The name of the service mesh.
metadata
— required — (map
)The associated metadata for the service mesh.
arn
— required — (String
)The full Amazon Resource Name (ARN) for the resource.
createdAt
— required — (Date
)The Unix epoch timestamp in seconds for when the resource was created.
lastUpdatedAt
— required — (Date
)The Unix epoch timestamp in seconds for when the resource was last updated.
uid
— required — (String
)The unique identifier for the resource.
version
— required — (Integer
)The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
spec
— required — (map
)The associated specification for the service mesh.
egressFilter
— (map
)The egress filter rules for the service mesh.
type
— required — (String
)The egress filter type. By default, the type is
Possible values include:DROP_ALL
, which allows egress only from virtual nodes to other defined resources in the service mesh (and any traffic to*.amazonaws.com
for AWS API calls). You can set the egress filter type toALLOW_ALL
to allow egress to any endpoint inside or outside of the service mesh."ALLOW_ALL"
"DROP_ALL"
status
— required — (map
)The status of the service mesh.
status
— (String
)The current mesh status.
Possible values include:"ACTIVE"
"DELETED"
"INACTIVE"
-
(AWS.Response)
—
Returns:
updateRoute(params = {}, callback) ⇒ AWS.Request
Updates an existing route for a specified service mesh and virtual router.
Service Reference:
Examples:
Calling the updateRoute operation
var params = {
meshName: 'STRING_VALUE', /* required */
routeName: 'STRING_VALUE', /* required */
spec: { /* required */
httpRoute: {
action: { /* required */
weightedTargets: [ /* required */
{
virtualNode: 'STRING_VALUE', /* required */
weight: 'NUMBER_VALUE' /* required */
},
/* more items */
]
},
match: { /* required */
prefix: 'STRING_VALUE' /* required */
}
},
tcpRoute: {
action: { /* required */
weightedTargets: [ /* required */
{
virtualNode: 'STRING_VALUE', /* required */
weight: 'NUMBER_VALUE' /* required */
},
/* more items */
]
}
}
},
virtualRouterName: 'STRING_VALUE', /* required */
clientToken: 'STRING_VALUE'
};
appmesh.updateRoute(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
clientToken
— (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.
If a token is not provided, the SDK will use a version 4 UUID.meshName
— (String
)The name of the service mesh that the route resides in.
routeName
— (String
)The name of the route to update.
spec
— (map
)The new route specification to apply. This overwrites the existing data.
httpRoute
— (map
)The HTTP routing information for the route.
action
— required — (map
)The action to take if a match is determined.
weightedTargets
— required — (Array<map>
)The targets that traffic is routed to when a request matches the route. You can specify one or more targets and their relative weights to distribute traffic with.
virtualNode
— required — (String
)The virtual node to associate with the weighted target.
weight
— required — (Integer
)The relative weight of the weighted target.
match
— required — (map
)The criteria for determining an HTTP request match.
prefix
— required — (String
)Specifies the path to match requests with. This parameter must always start with
/
, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name ismy-service.local
and you want the route to match requests tomy-service.local/metrics
, your prefix should be/metrics
.
tcpRoute
— (map
)The TCP routing information for the route.
action
— required — (map
)The action to take if a match is determined.
weightedTargets
— required — (Array<map>
)The targets that traffic is routed to when a request matches the route. You can specify one or more targets and their relative weights to distribute traffic with.
virtualNode
— required — (String
)The virtual node to associate with the weighted target.
weight
— required — (Integer
)The relative weight of the weighted target.
virtualRouterName
— (String
)The name of the virtual router that the route is associated with.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:route
— (map
)A full description of the route that was updated.
meshName
— required — (String
)The name of the service mesh that the route resides in.
metadata
— required — (map
)The associated metadata for the route.
arn
— required — (String
)The full Amazon Resource Name (ARN) for the resource.
createdAt
— required — (Date
)The Unix epoch timestamp in seconds for when the resource was created.
lastUpdatedAt
— required — (Date
)The Unix epoch timestamp in seconds for when the resource was last updated.
uid
— required — (String
)The unique identifier for the resource.
version
— required — (Integer
)The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
routeName
— required — (String
)The name of the route.
spec
— required — (map
)The specifications of the route.
httpRoute
— (map
)The HTTP routing information for the route.
action
— required — (map
)The action to take if a match is determined.
weightedTargets
— required — (Array<map>
)The targets that traffic is routed to when a request matches the route. You can specify one or more targets and their relative weights to distribute traffic with.
virtualNode
— required — (String
)The virtual node to associate with the weighted target.
weight
— required — (Integer
)The relative weight of the weighted target.
match
— required — (map
)The criteria for determining an HTTP request match.
prefix
— required — (String
)Specifies the path to match requests with. This parameter must always start with
/
, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name ismy-service.local
and you want the route to match requests tomy-service.local/metrics
, your prefix should be/metrics
.
tcpRoute
— (map
)The TCP routing information for the route.
action
— required — (map
)The action to take if a match is determined.
weightedTargets
— required — (Array<map>
)The targets that traffic is routed to when a request matches the route. You can specify one or more targets and their relative weights to distribute traffic with.
virtualNode
— required — (String
)The virtual node to associate with the weighted target.
weight
— required — (Integer
)The relative weight of the weighted target.
status
— required — (map
)The status of the route.
status
— required — (String
)The current status for the route.
Possible values include:"ACTIVE"
"DELETED"
"INACTIVE"
virtualRouterName
— required — (String
)The virtual router that the route is associated with.
-
(AWS.Response)
—
Returns:
updateVirtualNode(params = {}, callback) ⇒ AWS.Request
Updates an existing virtual node in a specified service mesh.
Service Reference:
Examples:
Calling the updateVirtualNode operation
var params = {
meshName: 'STRING_VALUE', /* required */
spec: { /* required */
backends: [
{
virtualService: {
virtualServiceName: 'STRING_VALUE' /* required */
}
},
/* more items */
],
listeners: [
{
portMapping: { /* required */
port: 'NUMBER_VALUE', /* required */
protocol: http | tcp /* required */
},
healthCheck: {
healthyThreshold: 'NUMBER_VALUE', /* required */
intervalMillis: 'NUMBER_VALUE', /* required */
protocol: http | tcp, /* required */
timeoutMillis: 'NUMBER_VALUE', /* required */
unhealthyThreshold: 'NUMBER_VALUE', /* required */
path: 'STRING_VALUE',
port: 'NUMBER_VALUE'
}
},
/* more items */
],
logging: {
accessLog: {
file: {
path: 'STRING_VALUE' /* required */
}
}
},
serviceDiscovery: {
dns: {
hostname: 'STRING_VALUE' /* required */
}
}
},
virtualNodeName: 'STRING_VALUE', /* required */
clientToken: 'STRING_VALUE'
};
appmesh.updateVirtualNode(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
clientToken
— (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.
If a token is not provided, the SDK will use a version 4 UUID.meshName
— (String
)The name of the service mesh that the virtual node resides in.
spec
— (map
)The new virtual node specification to apply. This overwrites the existing data.
backends
— (Array<map>
)The backends that the virtual node is expected to send outbound traffic to.
virtualService
— (map
)Specifies a virtual service to use as a backend for a virtual node.
virtualServiceName
— required — (String
)The name of the virtual service that is acting as a virtual node backend.
listeners
— (Array<map>
)The listeners that the virtual node is expected to receive inbound traffic from. Currently only one listener is supported per virtual node.
healthCheck
— (map
)The health check information for the listener.
healthyThreshold
— required — (Integer
)The number of consecutive successful health checks that must occur before declaring listener healthy.
intervalMillis
— required — (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
— required — (String
)The protocol for the health check request.
Possible values include:"http"
"tcp"
timeoutMillis
— required — (Integer
)The amount of time to wait when receiving a response from the health check, in milliseconds.
unhealthyThreshold
— required — (Integer
)The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.
portMapping
— required — (map
)The port mapping information for the listener.
port
— required — (Integer
)The port used for the port mapping.
protocol
— required — (String
)The protocol used for the port mapping.
Possible values include:"http"
"tcp"
logging
— (map
)The inbound and outbound access logging information for the virtual node.
accessLog
— (map
)The access log configuration for a virtual node.
file
— (map
)The file object to send virtual node access logs to.
path
— required — (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 asawslogs
, 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
— (map
)The service discovery information for the virtual node. If your virtual node does not expect ingress traffic, you can omit this parameter.
dns
— (map
)Specifies the DNS information for the virtual node.
hostname
— required — (String
)Specifies the DNS service discovery hostname for the virtual node.
virtualNodeName
— (String
)The name of the virtual node to update.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:virtualNode
— (map
)A full description of the virtual node that was updated.
meshName
— required — (String
)The name of the service mesh that the virtual node resides in.
metadata
— required — (map
)The associated metadata for the virtual node.
arn
— required — (String
)The full Amazon Resource Name (ARN) for the resource.
createdAt
— required — (Date
)The Unix epoch timestamp in seconds for when the resource was created.
lastUpdatedAt
— required — (Date
)The Unix epoch timestamp in seconds for when the resource was last updated.
uid
— required — (String
)The unique identifier for the resource.
version
— required — (Integer
)The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
spec
— required — (map
)The specifications of the virtual node.
backends
— (Array<map>
)The backends that the virtual node is expected to send outbound traffic to.
virtualService
— (map
)Specifies a virtual service to use as a backend for a virtual node.
virtualServiceName
— required — (String
)The name of the virtual service that is acting as a virtual node backend.
listeners
— (Array<map>
)The listeners that the virtual node is expected to receive inbound traffic from. Currently only one listener is supported per virtual node.
healthCheck
— (map
)The health check information for the listener.
healthyThreshold
— required — (Integer
)The number of consecutive successful health checks that must occur before declaring listener healthy.
intervalMillis
— required — (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
— required — (String
)The protocol for the health check request.
Possible values include:"http"
"tcp"
timeoutMillis
— required — (Integer
)The amount of time to wait when receiving a response from the health check, in milliseconds.
unhealthyThreshold
— required — (Integer
)The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.
portMapping
— required — (map
)The port mapping information for the listener.
port
— required — (Integer
)The port used for the port mapping.
protocol
— required — (String
)The protocol used for the port mapping.
Possible values include:"http"
"tcp"
logging
— (map
)The inbound and outbound access logging information for the virtual node.
accessLog
— (map
)The access log configuration for a virtual node.
file
— (map
)The file object to send virtual node access logs to.
path
— required — (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 asawslogs
, 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
— (map
)The service discovery information for the virtual node. If your virtual node does not expect ingress traffic, you can omit this parameter.
dns
— (map
)Specifies the DNS information for the virtual node.
hostname
— required — (String
)Specifies the DNS service discovery hostname for the virtual node.
status
— required — (map
)The current status for the virtual node.
status
— required — (String
)The current status of the virtual node.
Possible values include:"ACTIVE"
"DELETED"
"INACTIVE"
virtualNodeName
— required — (String
)The name of the virtual node.
-
(AWS.Response)
—
Returns:
updateVirtualRouter(params = {}, callback) ⇒ AWS.Request
Updates an existing virtual router in a specified service mesh.
Service Reference:
Examples:
Calling the updateVirtualRouter operation
var params = {
meshName: 'STRING_VALUE', /* required */
spec: { /* required */
listeners: [ /* required */
{
portMapping: { /* required */
port: 'NUMBER_VALUE', /* required */
protocol: http | tcp /* required */
}
},
/* more items */
]
},
virtualRouterName: 'STRING_VALUE', /* required */
clientToken: 'STRING_VALUE'
};
appmesh.updateVirtualRouter(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
clientToken
— (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.
If a token is not provided, the SDK will use a version 4 UUID.meshName
— (String
)The name of the service mesh that the virtual router resides in.
spec
— (map
)The new virtual router specification to apply. This overwrites the existing data.
listeners
— required — (Array<map>
)The listeners that the virtual router is expected to receive inbound traffic from. Currently only one listener is supported per virtual router.
portMapping
— required — (map
)An object representing a virtual node or virtual router listener port mapping.
port
— required — (Integer
)The port used for the port mapping.
protocol
— required — (String
)The protocol used for the port mapping.
Possible values include:"http"
"tcp"
virtualRouterName
— (String
)The name of the virtual router to update.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:virtualRouter
— (map
)A full description of the virtual router that was updated.
meshName
— required — (String
)The name of the service mesh that the virtual router resides in.
metadata
— required — (map
)The associated metadata for the virtual router.
arn
— required — (String
)The full Amazon Resource Name (ARN) for the resource.
createdAt
— required — (Date
)The Unix epoch timestamp in seconds for when the resource was created.
lastUpdatedAt
— required — (Date
)The Unix epoch timestamp in seconds for when the resource was last updated.
uid
— required — (String
)The unique identifier for the resource.
version
— required — (Integer
)The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
spec
— required — (map
)The specifications of the virtual router.
listeners
— required — (Array<map>
)The listeners that the virtual router is expected to receive inbound traffic from. Currently only one listener is supported per virtual router.
portMapping
— required — (map
)An object representing a virtual node or virtual router listener port mapping.
port
— required — (Integer
)The port used for the port mapping.
protocol
— required — (String
)The protocol used for the port mapping.
Possible values include:"http"
"tcp"
status
— required — (map
)The current status of the virtual router.
status
— required — (String
)The current status of the virtual router.
Possible values include:"ACTIVE"
"DELETED"
"INACTIVE"
virtualRouterName
— required — (String
)The name of the virtual router.
-
(AWS.Response)
—
Returns:
updateVirtualService(params = {}, callback) ⇒ AWS.Request
Updates an existing virtual service in a specified service mesh.
Service Reference:
Examples:
Calling the updateVirtualService operation
var params = {
meshName: 'STRING_VALUE', /* required */
spec: { /* required */
provider: {
virtualNode: {
virtualNodeName: 'STRING_VALUE' /* required */
},
virtualRouter: {
virtualRouterName: 'STRING_VALUE' /* required */
}
}
},
virtualServiceName: 'STRING_VALUE', /* required */
clientToken: 'STRING_VALUE'
};
appmesh.updateVirtualService(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
clientToken
— (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.
If a token is not provided, the SDK will use a version 4 UUID.meshName
— (String
)The name of the service mesh that the virtual service resides in.
spec
— (map
)The new virtual service specification to apply. This overwrites the existing data.
provider
— (map
)The App Mesh object that is acting as the provider for a virtual service. You can specify a single virtual node or virtual router.
virtualNode
— (map
)The virtual node associated with a virtual service.
virtualNodeName
— required — (String
)The name of the virtual node that is acting as a service provider.
virtualRouter
— (map
)The virtual router associated with a virtual service.
virtualRouterName
— required — (String
)The name of the virtual router that is acting as a service provider.
virtualServiceName
— (String
)The name of the virtual service to update.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:virtualService
— (map
)A full description of the virtual service that was updated.
meshName
— required — (String
)The name of the service mesh that the virtual service resides in.
metadata
— required — (map
)An object representing metadata for a resource.
arn
— required — (String
)The full Amazon Resource Name (ARN) for the resource.
createdAt
— required — (Date
)The Unix epoch timestamp in seconds for when the resource was created.
lastUpdatedAt
— required — (Date
)The Unix epoch timestamp in seconds for when the resource was last updated.
uid
— required — (String
)The unique identifier for the resource.
version
— required — (Integer
)The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
spec
— required — (map
)The specifications of the virtual service.
provider
— (map
)The App Mesh object that is acting as the provider for a virtual service. You can specify a single virtual node or virtual router.
virtualNode
— (map
)The virtual node associated with a virtual service.
virtualNodeName
— required — (String
)The name of the virtual node that is acting as a service provider.
virtualRouter
— (map
)The virtual router associated with a virtual service.
virtualRouterName
— required — (String
)The name of the virtual router that is acting as a service provider.
status
— required — (map
)The current status of the virtual service.
status
— required — (String
)The current status of the virtual service.
Possible values include:"ACTIVE"
"DELETED"
"INACTIVE"
virtualServiceName
— required — (String
)The name of the virtual service.
-
(AWS.Response)
—
Returns: