Skip to content

EC2  >  Operations  >  associate_route_server

associate_route_server

Operation

associate_route_server async 

associate_route_server(input: AssociateRouteServerInput, plugins: list[Plugin] | None = None) -> AssociateRouteServerOutput

Associates a route server with a VPC to enable dynamic route updates.

A route server association is the connection established between a route server and a VPC.

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 AssociateRouteServerInput

An instance of AssociateRouteServerInput.

 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
AssociateRouteServerOutput

An instance of AssociateRouteServerOutput.

Input

AssociateRouteServerInput dataclass

Bases: _SerdeShape

Dataclass for AssociateRouteServerInput 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 unique identifier for the route server to be associated.

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

The ID of the VPC to associate with the route server.

Output

AssociateRouteServerOutput dataclass

Bases: _SerdeShape

Dataclass for AssociateRouteServerOutput 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_association class-attribute instance-attribute 
route_server_association: RouteServerAssociation | None = ...

Information about the association between the route server and the VPC.