public static interface IpamPool.Builder extends SdkPojo, CopyableBuilder<IpamPool.Builder,IpamPool>
| Modifier and Type | Method and Description |
|---|---|
IpamPool.Builder |
addressFamily(AddressFamily addressFamily)
The address family of the pool.
|
IpamPool.Builder |
addressFamily(String addressFamily)
The address family of the pool.
|
IpamPool.Builder |
allocationDefaultNetmaskLength(Integer allocationDefaultNetmaskLength)
The default netmask length for allocations added to this pool.
|
IpamPool.Builder |
allocationMaxNetmaskLength(Integer allocationMaxNetmaskLength)
The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant.
|
IpamPool.Builder |
allocationMinNetmaskLength(Integer allocationMinNetmaskLength)
The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant.
|
IpamPool.Builder |
allocationResourceTags(Collection<IpamResourceTag> allocationResourceTags)
Tags that are required for resources that use CIDRs from this IPAM pool.
|
IpamPool.Builder |
allocationResourceTags(Consumer<IpamResourceTag.Builder>... allocationResourceTags)
Tags that are required for resources that use CIDRs from this IPAM pool.
|
IpamPool.Builder |
allocationResourceTags(IpamResourceTag... allocationResourceTags)
Tags that are required for resources that use CIDRs from this IPAM pool.
|
IpamPool.Builder |
autoImport(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.
|
IpamPool.Builder |
awsService(IpamPoolAwsService awsService)
Limits which service in Amazon Web Services that the pool can be used in.
|
IpamPool.Builder |
awsService(String awsService)
Limits which service in Amazon Web Services that the pool can be used in.
|
IpamPool.Builder |
description(String description)
The description of the IPAM pool.
|
IpamPool.Builder |
ipamArn(String ipamArn)
The ARN of the IPAM.
|
IpamPool.Builder |
ipamPoolArn(String ipamPoolArn)
The ARN of the IPAM pool.
|
IpamPool.Builder |
ipamPoolId(String ipamPoolId)
The ID of the IPAM pool.
|
IpamPool.Builder |
ipamRegion(String ipamRegion)
The Amazon Web Services Region of the IPAM pool.
|
IpamPool.Builder |
ipamScopeArn(String ipamScopeArn)
The ARN of the scope of the IPAM pool.
|
IpamPool.Builder |
ipamScopeType(IpamScopeType ipamScopeType)
In IPAM, a scope is the highest-level container within IPAM.
|
IpamPool.Builder |
ipamScopeType(String ipamScopeType)
In IPAM, a scope is the highest-level container within IPAM.
|
IpamPool.Builder |
locale(String locale)
The locale of the IPAM pool.
|
IpamPool.Builder |
ownerId(String ownerId)
The Amazon Web Services account ID of the owner of the IPAM pool.
|
IpamPool.Builder |
poolDepth(Integer poolDepth)
The depth of pools in your IPAM pool.
|
IpamPool.Builder |
publiclyAdvertisable(Boolean publiclyAdvertisable)
Determines if a pool is publicly advertisable.
|
IpamPool.Builder |
sourceIpamPoolId(String sourceIpamPoolId)
The ID of the source IPAM pool.
|
IpamPool.Builder |
state(IpamPoolState state)
The state of the IPAM pool.
|
IpamPool.Builder |
state(String state)
The state of the IPAM pool.
|
IpamPool.Builder |
stateMessage(String stateMessage)
A message related to the failed creation of an IPAM pool.
|
IpamPool.Builder |
tags(Collection<Tag> tags)
The key/value combination of a tag assigned to the resource.
|
IpamPool.Builder |
tags(Consumer<Tag.Builder>... tags)
The key/value combination of a tag assigned to the resource.
|
IpamPool.Builder |
tags(Tag... tags)
The key/value combination of a tag assigned to the resource.
|
equalsBySdkFields, sdkFieldscopyapplyMutation, buildIpamPool.Builder ownerId(String ownerId)
The Amazon Web Services account ID of the owner of the IPAM pool.
ownerId - The Amazon Web Services account ID of the owner of the IPAM pool.IpamPool.Builder ipamPoolId(String ipamPoolId)
The ID of the IPAM pool.
ipamPoolId - The ID of the IPAM pool.IpamPool.Builder sourceIpamPoolId(String sourceIpamPoolId)
The ID of the source IPAM pool. You can use this option to create an IPAM pool within an existing source pool.
sourceIpamPoolId - The ID of the source IPAM pool. You can use this option to create an IPAM pool within an existing
source pool.IpamPool.Builder ipamPoolArn(String ipamPoolArn)
The ARN of the IPAM pool.
ipamPoolArn - The ARN of the IPAM pool.IpamPool.Builder ipamScopeArn(String ipamScopeArn)
The ARN of the scope of the IPAM pool.
ipamScopeArn - The ARN of the scope of the IPAM pool.IpamPool.Builder ipamScopeType(String 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.
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.IpamScopeType,
IpamScopeTypeIpamPool.Builder ipamScopeType(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.
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.IpamScopeType,
IpamScopeTypeIpamPool.Builder ipamArn(String ipamArn)
The ARN of the IPAM.
ipamArn - The ARN of the IPAM.IpamPool.Builder ipamRegion(String ipamRegion)
The Amazon Web Services Region of the IPAM pool.
ipamRegion - The Amazon Web Services Region of the IPAM pool.IpamPool.Builder locale(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.
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.IpamPool.Builder poolDepth(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.
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.IpamPool.Builder state(String state)
The state of the IPAM pool.
state - The state of the IPAM pool.IpamPoolState,
IpamPoolStateIpamPool.Builder state(IpamPoolState state)
The state of the IPAM pool.
state - The state of the IPAM pool.IpamPoolState,
IpamPoolStateIpamPool.Builder stateMessage(String stateMessage)
A message related to the failed creation of an IPAM pool.
stateMessage - A message related to the failed creation of an IPAM pool.IpamPool.Builder description(String description)
The description of the IPAM pool.
description - The description of the IPAM pool.IpamPool.Builder autoImport(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.
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.
IpamPool.Builder publiclyAdvertisable(Boolean publiclyAdvertisable)
Determines if a pool is publicly advertisable. This option is not available for pools with AddressFamily set
to ipv4.
publiclyAdvertisable - Determines if a pool is publicly advertisable. This option is not available for pools with
AddressFamily set to ipv4.IpamPool.Builder addressFamily(String addressFamily)
The address family of the pool.
addressFamily - The address family of the pool.AddressFamily,
AddressFamilyIpamPool.Builder addressFamily(AddressFamily addressFamily)
The address family of the pool.
addressFamily - The address family of the pool.AddressFamily,
AddressFamilyIpamPool.Builder allocationMinNetmaskLength(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.
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.IpamPool.Builder allocationMaxNetmaskLength(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.
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.IpamPool.Builder allocationDefaultNetmaskLength(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.
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.IpamPool.Builder allocationResourceTags(Collection<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.
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.IpamPool.Builder allocationResourceTags(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.
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.IpamPool.Builder allocationResourceTags(Consumer<IpamResourceTag.Builder>... 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.
This is a convenience method that creates an instance of theList.Builder avoiding
the need to create one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately and
its result is passed to #allocationResourceTags(List) .allocationResourceTags - a consumer that will call methods on List.Builder #allocationResourceTags(List) IpamPool.Builder tags(Collection<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.
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.IpamPool.Builder tags(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.
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.IpamPool.Builder tags(Consumer<Tag.Builder>... 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.
List.Builder avoiding the need to
create one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately and its result
is passed to #tags(List) .tags - a consumer that will call methods on List.Builder #tags(List) IpamPool.Builder awsService(String 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.
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.IpamPoolAwsService,
IpamPoolAwsServiceIpamPool.Builder awsService(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.
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.IpamPoolAwsService,
IpamPoolAwsServiceCopyright © 2022. All rights reserved.