Class IpamPrefixListResolver
- java.lang.Object
-
- software.amazon.awssdk.services.ec2.model.IpamPrefixListResolver
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<IpamPrefixListResolver.Builder,IpamPrefixListResolver>
@Generated("software.amazon.awssdk:codegen") public final class IpamPrefixListResolver extends Object implements SdkPojo, Serializable, ToCopyableBuilder<IpamPrefixListResolver.Builder,IpamPrefixListResolver>
Describes an IPAM prefix list resolver.
An IPAM prefix list resolver is a component that manages the synchronization between IPAM's CIDR selection rules and customer-managed prefix lists. It automates connectivity configurations by selecting CIDRs from IPAM's database based on your business logic and synchronizing them with prefix lists used in resources such as VPC route tables and security groups.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceIpamPrefixListResolver.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AddressFamilyaddressFamily()The address family (IPv4 or IPv6) for the IPAM prefix list resolver.StringaddressFamilyAsString()The address family (IPv4 or IPv6) for the IPAM prefix list resolver.static IpamPrefixListResolver.Builderbuilder()Stringdescription()The description of the IPAM prefix list resolver.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.StringipamArn()The Amazon Resource Name (ARN) of the IPAM associated with this resolver.StringipamPrefixListResolverArn()The Amazon Resource Name (ARN) of the IPAM prefix list resolver.StringipamPrefixListResolverId()The ID of the IPAM prefix list resolver.StringipamRegion()The Amazon Web Services Region where the associated IPAM is located.IpamPrefixListResolverVersionCreationStatuslastVersionCreationStatus()The status for the last time a version was created.StringlastVersionCreationStatusAsString()The status for the last time a version was created.StringlastVersionCreationStatusMessage()The status message for the last time a version was created.StringownerId()The ID of the Amazon Web Services account that owns the IPAM prefix list resolver.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends IpamPrefixListResolver.Builder>serializableBuilderClass()IpamPrefixListResolverStatestate()The current state of the IPAM prefix list resolver.StringstateAsString()The current state of the IPAM prefix list resolver.List<Tag>tags()The tags assigned to the IPAM prefix list resolver.IpamPrefixListResolver.BuildertoBuilder()StringtoString()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
-
ownerId
public final String ownerId()
The ID of the Amazon Web Services account that owns the IPAM prefix list resolver.
- Returns:
- The ID of the Amazon Web Services account that owns the IPAM prefix list resolver.
-
ipamPrefixListResolverId
public final String ipamPrefixListResolverId()
The ID of the IPAM prefix list resolver.
- Returns:
- The ID of the IPAM prefix list resolver.
-
ipamPrefixListResolverArn
public final String ipamPrefixListResolverArn()
The Amazon Resource Name (ARN) of the IPAM prefix list resolver.
- Returns:
- The Amazon Resource Name (ARN) of the IPAM prefix list resolver.
-
ipamArn
public final String ipamArn()
The Amazon Resource Name (ARN) of the IPAM associated with this resolver.
- Returns:
- The Amazon Resource Name (ARN) of the IPAM associated with this resolver.
-
ipamRegion
public final String ipamRegion()
The Amazon Web Services Region where the associated IPAM is located.
- Returns:
- The Amazon Web Services Region where the associated IPAM is located.
-
description
public final String description()
The description of the IPAM prefix list resolver.
- Returns:
- The description of the IPAM prefix list resolver.
-
addressFamily
public final AddressFamily addressFamily()
The address family (IPv4 or IPv6) for the IPAM prefix list resolver.
If the service returns an enum value that is not available in the current SDK version,
addressFamilywill returnAddressFamily.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromaddressFamilyAsString().- Returns:
- The address family (IPv4 or IPv6) for the IPAM prefix list resolver.
- See Also:
AddressFamily
-
addressFamilyAsString
public final String addressFamilyAsString()
The address family (IPv4 or IPv6) for the IPAM prefix list resolver.
If the service returns an enum value that is not available in the current SDK version,
addressFamilywill returnAddressFamily.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromaddressFamilyAsString().- Returns:
- The address family (IPv4 or IPv6) for the IPAM prefix list resolver.
- See Also:
AddressFamily
-
state
public final IpamPrefixListResolverState state()
The current state of the IPAM prefix list resolver. Valid values include
create-in-progress,create-complete,create-failed,modify-in-progress,modify-complete,modify-failed,delete-in-progress,delete-complete, anddelete-failed.If the service returns an enum value that is not available in the current SDK version,
statewill returnIpamPrefixListResolverState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstateAsString().- Returns:
- The current state of the IPAM prefix list resolver. Valid values include
create-in-progress,create-complete,create-failed,modify-in-progress,modify-complete,modify-failed,delete-in-progress,delete-complete, anddelete-failed. - See Also:
IpamPrefixListResolverState
-
stateAsString
public final String stateAsString()
The current state of the IPAM prefix list resolver. Valid values include
create-in-progress,create-complete,create-failed,modify-in-progress,modify-complete,modify-failed,delete-in-progress,delete-complete, anddelete-failed.If the service returns an enum value that is not available in the current SDK version,
statewill returnIpamPrefixListResolverState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstateAsString().- Returns:
- The current state of the IPAM prefix list resolver. Valid values include
create-in-progress,create-complete,create-failed,modify-in-progress,modify-complete,modify-failed,delete-in-progress,delete-complete, anddelete-failed. - See Also:
IpamPrefixListResolverState
-
hasTags
public final boolean hasTags()
For responses, this returns true if the service returned a value for the Tags 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.
-
tags
public final List<Tag> tags()
The tags assigned to the IPAM prefix list resolver.
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
hasTags()method.- Returns:
- The tags assigned to the IPAM prefix list resolver.
-
lastVersionCreationStatus
public final IpamPrefixListResolverVersionCreationStatus lastVersionCreationStatus()
The status for the last time a version was created.
Each version is a snapshot of what CIDRs matched your rules at that moment in time. The version number increments every time the CIDR list changes due to infrastructure changes.
If the service returns an enum value that is not available in the current SDK version,
lastVersionCreationStatuswill returnIpamPrefixListResolverVersionCreationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromlastVersionCreationStatusAsString().- Returns:
- The status for the last time a version was created.
Each version is a snapshot of what CIDRs matched your rules at that moment in time. The version number increments every time the CIDR list changes due to infrastructure changes.
- See Also:
IpamPrefixListResolverVersionCreationStatus
-
lastVersionCreationStatusAsString
public final String lastVersionCreationStatusAsString()
The status for the last time a version was created.
Each version is a snapshot of what CIDRs matched your rules at that moment in time. The version number increments every time the CIDR list changes due to infrastructure changes.
If the service returns an enum value that is not available in the current SDK version,
lastVersionCreationStatuswill returnIpamPrefixListResolverVersionCreationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromlastVersionCreationStatusAsString().- Returns:
- The status for the last time a version was created.
Each version is a snapshot of what CIDRs matched your rules at that moment in time. The version number increments every time the CIDR list changes due to infrastructure changes.
- See Also:
IpamPrefixListResolverVersionCreationStatus
-
lastVersionCreationStatusMessage
public final String lastVersionCreationStatusMessage()
The status message for the last time a version was created.
Each version is a snapshot of what CIDRs matched your rules at that moment in time. The version number increments every time the CIDR list changes due to infrastructure changes.
- Returns:
- The status message for the last time a version was created.
Each version is a snapshot of what CIDRs matched your rules at that moment in time. The version number increments every time the CIDR list changes due to infrastructure changes.
-
toBuilder
public IpamPrefixListResolver.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<IpamPrefixListResolver.Builder,IpamPrefixListResolver>
-
builder
public static IpamPrefixListResolver.Builder builder()
-
serializableBuilderClass
public static Class<? extends IpamPrefixListResolver.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin 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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-