Class ByoipCidr
- java.lang.Object
-
- software.amazon.awssdk.services.ec2.model.ByoipCidr
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ByoipCidr.Builder,ByoipCidr>
@Generated("software.amazon.awssdk:codegen") public final class ByoipCidr extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ByoipCidr.Builder,ByoipCidr>
Information about an address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP).
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ByoipCidr.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<AsnAssociation>
asnAssociations()
The BYOIP CIDR associations with ASNs.static ByoipCidr.Builder
builder()
String
cidr()
The address range, in CIDR notation.String
description()
The description of the address range.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasAsnAssociations()
For responses, this returns true if the service returned a value for the AsnAssociations property.int
hashCode()
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.List<SdkField<?>>
sdkFields()
static Class<? extends ByoipCidr.Builder>
serializableBuilderClass()
ByoipCidrState
state()
The state of the address pool.String
stateAsString()
The state of the address pool.String
statusMessage()
Upon success, contains the ID of the address pool.ByoipCidr.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 address range, in CIDR notation.
- Returns:
- The address range, in CIDR notation.
-
description
public final String description()
The description of the address range.
- Returns:
- The description of the address range.
-
hasAsnAssociations
public final boolean hasAsnAssociations()
For responses, this returns true if the service returned a value for the AsnAssociations property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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.
-
asnAssociations
public final List<AsnAssociation> asnAssociations()
The BYOIP CIDR associations with ASNs.
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
hasAsnAssociations()
method.- Returns:
- The BYOIP CIDR associations with ASNs.
-
statusMessage
public final String statusMessage()
Upon success, contains the ID of the address pool. Otherwise, contains an error message.
- Returns:
- Upon success, contains the ID of the address pool. Otherwise, contains an error message.
-
state
public final ByoipCidrState state()
The state of the address pool.
If the service returns an enum value that is not available in the current SDK version,
state
will returnByoipCidrState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The state of the address pool.
- See Also:
ByoipCidrState
-
stateAsString
public final String stateAsString()
The state of the address pool.
If the service returns an enum value that is not available in the current SDK version,
state
will returnByoipCidrState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The state of the address pool.
- See Also:
ByoipCidrState
-
networkBorderGroup
public final 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.
- Returns:
- 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.
-
-
-
toBuilder
public ByoipCidr.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<ByoipCidr.Builder,ByoipCidr>
-
builder
public static ByoipCidr.Builder builder()
-
serializableBuilderClass
public static Class<? extends ByoipCidr.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-