Skip to content

EC2  >  Operations  >  disable_route_server_propagation

disable_route_server_propagation

Operation

disable_route_server_propagation async

disable_route_server_propagation(request: DisableRouteServerPropagationInput | DisableRouteServerPropagationInputDict, /, *, plugins: list[Plugin] | None = None) -> DisableRouteServerPropagationOutput
disable_route_server_propagation(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DisableRouteServerPropagationInputDict]) -> DisableRouteServerPropagationOutput

Disables route propagation from a route server to a specified route table.

When enabled, route server propagation installs the routes in the FIB on the route table you've specified. Route server supports IPv4 and IPv6 route propagation.

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
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
DisableRouteServerPropagationOutput

An instance of DisableRouteServerPropagationOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

DisableRouteServerPropagationInput dataclass

Bases: _SerdeShape

Dataclass for DisableRouteServerPropagationInput 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 for which to disable propagation.

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

The ID of the route table for which to disable route server propagation.

Dictionaries

DisableRouteServerPropagationInputDict

Bases: TypedDict

Dictionary form of DisableRouteServerPropagationInput.

Attributes
dry_run 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 instance-attribute
route_server_id: Required[str]

The ID of the route server for which to disable propagation.

route_table_id instance-attribute
route_table_id: Required[str]

The ID of the route table for which to disable route server propagation.

Output

DisableRouteServerPropagationOutput dataclass

Bases: _SerdeShape

Dataclass for DisableRouteServerPropagationOutput 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_propagation class-attribute instance-attribute
route_server_propagation: RouteServerPropagation | None = ...

Information about the disabled route server propagation.