Skip to content

Updates an existing gateway route that is associated to a specified virtual gateway in a service mesh

Description

Updates an existing gateway route that is associated to a specified virtual gateway in a service mesh.

Usage

appmesh_update_gateway_route(clientToken, gatewayRouteName, meshName,
  meshOwner, spec, virtualGatewayName)

Arguments

  • clientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

  • gatewayRouteName

[required] The name of the gateway route to update.

  • meshName

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

  • meshOwner

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.

  • spec

[required] The new gateway route specification to apply. This overwrites the existing data.

  • virtualGatewayName

[required] The name of the virtual gateway that the gateway route is associated with.

Value

A list with the following syntax:

list(
  gatewayRoute = list(
    gatewayRouteName = "string",
    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
    ),
    spec = list(
      grpcRoute = list(
        action = list(
          rewrite = list(
            hostname = list(
              defaultTargetHostname = "ENABLED"|"DISABLED"
            )
          ),
          target = list(
            port = 123,
            virtualService = list(
              virtualServiceName = "string"
            )
          )
        ),
        match = list(
          hostname = list(
            exact = "string",
            suffix = "string"
          ),
          metadata = list(
            list(
              invert = TRUE|FALSE,
              match = list(
                exact = "string",
                prefix = "string",
                range = list(
                  end = 123,
                  start = 123
                ),
                regex = "string",
                suffix = "string"
              ),
              name = "string"
            )
          ),
          port = 123,
          serviceName = "string"
        )
      ),
      http2Route = list(
        action = list(
          rewrite = list(
            hostname = list(
              defaultTargetHostname = "ENABLED"|"DISABLED"
            ),
            path = list(
              exact = "string"
            ),
            prefix = list(
              defaultPrefix = "ENABLED"|"DISABLED",
              value = "string"
            )
          ),
          target = list(
            port = 123,
            virtualService = list(
              virtualServiceName = "string"
            )
          )
        ),
        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"
            )
          ),
          hostname = list(
            exact = "string",
            suffix = "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"
            )
          )
        )
      ),
      httpRoute = list(
        action = list(
          rewrite = list(
            hostname = list(
              defaultTargetHostname = "ENABLED"|"DISABLED"
            ),
            path = list(
              exact = "string"
            ),
            prefix = list(
              defaultPrefix = "ENABLED"|"DISABLED",
              value = "string"
            )
          ),
          target = list(
            port = 123,
            virtualService = list(
              virtualServiceName = "string"
            )
          )
        ),
        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"
            )
          ),
          hostname = list(
            exact = "string",
            suffix = "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"
            )
          )
        )
      ),
      priority = 123
    ),
    status = list(
      status = "ACTIVE"|"INACTIVE"|"DELETED"
    ),
    virtualGatewayName = "string"
  )
)

Request syntax

svc$update_gateway_route(
  clientToken = "string",
  gatewayRouteName = "string",
  meshName = "string",
  meshOwner = "string",
  spec = list(
    grpcRoute = list(
      action = list(
        rewrite = list(
          hostname = list(
            defaultTargetHostname = "ENABLED"|"DISABLED"
          )
        ),
        target = list(
          port = 123,
          virtualService = list(
            virtualServiceName = "string"
          )
        )
      ),
      match = list(
        hostname = list(
          exact = "string",
          suffix = "string"
        ),
        metadata = list(
          list(
            invert = TRUE|FALSE,
            match = list(
              exact = "string",
              prefix = "string",
              range = list(
                end = 123,
                start = 123
              ),
              regex = "string",
              suffix = "string"
            ),
            name = "string"
          )
        ),
        port = 123,
        serviceName = "string"
      )
    ),
    http2Route = list(
      action = list(
        rewrite = list(
          hostname = list(
            defaultTargetHostname = "ENABLED"|"DISABLED"
          ),
          path = list(
            exact = "string"
          ),
          prefix = list(
            defaultPrefix = "ENABLED"|"DISABLED",
            value = "string"
          )
        ),
        target = list(
          port = 123,
          virtualService = list(
            virtualServiceName = "string"
          )
        )
      ),
      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"
          )
        ),
        hostname = list(
          exact = "string",
          suffix = "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"
          )
        )
      )
    ),
    httpRoute = list(
      action = list(
        rewrite = list(
          hostname = list(
            defaultTargetHostname = "ENABLED"|"DISABLED"
          ),
          path = list(
            exact = "string"
          ),
          prefix = list(
            defaultPrefix = "ENABLED"|"DISABLED",
            value = "string"
          )
        ),
        target = list(
          port = 123,
          virtualService = list(
            virtualServiceName = "string"
          )
        )
      ),
      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"
          )
        ),
        hostname = list(
          exact = "string",
          suffix = "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"
          )
        )
      )
    ),
    priority = 123
  ),
  virtualGatewayName = "string"
)