RouteSummary
The summary information for the routes as a response to ListRoutes.
Contents
- AppendSourcePath
-
If set to
true, this option appends the source path to the service URL endpoint.Type: Boolean
Required: No
- ApplicationId
-
The unique identifier of the application.
Type: String
Length Constraints: Fixed length of 14.
Pattern:
^app-[0-9A-Za-z]{10}$Required: No
- Arn
-
The Amazon Resource Name (ARN) of the route.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
^arn:aws:refactor-spaces:[a-zA-Z0-9\-]+:\w{12}:[a-zA-Z_0-9+=,.@\-_/]+$Required: No
- CreatedByAccountId
-
The AWS account ID of the route creator.
Type: String
Length Constraints: Fixed length of 12.
Pattern:
^\d{12}$Required: No
- CreatedTime
-
A timestamp that indicates when the route is created.
Type: Timestamp
Required: No
- EnvironmentId
-
The unique identifier of the environment.
Type: String
Length Constraints: Fixed length of 14.
Pattern:
^env-[0-9A-Za-z]{10}$Required: No
- Error
-
Any error associated with the route resource.
Type: ErrorResponse object
Required: No
- IncludeChildPaths
-
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.Type: Boolean
Required: No
- LastUpdatedTime
-
A timestamp that indicates when the route was last updated.
Type: Timestamp
Required: No
- Methods
-
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.
Type: Array of strings
Valid Values:
DELETE | GET | HEAD | OPTIONS | PATCH | POST | PUTRequired: No
- OwnerAccountId
-
The AWS account ID of the route owner.
Type: String
Length Constraints: Fixed length of 12.
Pattern:
^\d{12}$Required: No
- PathResourceToId
-
A mapping of Amazon API Gateway path resources to resource IDs.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 2048.
Value Length Constraints: Fixed length of 10.
Value Pattern:
^[a-z0-9]{10}$Required: No
- RouteId
-
The unique identifier of the route.
Type: String
Length Constraints: Fixed length of 14.
Pattern:
^rte-[0-9A-Za-z]{10}$Required: No
- RouteType
-
The route type of the route.
Type: String
Valid Values:
DEFAULT | URI_PATHRequired: No
- ServiceId
-
The unique identifier of the service.
Type: String
Length Constraints: Fixed length of 14.
Pattern:
^svc-[0-9A-Za-z]{10}$Required: No
- SourcePath
-
This is the path that Refactor Spaces uses to match traffic. Paths must start with
/and are relative to the base of the application. To use path parameters in the source path, add a variable in curly braces. For example, the resource path {user} represents a path parameter called 'user'.Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^(/([a-zA-Z0-9._:-]+|\{[a-zA-Z0-9._:-]+\}))+$Required: No
- State
-
The current state of the route.
Type: String
Valid Values:
CREATING | ACTIVE | DELETING | FAILED | UPDATING | INACTIVERequired: No
- Tags
-
The tags assigned to the route.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
^(?!aws:).+Value Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
