--- title: "DELETE /v20190125/meshes/{meshName}/virtualGateways/{virtualGatewayName}" method: DELETE path: "/v20190125/meshes/{meshName}/virtualGateways/{virtualGatewayName}" --- # DELETE /v20190125/meshes/{meshName}/virtualGateways/{virtualGatewayName} `DELETE /v20190125/meshes/{meshName}/virtualGateways/{virtualGatewayName}` Deletes an existing virtual gateway. You cannot delete a virtual gateway if any gateway routes are associated to it. ## Path parameters - `meshName` string, required - `virtualGatewayName` string, required ## Query parameters - `meshOwner` string ## Response `200` Success - DeleteVirtualGatewayOutput - `virtualGateway` object, required — The virtual gateway that was deleted. - `meshName` string, required — The name of the service mesh that the virtual gateway resides in. - `metadata` ResourceMetadata, required — An object that represents metadata for a resource. - `arn` string, required — The full Amazon Resource Name (ARN) for the resource. - `createdAt` string, date-time, required — The Unix epoch timestamp in seconds for when the resource was created. - `lastUpdatedAt` string, date-time, required — The Unix epoch timestamp in seconds for when the resource was last updated. - `meshOwner` string, required — 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. - `resourceOwner` string, required — The Amazon Web Services IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes. - `uid` string, required — The unique identifier for the resource. - `version` integer, required — The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated. - `spec` object, required — The specifications of the virtual gateway. - `backendDefaults` object — A reference to an object that represents the defaults for backends. - `clientPolicy` object — A reference to an object that represents a client policy. - `tls` object — A reference to an object that represents a Transport Layer Security (TLS) client policy. - `certificate` object — A reference to an object that represents a virtual gateway's client's Transport Layer Security (TLS) certificate. - … - `enforce` boolean — Whether the policy is enforced. The default is True, if a value isn't specified. - `ports` PortNumber[] — One or more ports that the policy is enforced for. - `validation` object, required — A reference to an object that represents a Transport Layer Security (TLS) validation context. - … - `listeners` VirtualGatewayListener[], required — The listeners that the mesh endpoint is expected to receive inbound traffic from. You can specify one listener. - `connectionPool` object — The connection pool information for the virtual gateway listener. - `grpc` object — An object that represents a type of connection pool. - `maxRequests` integer, required — Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster. - `http` object — An object that represents a type of connection pool. - `maxConnections` integer, required — Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster. - `maxPendingRequests` integer — Number of overflowing requests after max_connections Envoy will queue to upstream cluster. - `http2` object — An object that represents a type of connection pool. - `maxRequests` integer, required — Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster. - `healthCheck` object — The health check information for the listener. - `healthyThreshold` integer, required — The number of consecutive successful health checks that must occur before declaring the listener healthy. - `intervalMillis` integer, required — The time period in milliseconds between each health check execution. - `path` string — The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored. - `port` integer — The destination port for the health check request. This port must match the port defined in the PortMapping for the listener. - `protocol` 'http' | 'http2' | 'grpc', required — The protocol for the health check request. If you specify grpc, then your service must conform to the GRPC Health Checking Protocol. - `timeoutMillis` integer, required — The amount of time to wait when receiving a response from the health check, in milliseconds. - `unhealthyThreshold` integer, required — The number of consecutive failed health checks that must occur before declaring a virtual gateway unhealthy. - `portMapping` object, required — The port mapping information for the listener. - `port` integer, required — The port used for the port mapping. Specify one protocol. - `protocol` 'http' | 'http2' | 'grpc', required — The protocol used for the port mapping. - `tls` object — A reference to an object that represents the Transport Layer Security (TLS) properties for the listener. - `certificate` object, required — An object that represents a Transport Layer Security (TLS) certificate. - `acm` object — A reference to an object that represents an Certificate Manager certificate. - … - `file` object — A reference to an object that represents a local file certificate. - … - `sds` object — A reference to an object that represents a virtual gateway's listener's Secret Discovery Service certificate. - … - `mode` 'STRICT' | 'PERMISSIVE' | 'DISABLED', required —

Specify one of the following modes.

- `validation` object — A reference to an object that represents a virtual gateway's listener's Transport Layer Security (TLS) validation context. - `subjectAlternativeNames` object — A reference to an object that represents the SANs for a virtual gateway listener's Transport Layer Security (TLS) validation context. - … - `trust` object, required — A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate. - … - `logging` VirtualGatewayLogging — An object that represents logging information. - `accessLog` object — The access log configuration. - `file` object — The file object to send virtual gateway access logs to. - `format` object — The specified format for the virtual gateway access logs. It can be either json_format or text_format. - … - `path` string, required — The file path to write access logs to. You can use /dev/stdout to send access logs to standard out and configure your Envoy container to use a log driver, such as awslogs, to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk. - `status` object, required — The current status of the virtual gateway. - `status` 'ACTIVE' | 'INACTIVE' | 'DELETED', required — The current status. - `virtualGatewayName` string, required — The name of the virtual gateway. ## Other responses - `480` — NotFoundException - `481` — BadRequestException - `482` — TooManyRequestsException - `483` — ForbiddenException - `484` — ResourceInUseException - `485` — ServiceUnavailableException - `486` — InternalServerErrorException --- [API](https://skmtc.net/aws/apis/appmesh.md) · [All operations](https://skmtc.net/aws/apis/appmesh/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/appmesh/versions/bfbda8660009/schema)