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

Class AssignPrivateIpAddressesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ec2.model.Ec2Request

software.amazon.awssdk.services.ec2.model.AssignPrivateIpAddressesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<AssignPrivateIpAddressesRequest.Builder,AssignPrivateIpAddressesRequest>

@Generated("software.amazon.awssdk:codegen")
public final class AssignPrivateIpAddressesRequest
extends Ec2Request
implements ToCopyableBuilder<AssignPrivateIpAddressesRequest.Builder,AssignPrivateIpAddressesRequest>

Contains the parameters for AssignPrivateIpAddresses.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AssignPrivateIpAddressesRequest.Builder

Method Summary

Modifier and Type	Method	Description
Boolean	allowReassignment()	Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.
static AssignPrivateIpAddressesRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasIpv4Prefixes()	For responses, this returns true if the service returned a value for the Ipv4Prefixes property.
boolean	hasPrivateIpAddresses()	For responses, this returns true if the service returned a value for the PrivateIpAddresses property.
Integer	ipv4PrefixCount()	The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface.
List<String>	ipv4Prefixes()	One or more IPv4 prefixes assigned to the network interface.
String	networkInterfaceId()	The ID of the network interface.
List<String>	privateIpAddresses()	The IP addresses to be assigned as a secondary private IP address to the network interface.
List<SdkField<?>>	sdkFields()
Integer	secondaryPrivateIpAddressCount()	The number of secondary IP addresses to assign to the network interface.
static Class<? extends AssignPrivateIpAddressesRequest.Builder>	serializableBuilderClass()
AssignPrivateIpAddressesRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

allowReassignment

public final Boolean allowReassignment()

Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.

Returns:

Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.

networkInterfaceId

public final String networkInterfaceId()

The ID of the network interface.

Returns:

The ID of the network interface.

hasPrivateIpAddresses

public final boolean hasPrivateIpAddresses()

For responses, this returns true if the service returned a value for the PrivateIpAddresses property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

privateIpAddresses

public final List<String> privateIpAddresses()

The IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.

If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPrivateIpAddresses() method.

Returns:

The IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.

If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.

secondaryPrivateIpAddressCount

public final Integer secondaryPrivateIpAddressCount()

The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.

Returns:

The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.

hasIpv4Prefixes

public final boolean hasIpv4Prefixes()

For responses, this returns true if the service returned a value for the Ipv4Prefixes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

ipv4Prefixes

public final List<String> ipv4Prefixes()

One or more IPv4 prefixes assigned to the network interface. You cannot use this option if you use the Ipv4PrefixCount option.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasIpv4Prefixes() method.

Returns:

One or more IPv4 prefixes assigned to the network interface. You cannot use this option if you use the Ipv4PrefixCount option.

ipv4PrefixCount

public final Integer ipv4PrefixCount()

The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv4 Prefixes option.

Returns:

The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv4 Prefixes option.

toBuilder

public AssignPrivateIpAddressesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AssignPrivateIpAddressesRequest.Builder,AssignPrivateIpAddressesRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static AssignPrivateIpAddressesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends AssignPrivateIpAddressesRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo