Skip to content

create_route_server async

create_route_server(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    amazon_side_asn: Optional[Long] = None,
    client_token: Optional[String] = None,
    dry_run: Optional[Boolean] = None,
    persist_routes: Optional[RouteServerPersistRoutesAction] = None,
    persist_routes_duration: Optional[BoxedLong] = None,
    sns_notifications_enabled: Optional[Boolean] = None,
    tag_specifications: Optional[TagSpecificationList] = None,
) -> CreateRouteServerResult

Creates a new route server to manage dynamic routing in a VPC.

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.

Route server supports the follow route table types:

  • VPC route tables not associated with subnets

  • Subnet route tables

  • Internet gateway route tables

Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use Transit Gateway Connect.

For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.

Parameters:

  • amazon_side_asn (Optional[Long], default: None ) –

    The private Autonomous System Number (ASN) for the Amazon side of the BGP session. Valid values are from 1 to 4294967295. We recommend using a private ASN in the 64512–65534 (16-bit ASN) or 4200000000–4294967294 (32-bit ASN) range.

  • client_token (Optional[String], default: None ) –

    Unique, case-sensitive identifier to ensure idempotency of the request.

  • 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.

  • persist_routes (Optional[RouteServerPersistRoutesAction], default: None ) –

    Indicates whether routes should be persisted after all BGP sessions are terminated.

  • persist_routes_duration (Optional[BoxedLong], default: None ) –

    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 enabled.

    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.

  • sns_notifications_enabled (Optional[Boolean], default: None ) –

    Indicates whether SNS notifications should be enabled for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by Amazon Web Services.

  • tag_specifications (Optional[TagSpecificationList], default: None ) –

    The tags to apply to the route server during creation.

Raises:

Source code in docs_src/capo_ec2/_services/async_ec2.py
async def create_route_server(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    amazon_side_asn: Optional["capo_ec2.types.long.Long"] = None,
    client_token: Optional["capo_ec2.types.string.String"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = 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,
    tag_specifications: Optional[
        "capo_ec2.types.tag_specification_list.TagSpecificationList"
    ] = None,
) -> "capo_ec2.types.create_route_server_result.CreateRouteServerResult":
    """<p>Creates a new route server to manage dynamic routing in a VPC.</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:
        amazon_side_asn: <p>The private Autonomous System Number (ASN) for the Amazon side of the BGP session. Valid values are from 1 to 4294967295. We recommend using a private ASN in the 64512–65534 (16-bit ASN) or 4200000000–4294967294 (32-bit ASN) range.</p>
        client_token: <p>Unique, case-sensitive identifier to ensure idempotency of the request.</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>
        persist_routes: <p>Indicates whether routes should be persisted after all BGP sessions are terminated.</p>
        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>Indicates whether SNS notifications should be enabled for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by Amazon Web Services.</p>
        tag_specifications: <p>The tags to apply to the route server during creation.</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.create_route_server_request.CreateRouteServerRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.create_route_server_result.CreateRouteServerResult"
    ]:
        import capo_ec2._operations.amazon_ec2.create_route_server

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateRouteServer")
    )
    input_: capo_ec2.types.create_route_server_request.CreateRouteServerRequest = {}
    if amazon_side_asn is not None:
        input_["amazon_side_asn"] = amazon_side_asn
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if dry_run is not None:
        input_["dry_run"] = dry_run
    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 tag_specifications is not None:
        input_["tag_specifications"] = tag_specifications

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