Package software.amazon.awssdk.services.ec2.model

Interface ModifyRouteServerRequest.Builder

    • Method Detail

      • routeServerId

        ModifyRouteServerRequest.Builder routeServerId​(String routeServerId)

        The ID of the route server to modify.

        Parameters:
        routeServerId - The ID of the route server to modify.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • persistRoutes

        ModifyRouteServerRequest.Builder persistRoutes​(String persistRoutes)

        Specifies whether to persist routes after all BGP sessions are terminated.

        • enable: Routes will be persisted in FIB and RIB after all BGP sessions are terminated.

        • disable: Routes will not be persisted in FIB and RIB after all BGP sessions are terminated.

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

        Parameters:
        persistRoutes - Specifies whether to persist routes after all BGP sessions are terminated.

        • enable: Routes will be persisted in FIB and RIB after all BGP sessions are terminated.

        • disable: Routes will not be persisted in FIB and RIB after all BGP sessions are terminated.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        RouteServerPersistRoutesAction, RouteServerPersistRoutesAction

      • persistRoutes

        ModifyRouteServerRequest.Builder persistRoutes​(RouteServerPersistRoutesAction persistRoutes)

        Specifies whether to persist routes after all BGP sessions are terminated.

        • enable: Routes will be persisted in FIB and RIB after all BGP sessions are terminated.

        • disable: Routes will not be persisted in FIB and RIB after all BGP sessions are terminated.

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

        Parameters:
        persistRoutes - Specifies whether to persist routes after all BGP sessions are terminated.

        • enable: Routes will be persisted in FIB and RIB after all BGP sessions are terminated.

        • disable: Routes will not be persisted in FIB and RIB after all BGP sessions are terminated.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        RouteServerPersistRoutesAction, RouteServerPersistRoutesAction

      • persistRoutesDuration

        ModifyRouteServerRequest.Builder persistRoutesDuration​(Long persistRoutesDuration)

        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.

        Parameters:
        persistRoutesDuration - 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • snsNotificationsEnabled

        ModifyRouteServerRequest.Builder snsNotificationsEnabled​(Boolean snsNotificationsEnabled)

        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.

        Parameters:
        snsNotificationsEnabled - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dryRun

        ModifyRouteServerRequest.Builder dryRun​(Boolean dryRun)

        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.

        Parameters:
        dryRun - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.