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

Class IpamPoolCidr

java.lang.Object

software.amazon.awssdk.services.ec2.model.IpamPoolCidr

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<IpamPoolCidr.Builder,IpamPoolCidr>

@Generated("software.amazon.awssdk:codegen")
public final class IpamPoolCidr
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<IpamPoolCidr.Builder,IpamPoolCidr>

A CIDR provisioned to an IPAM pool.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	IpamPoolCidr.Builder

Method Summary

Modifier and Type	Method	Description
static IpamPoolCidr.Builder	builder()
String	cidr()	The CIDR provisioned to the IPAM pool.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
IpamPoolCidrFailureReason	failureReason()	Details related to why an IPAM pool CIDR failed to be provisioned.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	ipamPoolCidrId()	The IPAM pool CIDR ID.
Integer	netmaskLength()	The netmask length of the CIDR you'd like to provision to a pool.
List<SdkField<?>>	sdkFields()
static Class<? extends IpamPoolCidr.Builder>	serializableBuilderClass()
IpamPoolCidrState	state()	The state of the CIDR.
String	stateAsString()	The state of the CIDR.
IpamPoolCidr.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

cidr

public final String cidr()

The CIDR provisioned to the IPAM pool. A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is 10.24.34.0/23. An IPv6 CIDR example is 2001:DB8::/32.

Returns:

The CIDR provisioned to the IPAM pool. A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is 10.24.34.0/23. An IPv6 CIDR example is 2001:DB8::/32.

state

public final IpamPoolCidrState state()

The state of the CIDR.

If the service returns an enum value that is not available in the current SDK version, state will return IpamPoolCidrState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

The state of the CIDR.

See Also:

IpamPoolCidrState

stateAsString

public final String stateAsString()

The state of the CIDR.

If the service returns an enum value that is not available in the current SDK version, state will return IpamPoolCidrState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

The state of the CIDR.

See Also:

IpamPoolCidrState

failureReason

public final IpamPoolCidrFailureReason failureReason()

Details related to why an IPAM pool CIDR failed to be provisioned.

Returns:

Details related to why an IPAM pool CIDR failed to be provisioned.

ipamPoolCidrId

public final String ipamPoolCidrId()

The IPAM pool CIDR ID.

Returns:

The IPAM pool CIDR ID.

netmaskLength

public final Integer netmaskLength()

The netmask length of the CIDR you'd like to provision to a pool. Can be used for provisioning Amazon-provided IPv6 CIDRs to top-level pools and for provisioning CIDRs to pools with source pools. Cannot be used to provision BYOIP CIDRs to top-level pools. "NetmaskLength" or "Cidr" is required.

Returns:

The netmask length of the CIDR you'd like to provision to a pool. Can be used for provisioning Amazon-provided IPv6 CIDRs to top-level pools and for provisioning CIDRs to pools with source pools. Cannot be used to provision BYOIP CIDRs to top-level pools. "NetmaskLength" or "Cidr" is required.

toBuilder

public IpamPoolCidr.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<IpamPoolCidr.Builder,IpamPoolCidr>

builder

public static IpamPoolCidr.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo