Class IpamResourceCidr

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

The CIDR for an IPAM resource.

See Also:

  • Method Details

    • ipamId

      public final String ipamId()

      The IPAM ID for an IPAM resource.

      Returns:
      The IPAM ID for an IPAM resource.

    • ipamScopeId

      public final String ipamScopeId()

      The scope ID for an IPAM resource.

      Returns:
      The scope ID for an IPAM resource.

    • ipamPoolId

      public final String ipamPoolId()

      The pool ID for an IPAM resource.

      Returns:
      The pool ID for an IPAM resource.

    • resourceRegion

      public final String resourceRegion()

      The Amazon Web Services Region for an IPAM resource.

      Returns:
      The Amazon Web Services Region for an IPAM resource.

    • resourceOwnerId

      public final String resourceOwnerId()

      The Amazon Web Services account number of the owner of an IPAM resource.

      Returns:
      The Amazon Web Services account number of the owner of an IPAM resource.

    • resourceId

      public final String resourceId()

      The ID of an IPAM resource.

      Returns:
      The ID of an IPAM resource.

    • resourceName

      public final String resourceName()

      The name of an IPAM resource.

      Returns:
      The name of an IPAM resource.

    • resourceCidr

      public final String resourceCidr()

      The CIDR for an IPAM resource.

      Returns:
      The CIDR for an IPAM resource.

    • resourceType

      public final IpamResourceType resourceType()

      The type of IPAM resource.

      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 type of IPAM resource.
      See Also:

    • resourceTypeAsString

      public final String resourceTypeAsString()

      The type of IPAM resource.

      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 type of IPAM resource.
      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 tags for an IPAM resource.

      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 tags for an IPAM resource.

    • 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).

    • complianceStatus

      public final IpamComplianceStatus complianceStatus()

      The compliance status of the IPAM resource. For more information on compliance statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.

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

      Returns:
      The compliance status of the IPAM resource. For more information on compliance statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.
      See Also:

    • complianceStatusAsString

      public final String complianceStatusAsString()

      The compliance status of the IPAM resource. For more information on compliance statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.

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

      Returns:
      The compliance status of the IPAM resource. For more information on compliance statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.
      See Also:

    • managementState

      public final IpamManagementState managementState()

      The management state of the resource. For more information about management states, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.

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

      Returns:
      The management state of the resource. For more information about management states, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.
      See Also:

    • managementStateAsString

      public final String managementStateAsString()

      The management state of the resource. For more information about management states, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.

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

      Returns:
      The management state of the resource. For more information about management states, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.
      See Also:

    • overlapStatus

      public final IpamOverlapStatus overlapStatus()

      The overlap status of an IPAM resource. The overlap status tells you if the CIDR for a resource overlaps with another CIDR in the scope. For more information on overlap statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.

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

      Returns:
      The overlap status of an IPAM resource. The overlap status tells you if the CIDR for a resource overlaps with another CIDR in the scope. For more information on overlap statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.
      See Also:

    • overlapStatusAsString

      public final String overlapStatusAsString()

      The overlap status of an IPAM resource. The overlap status tells you if the CIDR for a resource overlaps with another CIDR in the scope. For more information on overlap statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.

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

      Returns:
      The overlap status of an IPAM resource. The overlap status tells you if the CIDR for a resource overlaps with another CIDR in the scope. For more information on overlap statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.
      See Also:

    • vpcId

      public final String vpcId()

      The ID of a VPC.

      Returns:
      The ID of a VPC.

    • availabilityZoneId

      public final String availabilityZoneId()

      The Availability Zone ID.

      Returns:
      The Availability Zone ID.

    • toBuilder

      public IpamResourceCidr.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<IpamResourceCidr.Builder,IpamResourceCidr>
      Returns:
      a builder for type T

    • builder

      public static IpamResourceCidr.Builder builder()

    • serializableBuilderClass

      public static Class<? extends IpamResourceCidr.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.