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

Class IpamPool

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

In IPAM, a pool is a collection of contiguous IP addresses CIDRs. Pools enable you to organize your IP addresses according to your routing and security needs. For example, if you have separate routing and security needs for development and production applications, you can create a pool for each.

See Also:

  • Method Details

    • ownerId

      public final String ownerId()

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

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

    • ipamPoolId

      public final String ipamPoolId()

      The ID of the IPAM pool.

      Returns:
      The ID of the IPAM pool.

    • sourceIpamPoolId

      public final String sourceIpamPoolId()

      The ID of the source IPAM pool. You can use this option to create an IPAM pool within an existing source pool.

      Returns:
      The ID of the source IPAM pool. You can use this option to create an IPAM pool within an existing source pool.

    • ipamPoolArn

      public final String ipamPoolArn()

      The Amazon Resource Name (ARN) of the IPAM pool.

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

    • ipamScopeArn

      public final String ipamScopeArn()

      The ARN of the scope of the IPAM pool.

      Returns:
      The ARN of the scope of the IPAM pool.

    • ipamScopeType

      public final IpamScopeType ipamScopeType()

      In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.

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

      Returns:
      In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.
      See Also:

    • ipamScopeTypeAsString

      public final String ipamScopeTypeAsString()

      In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.

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

      Returns:
      In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.
      See Also:

    • ipamArn

      public final String ipamArn()

      The ARN of the IPAM.

      Returns:
      The ARN of the IPAM.

    • ipamRegion

      public final String ipamRegion()

      The Amazon Web Services Region of the IPAM pool.

      Returns:
      The Amazon Web Services Region of the IPAM pool.

    • locale

      public final String locale()

      The locale of the IPAM pool. In IPAM, the locale is the Amazon Web Services Region where you want to make an IPAM pool available for allocations. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot modify it. If you choose an Amazon Web Services Region for locale that has not been configured as an operating Region for the IPAM, you'll get an error.

      Returns:
      The locale of the IPAM pool. In IPAM, the locale is the Amazon Web Services Region where you want to make an IPAM pool available for allocations. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot modify it. If you choose an Amazon Web Services Region for locale that has not been configured as an operating Region for the IPAM, you'll get an error.

    • poolDepth

      public final Integer poolDepth()

      The depth of pools in your IPAM pool. The pool depth quota is 10. For more information, see Quotas in IPAM in the Amazon VPC IPAM User Guide.

      Returns:
      The depth of pools in your IPAM pool. The pool depth quota is 10. For more information, see Quotas in IPAM in the Amazon VPC IPAM User Guide.

    • state

      public final IpamPoolState state()

      The state of the IPAM pool.

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

      Returns:
      The state of the IPAM pool.
      See Also:

    • stateAsString

      public final String stateAsString()

      The state of the IPAM pool.

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

      Returns:
      The state of the IPAM pool.
      See Also:

    • stateMessage

      public final String stateMessage()

      The state message.

      Returns:
      The state message.

    • description

      public final String description()

      The description of the IPAM pool.

      Returns:
      The description of the IPAM pool.

    • autoImport

      public final Boolean autoImport()

      If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.

      A locale must be set on the pool for this feature to work.

      Returns:
      If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.

      A locale must be set on the pool for this feature to work.

    • publiclyAdvertisable

      public final Boolean publiclyAdvertisable()

      Determines if a pool is publicly advertisable. This option is not available for pools with AddressFamily set to ipv4.

      Returns:
      Determines if a pool is publicly advertisable. This option is not available for pools with AddressFamily set to ipv4.

    • addressFamily

      public final AddressFamily addressFamily()

      The address family of the pool.

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

      Returns:
      The address family of the pool.
      See Also:

    • addressFamilyAsString

      public final String addressFamilyAsString()

      The address family of the pool.

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

      Returns:
      The address family of the pool.
      See Also:

    • allocationMinNetmaskLength

      public final Integer allocationMinNetmaskLength()

      The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

      Returns:
      The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

    • allocationMaxNetmaskLength

      public final Integer allocationMaxNetmaskLength()

      The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

      Returns:
      The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

    • allocationDefaultNetmaskLength

      public final Integer allocationDefaultNetmaskLength()

      The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.

      Returns:
      The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.

    • hasAllocationResourceTags

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

    • allocationResourceTags

      public final List<IpamResourceTag> allocationResourceTags()

      Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.

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

      Returns:
      Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.

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

    • awsService

      public final IpamPoolAwsService awsService()

      Limits which service in Amazon Web Services that the pool can be used in. "ec2", for example, allows users to use space for Elastic IP addresses and VPCs.

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

      Returns:
      Limits which service in Amazon Web Services that the pool can be used in. "ec2", for example, allows users to use space for Elastic IP addresses and VPCs.
      See Also:

    • awsServiceAsString

      public final String awsServiceAsString()

      Limits which service in Amazon Web Services that the pool can be used in. "ec2", for example, allows users to use space for Elastic IP addresses and VPCs.

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

      Returns:
      Limits which service in Amazon Web Services that the pool can be used in. "ec2", for example, allows users to use space for Elastic IP addresses and VPCs.
      See Also:

    • publicIpSource

      public final IpamPoolPublicIpSource publicIpSource()

      The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is BYOIP. For more information, see Create IPv6 pools in the Amazon VPC IPAM User Guide. By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool. For information on increasing the default limit, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.

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

      Returns:
      The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is BYOIP. For more information, see Create IPv6 pools in the Amazon VPC IPAM User Guide. By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool. For information on increasing the default limit, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.
      See Also:

    • publicIpSourceAsString

      public final String publicIpSourceAsString()

      The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is BYOIP. For more information, see Create IPv6 pools in the Amazon VPC IPAM User Guide. By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool. For information on increasing the default limit, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.

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

      Returns:
      The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is BYOIP. For more information, see Create IPv6 pools in the Amazon VPC IPAM User Guide. By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool. For information on increasing the default limit, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.
      See Also:

    • sourceResource

      public final IpamPoolSourceResource sourceResource()

      The resource used to provision CIDRs to a resource planning pool.

      Returns:
      The resource used to provision CIDRs to a resource planning pool.

    • toBuilder

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

    • builder

      public static IpamPool.Builder builder()

    • serializableBuilderClass

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