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

Class Ipam

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

IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.

See Also:

  • Method Details

    • ownerId

      public final String ownerId()

      The Amazon Web Services account ID of the owner of the IPAM.

      Returns:
      The Amazon Web Services account ID of the owner of the IPAM.

    • ipamId

      public final String ipamId()

      The ID of the IPAM.

      Returns:
      The ID of the IPAM.

    • ipamArn

      public final String ipamArn()

      The Amazon Resource Name (ARN) of the IPAM.

      Returns:
      The Amazon Resource Name (ARN) of the IPAM.

    • ipamRegion

      public final String ipamRegion()

      The Amazon Web Services Region of the IPAM.

      Returns:
      The Amazon Web Services Region of the IPAM.

    • publicDefaultScopeId

      public final String publicDefaultScopeId()

      The ID of the IPAM's default public scope.

      Returns:
      The ID of the IPAM's default public scope.

    • privateDefaultScopeId

      public final String privateDefaultScopeId()

      The ID of the IPAM's default private scope.

      Returns:
      The ID of the IPAM's default private scope.

    • scopeCount

      public final Integer scopeCount()

      The number of scopes in the IPAM. The scope quota is 5. For more information on quotas, see Quotas in IPAM in the Amazon VPC IPAM User Guide.

      Returns:
      The number of scopes in the IPAM. The scope quota is 5. For more information on quotas, see Quotas in IPAM in the Amazon VPC IPAM User Guide.

    • description

      public final String description()

      The description for the IPAM.

      Returns:
      The description for the IPAM.

    • hasOperatingRegions

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

    • operatingRegions

      public final List<IpamOperatingRegion> operatingRegions()

      The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

      For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.

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

      Returns:
      The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

      For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.

    • state

      public final IpamState state()

      The state of the IPAM.

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

      Returns:
      The state of the IPAM.
      See Also:

    • stateAsString

      public final String stateAsString()

      The state of the IPAM.

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

      Returns:
      The state of the IPAM.
      See Also:

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

    • tags

      public final List<Tag> tags()

      The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

      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 key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    • defaultResourceDiscoveryId

      public final String defaultResourceDiscoveryId()

      The IPAM's default resource discovery ID.

      Returns:
      The IPAM's default resource discovery ID.

    • defaultResourceDiscoveryAssociationId

      public final String defaultResourceDiscoveryAssociationId()

      The IPAM's default resource discovery association ID.

      Returns:
      The IPAM's default resource discovery association ID.

    • resourceDiscoveryAssociationCount

      public final Integer resourceDiscoveryAssociationCount()

      The IPAM's resource discovery association count.

      Returns:
      The IPAM's resource discovery association count.

    • stateMessage

      public final String stateMessage()

      The state message.

      Returns:
      The state message.

    • tier

      public final IpamTier tier()

      IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab.

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

      Returns:
      IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab.
      See Also:

    • tierAsString

      public final String tierAsString()

      IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab.

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

      Returns:
      IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab.
      See Also:

    • enablePrivateGua

      public final Boolean enablePrivateGua()

      Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default.

      Returns:
      Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default.

    • toBuilder

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

    • builder

      public static Ipam.Builder builder()

    • serializableBuilderClass

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