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

Interface ProvisionByoipCidrRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<ProvisionByoipCidrRequest.Builder,ProvisionByoipCidrRequest>, Ec2Request.Builder, SdkBuilder<ProvisionByoipCidrRequest.Builder,ProvisionByoipCidrRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
ProvisionByoipCidrRequest
public static interface ProvisionByoipCidrRequest.Builder extends Ec2Request.Builder, SdkPojo, CopyableBuilder<ProvisionByoipCidrRequest.Builder,ProvisionByoipCidrRequest>

  • Method Details

    • cidr

      ProvisionByoipCidrRequest.Builder cidr(String cidr)

      The public IPv4 or IPv6 address range, in CIDR notation. The most specific IPv4 prefix that you can specify is /24. The most specific IPv6 address range that you can bring is /48 for CIDRs that are publicly advertisable and /56 for CIDRs that are not publicly advertisable. The address range cannot overlap with another address range that you've brought to this or another Region.

      Parameters:
      cidr - The public IPv4 or IPv6 address range, in CIDR notation. The most specific IPv4 prefix that you can specify is /24. The most specific IPv6 address range that you can bring is /48 for CIDRs that are publicly advertisable and /56 for CIDRs that are not publicly advertisable. The address range cannot overlap with another address range that you've brought to this or another Region.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cidrAuthorizationContext

      ProvisionByoipCidrRequest.Builder cidrAuthorizationContext(CidrAuthorizationContext cidrAuthorizationContext)

      A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.

      Parameters:
      cidrAuthorizationContext - A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cidrAuthorizationContext

      default ProvisionByoipCidrRequest.Builder cidrAuthorizationContext(Consumer<CidrAuthorizationContext.Builder> cidrAuthorizationContext)

      A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to cidrAuthorizationContext(CidrAuthorizationContext).

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

    • publiclyAdvertisable

      ProvisionByoipCidrRequest.Builder publiclyAdvertisable(Boolean publiclyAdvertisable)

      (IPv6 only) Indicate whether the address range will be publicly advertised to the internet.

      Default: true

      Parameters:
      publiclyAdvertisable - (IPv6 only) Indicate whether the address range will be publicly advertised to the internet.

      Default: true

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

    • description

      ProvisionByoipCidrRequest.Builder description(String description)

      A description for the address range and the address pool.

      Parameters:
      description - A description for the address range and the address pool.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dryRun

      ProvisionByoipCidrRequest.Builder dryRun(Boolean dryRun)

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

    • poolTagSpecifications

      ProvisionByoipCidrRequest.Builder poolTagSpecifications(Collection<TagSpecification> poolTagSpecifications)

      The tags to apply to the address pool.

      Parameters:
      poolTagSpecifications - The tags to apply to the address pool.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • poolTagSpecifications

      ProvisionByoipCidrRequest.Builder poolTagSpecifications(TagSpecification... poolTagSpecifications)

      The tags to apply to the address pool.

      Parameters:
      poolTagSpecifications - The tags to apply to the address pool.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • poolTagSpecifications

      ProvisionByoipCidrRequest.Builder poolTagSpecifications(Consumer<TagSpecification.Builder>... poolTagSpecifications)

      The tags to apply to the address pool.

      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 poolTagSpecifications(List<TagSpecification>).

      Parameters:
      poolTagSpecifications - 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:

    • multiRegion

      ProvisionByoipCidrRequest.Builder multiRegion(Boolean multiRegion)

      Reserved.

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

    • networkBorderGroup

      ProvisionByoipCidrRequest.Builder networkBorderGroup(String networkBorderGroup)

      If you have Local Zones enabled, you can choose a network border group for Local Zones when you provision and advertise a BYOIPv4 CIDR. Choose the network border group carefully as the EIP and the Amazon Web Services resource it is associated with must reside in the same network border group.

      You can provision BYOIP address ranges to and advertise them in the following Local Zone network border groups:

      • us-east-1-dfw-2

      • us-west-2-lax-1

      • us-west-2-phx-2

      You cannot provision or advertise BYOIPv6 address ranges in Local Zones at this time.

      Parameters:
      networkBorderGroup - If you have Local Zones enabled, you can choose a network border group for Local Zones when you provision and advertise a BYOIPv4 CIDR. Choose the network border group carefully as the EIP and the Amazon Web Services resource it is associated with must reside in the same network border group.

      You can provision BYOIP address ranges to and advertise them in the following Local Zone network border groups:

      • us-east-1-dfw-2

      • us-west-2-lax-1

      • us-west-2-phx-2

      You cannot provision or advertise BYOIPv6 address ranges in Local Zones at this time.

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

    • overrideConfiguration

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

      ProvisionByoipCidrRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      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.