Skip to content

EC2  >  Operations  >  enable_route_server_propagation

enable_route_server_propagation

Operation

enable_route_server_propagation async

enable_route_server_propagation(request: EnableRouteServerPropagationInput | EnableRouteServerPropagationInputDict, /, *, plugins: list[Plugin] | None = None) -> EnableRouteServerPropagationOutput
enable_route_server_propagation(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[EnableRouteServerPropagationInputDict]) -> EnableRouteServerPropagationOutput

Defines which route tables the route server can update with routes.

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.

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
EnableRouteServerPropagationOutput

An instance of EnableRouteServerPropagationOutput.

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

EnableRouteServerPropagationInput dataclass

Bases: _SerdeShape

Dataclass for EnableRouteServerPropagationInput 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 enable propagation.

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

The ID of the route table to which route server will propagate routes.

Dictionaries

EnableRouteServerPropagationInputDict

Bases: TypedDict

Dictionary form of EnableRouteServerPropagationInput.

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 enable propagation.

route_table_id instance-attribute
route_table_id: Required[str]

The ID of the route table to which route server will propagate routes.

Output

EnableRouteServerPropagationOutput dataclass

Bases: _SerdeShape

Dataclass for EnableRouteServerPropagationOutput 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 enabled route server propagation.