Describe Route
| appmesh_describe_route | R Documentation |
Describes an existing route¶
Description¶
Describes an existing route.
Usage¶
Arguments¶
meshName[required] The name of the service mesh that the route resides in.
meshOwnerThe 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.
routeName[required] The name of the route to describe.
virtualRouterName[required] The name of the virtual router that the route is associated with.
Value¶
A list with the following syntax:
list(
route = list(
meshName = "string",
metadata = list(
arn = "string",
createdAt = as.POSIXct(
"2015-01-01"
),
lastUpdatedAt = as.POSIXct(
"2015-01-01"
),
meshOwner = "string",
resourceOwner = "string",
uid = "string",
version = 123
),
routeName = "string",
spec = list(
grpcRoute = list(
action = list(
weightedTargets = list(
list(
port = 123,
virtualNode = "string",
weight = 123
)
)
),
match = list(
metadata = list(
list(
invert = TRUE|FALSE,
match = list(
exact = "string",
prefix = "string",
range = list(
end = 123,
start = 123
),
regex = "string",
suffix = "string"
),
name = "string"
)
),
methodName = "string",
port = 123,
serviceName = "string"
),
retryPolicy = list(
grpcRetryEvents = list(
"cancelled"|"deadline-exceeded"|"internal"|"resource-exhausted"|"unavailable"
),
httpRetryEvents = list(
"string"
),
maxRetries = 123,
perRetryTimeout = list(
unit = "s"|"ms",
value = 123
),
tcpRetryEvents = list(
"connection-error"
)
),
timeout = list(
idle = list(
unit = "s"|"ms",
value = 123
),
perRequest = list(
unit = "s"|"ms",
value = 123
)
)
),
http2Route = list(
action = list(
weightedTargets = list(
list(
port = 123,
virtualNode = "string",
weight = 123
)
)
),
match = list(
headers = list(
list(
invert = TRUE|FALSE,
match = list(
exact = "string",
prefix = "string",
range = list(
end = 123,
start = 123
),
regex = "string",
suffix = "string"
),
name = "string"
)
),
method = "GET"|"HEAD"|"POST"|"PUT"|"DELETE"|"CONNECT"|"OPTIONS"|"TRACE"|"PATCH",
path = list(
exact = "string",
regex = "string"
),
port = 123,
prefix = "string",
queryParameters = list(
list(
match = list(
exact = "string"
),
name = "string"
)
),
scheme = "http"|"https"
),
retryPolicy = list(
httpRetryEvents = list(
"string"
),
maxRetries = 123,
perRetryTimeout = list(
unit = "s"|"ms",
value = 123
),
tcpRetryEvents = list(
"connection-error"
)
),
timeout = list(
idle = list(
unit = "s"|"ms",
value = 123
),
perRequest = list(
unit = "s"|"ms",
value = 123
)
)
),
httpRoute = list(
action = list(
weightedTargets = list(
list(
port = 123,
virtualNode = "string",
weight = 123
)
)
),
match = list(
headers = list(
list(
invert = TRUE|FALSE,
match = list(
exact = "string",
prefix = "string",
range = list(
end = 123,
start = 123
),
regex = "string",
suffix = "string"
),
name = "string"
)
),
method = "GET"|"HEAD"|"POST"|"PUT"|"DELETE"|"CONNECT"|"OPTIONS"|"TRACE"|"PATCH",
path = list(
exact = "string",
regex = "string"
),
port = 123,
prefix = "string",
queryParameters = list(
list(
match = list(
exact = "string"
),
name = "string"
)
),
scheme = "http"|"https"
),
retryPolicy = list(
httpRetryEvents = list(
"string"
),
maxRetries = 123,
perRetryTimeout = list(
unit = "s"|"ms",
value = 123
),
tcpRetryEvents = list(
"connection-error"
)
),
timeout = list(
idle = list(
unit = "s"|"ms",
value = 123
),
perRequest = list(
unit = "s"|"ms",
value = 123
)
)
),
priority = 123,
tcpRoute = list(
action = list(
weightedTargets = list(
list(
port = 123,
virtualNode = "string",
weight = 123
)
)
),
match = list(
port = 123
),
timeout = list(
idle = list(
unit = "s"|"ms",
value = 123
)
)
)
),
status = list(
status = "ACTIVE"|"INACTIVE"|"DELETED"
),
virtualRouterName = "string"
)
)