software.amazon.awssdk.services.ec2.model

Interface AllocateAddressRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<AllocateAddressRequest.Builder,AllocateAddressRequest>, Ec2Request.Builder, SdkBuilder<AllocateAddressRequest.Builder,AllocateAddressRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

AllocateAddressRequest

public static interface AllocateAddressRequest.Builder
extends Ec2Request.Builder, SdkPojo, CopyableBuilder<AllocateAddressRequest.Builder,AllocateAddressRequest>

Method Summary

Modifier and Type	Method and Description
AllocateAddressRequest.Builder	address(String address) [EC2-VPC] The Elastic IP address to recover or an IPv4 address from an address pool.
AllocateAddressRequest.Builder	customerOwnedIpv4Pool(String customerOwnedIpv4Pool) The ID of a customer-owned address pool.
AllocateAddressRequest.Builder	domain(DomainType domain) Set to vpc to allocate the address for use with instances in a VPC.
AllocateAddressRequest.Builder	domain(String domain) Set to vpc to allocate the address for use with instances in a VPC.
AllocateAddressRequest.Builder	networkBorderGroup(String networkBorderGroup) The location from which the IP address is advertised.
AllocateAddressRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AllocateAddressRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AllocateAddressRequest.Builder	publicIpv4Pool(String publicIpv4Pool) The ID of an address pool that you own.

Methods inherited from interface software.amazon.awssdk.services.ec2.model.Ec2Request.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

domain

AllocateAddressRequest.Builder domain(String domain)

Set to vpc to allocate the address for use with instances in a VPC.

Default: The address is for use with instances in EC2-Classic.

Parameters:

domain - Set to vpc to allocate the address for use with instances in a VPC.

Default: The address is for use with instances in EC2-Classic.

Returns:

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

See Also:

DomainType, DomainType

domain

AllocateAddressRequest.Builder domain(DomainType domain)

Set to vpc to allocate the address for use with instances in a VPC.

Default: The address is for use with instances in EC2-Classic.

Parameters:

domain - Set to vpc to allocate the address for use with instances in a VPC.

Default: The address is for use with instances in EC2-Classic.

Returns:

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

See Also:

DomainType, DomainType

address

AllocateAddressRequest.Builder address(String address)

[EC2-VPC] The Elastic IP address to recover or an IPv4 address from an address pool.

Parameters:

address - [EC2-VPC] The Elastic IP address to recover or an IPv4 address from an address pool.

Returns:

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

publicIpv4Pool

AllocateAddressRequest.Builder publicIpv4Pool(String publicIpv4Pool)

The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool. To specify a specific address from the address pool, use the Address parameter instead.

Parameters:

publicIpv4Pool - The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool. To specify a specific address from the address pool, use the Address parameter instead.

Returns:

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

networkBorderGroup

AllocateAddressRequest.Builder networkBorderGroup(String networkBorderGroup)

The location from which the IP address is advertised. Use this parameter to limit the address to this location.

A network border group is a unique set of Availability Zones or Local Zones from where AWS advertises IP addresses and limits the addresses to the group. IP addresses cannot move between network border groups.

Use DescribeAvailabilityZones to view the network border groups.

You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 classic, you will receive an InvalidParameterCombination error. For more information, see Error Codes.

Parameters:

networkBorderGroup - The location from which the IP address is advertised. Use this parameter to limit the address to this location.

A network border group is a unique set of Availability Zones or Local Zones from where AWS advertises IP addresses and limits the addresses to the group. IP addresses cannot move between network border groups.

Use DescribeAvailabilityZones to view the network border groups.

You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 classic, you will receive an InvalidParameterCombination error. For more information, see Error Codes.

Returns:

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

customerOwnedIpv4Pool

AllocateAddressRequest.Builder customerOwnedIpv4Pool(String customerOwnedIpv4Pool)

The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 select an address from the address pool. Alternatively, specify a specific address from the address pool.

Parameters:

customerOwnedIpv4Pool - The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 select an address from the address pool. Alternatively, specify a specific address from the address pool.

Returns:

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

overrideConfiguration

AllocateAddressRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

AllocateAddressRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder