Skip to content

Delete Virtual Gateway

appmesh_delete_virtual_gateway R Documentation

Deletes an existing virtual gateway

Description

Deletes an existing virtual gateway. You cannot delete a virtual gateway if any gateway routes are associated to it.

Usage

appmesh_delete_virtual_gateway(meshName, meshOwner, virtualGatewayName)

Arguments

meshName

[required] The name of the service mesh to delete the virtual gateway from.

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.

virtualGatewayName

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

Value

A list with the following syntax:

list(
  virtualGateway = 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(
      backendDefaults = list(
        clientPolicy = list(
          tls = list(
            certificate = list(
              file = list(
                certificateChain = "string",
                privateKey = "string"
              ),
              sds = list(
                secretName = "string"
              )
            ),
            enforce = TRUE|FALSE,
            ports = list(
              123
            ),
            validation = list(
              subjectAlternativeNames = list(
                match = list(
                  exact = list(
                    "string"
                  )
                )
              ),
              trust = list(
                acm = list(
                  certificateAuthorityArns = list(
                    "string"
                  )
                ),
                file = list(
                  certificateChain = "string"
                ),
                sds = list(
                  secretName = "string"
                )
              )
            )
          )
        )
      ),
      listeners = list(
        list(
          connectionPool = list(
            grpc = list(
              maxRequests = 123
            ),
            http = list(
              maxConnections = 123,
              maxPendingRequests = 123
            ),
            http2 = list(
              maxRequests = 123
            )
          ),
          healthCheck = list(
            healthyThreshold = 123,
            intervalMillis = 123,
            path = "string",
            port = 123,
            protocol = "http"|"http2"|"grpc",
            timeoutMillis = 123,
            unhealthyThreshold = 123
          ),
          portMapping = list(
            port = 123,
            protocol = "http"|"http2"|"grpc"
          ),
          tls = list(
            certificate = list(
              acm = list(
                certificateArn = "string"
              ),
              file = list(
                certificateChain = "string",
                privateKey = "string"
              ),
              sds = list(
                secretName = "string"
              )
            ),
            mode = "STRICT"|"PERMISSIVE"|"DISABLED",
            validation = list(
              subjectAlternativeNames = list(
                match = list(
                  exact = list(
                    "string"
                  )
                )
              ),
              trust = list(
                file = list(
                  certificateChain = "string"
                ),
                sds = list(
                  secretName = "string"
                )
              )
            )
          )
        )
      ),
      logging = list(
        accessLog = list(
          file = list(
            format = list(
              json = list(
                list(
                  key = "string",
                  value = "string"
                )
              ),
              text = "string"
            ),
            path = "string"
          )
        )
      )
    ),
    status = list(
      status = "ACTIVE"|"INACTIVE"|"DELETED"
    ),
    virtualGatewayName = "string"
  )
)

Request syntax

svc$delete_virtual_gateway(
  meshName = "string",
  meshOwner = "string",
  virtualGatewayName = "string"
)