Delete Virtual Router

appmesh_delete_virtual_router

R Documentation

Deletes an existing virtual router

Description

Deletes an existing virtual router.

You must delete any routes associated with the virtual router before you can delete the router itself.

Usage

appmesh_delete_virtual_router(meshName, meshOwner, virtualRouterName)

Arguments

meshName

[required] The name of the service mesh to delete the virtual router 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.

virtualRouterName

[required] The name of the virtual router to delete.

Value

A list with the following syntax:

list(
  virtualRouter = 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
    ),
    spec = list(
      listeners = list(
        list(
          portMapping = list(
            port = 123,
            protocol = "http"|"tcp"|"http2"|"grpc"
          )
        )
      )
    ),
    status = list(
      status = "ACTIVE"|"INACTIVE"|"DELETED"
    ),
    virtualRouterName = "string"
  )
)

Request syntax

svc$delete_virtual_router(
  meshName = "string",
  meshOwner = "string",
  virtualRouterName = "string"
)