Skip to content
AWS for Query.Farm

aws.appmesh.describe_virtual_gateway

Example SQL Queries

SELECT * FROM
aws.appmesh.describe_virtual_gateway
WHERE
"mesh_name" = 'VALUE'
AND "virtual_gateway_name" = 'VALUE';

Description

Describes an existing virtual gateway.

Table Definition

Column NameColumn Data Type
mesh_name Required Input Column

The name of the service mesh that the gateway route resides in.

VARCHAR
virtual_gateway_name Required Input Column

The name of the virtual gateway 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_gateway

The full description of your virtual gateway.

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
                            )
                        )
                    )
                )
            )
        ),
        "listeners" STRUCT(
            "connection_pool" STRUCT(
                "grpc" STRUCT(
                    "max_requests" BIGINT
                ),
                "http" STRUCT(
                    "max_connections" BIGINT,
                    "max_pending_requests" BIGINT
                ),
                "http2" STRUCT(
                    "max_requests" BIGINT
                )
            ),
            "health_check" STRUCT(
                "healthy_threshold" BIGINT,
                "interval_millis" BIGINT,
                "path" VARCHAR,
                "port" BIGINT,
                "protocol" VARCHAR,
                "timeout_millis" BIGINT,
                "unhealthy_threshold" BIGINT
            ),
            "port_mapping" STRUCT(
                "port" BIGINT,
                "protocol" VARCHAR
            ),
            "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
                )
            )
        )
    ),
    "status" STRUCT(
        "status" VARCHAR
    ),
    "virtual_gateway_name" VARCHAR
)
Show child fields
virtual_gateway.mesh_name

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

virtual_gateway.metadata

An object that represents metadata for a resource.

Show child fields
virtual_gateway.metadata.arn

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

virtual_gateway.metadata.created_at

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

virtual_gateway.metadata.last_updated_at

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

virtual_gateway.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_gateway.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_gateway.metadata.uid

The unique identifier for the resource.

virtual_gateway.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_gateway.spec

The specifications of the virtual gateway.

Show child fields
virtual_gateway.spec.backend_defaults

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

Show child fields
virtual_gateway.spec.backend_defaults.client_policy

A reference to an object that represents a client policy.

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

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

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

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

Show child fields
virtual_gateway.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_gateway.spec.backend_defaults.client_policy.tls.certificate.file.certificate_chain

The certificate chain for the certificate.

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

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

virtual_gateway.spec.backend_defaults.client_policy.tls.certificate.sds

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

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

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

virtual_gateway.spec.backend_defaults.client_policy.tls.enforce

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

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

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

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

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

Show child fields
virtual_gateway.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_gateway.spec.backend_defaults.client_policy.tls.validation.subject_alternative_names.match.exact[]
virtual_gateway.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_gateway.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_gateway.spec.backend_defaults.client_policy.tls.validation.trust.acm.certificate_authority_arns[]
virtual_gateway.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_gateway.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_gateway.spec.backend_defaults.client_policy.tls.validation.trust.sds

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

Show child fields
virtual_gateway.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 virtual gateway's Transport Layer Security (TLS) Secret Discovery Service validation context trust.

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

The connection pool information for the virtual gateway listener.

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

An object that represents a type of connection pool.

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

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

virtual_gateway.spec.listeners[].connection_pool.http

An object that represents a type of connection pool.

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

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

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

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

virtual_gateway.spec.listeners[].connection_pool.http2

An object that represents a type of connection pool.

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

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

virtual_gateway.spec.listeners[].health_check

The health check information for the listener.

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

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

virtual_gateway.spec.listeners[].health_check.interval_millis

The time period in milliseconds between each health check execution.

virtual_gateway.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_gateway.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_gateway.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_gateway.spec.listeners[].health_check.timeout_millis

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

virtual_gateway.spec.listeners[].health_check.unhealthy_threshold

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

virtual_gateway.spec.listeners[].port_mapping

The port mapping information for the listener.

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

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

virtual_gateway.spec.listeners[].port_mapping.protocol

The protocol used for the port mapping.

virtual_gateway.spec.listeners[].tls

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

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

An object that represents a Transport Layer Security (TLS) certificate.

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

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

Show child fields
virtual_gateway.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_gateway.spec.listeners[].tls.certificate.file

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

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

The certificate chain for the certificate.

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

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

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

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

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

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

virtual_gateway.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_gateway.spec.listeners[].tls.validation

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

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

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

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

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

Show child fields
virtual_gateway.spec.listeners[].tls.validation.subject_alternative_names.match.exact[]
virtual_gateway.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_gateway.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_gateway.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_gateway.spec.listeners[].tls.validation.trust.sds

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

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

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

virtual_gateway.spec.logging

An object that represents logging information.

Show child fields
virtual_gateway.spec.logging.access_log

The access log configuration.

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

The file object to send virtual gateway access logs to.

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

The specified format for the virtual gateway access logs. It can be either json_format or text_format.

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

The specified key for the JSON.

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

The specified value for the JSON.

virtual_gateway.spec.logging.access_log.file.format.text

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

virtual_gateway.status

The current status of the virtual gateway.

Show child fields
virtual_gateway.status.status

The current status.

virtual_gateway.virtual_gateway_name

The name of the virtual gateway.