Class IpamDiscoveredResourceCidr

java.lang.Object
software.amazon.awssdk.services.ec2.model.IpamDiscoveredResourceCidr
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<IpamDiscoveredResourceCidr.Builder,IpamDiscoveredResourceCidr>
@Generated("software.amazon.awssdk:codegen") public final class IpamDiscoveredResourceCidr extends Object implements SdkPojo, Serializable, ToCopyableBuilder<IpamDiscoveredResourceCidr.Builder,IpamDiscoveredResourceCidr>

An IPAM discovered resource CIDR. A discovered resource is a resource CIDR monitored under a resource discovery. The following resources can be discovered: VPCs, Public IPv4 pools, VPC subnets, and Elastic IP addresses. The discovered resource CIDR is the IP address range in CIDR notation that is associated with the resource.

See Also:

  • Method Details

    • ipamResourceDiscoveryId

      public final String ipamResourceDiscoveryId()

      The resource discovery ID.

      Returns:
      The resource discovery ID.

    • resourceRegion

      public final String resourceRegion()

      The resource Region.

      Returns:
      The resource Region.

    • resourceId

      public final String resourceId()

      The resource ID.

      Returns:
      The resource ID.

    • resourceOwnerId

      public final String resourceOwnerId()

      The resource owner ID.

      Returns:
      The resource owner ID.

    • resourceCidr

      public final String resourceCidr()

      The resource CIDR.

      Returns:
      The resource CIDR.

    • ipSource

      public final IpamResourceCidrIpSource ipSource()

      The source that allocated the IP address space. byoip or amazon indicates public IP address space allocated by Amazon or space that you have allocated with Bring your own IP (BYOIP). none indicates private space.

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

      Returns:
      The source that allocated the IP address space. byoip or amazon indicates public IP address space allocated by Amazon or space that you have allocated with Bring your own IP (BYOIP). none indicates private space.
      See Also:

    • ipSourceAsString

      public final String ipSourceAsString()

      The source that allocated the IP address space. byoip or amazon indicates public IP address space allocated by Amazon or space that you have allocated with Bring your own IP (BYOIP). none indicates private space.

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

      Returns:
      The source that allocated the IP address space. byoip or amazon indicates public IP address space allocated by Amazon or space that you have allocated with Bring your own IP (BYOIP). none indicates private space.
      See Also:

    • resourceType

      public final IpamResourceType resourceType()

      The resource type.

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

      Returns:
      The resource type.
      See Also:

    • resourceTypeAsString

      public final String resourceTypeAsString()

      The resource type.

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

      Returns:
      The resource type.
      See Also:

    • hasResourceTags

      public final boolean hasResourceTags()
      For responses, this returns true if the service returned a value for the ResourceTags 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.

    • resourceTags

      public final List<IpamResourceTag> resourceTags()

      The resource tags.

      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 hasResourceTags() method.

      Returns:
      The resource tags.

    • ipUsage

      public final Double ipUsage()

      The percentage of IP address space in use. To convert the decimal to a percentage, multiply the decimal by 100. Note the following:

      • For resources that are VPCs, this is the percentage of IP address space in the VPC that's taken up by subnet CIDRs.

      • For resources that are subnets, if the subnet has an IPv4 CIDR provisioned to it, this is the percentage of IPv4 address space in the subnet that's in use. If the subnet has an IPv6 CIDR provisioned to it, the percentage of IPv6 address space in use is not represented. The percentage of IPv6 address space in use cannot currently be calculated.

      • For resources that are public IPv4 pools, this is the percentage of IP address space in the pool that's been allocated to Elastic IP addresses (EIPs).

      Returns:
      The percentage of IP address space in use. To convert the decimal to a percentage, multiply the decimal by 100. Note the following:

      • For resources that are VPCs, this is the percentage of IP address space in the VPC that's taken up by subnet CIDRs.

      • For resources that are subnets, if the subnet has an IPv4 CIDR provisioned to it, this is the percentage of IPv4 address space in the subnet that's in use. If the subnet has an IPv6 CIDR provisioned to it, the percentage of IPv6 address space in use is not represented. The percentage of IPv6 address space in use cannot currently be calculated.

      • For resources that are public IPv4 pools, this is the percentage of IP address space in the pool that's been allocated to Elastic IP addresses (EIPs).

    • vpcId

      public final String vpcId()

      The VPC ID.

      Returns:
      The VPC ID.

    • subnetId

      public final String subnetId()

      The subnet ID.

      Returns:
      The subnet ID.

    • networkInterfaceAttachmentStatus

      public final IpamNetworkInterfaceAttachmentStatus networkInterfaceAttachmentStatus()

      For elastic network interfaces, this is the status of whether or not the elastic network interface is attached.

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

      Returns:
      For elastic network interfaces, this is the status of whether or not the elastic network interface is attached.
      See Also:

    • networkInterfaceAttachmentStatusAsString

      public final String networkInterfaceAttachmentStatusAsString()

      For elastic network interfaces, this is the status of whether or not the elastic network interface is attached.

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

      Returns:
      For elastic network interfaces, this is the status of whether or not the elastic network interface is attached.
      See Also:

    • sampleTime

      public final Instant sampleTime()

      The last successful resource discovery time.

      Returns:
      The last successful resource discovery time.

    • availabilityZoneId

      public final String availabilityZoneId()

      The Availability Zone ID.

      Returns:
      The Availability Zone ID.

    • toBuilder

      public IpamDiscoveredResourceCidr.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<IpamDiscoveredResourceCidr.Builder,IpamDiscoveredResourceCidr>
      Returns:
      a builder for type T

    • builder

      public static IpamDiscoveredResourceCidr.Builder builder()

    • serializableBuilderClass

      public static Class<? extends IpamDiscoveredResourceCidr.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.