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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
IpamPool.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AddressFamily
addressFamily()
The address family of the pool.String
addressFamilyAsString()
The address family of the pool.Integer
allocationDefaultNetmaskLength()
The default netmask length for allocations added to this pool.Integer
allocationMaxNetmaskLength()
The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant.Integer
allocationMinNetmaskLength()
The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant.List<IpamResourceTag>
allocationResourceTags()
Tags that are required for resources that use CIDRs from this IPAM pool.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.IpamPoolAwsService
awsService()
Limits which service in Amazon Web Services that the pool can be used in.String
awsServiceAsString()
Limits which service in Amazon Web Services that the pool can be used in.static IpamPool.Builder
builder()
String
description()
The description of the IPAM pool.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasAllocationResourceTags()
For responses, this returns true if the service returned a value for the AllocationResourceTags property.int
hashCode()
boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.String
ipamArn()
The ARN of the IPAM.String
ipamPoolArn()
The Amazon Resource Name (ARN) of the IPAM pool.String
ipamPoolId()
The ID of the IPAM pool.String
ipamRegion()
The Amazon Web Services Region of the IPAM pool.String
ipamScopeArn()
The ARN of the scope of the IPAM pool.IpamScopeType
ipamScopeType()
In IPAM, a scope is the highest-level container within IPAM.String
ipamScopeTypeAsString()
In IPAM, a scope is the highest-level container within IPAM.String
locale()
The locale of the IPAM pool.String
ownerId()
The Amazon Web Services account ID of the owner of the IPAM pool.Integer
poolDepth()
The depth of pools in your IPAM pool.IpamPoolPublicIpSource
publicIpSource()
The IP address source for pools in the public scope.String
publicIpSourceAsString()
The IP address source for pools in the public scope.Boolean
publiclyAdvertisable()
Determines if a pool is publicly advertisable.List<SdkField<?>>
sdkFields()
static Class<? extends IpamPool.Builder>
serializableBuilderClass()
String
sourceIpamPoolId()
The ID of the source IPAM pool.IpamPoolSourceResource
sourceResource()
Returns the value of the SourceResource property for this object.IpamPoolState
state()
The state of the IPAM pool.String
stateAsString()
The state of the IPAM pool.String
stateMessage()
The state message.List<Tag>
tags()
The key/value combination of a tag assigned to the resource.IpamPool.Builder
toBuilder()
String
toString()
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 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 returnIpamScopeType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromipamScopeTypeAsString()
.- 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:
IpamScopeType
-
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 returnIpamScopeType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromipamScopeTypeAsString()
.- 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:
IpamScopeType
-
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 returnIpamPoolState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The state of the IPAM pool.
- See Also:
IpamPoolState
-
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 returnIpamPoolState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The state of the IPAM pool.
- See Also:
IpamPoolState
-
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 returnAddressFamily.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromaddressFamilyAsString()
.- Returns:
- The address family of the pool.
- See Also:
AddressFamily
-
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 returnAddressFamily.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromaddressFamilyAsString()
.- Returns:
- The address family of the pool.
- See Also:
AddressFamily
-
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 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.
-
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 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 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 valueTeamA
, specifytag:Owner
for the filter name andTeamA
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 valueTeamA
, specifytag:Owner
for the filter name andTeamA
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 returnIpamPoolAwsService.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromawsServiceAsString()
.- 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:
IpamPoolAwsService
-
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 returnIpamPoolAwsService.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromawsServiceAsString()
.- 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:
IpamPoolAwsService
-
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 returnIpamPoolPublicIpSource.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompublicIpSourceAsString()
.- 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:
IpamPoolPublicIpSource
-
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 returnIpamPoolPublicIpSource.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompublicIpSourceAsString()
.- 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:
IpamPoolPublicIpSource
-
sourceResource
public final IpamPoolSourceResource sourceResource()
Returns the value of the SourceResource property for this object.- Returns:
- The value of the SourceResource property for this object.
-
toBuilder
public IpamPool.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<IpamPool.Builder,IpamPool>
-
builder
public static IpamPool.Builder builder()
-
serializableBuilderClass
public static Class<? extends IpamPool.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in 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.
-
-