Interface NewPrivateVirtualInterfaceAllocation.Builder

All Superinterfaces:
Buildable, CopyableBuilder<NewPrivateVirtualInterfaceAllocation.Builder,NewPrivateVirtualInterfaceAllocation>, SdkBuilder<NewPrivateVirtualInterfaceAllocation.Builder,NewPrivateVirtualInterfaceAllocation>, SdkPojo
Enclosing class:
NewPrivateVirtualInterfaceAllocation
@Mutable @NotThreadSafe public static interface NewPrivateVirtualInterfaceAllocation.Builder extends SdkPojo, CopyableBuilder<NewPrivateVirtualInterfaceAllocation.Builder,NewPrivateVirtualInterfaceAllocation>

  • Method Details

    • virtualInterfaceName

      NewPrivateVirtualInterfaceAllocation.Builder virtualInterfaceName(String virtualInterfaceName)

      The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

      Parameters:
      virtualInterfaceName - The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vlan

      NewPrivateVirtualInterfaceAllocation.Builder vlan(Integer vlan)

      The ID of the VLAN.

      Parameters:
      vlan - The ID of the VLAN.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • asn

      NewPrivateVirtualInterfaceAllocation.Builder asn(Integer asn)

      The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead.

      • You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.

      • If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.

      • If you enter a 4-byte ASN for the asn parameter, the API returns an error.

      • If you are using a 2-byte ASN, the API response will include the 2-byte value for both the asn and asnLong fields.

      The valid values are 1-2147483646.

      Parameters:
      asn - The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead.

      • You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.

      • If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.

      • If you enter a 4-byte ASN for the asn parameter, the API returns an error.

      • If you are using a 2-byte ASN, the API response will include the 2-byte value for both the asn and asnLong fields.

      The valid values are 1-2147483646.

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

    • asnLong

      NewPrivateVirtualInterfaceAllocation.Builder asnLong(Long asnLong)

      The ASN when allocating a new private virtual interface. The valid range is from 1 to 4294967294 for BGP configuration.

      Note the following limitations when using asnLong:

      • You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.

      • asnLong accepts any valid ASN value, regardless if it's 2-byte or 4-byte.

      • When using a 4-byte asnLong, the API response returns 0 for the legacy asn attribute since 4-byte ASN values exceed the maximum supported value of 2,147,483,647.

      • If you are using a 2-byte ASN, the API response will include the 2-byte value for both the asn and asnLong fields.

      • If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.

      Parameters:
      asnLong - The ASN when allocating a new private virtual interface. The valid range is from 1 to 4294967294 for BGP configuration.

      Note the following limitations when using asnLong:

      • You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.

      • asnLong accepts any valid ASN value, regardless if it's 2-byte or 4-byte.

      • When using a 4-byte asnLong, the API response returns 0 for the legacy asn attribute since 4-byte ASN values exceed the maximum supported value of 2,147,483,647.

      • If you are using a 2-byte ASN, the API response will include the 2-byte value for both the asn and asnLong fields.

      • If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.

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

    • mtu

      NewPrivateVirtualInterfaceAllocation.Builder mtu(Integer mtu)

      The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500.

      Parameters:
      mtu - The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • authKey

      NewPrivateVirtualInterfaceAllocation.Builder authKey(String authKey)

      The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

      Parameters:
      authKey - The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • amazonAddress

      NewPrivateVirtualInterfaceAllocation.Builder amazonAddress(String amazonAddress)

      The IP address assigned to the Amazon interface.

      Parameters:
      amazonAddress - The IP address assigned to the Amazon interface.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • addressFamily

      NewPrivateVirtualInterfaceAllocation.Builder addressFamily(String addressFamily)

      The address family for the BGP peer.

      Parameters:
      addressFamily - The address family for the BGP peer.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • addressFamily

      NewPrivateVirtualInterfaceAllocation.Builder addressFamily(AddressFamily addressFamily)

      The address family for the BGP peer.

      Parameters:
      addressFamily - The address family for the BGP peer.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • customerAddress

      NewPrivateVirtualInterfaceAllocation.Builder customerAddress(String customerAddress)

      The IP address assigned to the customer interface.

      Parameters:
      customerAddress - The IP address assigned to the customer interface.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      NewPrivateVirtualInterfaceAllocation.Builder tags(Collection<Tag> tags)

      The tags associated with the private virtual interface.

      Parameters:
      tags - The tags associated with the private virtual interface.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      NewPrivateVirtualInterfaceAllocation.Builder tags(Tag... tags)

      The tags associated with the private virtual interface.

      Parameters:
      tags - The tags associated with the private virtual interface.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      NewPrivateVirtualInterfaceAllocation.Builder tags(Consumer<Tag.Builder>... tags)

      The tags associated with the private virtual interface.

      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<Tag>).

      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:

    • rateLimit

      NewPrivateVirtualInterfaceAllocation.Builder rateLimit(String rateLimit)

      The rate limit (bandwidth allocation) to apply to the virtual interface. The rate limit restricts the maximum bandwidth that the virtual interface can use on the parent connection.

      Parameters:
      rateLimit - The rate limit (bandwidth allocation) to apply to the virtual interface. The rate limit restricts the maximum bandwidth that the virtual interface can use on the parent connection.
      Returns:
      Returns a reference to this object so that method calls can be chained together.