modify_route_server ¶

def modify_route_server(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    route_server_id: Optional[
        "capo_ec2.types.route_server_id.RouteServerId"
    ] = None,
    persist_routes: Optional[
        "capo_ec2.types.route_server_persist_routes_action.RouteServerPersistRoutesAction"
    ] = None,
    persist_routes_duration: Optional["capo_ec2.types.boxed_long.BoxedLong"] = None,
    sns_notifications_enabled: Optional["capo_ec2.types.boolean.Boolean"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.modify_route_server_result.ModifyRouteServerResult":
    """<p>Modifies the configuration of an existing route server.</p> <p>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.</p> <p>Route server supports the follow route table types:</p> <ul> <li> <p>VPC route tables not associated with subnets</p> </li> <li> <p>Subnet route tables</p> </li> <li> <p>Internet gateway route tables</p> </li> </ul> <p>Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use <a href="https://docs.aws.amazon.com/vpc/latest/tgw/tgw-connect.html">Transit Gateway Connect</a>.</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 to modify.</p>
        persist_routes: <p>Specifies whether to persist routes after all BGP sessions are terminated.</p> <ul> <li> <p>enable: Routes will be persisted in FIB and RIB after all BGP sessions are terminated.</p> </li> <li> <p>disable: Routes will not be persisted in FIB and RIB after all BGP sessions are terminated.</p> </li> <li> <p>reset: If a route server has persisted routes due to all BGP sessions having ended, reset will withdraw all routes and reset route server to an empty FIB and RIB.</p> </li> </ul>
        persist_routes_duration: <p>The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. Required if PersistRoutes is <code>enabled</code>.</p> <p>If you set the duration to 1 minute, then when your network appliance re-establishes BGP with route server, it has 1 minute to relearn it's adjacent network and advertise those routes to route server before route server resumes normal functionality. In most cases, 1 minute is probably sufficient. If, however, you have concerns that your BGP network may not be capable of fully re-establishing and re-learning everything in 1 minute, you can increase the duration up to 5 minutes.</p>
        sns_notifications_enabled: <p>Specifies whether to enable SNS notifications for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by Amazon Web Services.</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.
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.modify_route_server_request.ModifyRouteServerRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.modify_route_server_result.ModifyRouteServerResult"
    ]:
        import capo_ec2._operations.amazon_ec2.modify_route_server

        output, http_response = (
            capo_ec2._operations.amazon_ec2.modify_route_server.modify_route_server(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ModifyRouteServer")
    )
    input_: capo_ec2.types.modify_route_server_request.ModifyRouteServerRequest = {}
    if route_server_id is not None:
        input_["route_server_id"] = route_server_id
    if persist_routes is not None:
        input_["persist_routes"] = persist_routes
    if persist_routes_duration is not None:
        input_["persist_routes_duration"] = persist_routes_duration
    if sns_notifications_enabled is not None:
        input_["sns_notifications_enabled"] = sns_notifications_enabled
    if dry_run is not None:
        input_["dry_run"] = dry_run

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output