Skip to content

EC2  >  Operations  >  delete_route_server

delete_route_server

Operation

delete_route_server async

delete_route_server(input: DeleteRouteServerInput, plugins: list[Plugin] | None = None) -> DeleteRouteServerOutput

Deletes the specified route server.

Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads.

Route server supports the follow route table types:

  • VPC route tables not associated with subnets

  • Subnet route tables

  • Internet gateway route tables

Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use Transit Gateway Connect.

For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.

Parameters:

Name Type Description Default
input DeleteRouteServerInput

An instance of DeleteRouteServerInput.

required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
DeleteRouteServerOutput

An instance of DeleteRouteServerOutput.

Input

DeleteRouteServerInput dataclass

Bases: _SerdeShape

Dataclass for DeleteRouteServerInput structure.

Attributes

dry_run class-attribute instance-attribute
dry_run: bool | None = ...

A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

route_server_id class-attribute instance-attribute
route_server_id: str | None = ...

The ID of the route server to delete.

Output

DeleteRouteServerOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteRouteServerOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

route_server class-attribute instance-attribute
route_server: RouteServer | None = ...

Information about the deleted route server.