Interface CreateRouteServerRequest.Builder

  • Method Details

    • amazonSideAsn

      CreateRouteServerRequest.Builder amazonSideAsn(Long amazonSideAsn)

      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.

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

      CreateRouteServerRequest.Builder clientToken(String clientToken)

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

      Parameters:
      clientToken - Unique, case-sensitive identifier to ensure idempotency of the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • 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.
    • persistRoutes

      CreateRouteServerRequest.Builder persistRoutes(String persistRoutes)

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

      Parameters:
      persistRoutes - Indicates whether routes should be persisted after all BGP sessions are terminated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • persistRoutes

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

      Parameters:
      persistRoutes - Indicates whether routes should be persisted after all BGP sessions are terminated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • persistRoutesDuration

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

      CreateRouteServerRequest.Builder snsNotificationsEnabled(Boolean snsNotificationsEnabled)

      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.

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

      CreateRouteServerRequest.Builder tagSpecifications(Collection<TagSpecification> tagSpecifications)

      The tags to apply to the route server during creation.

      Parameters:
      tagSpecifications - The tags to apply to the route server during creation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • tagSpecifications

      CreateRouteServerRequest.Builder tagSpecifications(TagSpecification... tagSpecifications)

      The tags to apply to the route server during creation.

      Parameters:
      tagSpecifications - The tags to apply to the route server during creation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • tagSpecifications

      CreateRouteServerRequest.Builder tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications)

      The tags to apply to the route server during creation.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tagSpecifications(List<TagSpecification>).

      Parameters:
      tagSpecifications - a consumer that will call methods on TagSpecification.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • overrideConfiguration

      CreateRouteServerRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.
    • overrideConfiguration

      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.