Skip to content
AWS for Query.Farm

aws.appmesh.describe_route

Example SQL Queries

SELECT * FROM
aws.appmesh.describe_route
WHERE
"mesh_name" = 'VALUE'
AND "route_name" = 'VALUE'
AND "virtual_router_name" = 'VALUE';

Description

Describes an existing route.

Table Definition

Column NameColumn Data Type
mesh_name Required Input Column

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

VARCHAR
route_name Required Input Column

The name of the route to describe.

VARCHAR
virtual_router_name Required Input Column

The name of the virtual router that the route is associated with.

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
route

The full description of your route.

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
    ),
    "route_name" VARCHAR,
    "spec" STRUCT(
        "grpc_route" STRUCT(
            "action" STRUCT(
                "weighted_targets" STRUCT(
                    "port" BIGINT,
                    "virtual_node" VARCHAR,
                    "weight" BIGINT
                )[]
            ),
            "match" STRUCT(
                "metadata" STRUCT(
                    "invert" BOOLEAN,
                    "match" STRUCT(
                        "exact" VARCHAR,
                        "prefix" VARCHAR,
                        "range" STRUCT(
                            "end" BIGINT,
                            "start" BIGINT
                        ),
                        "regex" VARCHAR,
                        "suffix" VARCHAR
                    ),
                    "name" VARCHAR
                )[],
                "method_name" VARCHAR,
                "port" BIGINT,
                "service_name" VARCHAR
            ),
            "retry_policy" STRUCT(
                "grpc_retry_events" VARCHAR[],
                "http_retry_events" VARCHAR[],
                "max_retries" BIGINT,
                "per_retry_timeout" STRUCT(
                    "unit" VARCHAR,
                    "value" BIGINT
                ),
                "tcp_retry_events" VARCHAR[]
            ),
            "timeout" STRUCT(
                "idle" STRUCT(
                    "unit" VARCHAR,
                    "value" BIGINT
                ),
                "per_request" STRUCT(
                    "unit" VARCHAR,
                    "value" BIGINT
                )
            )
        ),
        "http2_route" STRUCT(
            "action" STRUCT(
                "weighted_targets" STRUCT(
                    "port" BIGINT,
                    "virtual_node" VARCHAR,
                    "weight" BIGINT
                )[]
            ),
            "match" STRUCT(
                "headers" STRUCT(
                    "invert" BOOLEAN,
                    "match" STRUCT(
                        "exact" VARCHAR,
                        "prefix" VARCHAR,
                        "range" STRUCT(
                            "end" BIGINT,
                            "start" BIGINT
                        ),
                        "regex" VARCHAR,
                        "suffix" VARCHAR
                    ),
                    "name" VARCHAR
                )[],
                "method" VARCHAR,
                "path" STRUCT(
                    "exact" VARCHAR,
                    "regex" VARCHAR
                ),
                "port" BIGINT,
                "prefix" VARCHAR,
                "query_parameters" STRUCT(
                    "match" STRUCT(
                        "exact" VARCHAR
                    ),
                    "name" VARCHAR
                )[],
                "scheme" VARCHAR
            ),
            "retry_policy" STRUCT(
                "http_retry_events" VARCHAR[],
                "max_retries" BIGINT,
                "per_retry_timeout" STRUCT(
                    "unit" VARCHAR,
                    "value" BIGINT
                ),
                "tcp_retry_events" VARCHAR[]
            ),
            "timeout" STRUCT(
                "idle" STRUCT(
                    "unit" VARCHAR,
                    "value" BIGINT
                ),
                "per_request" STRUCT(
                    "unit" VARCHAR,
                    "value" BIGINT
                )
            )
        ),
        "http_route" STRUCT(
            "action" STRUCT(
                "weighted_targets" STRUCT(
                    "port" BIGINT,
                    "virtual_node" VARCHAR,
                    "weight" BIGINT
                )[]
            ),
            "match" STRUCT(
                "headers" STRUCT(
                    "invert" BOOLEAN,
                    "match" STRUCT(
                        "exact" VARCHAR,
                        "prefix" VARCHAR,
                        "range" STRUCT(
                            "end" BIGINT,
                            "start" BIGINT
                        ),
                        "regex" VARCHAR,
                        "suffix" VARCHAR
                    ),
                    "name" VARCHAR
                )[],
                "method" VARCHAR,
                "path" STRUCT(
                    "exact" VARCHAR,
                    "regex" VARCHAR
                ),
                "port" BIGINT,
                "prefix" VARCHAR,
                "query_parameters" STRUCT(
                    "match" STRUCT(
                        "exact" VARCHAR
                    ),
                    "name" VARCHAR
                )[],
                "scheme" VARCHAR
            ),
            "retry_policy" STRUCT(
                "http_retry_events" VARCHAR[],
                "max_retries" BIGINT,
                "per_retry_timeout" STRUCT(
                    "unit" VARCHAR,
                    "value" BIGINT
                ),
                "tcp_retry_events" VARCHAR[]
            ),
            "timeout" STRUCT(
                "idle" STRUCT(
                    "unit" VARCHAR,
                    "value" BIGINT
                ),
                "per_request" STRUCT(
                    "unit" VARCHAR,
                    "value" BIGINT
                )
            )
        ),
        "priority" BIGINT,
        "tcp_route" STRUCT(
            "action" STRUCT(
                "weighted_targets" STRUCT(
                    "port" BIGINT,
                    "virtual_node" VARCHAR,
                    "weight" BIGINT
                )[]
            ),
            "match" STRUCT(
                "port" BIGINT
            ),
            "timeout" STRUCT(
                "idle" STRUCT(
                    "unit" VARCHAR,
                    "value" BIGINT
                )
            )
        )
    ),
    "status" STRUCT(
        "status" VARCHAR
    ),
    "virtual_router_name" VARCHAR
)
Show child fields
route.mesh_name

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

route.metadata

The associated metadata for the route.

Show child fields
route.metadata.arn

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

route.metadata.created_at

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

route.metadata.last_updated_at

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

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

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

route.metadata.uid

The unique identifier for the resource.

route.metadata.version

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

route.route_name

The name of the route.

route.spec

The specifications of the route.

Show child fields
route.spec.grpc_route

An object that represents the specification of a gRPC route.

Show child fields
route.spec.grpc_route.action

An object that represents the action to take if a match is determined.

Show child fields
route.spec.grpc_route.action.weighted_targets[]
Show child fields
route.spec.grpc_route.action.weighted_targets[].port

The targeted port of the weighted object.

route.spec.grpc_route.action.weighted_targets[].virtual_node

The virtual node to associate with the weighted target.

route.spec.grpc_route.action.weighted_targets[].weight

The relative weight of the weighted target.

route.spec.grpc_route.match

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

Show child fields
route.spec.grpc_route.match.metadata[]
Show child fields
route.spec.grpc_route.match.metadata[].invert

Specify True to match anything except the match criteria. The default value is False.

route.spec.grpc_route.match.metadata[].match

An object that represents the data to match from the request.

Show child fields
route.spec.grpc_route.match.metadata[].match.exact

The value sent by the client must match the specified value exactly.

route.spec.grpc_route.match.metadata[].match.prefix

The value sent by the client must begin with the specified characters.

route.spec.grpc_route.match.metadata[].match.range

An object that represents the range of values to match on.

Show child fields
route.spec.grpc_route.match.metadata[].match.range.end

The end of the range.

route.spec.grpc_route.match.metadata[].match.range.start

The start of the range.

route.spec.grpc_route.match.metadata[].match.regex

The value sent by the client must include the specified characters.

route.spec.grpc_route.match.metadata[].match.suffix

The value sent by the client must end with the specified characters.

route.spec.grpc_route.match.metadata[].name

The name of the route.

route.spec.grpc_route.match.method_name

The method name to match from the request. If you specify a name, you must also specify a serviceName.

route.spec.grpc_route.match.port

The port number to match on.

route.spec.grpc_route.match.service_name

The fully qualified domain name for the service to match from the request.

route.spec.grpc_route.retry_policy

An object that represents a retry policy.

Show child fields
route.spec.grpc_route.retry_policy.grpc_retry_events[]
route.spec.grpc_route.retry_policy.http_retry_events[]
route.spec.grpc_route.retry_policy.max_retries

The maximum number of retry attempts.

route.spec.grpc_route.retry_policy.per_retry_timeout

The timeout for each retry attempt.

Show child fields
route.spec.grpc_route.retry_policy.per_retry_timeout.unit

A unit of time.

route.spec.grpc_route.retry_policy.per_retry_timeout.value

A number of time units.

route.spec.grpc_route.retry_policy.tcp_retry_events[]
route.spec.grpc_route.timeout

An object that represents types of timeouts.

Show child fields
route.spec.grpc_route.timeout.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
route.spec.grpc_route.timeout.idle.unit

A unit of time.

route.spec.grpc_route.timeout.idle.value

A number of time units.

route.spec.grpc_route.timeout.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
route.spec.grpc_route.timeout.per_request.unit

A unit of time.

route.spec.grpc_route.timeout.per_request.value

A number of time units.

route.spec.http2_route

An object that represents the specification of an HTTP/2 route.

Show child fields
route.spec.http2_route.action

An object that represents the action to take if a match is determined.

Show child fields
route.spec.http2_route.action.weighted_targets[]
Show child fields
route.spec.http2_route.action.weighted_targets[].port

The targeted port of the weighted object.

route.spec.http2_route.action.weighted_targets[].virtual_node

The virtual node to associate with the weighted target.

route.spec.http2_route.action.weighted_targets[].weight

The relative weight of the weighted target.

route.spec.http2_route.match

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

Show child fields
route.spec.http2_route.match.headers[]
Show child fields
route.spec.http2_route.match.headers[].invert

Specify True to match anything except the match criteria. The default value is False.

route.spec.http2_route.match.headers[].match

The HeaderMatchMethod object.

Show child fields
route.spec.http2_route.match.headers[].match.exact

The value sent by the client must match the specified value exactly.

route.spec.http2_route.match.headers[].match.prefix

The value sent by the client must begin with the specified characters.

route.spec.http2_route.match.headers[].match.range

An object that represents the range of values to match on.

Show child fields
route.spec.http2_route.match.headers[].match.range.end

The end of the range.

route.spec.http2_route.match.headers[].match.range.start

The start of the range.

route.spec.http2_route.match.headers[].match.regex

The value sent by the client must include the specified characters.

route.spec.http2_route.match.headers[].match.suffix

The value sent by the client must end with the specified characters.

route.spec.http2_route.match.headers[].name

A name for the HTTP header in the client request that will be matched on.

route.spec.http2_route.match.method

The client request method to match on. Specify only one.

route.spec.http2_route.match.path

The client request path to match on.

Show child fields
route.spec.http2_route.match.path.exact

The exact path to match on.

route.spec.http2_route.match.path.regex

The regex used to match the path.

route.spec.http2_route.match.port

The port number to match on.

route.spec.http2_route.match.prefix

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 is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be /metrics.

route.spec.http2_route.match.query_parameters[]
Show child fields
route.spec.http2_route.match.query_parameters[].match

The query parameter to match on.

Show child fields
route.spec.http2_route.match.query_parameters[].match.exact

The exact query parameter to match on.

route.spec.http2_route.match.query_parameters[].name

A name for the query parameter that will be matched on.

route.spec.http2_route.match.scheme

The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.

route.spec.http2_route.retry_policy

An object that represents a retry policy.

Show child fields
route.spec.http2_route.retry_policy.http_retry_events[]
route.spec.http2_route.retry_policy.max_retries

The maximum number of retry attempts.

route.spec.http2_route.retry_policy.per_retry_timeout

The timeout for each retry attempt.

Show child fields
route.spec.http2_route.retry_policy.per_retry_timeout.unit

A unit of time.

route.spec.http2_route.retry_policy.per_retry_timeout.value

A number of time units.

route.spec.http2_route.retry_policy.tcp_retry_events[]
route.spec.http2_route.timeout

An object that represents types of timeouts.

Show child fields
route.spec.http2_route.timeout.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
route.spec.http2_route.timeout.idle.unit

A unit of time.

route.spec.http2_route.timeout.idle.value

A number of time units.

route.spec.http2_route.timeout.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
route.spec.http2_route.timeout.per_request.unit

A unit of time.

route.spec.http2_route.timeout.per_request.value

A number of time units.

route.spec.http_route

An object that represents the specification of an HTTP route.

Show child fields
route.spec.http_route.action

An object that represents the action to take if a match is determined.

Show child fields
route.spec.http_route.action.weighted_targets[]
Show child fields
route.spec.http_route.action.weighted_targets[].port

The targeted port of the weighted object.

route.spec.http_route.action.weighted_targets[].virtual_node

The virtual node to associate with the weighted target.

route.spec.http_route.action.weighted_targets[].weight

The relative weight of the weighted target.

route.spec.http_route.match

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

Show child fields
route.spec.http_route.match.headers[]
Show child fields
route.spec.http_route.match.headers[].invert

Specify True to match anything except the match criteria. The default value is False.

route.spec.http_route.match.headers[].match

The HeaderMatchMethod object.

Show child fields
route.spec.http_route.match.headers[].match.exact

The value sent by the client must match the specified value exactly.

route.spec.http_route.match.headers[].match.prefix

The value sent by the client must begin with the specified characters.

route.spec.http_route.match.headers[].match.range

An object that represents the range of values to match on.

Show child fields
route.spec.http_route.match.headers[].match.range.end

The end of the range.

route.spec.http_route.match.headers[].match.range.start

The start of the range.

route.spec.http_route.match.headers[].match.regex

The value sent by the client must include the specified characters.

route.spec.http_route.match.headers[].match.suffix

The value sent by the client must end with the specified characters.

route.spec.http_route.match.headers[].name

A name for the HTTP header in the client request that will be matched on.

route.spec.http_route.match.method

The client request method to match on. Specify only one.

route.spec.http_route.match.path

The client request path to match on.

Show child fields
route.spec.http_route.match.path.exact

The exact path to match on.

route.spec.http_route.match.path.regex

The regex used to match the path.

route.spec.http_route.match.port

The port number to match on.

route.spec.http_route.match.prefix

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 is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be /metrics.

route.spec.http_route.match.query_parameters[]
Show child fields
route.spec.http_route.match.query_parameters[].match

The query parameter to match on.

Show child fields
route.spec.http_route.match.query_parameters[].match.exact

The exact query parameter to match on.

route.spec.http_route.match.query_parameters[].name

A name for the query parameter that will be matched on.

route.spec.http_route.match.scheme

The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.

route.spec.http_route.retry_policy

An object that represents a retry policy.

Show child fields
route.spec.http_route.retry_policy.http_retry_events[]
route.spec.http_route.retry_policy.max_retries

The maximum number of retry attempts.

route.spec.http_route.retry_policy.per_retry_timeout

The timeout for each retry attempt.

Show child fields
route.spec.http_route.retry_policy.per_retry_timeout.unit

A unit of time.

route.spec.http_route.retry_policy.per_retry_timeout.value

A number of time units.

route.spec.http_route.retry_policy.tcp_retry_events[]
route.spec.http_route.timeout

An object that represents types of timeouts.

Show child fields
route.spec.http_route.timeout.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
route.spec.http_route.timeout.idle.unit

A unit of time.

route.spec.http_route.timeout.idle.value

A number of time units.

route.spec.http_route.timeout.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
route.spec.http_route.timeout.per_request.unit

A unit of time.

route.spec.http_route.timeout.per_request.value

A number of time units.

route.spec.priority

The priority for the route. Routes are matched based on the specified value, where 0 is the highest priority.

route.spec.tcp_route

An object that represents the specification of a TCP route.

Show child fields
route.spec.tcp_route.action

The action to take if a match is determined.

Show child fields
route.spec.tcp_route.action.weighted_targets[]
Show child fields
route.spec.tcp_route.action.weighted_targets[].port

The targeted port of the weighted object.

route.spec.tcp_route.action.weighted_targets[].virtual_node

The virtual node to associate with the weighted target.

route.spec.tcp_route.action.weighted_targets[].weight

The relative weight of the weighted target.

route.spec.tcp_route.match

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

Show child fields
route.spec.tcp_route.match.port

The port number to match on.

route.spec.tcp_route.timeout

An object that represents types of timeouts.

Show child fields
route.spec.tcp_route.timeout.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
route.spec.tcp_route.timeout.idle.unit

A unit of time.

route.spec.tcp_route.timeout.idle.value

A number of time units.

route.status

The status of the route.

Show child fields
route.status.status

The current status for the route.

route.virtual_router_name

The virtual router that the route is associated with.