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

Interface RouteServer.Builder

    • Method Detail

      • routeServerId

        RouteServer.Builder routeServerId​(String routeServerId)

        The unique identifier of the route server.

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

      • amazonSideAsn

        RouteServer.Builder amazonSideAsn​(Long amazonSideAsn)

        The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. 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.

        Parameters:
        amazonSideAsn - The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • state

        RouteServer.Builder state​(String state)

        The current state of the route server.

        Parameters:
        state - The current state of the route server.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        RouteServerState, RouteServerState

      • tags

        RouteServer.Builder tags​(Collection<Tag> tags)

        Any tags assigned to the route server.

        Parameters:
        tags - Any tags assigned to the route server.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        RouteServer.Builder tags​(Tag... tags)

        Any tags assigned to the route server.

        Parameters:
        tags - Any tags assigned to the route server.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        RouteServer.Builder tags​(Consumer<Tag.Builder>... tags)

        Any tags assigned to the route server.

        This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

        Parameters:
        tags - a consumer that will call methods on Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tags(java.util.Collection)

      • persistRoutesDuration

        RouteServer.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. The default value is 1. Only valid if persistRoutesState 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. The default value is 1. Only valid if persistRoutesState 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

        RouteServer.Builder snsNotificationsEnabled​(Boolean snsNotificationsEnabled)

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

        Parameters:
        snsNotificationsEnabled - Indicates whether SNS notifications are enabled for the route server. 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.

      • snsTopicArn

        RouteServer.Builder snsTopicArn​(String snsTopicArn)

        The ARN of the SNS topic where notifications are published.

        Parameters:
        snsTopicArn - The ARN of the SNS topic where notifications are published.
        Returns:
        Returns a reference to this object so that method calls can be chained together.