[ aws . appmesh ]

describe-virtual-node

Description

Describes an existing virtual node.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-virtual-node
--mesh-name <value>
[--mesh-owner <value>]
--virtual-node-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--mesh-name (string)

The name of the service mesh that the virtual node resides in.

--mesh-owner (string)

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it’s the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes .

--virtual-node-name (string)

The name of the virtual node to describe.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To describe a virtual node

The following describe-virtual-node example returns details about the specified virtual node.

aws appmesh describe-virtual-node \
    --mesh-name app1 \
    --virtual-node-name vnServiceBv1

Output:

{
    "virtualNode": {
        "meshName": "app1",
        "metadata": {
            "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualNode/vnServiceBv1",
            "createdAt": 1563810019.874,
            "lastUpdatedAt": 1563810019.874,
            "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
            "version": 1
        },
        "spec": {
            "backends": [],
            "listeners": [
                {
                    "portMapping": {
                        "port": 80,
                        "protocol": "http"
                    }
                }
            ],
            "serviceDiscovery": {
                "dns": {
                    "hostname": "serviceBv1.svc.cluster.local"
                }
            }
        },
        "status": {
            "status": "ACTIVE"
        },
        "virtualNodeName": "vnServiceBv1"
    }
}

For more information, see Virtual Nodes in the AWS App Mesh User Guide.

Output

virtualNode -> (structure)

The full description of your virtual node.

meshName -> (string)

The name of the service mesh that the virtual node resides in.

metadata -> (structure)

The associated metadata for the virtual node.

arn -> (string)

The full Amazon Resource Name (ARN) for the resource.

createdAt -> (timestamp)

The Unix epoch timestamp in seconds for when the resource was created.

lastUpdatedAt -> (timestamp)

The Unix epoch timestamp in seconds for when the resource was last updated.

meshOwner -> (string)

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it’s the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes .

resourceOwner -> (string)

The AWS IAM account ID of the resource owner. If the account ID is not your own, then it’s the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes .

uid -> (string)

The unique identifier for the resource.

version -> (long)

The version of the resource. Resources are created at version 1, and this version is incremented each time that they’re updated.

spec -> (structure)

The specifications of the virtual node.

backendDefaults -> (structure)

A reference to an object that represents the defaults for backends.

clientPolicy -> (structure)

A reference to an object that represents a client policy.

tls -> (structure)

A reference to an object that represents a Transport Layer Security (TLS) client policy.

enforce -> (boolean)

Whether the policy is enforced. The default is True , if a value isn’t specified.

ports -> (list)

One or more ports that the policy is enforced for.

(integer)

validation -> (structure)

A reference to an object that represents a TLS validation context.

trust -> (structure)

A reference to an object that represents a TLS validation context trust.

acm -> (structure)

A reference to an object that represents a TLS validation context trust for an AWS Certicate Manager (ACM) certificate.

certificateAuthorityArns -> (list)

One or more ACM Amazon Resource Name (ARN)s.

(string)

file -> (structure)

An object that represents a TLS validation context trust for a local file.

certificateChain -> (string)

The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.

backends -> (list)

The backends that the virtual node is expected to send outbound traffic to.

(structure)

An object that represents the backends that a virtual node is expected to send outbound traffic to.

virtualService -> (structure)

Specifies a virtual service to use as a backend for a virtual node.

clientPolicy -> (structure)

A reference to an object that represents the client policy for a backend.

tls -> (structure)

A reference to an object that represents a Transport Layer Security (TLS) client policy.

enforce -> (boolean)

Whether the policy is enforced. The default is True , if a value isn’t specified.

ports -> (list)

One or more ports that the policy is enforced for.

(integer)

validation -> (structure)

A reference to an object that represents a TLS validation context.

trust -> (structure)

A reference to an object that represents a TLS validation context trust.

acm -> (structure)

A reference to an object that represents a TLS validation context trust for an AWS Certicate Manager (ACM) certificate.

certificateAuthorityArns -> (list)

One or more ACM Amazon Resource Name (ARN)s.

(string)

file -> (structure)

An object that represents a TLS validation context trust for a local file.

certificateChain -> (string)

The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.

virtualServiceName -> (string)

The name of the virtual service that is acting as a virtual node backend.

listeners -> (list)

The listener that the virtual node is expected to receive inbound traffic from. You can specify one listener.

(structure)

An object that represents a listener for a virtual node.

healthCheck -> (structure)

The health check information for the listener.

healthyThreshold -> (integer)

The number of consecutive successful health checks that must occur before declaring listener healthy.

intervalMillis -> (long)

The time period in milliseconds between each health check execution.

path -> (string)

The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.

port -> (integer)

The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.

protocol -> (string)

The protocol for the health check request. If you specify grpc , then your service must conform to the GRPC Health Checking Protocol .

timeoutMillis -> (long)

The amount of time to wait when receiving a response from the health check, in milliseconds.

unhealthyThreshold -> (integer)

The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.

portMapping -> (structure)

The port mapping information for the listener.

port -> (integer)

The port used for the port mapping.

protocol -> (string)

The protocol used for the port mapping. Specify one protocol.

timeout -> (structure)

An object that represents timeouts for different protocols.

grpc -> (structure)

An object that represents types of timeouts.

idle -> (structure)

An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.

unit -> (string)

A unit of time.

value -> (long)

A number of time units.

perRequest -> (structure)

An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.

unit -> (string)

A unit of time.

value -> (long)

A number of time units.

http -> (structure)

An object that represents types of timeouts.

idle -> (structure)

An object that represents a duration of time.

unit -> (string)

A unit of time.

value -> (long)

A number of time units.

perRequest -> (structure)

An object that represents a duration of time.

unit -> (string)

A unit of time.

value -> (long)

A number of time units.

http2 -> (structure)

An object that represents types of timeouts.

idle -> (structure)

An object that represents a duration of time.

unit -> (string)

A unit of time.

value -> (long)

A number of time units.

perRequest -> (structure)

An object that represents a duration of time.

unit -> (string)

A unit of time.

value -> (long)

A number of time units.

tcp -> (structure)

An object that represents types of timeouts.

idle -> (structure)

An object that represents a duration of time.

unit -> (string)

A unit of time.

value -> (long)

A number of time units.

tls -> (structure)

A reference to an object that represents the Transport Layer Security (TLS) properties for a listener.

certificate -> (structure)

A reference to an object that represents a listener’s TLS certificate.

acm -> (structure)

A reference to an object that represents an AWS Certicate Manager (ACM) certificate.

certificateArn -> (string)

The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS) .

file -> (structure)

A reference to an object that represents a local file certificate.

certificateChain -> (string)

The certificate chain for the certificate.

privateKey -> (string)

The private key for a certificate stored on the file system of the virtual node that the proxy is running on.

mode -> (string)

Specify one of the following modes.

• STRICT – Listener only accepts connections with TLS enabled.

• PERMISSIVE – Listener accepts connections with or without TLS enabled.

• DISABLED – Listener only accepts connections without TLS.

logging -> (structure)

The inbound and outbound access logging information for the virtual node.

accessLog -> (structure)

The access log configuration for a virtual node.

file -> (structure)

The file object to send virtual node access logs to.

path -> (string)

The file path to write access logs to. You can use /dev/stdout to send access logs to standard out and configure your Envoy container to use a log driver, such as awslogs , to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container’s file system to write the files to disk.

Note

The Envoy process must have write permissions to the path that you specify here. Otherwise, Envoy fails to bootstrap properly.

serviceDiscovery -> (structure)

The service discovery information for the virtual node. If your virtual node does not expect ingress traffic, you can omit this parameter. If you specify a listener , then you must specify service discovery information.

awsCloudMap -> (structure)

Specifies any AWS Cloud Map information for the virtual node.

attributes -> (list)

A string map that contains attributes with values that you can use to filter instances by any custom attribute that you specified when you registered the instance. Only instances that match all of the specified key/value pairs will be returned.

(structure)

An object that represents the AWS Cloud Map attribute information for your virtual node.

key -> (string)

The name of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service instance that contains the specified key and value is returned.

value -> (string)

The value of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service instance that contains the specified key and value is returned.

namespaceName -> (string)

The name of the AWS Cloud Map namespace to use.

serviceName -> (string)

The name of the AWS Cloud Map service to use.

dns -> (structure)

Specifies the DNS information for the virtual node.

hostname -> (string)

Specifies the DNS service discovery hostname for the virtual node.

status -> (structure)

The current status for the virtual node.

status -> (string)

The current status of the virtual node.

virtualNodeName -> (string)

The name of the virtual node.