Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GetRouteCommandOutput

Hierarchy

Index

Properties

$metadata

$metadata: ResponseMetadata

Metadata pertaining to this request.

Optional ApplicationId

ApplicationId: undefined | string

The ID of the application that the route belongs to.

Optional Arn

Arn: undefined | string

The Amazon Resource Name (ARN) of the route.

Optional CreatedByAccountId

CreatedByAccountId: undefined | string

The Amazon Web Services account ID of the route creator.

Optional CreatedTime

CreatedTime: Date

The timestamp of when the route is created.

Optional EnvironmentId

EnvironmentId: undefined | string

Unique identifier of the environment.

Optional Error

Any error associated with the route resource.

Optional IncludeChildPaths

IncludeChildPaths: undefined | false | true

Indicates whether to match all subpaths of the given source path. If this value is false, requests must match the source path exactly before they are forwarded to this route's service.

Optional LastUpdatedTime

LastUpdatedTime: Date

A timestamp that indicates when the route was last updated.

Optional Methods

Methods: (HttpMethod | string)[]

A list of HTTP methods to match. An empty list matches all values. If a method is present, only HTTP requests using that method are forwarded to this route’s service.

Optional OwnerAccountId

OwnerAccountId: undefined | string

The Amazon Web Services account ID of the route owner.

Optional PathResourceToId

PathResourceToId: Record<string, string>

A mapping of Amazon API Gateway path resources to resource IDs.

Optional RouteId

RouteId: undefined | string

The unique identifier of the route.

DEFAULT: All traffic that does not match another route is forwarded to the default route. Applications must have a default route before any other routes can be created.

URI_PATH: A route that is based on a URI path.

Optional RouteType

RouteType: RouteType | string

The type of route.

Optional ServiceId

ServiceId: undefined | string

The unique identifier of the service.

Optional SourcePath

SourcePath: undefined | string

The path to use to match traffic. Paths must start with / and are relative to the base of the application.

Optional State

State: RouteState | string

The current state of the route.

Optional Tags

Tags: Record<string, string>

The tags assigned to the route. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.