Skip to content

aws.appmesh.describe_virtual_node

Example SQL Queries

SELECT * FROM
aws.appmesh.describe_virtual_node
WHERE
"mesh_name" = 'VALUE'
AND "virtual_node_name" = 'VALUE';

Description

Describes an existing virtual node.

Table Definition

Column NameColumn Data Type
mesh_name Required Input Column

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

VARCHAR
virtual_node_name Required Input Column

The name of the virtual node to describe.

VARCHAR
mesh_owner Input Column

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

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
virtual_node

The full description of your virtual node.

STRUCT(
"mesh_name" VARCHAR,
"metadata" STRUCT(
"arn" VARCHAR,
"created_at" TIMESTAMP_S,
"last_updated_at" TIMESTAMP_S,
"mesh_owner" VARCHAR,
"resource_owner" VARCHAR,
"uid" VARCHAR,
"version" BIGINT
),
"spec" STRUCT(
"backend_defaults" STRUCT(
"client_policy" STRUCT(
"tls" STRUCT(
"certificate" STRUCT(
"file" STRUCT(
"certificate_chain" VARCHAR,
"private_key" VARCHAR
),
"sds" STRUCT(
"secret_name" VARCHAR
)
),
"enforce" BOOLEAN,
"ports" BIGINT[],
"validation" STRUCT(
"subject_alternative_names" STRUCT(
"match" STRUCT(
"exact" VARCHAR[]
)
),
"trust" STRUCT(
"acm" STRUCT(
"certificate_authority_arns" VARCHAR[]
),
"file" STRUCT(
"certificate_chain" VARCHAR
),
"sds" STRUCT(
"secret_name" VARCHAR
)
)
)
)
)
),
"backends" STRUCT(
"virtual_service" STRUCT(
"client_policy" STRUCT(
"tls" STRUCT(
"certificate" STRUCT(
"file" STRUCT(
"certificate_chain" VARCHAR,
"private_key" VARCHAR
),
"sds" STRUCT(
"secret_name" VARCHAR
)
),
"enforce" BOOLEAN,
"ports" BIGINT[],
"validation" STRUCT(
"subject_alternative_names" STRUCT(
"match" STRUCT(
"exact" VARCHAR[]
)
),
"trust" STRUCT(
"acm" STRUCT(
"certificate_authority_arns" VARCHAR[]
),
"file" STRUCT(
"certificate_chain" VARCHAR
),
"sds" STRUCT(
"secret_name" VARCHAR
)
)
)
)
),
"virtual_service_name" VARCHAR
)
)[],
"listeners" STRUCT(
"connection_pool" STRUCT(
"grpc" STRUCT(
"max_requests" BIGINT
),
"http" STRUCT(
"max_connections" BIGINT,
"max_pending_requests" BIGINT
),
"http2" STRUCT(
"max_requests" BIGINT
),
"tcp" STRUCT(
"max_connections" BIGINT
)
),
"health_check" STRUCT(
"healthy_threshold" BIGINT,
"interval_millis" BIGINT,
"path" VARCHAR,
"port" BIGINT,
"protocol" VARCHAR,
"timeout_millis" BIGINT,
"unhealthy_threshold" BIGINT
),
"outlier_detection" STRUCT(
"base_ejection_duration" STRUCT(
"unit" VARCHAR,
"value" BIGINT
),
"interval" STRUCT(
"unit" VARCHAR,
"value" BIGINT
),
"max_ejection_percent" BIGINT,
"max_server_errors" BIGINT
),
"port_mapping" STRUCT(
"port" BIGINT,
"protocol" VARCHAR
),
"timeout" STRUCT(
"grpc" STRUCT(
"idle" STRUCT(
"unit" VARCHAR,
"value" BIGINT
),
"per_request" STRUCT(
"unit" VARCHAR,
"value" BIGINT
)
),
"http" STRUCT(
"idle" STRUCT(
"unit" VARCHAR,
"value" BIGINT
),
"per_request" STRUCT(
"unit" VARCHAR,
"value" BIGINT
)
),
"http2" STRUCT(
"idle" STRUCT(
"unit" VARCHAR,
"value" BIGINT
),
"per_request" STRUCT(
"unit" VARCHAR,
"value" BIGINT
)
),
"tcp" STRUCT(
"idle" STRUCT(
"unit" VARCHAR,
"value" BIGINT
)
)
),
"tls" STRUCT(
"certificate" STRUCT(
"acm" STRUCT(
"certificate_arn" VARCHAR
),
"file" STRUCT(
"certificate_chain" VARCHAR,
"private_key" VARCHAR
),
"sds" STRUCT(
"secret_name" VARCHAR
)
),
"mode" VARCHAR,
"validation" STRUCT(
"subject_alternative_names" STRUCT(
"match" STRUCT(
"exact" VARCHAR[]
)
),
"trust" STRUCT(
"file" STRUCT(
"certificate_chain" VARCHAR
),
"sds" STRUCT(
"secret_name" VARCHAR
)
)
)
)
)[],
"logging" STRUCT(
"access_log" STRUCT(
"file" STRUCT(
"format" STRUCT(
"json" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"text" VARCHAR
),
"path" VARCHAR
)
)
),
"service_discovery" STRUCT(
"aws_cloud_map" STRUCT(
"attributes" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"ip_preference" VARCHAR,
"namespace_name" VARCHAR,
"service_name" VARCHAR
),
"dns" STRUCT(
"hostname" VARCHAR,
"ip_preference" VARCHAR,
"response_type" VARCHAR
)
)
),
"status" STRUCT(
"status" VARCHAR
),
"virtual_node_name" VARCHAR
)
Show child fields
virtual_node.mesh_name

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

virtual_node.metadata

The associated metadata for the virtual node.

Show child fields
virtual_node.metadata.arn

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

virtual_node.metadata.created_at

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

virtual_node.metadata.last_updated_at

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

virtual_node.metadata.mesh_owner

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

virtual_node.metadata.resource_owner

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

virtual_node.metadata.uid

The unique identifier for the resource.

virtual_node.metadata.version

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

virtual_node.spec

The specifications of the virtual node.

Show child fields
virtual_node.spec.backend_defaults

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

Show child fields
virtual_node.spec.backend_defaults.client_policy

A reference to an object that represents a client policy.

Show child fields
virtual_node.spec.backend_defaults.client_policy.tls

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

Show child fields
virtual_node.spec.backend_defaults.client_policy.tls.certificate

A reference to an object that represents a client's TLS certificate.

Show child fields
virtual_node.spec.backend_defaults.client_policy.tls.certificate.file

An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).

Show child fields
virtual_node.spec.backend_defaults.client_policy.tls.certificate.file.certificate_chain

The certificate chain for the certificate.

virtual_node.spec.backend_defaults.client_policy.tls.certificate.file.private_key

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

virtual_node.spec.backend_defaults.client_policy.tls.certificate.sds

A reference to an object that represents a client's TLS Secret Discovery Service certificate.

Show child fields
virtual_node.spec.backend_defaults.client_policy.tls.certificate.sds.secret_name

A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.

virtual_node.spec.backend_defaults.client_policy.tls.enforce

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

virtual_node.spec.backend_defaults.client_policy.tls.ports[]
virtual_node.spec.backend_defaults.client_policy.tls.validation

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

Show child fields
virtual_node.spec.backend_defaults.client_policy.tls.validation.subject_alternative_names

A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context. If you don't specify SANs on the terminating mesh endpoint, the Envoy proxy for that node doesn't verify the SAN on a peer client certificate. If you don't specify SANs on the originating mesh endpoint, the SAN on the certificate provided by the terminating endpoint must match the mesh endpoint service discovery configuration. Since SPIRE vended certificates have a SPIFFE ID as a name, you must set the SAN since the name doesn't match the service discovery name.

Show child fields
virtual_node.spec.backend_defaults.client_policy.tls.validation.subject_alternative_names.match

An object that represents the criteria for determining a SANs match.

Show child fields
virtual_node.spec.backend_defaults.client_policy.tls.validation.subject_alternative_names.match.exact[]
virtual_node.spec.backend_defaults.client_policy.tls.validation.trust

A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.

Show child fields
virtual_node.spec.backend_defaults.client_policy.tls.validation.trust.acm

A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.

Show child fields
virtual_node.spec.backend_defaults.client_policy.tls.validation.trust.acm.certificate_authority_arns[]
virtual_node.spec.backend_defaults.client_policy.tls.validation.trust.file

An object that represents a Transport Layer Security (TLS) validation context trust for a local file.

Show child fields
virtual_node.spec.backend_defaults.client_policy.tls.validation.trust.file.certificate_chain

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

virtual_node.spec.backend_defaults.client_policy.tls.validation.trust.sds

A reference to an object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust.

Show child fields
virtual_node.spec.backend_defaults.client_policy.tls.validation.trust.sds.secret_name

A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.

virtual_node.spec.backends[]
Show child fields
virtual_node.spec.backends[].virtual_service

Specifies a virtual service to use as a backend.

Show child fields
virtual_node.spec.backends[].virtual_service.client_policy

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

Show child fields
virtual_node.spec.backends[].virtual_service.client_policy.tls

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

Show child fields
virtual_node.spec.backends[].virtual_service.client_policy.tls.certificate

A reference to an object that represents a client's TLS certificate.

Show child fields
virtual_node.spec.backends[].virtual_service.client_policy.tls.certificate.file

An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).

Show child fields
virtual_node.spec.backends[].virtual_service.client_policy.tls.certificate.file.certificate_chain

The certificate chain for the certificate.

virtual_node.spec.backends[].virtual_service.client_policy.tls.certificate.file.private_key

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

virtual_node.spec.backends[].virtual_service.client_policy.tls.certificate.sds

A reference to an object that represents a client's TLS Secret Discovery Service certificate.

Show child fields
virtual_node.spec.backends[].virtual_service.client_policy.tls.certificate.sds.secret_name

A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.

virtual_node.spec.backends[].virtual_service.client_policy.tls.enforce

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

virtual_node.spec.backends[].virtual_service.client_policy.tls.ports[]
virtual_node.spec.backends[].virtual_service.client_policy.tls.validation

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

Show child fields
virtual_node.spec.backends[].virtual_service.client_policy.tls.validation.subject_alternative_names

A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context. If you don't specify SANs on the terminating mesh endpoint, the Envoy proxy for that node doesn't verify the SAN on a peer client certificate. If you don't specify SANs on the originating mesh endpoint, the SAN on the certificate provided by the terminating endpoint must match the mesh endpoint service discovery configuration. Since SPIRE vended certificates have a SPIFFE ID as a name, you must set the SAN since the name doesn't match the service discovery name.

Show child fields
virtual_node.spec.backends[].virtual_service.client_policy.tls.validation.subject_alternative_names.match

An object that represents the criteria for determining a SANs match.

Show child fields
virtual_node.spec.backends[].virtual_service.client_policy.tls.validation.subject_alternative_names.match.exact[]
virtual_node.spec.backends[].virtual_service.client_policy.tls.validation.trust

A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.

Show child fields
virtual_node.spec.backends[].virtual_service.client_policy.tls.validation.trust.acm

A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.

Show child fields
virtual_node.spec.backends[].virtual_service.client_policy.tls.validation.trust.acm.certificate_authority_arns[]
virtual_node.spec.backends[].virtual_service.client_policy.tls.validation.trust.file

An object that represents a Transport Layer Security (TLS) validation context trust for a local file.

Show child fields
virtual_node.spec.backends[].virtual_service.client_policy.tls.validation.trust.file.certificate_chain

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

virtual_node.spec.backends[].virtual_service.client_policy.tls.validation.trust.sds

A reference to an object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust.

Show child fields
virtual_node.spec.backends[].virtual_service.client_policy.tls.validation.trust.sds.secret_name

A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.

virtual_node.spec.backends[].virtual_service.virtual_service_name

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

virtual_node.spec.listeners[]
Show child fields
virtual_node.spec.listeners[].connection_pool

The connection pool information for the listener.

Show child fields
virtual_node.spec.listeners[].connection_pool.grpc

An object that represents a type of connection pool.

Show child fields
virtual_node.spec.listeners[].connection_pool.grpc.max_requests

Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.

virtual_node.spec.listeners[].connection_pool.http

An object that represents a type of connection pool.

Show child fields
virtual_node.spec.listeners[].connection_pool.http.max_connections

Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.

virtual_node.spec.listeners[].connection_pool.http.max_pending_requests

Number of overflowing requests after max_connections Envoy will queue to upstream cluster.

virtual_node.spec.listeners[].connection_pool.http2

An object that represents a type of connection pool.

Show child fields
virtual_node.spec.listeners[].connection_pool.http2.max_requests

Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.

virtual_node.spec.listeners[].connection_pool.tcp

An object that represents a type of connection pool.

Show child fields
virtual_node.spec.listeners[].connection_pool.tcp.max_connections

Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.

virtual_node.spec.listeners[].health_check

The health check information for the listener.

Show child fields
virtual_node.spec.listeners[].health_check.healthy_threshold

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

virtual_node.spec.listeners[].health_check.interval_millis

The time period in milliseconds between each health check execution.

virtual_node.spec.listeners[].health_check.path

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.

virtual_node.spec.listeners[].health_check.port

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

virtual_node.spec.listeners[].health_check.protocol

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

virtual_node.spec.listeners[].health_check.timeout_millis

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

virtual_node.spec.listeners[].health_check.unhealthy_threshold

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

virtual_node.spec.listeners[].outlier_detection

The outlier detection information for the listener.

Show child fields
virtual_node.spec.listeners[].outlier_detection.base_ejection_duration

The base amount of time for which a host is ejected.

Show child fields
virtual_node.spec.listeners[].outlier_detection.base_ejection_duration.unit

A unit of time.

virtual_node.spec.listeners[].outlier_detection.base_ejection_duration.value

A number of time units.

virtual_node.spec.listeners[].outlier_detection.interval

The time interval between ejection sweep analysis.

Show child fields
virtual_node.spec.listeners[].outlier_detection.interval.unit

A unit of time.

virtual_node.spec.listeners[].outlier_detection.interval.value

A number of time units.

virtual_node.spec.listeners[].outlier_detection.max_ejection_percent

Maximum percentage of hosts in load balancing pool for upstream service that can be ejected. Will eject at least one host regardless of the value.

virtual_node.spec.listeners[].outlier_detection.max_server_errors

Number of consecutive 5xx errors required for ejection.

virtual_node.spec.listeners[].port_mapping

The port mapping information for the listener.

Show child fields
virtual_node.spec.listeners[].port_mapping.port

The port used for the port mapping.

virtual_node.spec.listeners[].port_mapping.protocol

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

virtual_node.spec.listeners[].timeout

An object that represents timeouts for different protocols.

Show child fields
virtual_node.spec.listeners[].timeout.grpc

An object that represents types of timeouts.

Show child fields
virtual_node.spec.listeners[].timeout.grpc.idle

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.

Show child fields
virtual_node.spec.listeners[].timeout.grpc.idle.unit

A unit of time.

virtual_node.spec.listeners[].timeout.grpc.idle.value

A number of time units.

virtual_node.spec.listeners[].timeout.grpc.per_request

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.

Show child fields
virtual_node.spec.listeners[].timeout.grpc.per_request.unit

A unit of time.

virtual_node.spec.listeners[].timeout.grpc.per_request.value

A number of time units.

virtual_node.spec.listeners[].timeout.http

An object that represents types of timeouts.

Show child fields
virtual_node.spec.listeners[].timeout.http.idle

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.

Show child fields
virtual_node.spec.listeners[].timeout.http.idle.unit

A unit of time.

virtual_node.spec.listeners[].timeout.http.idle.value

A number of time units.

virtual_node.spec.listeners[].timeout.http.per_request

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.

Show child fields
virtual_node.spec.listeners[].timeout.http.per_request.unit

A unit of time.

virtual_node.spec.listeners[].timeout.http.per_request.value

A number of time units.

virtual_node.spec.listeners[].timeout.http2

An object that represents types of timeouts.

Show child fields
virtual_node.spec.listeners[].timeout.http2.idle

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.

Show child fields
virtual_node.spec.listeners[].timeout.http2.idle.unit

A unit of time.

virtual_node.spec.listeners[].timeout.http2.idle.value

A number of time units.

virtual_node.spec.listeners[].timeout.http2.per_request

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.

Show child fields
virtual_node.spec.listeners[].timeout.http2.per_request.unit

A unit of time.

virtual_node.spec.listeners[].timeout.http2.per_request.value

A number of time units.

virtual_node.spec.listeners[].timeout.tcp

An object that represents types of timeouts.

Show child fields
virtual_node.spec.listeners[].timeout.tcp.idle

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.

Show child fields
virtual_node.spec.listeners[].timeout.tcp.idle.unit

A unit of time.

virtual_node.spec.listeners[].timeout.tcp.idle.value

A number of time units.

virtual_node.spec.listeners[].tls

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

Show child fields
virtual_node.spec.listeners[].tls.certificate

A reference to an object that represents a listener's Transport Layer Security (TLS) certificate.

Show child fields
virtual_node.spec.listeners[].tls.certificate.acm

A reference to an object that represents an Certificate Manager certificate.

Show child fields
virtual_node.spec.listeners[].tls.certificate.acm.certificate_arn

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).

virtual_node.spec.listeners[].tls.certificate.file

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

Show child fields
virtual_node.spec.listeners[].tls.certificate.file.certificate_chain

The certificate chain for the certificate.

virtual_node.spec.listeners[].tls.certificate.file.private_key

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

virtual_node.spec.listeners[].tls.certificate.sds

A reference to an object that represents a listener's Secret Discovery Service certificate.

Show child fields
virtual_node.spec.listeners[].tls.certificate.sds.secret_name

A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.

virtual_node.spec.listeners[].tls.mode

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.

virtual_node.spec.listeners[].tls.validation

A reference to an object that represents a listener's Transport Layer Security (TLS) validation context.

Show child fields
virtual_node.spec.listeners[].tls.validation.subject_alternative_names

A reference to an object that represents the SANs for a listener's Transport Layer Security (TLS) validation context.

Show child fields
virtual_node.spec.listeners[].tls.validation.subject_alternative_names.match

An object that represents the criteria for determining a SANs match.

Show child fields
virtual_node.spec.listeners[].tls.validation.subject_alternative_names.match.exact[]
virtual_node.spec.listeners[].tls.validation.trust

A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.

Show child fields
virtual_node.spec.listeners[].tls.validation.trust.file

An object that represents a Transport Layer Security (TLS) validation context trust for a local file.

Show child fields
virtual_node.spec.listeners[].tls.validation.trust.file.certificate_chain

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

virtual_node.spec.listeners[].tls.validation.trust.sds

A reference to an object that represents a listener's Transport Layer Security (TLS) Secret Discovery Service validation context trust.

Show child fields
virtual_node.spec.listeners[].tls.validation.trust.sds.secret_name

A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.

virtual_node.spec.logging

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

Show child fields
virtual_node.spec.logging.access_log

The access log configuration for a virtual node.

Show child fields
virtual_node.spec.logging.access_log.file

The file object to send virtual node access logs to.

Show child fields
virtual_node.spec.logging.access_log.file.format

The specified format for the logs. The format is either json_format or text_format.

Show child fields
virtual_node.spec.logging.access_log.file.format.json[]
Show child fields
virtual_node.spec.logging.access_log.file.format.json[].key

The specified key for the JSON.

virtual_node.spec.logging.access_log.file.format.json[].value

The specified value for the JSON.

virtual_node.spec.logging.access_log.file.format.text

virtual_node.spec.logging.access_log.file.path

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.

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

virtual_node.spec.service_discovery

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.

Show child fields
virtual_node.spec.service_discovery.aws_cloud_map

Specifies any Cloud Map information for the virtual node.

Show child fields
virtual_node.spec.service_discovery.aws_cloud_map.attributes[]
Show child fields
virtual_node.spec.service_discovery.aws_cloud_map.attributes[].key

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

virtual_node.spec.service_discovery.aws_cloud_map.attributes[].value

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

virtual_node.spec.service_discovery.aws_cloud_map.ip_preference

The preferred IP version that this virtual node uses. Setting the IP preference on the virtual node only overrides the IP preference set for the mesh on this specific node.

virtual_node.spec.service_discovery.aws_cloud_map.namespace_name

The name of the Cloud Map namespace to use.

virtual_node.spec.service_discovery.aws_cloud_map.service_name

The name of the Cloud Map service to use.

virtual_node.spec.service_discovery.dns

Specifies the DNS information for the virtual node.

Show child fields
virtual_node.spec.service_discovery.dns.hostname

Specifies the DNS service discovery hostname for the virtual node.

virtual_node.spec.service_discovery.dns.ip_preference

The preferred IP version that this virtual node uses. Setting the IP preference on the virtual node only overrides the IP preference set for the mesh on this specific node.

virtual_node.spec.service_discovery.dns.response_type

Specifies the DNS response type for the virtual node.

virtual_node.status

The current status for the virtual node.

Show child fields
virtual_node.status.status

The current status of the virtual node.

virtual_node.virtual_node_name

The name of the virtual node.