Skip to content
AWS for Query.Farm

aws.appmesh.describe_gateway_route

Example SQL Queries

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

Description

Describes an existing gateway route.

Table Definition

Column NameColumn Data Type
gateway_route_name Required Input Column

The name of the gateway route to describe.

VARCHAR
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 that the gateway 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
gateway_route

The full description of your gateway route.

STRUCT(
    "gateway_route_name" VARCHAR,
    "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(
        "grpc_route" STRUCT(
            "action" STRUCT(
                "rewrite" STRUCT(
                    "hostname" STRUCT(
                        "default_target_hostname" VARCHAR
                    )
                ),
                "target" STRUCT(
                    "port" BIGINT,
                    "virtual_service" STRUCT(
                        "virtual_service_name" VARCHAR
                    )
                )
            ),
            "match" STRUCT(
                "hostname" STRUCT(
                    "exact" VARCHAR,
                    "suffix" VARCHAR
                ),
                "metadata" STRUCT(
                    "invert" BOOLEAN,
                    "match" STRUCT(
                        "exact" VARCHAR,
                        "prefix" VARCHAR,
                        "range" STRUCT(
                            "end" BIGINT,
                            "start" BIGINT
                        ),
                        "regex" VARCHAR,
                        "suffix" VARCHAR
                    ),
                    "name" VARCHAR
                )[],
                "port" BIGINT,
                "service_name" VARCHAR
            )
        ),
        "http2_route" STRUCT(
            "action" STRUCT(
                "rewrite" STRUCT(
                    "hostname" STRUCT(
                        "default_target_hostname" VARCHAR
                    ),
                    "path" STRUCT(
                        "exact" VARCHAR
                    ),
                    "prefix" STRUCT(
                        "default_prefix" VARCHAR,
                        "value" VARCHAR
                    )
                ),
                "target" STRUCT(
                    "port" BIGINT,
                    "virtual_service" STRUCT(
                        "virtual_service_name" VARCHAR
                    )
                )
            ),
            "match" STRUCT(
                "headers" STRUCT(
                    "invert" BOOLEAN,
                    "match" STRUCT(
                        "exact" VARCHAR,
                        "prefix" VARCHAR,
                        "range" STRUCT(
                            "end" BIGINT,
                            "start" BIGINT
                        ),
                        "regex" VARCHAR,
                        "suffix" VARCHAR
                    ),
                    "name" VARCHAR
                )[],
                "hostname" STRUCT(
                    "exact" VARCHAR,
                    "suffix" VARCHAR
                ),
                "method" VARCHAR,
                "path" STRUCT(
                    "exact" VARCHAR,
                    "regex" VARCHAR
                ),
                "port" BIGINT,
                "prefix" VARCHAR,
                "query_parameters" STRUCT(
                    "match" STRUCT(
                        "exact" VARCHAR
                    ),
                    "name" VARCHAR
                )[]
            )
        ),
        "http_route" STRUCT(
            "action" STRUCT(
                "rewrite" STRUCT(
                    "hostname" STRUCT(
                        "default_target_hostname" VARCHAR
                    ),
                    "path" STRUCT(
                        "exact" VARCHAR
                    ),
                    "prefix" STRUCT(
                        "default_prefix" VARCHAR,
                        "value" VARCHAR
                    )
                ),
                "target" STRUCT(
                    "port" BIGINT,
                    "virtual_service" STRUCT(
                        "virtual_service_name" VARCHAR
                    )
                )
            ),
            "match" STRUCT(
                "headers" STRUCT(
                    "invert" BOOLEAN,
                    "match" STRUCT(
                        "exact" VARCHAR,
                        "prefix" VARCHAR,
                        "range" STRUCT(
                            "end" BIGINT,
                            "start" BIGINT
                        ),
                        "regex" VARCHAR,
                        "suffix" VARCHAR
                    ),
                    "name" VARCHAR
                )[],
                "hostname" STRUCT(
                    "exact" VARCHAR,
                    "suffix" VARCHAR
                ),
                "method" VARCHAR,
                "path" STRUCT(
                    "exact" VARCHAR,
                    "regex" VARCHAR
                ),
                "port" BIGINT,
                "prefix" VARCHAR,
                "query_parameters" STRUCT(
                    "match" STRUCT(
                        "exact" VARCHAR
                    ),
                    "name" VARCHAR
                )[]
            )
        ),
        "priority" BIGINT
    ),
    "status" STRUCT(
        "status" VARCHAR
    ),
    "virtual_gateway_name" VARCHAR
)
Show child fields
gateway_route.gateway_route_name

The name of the gateway route.

gateway_route.mesh_name

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

gateway_route.metadata

An object that represents metadata for a resource.

Show child fields
gateway_route.metadata.arn

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

gateway_route.metadata.created_at

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

gateway_route.metadata.last_updated_at

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

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

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

gateway_route.metadata.uid

The unique identifier for the resource.

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

gateway_route.spec

The specifications of the gateway route.

Show child fields
gateway_route.spec.grpc_route

An object that represents the specification of a gRPC gateway route.

Show child fields
gateway_route.spec.grpc_route.action

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

Show child fields
gateway_route.spec.grpc_route.action.rewrite

The gateway route action to rewrite.

Show child fields
gateway_route.spec.grpc_route.action.rewrite.hostname

The host name of the gateway route to rewrite.

Show child fields
gateway_route.spec.grpc_route.action.rewrite.hostname.default_target_hostname

The default target host name to write to.

gateway_route.spec.grpc_route.action.target

An object that represents the target that traffic is routed to when a request matches the gateway route.

Show child fields
gateway_route.spec.grpc_route.action.target.port

The port number of the gateway route target.

gateway_route.spec.grpc_route.action.target.virtual_service

An object that represents a virtual service gateway route target.

Show child fields
gateway_route.spec.grpc_route.action.target.virtual_service.virtual_service_name

The name of the virtual service that traffic is routed to.

gateway_route.spec.grpc_route.match

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

Show child fields
gateway_route.spec.grpc_route.match.hostname

The gateway route host name to be matched on.

Show child fields
gateway_route.spec.grpc_route.match.hostname.exact

The exact host name to match on.

gateway_route.spec.grpc_route.match.hostname.suffix

The specified ending characters of the host name to match on.

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

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

gateway_route.spec.grpc_route.match.metadata[].match

The criteria for determining a metadata match.

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

The exact method header to be matched on.

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

The specified beginning characters of the method header to be matched on.

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

An object that represents the range of values to match on. The first character of the range is included in the range, though the last character is not. For example, if the range specified were 1-100, only values 1-99 would be matched.

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

The end of the range.

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

The start of the range.

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

The regex used to match the method header.

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

The specified ending characters of the method header to match on.

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

A name for the gateway route metadata.

gateway_route.spec.grpc_route.match.port

The gateway route port to be matched on.

gateway_route.spec.grpc_route.match.service_name

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

gateway_route.spec.http2_route

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

Show child fields
gateway_route.spec.http2_route.action

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

Show child fields
gateway_route.spec.http2_route.action.rewrite

The gateway route action to rewrite.

Show child fields
gateway_route.spec.http2_route.action.rewrite.hostname

The host name to rewrite.

Show child fields
gateway_route.spec.http2_route.action.rewrite.hostname.default_target_hostname

The default target host name to write to.

gateway_route.spec.http2_route.action.rewrite.path

The path to rewrite.

Show child fields
gateway_route.spec.http2_route.action.rewrite.path.exact

The exact path to rewrite.

gateway_route.spec.http2_route.action.rewrite.prefix

The specified beginning characters to rewrite.

Show child fields
gateway_route.spec.http2_route.action.rewrite.prefix.default_prefix

The default prefix used to replace the incoming route prefix when rewritten.

gateway_route.spec.http2_route.action.rewrite.prefix.value

The value used to replace the incoming route prefix when rewritten.

gateway_route.spec.http2_route.action.target

An object that represents the target that traffic is routed to when a request matches the gateway route.

Show child fields
gateway_route.spec.http2_route.action.target.port

The port number of the gateway route target.

gateway_route.spec.http2_route.action.target.virtual_service

An object that represents a virtual service gateway route target.

Show child fields
gateway_route.spec.http2_route.action.target.virtual_service.virtual_service_name

The name of the virtual service that traffic is routed to.

gateway_route.spec.http2_route.match

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

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

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

gateway_route.spec.http2_route.match.headers[].match

An object that represents the method and value to match with the header value sent in a request. Specify one match method.

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

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

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

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

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

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

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

The end of the range.

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

The start of the range.

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

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

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

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

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

A name for the HTTP header in the gateway route that will be matched on.

gateway_route.spec.http2_route.match.hostname

The host name to match on.

Show child fields
gateway_route.spec.http2_route.match.hostname.exact

The exact host name to match on.

gateway_route.spec.http2_route.match.hostname.suffix

The specified ending characters of the host name to match on.

gateway_route.spec.http2_route.match.method

The method to match on.

gateway_route.spec.http2_route.match.path

The path to match on.

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

The exact path to match on.

gateway_route.spec.http2_route.match.path.regex

The regex used to match the path.

gateway_route.spec.http2_route.match.port

The port number to match on.

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

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

The query parameter to match on.

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

The exact query parameter to match on.

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

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

gateway_route.spec.http_route

An object that represents the specification of an HTTP gateway route.

Show child fields
gateway_route.spec.http_route.action

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

Show child fields
gateway_route.spec.http_route.action.rewrite

The gateway route action to rewrite.

Show child fields
gateway_route.spec.http_route.action.rewrite.hostname

The host name to rewrite.

Show child fields
gateway_route.spec.http_route.action.rewrite.hostname.default_target_hostname

The default target host name to write to.

gateway_route.spec.http_route.action.rewrite.path

The path to rewrite.

Show child fields
gateway_route.spec.http_route.action.rewrite.path.exact

The exact path to rewrite.

gateway_route.spec.http_route.action.rewrite.prefix

The specified beginning characters to rewrite.

Show child fields
gateway_route.spec.http_route.action.rewrite.prefix.default_prefix

The default prefix used to replace the incoming route prefix when rewritten.

gateway_route.spec.http_route.action.rewrite.prefix.value

The value used to replace the incoming route prefix when rewritten.

gateway_route.spec.http_route.action.target

An object that represents the target that traffic is routed to when a request matches the gateway route.

Show child fields
gateway_route.spec.http_route.action.target.port

The port number of the gateway route target.

gateway_route.spec.http_route.action.target.virtual_service

An object that represents a virtual service gateway route target.

Show child fields
gateway_route.spec.http_route.action.target.virtual_service.virtual_service_name

The name of the virtual service that traffic is routed to.

gateway_route.spec.http_route.match

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

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

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

gateway_route.spec.http_route.match.headers[].match

An object that represents the method and value to match with the header value sent in a request. Specify one match method.

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

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

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

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

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

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

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

The end of the range.

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

The start of the range.

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

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

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

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

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

A name for the HTTP header in the gateway route that will be matched on.

gateway_route.spec.http_route.match.hostname

The host name to match on.

Show child fields
gateway_route.spec.http_route.match.hostname.exact

The exact host name to match on.

gateway_route.spec.http_route.match.hostname.suffix

The specified ending characters of the host name to match on.

gateway_route.spec.http_route.match.method

The method to match on.

gateway_route.spec.http_route.match.path

The path to match on.

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

The exact path to match on.

gateway_route.spec.http_route.match.path.regex

The regex used to match the path.

gateway_route.spec.http_route.match.port

The port number to match on.

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

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

The query parameter to match on.

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

The exact query parameter to match on.

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

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

gateway_route.spec.priority

The ordering of the gateway routes spec.

gateway_route.status

The status of the gateway route.

Show child fields
gateway_route.status.status

The current status for the gateway route.

gateway_route.virtual_gateway_name

The virtual gateway that the gateway route is associated with.