Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!
Get Started for Free

appmesh_describe_route

Describes an existing route


Description

Describes an existing route.

Usage

appmesh_describe_route(meshName, meshOwner, routeName,
  virtualRouterName)

Arguments

meshName

[required] The name of the service mesh that the route resides in.

meshOwner

The AWS 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(
              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",
          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(
              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",
          prefix = "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(
              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",
          prefix = "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(
              virtualNode = "string",
              weight = 123
            )
          )
        ),
        timeout = list(
          idle = list(
            unit = "s"|"ms",
            value = 123
          )
        )
      )
    ),
    status = list(
      status = "ACTIVE"|"INACTIVE"|"DELETED"
    ),
    virtualRouterName = "string"
  )
)

Request syntax

svc$describe_route(
  meshName = "string",
  meshOwner = "string",
  routeName = "string",
  virtualRouterName = "string"
)

paws.networking

Amazon Web Services Networking & Content Delivery Services

v0.1.11
Apache License (>= 2.0)
Authors
David Kretch [aut, cre], Adam Banker [aut], Amazon.com, Inc. [cph]
Initial release

We don't support your browser anymore

Please choose more modern alternatives, such as Google Chrome or Mozilla Firefox.