associate_route_server `async` ¶

associate_route_server(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    route_server_id: Optional[RouteServerId] = None,
    vpc_id: Optional[VpcId] = None,
    dry_run: Optional[Boolean] = None,
) -> AssociateRouteServerResult

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:

route_server_id (Optional[RouteServerId], default: None ) –

The unique identifier for the route server to be associated.
vpc_id (Optional[VpcId], default: None ) –

The ID of the VPC to associate with the route server.
dry_run (Optional[Boolean], default: 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.

Raises:

UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_ec2/_services/async_ec2.py

async def associate_route_server(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    route_server_id: Optional[
        "capo_ec2.types.route_server_id.RouteServerId"
    ] = None,
    vpc_id: Optional["capo_ec2.types.vpc_id.VpcId"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.associate_route_server_result.AssociateRouteServerResult":
    """<p>Associates a route server with a VPC to enable dynamic route updates.</p> <p>A route server association is the connection established between a route server and a VPC.</p> <p>For more information see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/dynamic-routing-route-server.html">Dynamic routing in your VPC with VPC Route Server</a> in the <i>Amazon VPC User Guide</i>.</p>

    Args:
        route_server_id: <p>The unique identifier for the route server to be associated.</p>
        vpc_id: <p>The ID of the VPC to associate with the route server.</p>
        dry_run: <p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ec2.types.associate_route_server_request.AssociateRouteServerRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.associate_route_server_result.AssociateRouteServerResult"
    ]:
        import capo_ec2._operations.amazon_ec2.associate_route_server

        (
            output,
            http_response,
        ) = await capo_ec2._operations.amazon_ec2.associate_route_server.async_associate_route_server(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("AssociateRouteServer")
    )
    input_: capo_ec2.types.associate_route_server_request.AssociateRouteServerRequest = {}
    if route_server_id is not None:
        input_["route_server_id"] = route_server_id
    if vpc_id is not None:
        input_["vpc_id"] = vpc_id
    if dry_run is not None:
        input_["dry_run"] = dry_run

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

associate_route_server async ¶

associate_route_server `async` ¶