enable_route_server_propagation `async` ¶

enable_route_server_propagation(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    route_server_id: Optional[RouteServerId] = None,
    route_table_id: Optional[RouteTableId] = None,
    dry_run: Optional[Boolean] = None,
) -> EnableRouteServerPropagationResult

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:

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

The ID of the route server for which to enable propagation.
route_table_id (Optional[RouteTableId], default: None ) –

The ID of the route table to which route server will propagate routes.
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 enable_route_server_propagation(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    route_server_id: Optional[
        "capo_ec2.types.route_server_id.RouteServerId"
    ] = None,
    route_table_id: Optional["capo_ec2.types.route_table_id.RouteTableId"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.enable_route_server_propagation_result.EnableRouteServerPropagationResult":
    """<p>Defines which route tables the route server can update with routes.</p> <p>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.</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 ID of the route server for which to enable propagation.</p>
        route_table_id: <p>The ID of the route table to which route server will propagate routes.</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.enable_route_server_propagation_request.EnableRouteServerPropagationRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.enable_route_server_propagation_result.EnableRouteServerPropagationResult"
    ]:
        import capo_ec2._operations.amazon_ec2.enable_route_server_propagation

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("EnableRouteServerPropagation")
    )
    input_: capo_ec2.types.enable_route_server_propagation_request.EnableRouteServerPropagationRequest = {}
    if route_server_id is not None:
        input_["route_server_id"] = route_server_id
    if route_table_id is not None:
        input_["route_table_id"] = route_table_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

enable_route_server_propagation async ¶

enable_route_server_propagation `async` ¶