public static interface CreateIpamPoolRequest.Builder extends Ec2Request.Builder, SdkPojo, CopyableBuilder<CreateIpamPoolRequest.Builder,CreateIpamPoolRequest>
| Modifier and Type | Method and Description |
|---|---|
CreateIpamPoolRequest.Builder |
addressFamily(AddressFamily addressFamily)
The IP protocol assigned to this IPAM pool.
|
CreateIpamPoolRequest.Builder |
addressFamily(String addressFamily)
The IP protocol assigned to this IPAM pool.
|
CreateIpamPoolRequest.Builder |
allocationDefaultNetmaskLength(Integer allocationDefaultNetmaskLength)
The default netmask length for allocations added to this pool.
|
CreateIpamPoolRequest.Builder |
allocationMaxNetmaskLength(Integer allocationMaxNetmaskLength)
The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant.
|
CreateIpamPoolRequest.Builder |
allocationMinNetmaskLength(Integer allocationMinNetmaskLength)
The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant.
|
CreateIpamPoolRequest.Builder |
allocationResourceTags(Collection<RequestIpamResourceTag> allocationResourceTags)
Tags that are required for resources that use CIDRs from this IPAM pool.
|
CreateIpamPoolRequest.Builder |
allocationResourceTags(Consumer<RequestIpamResourceTag.Builder>... allocationResourceTags)
Tags that are required for resources that use CIDRs from this IPAM pool.
|
CreateIpamPoolRequest.Builder |
allocationResourceTags(RequestIpamResourceTag... allocationResourceTags)
Tags that are required for resources that use CIDRs from this IPAM pool.
|
CreateIpamPoolRequest.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.
|
CreateIpamPoolRequest.Builder |
awsService(IpamPoolAwsService awsService)
Limits which service in Amazon Web Services that the pool can be used in.
|
CreateIpamPoolRequest.Builder |
awsService(String awsService)
Limits which service in Amazon Web Services that the pool can be used in.
|
CreateIpamPoolRequest.Builder |
clientToken(String clientToken)
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
|
CreateIpamPoolRequest.Builder |
description(String description)
A description for the IPAM pool.
|
CreateIpamPoolRequest.Builder |
ipamScopeId(String ipamScopeId)
The ID of the scope in which you would like to create the IPAM pool.
|
CreateIpamPoolRequest.Builder |
locale(String locale)
In IPAM, the locale is the Amazon Web Services Region where you want to make an IPAM pool available for
allocations.
|
CreateIpamPoolRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
CreateIpamPoolRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
CreateIpamPoolRequest.Builder |
publicIpSource(IpamPoolPublicIpSource publicIpSource)
The IP address source for pools in the public scope.
|
CreateIpamPoolRequest.Builder |
publicIpSource(String publicIpSource)
The IP address source for pools in the public scope.
|
CreateIpamPoolRequest.Builder |
publiclyAdvertisable(Boolean publiclyAdvertisable)
Determines if the pool is publicly advertisable.
|
CreateIpamPoolRequest.Builder |
sourceIpamPoolId(String sourceIpamPoolId)
The ID of the source IPAM pool.
|
CreateIpamPoolRequest.Builder |
tagSpecifications(Collection<TagSpecification> tagSpecifications)
The key/value combination of a tag assigned to the resource.
|
CreateIpamPoolRequest.Builder |
tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications)
The key/value combination of a tag assigned to the resource.
|
CreateIpamPoolRequest.Builder |
tagSpecifications(TagSpecification... tagSpecifications)
The key/value combination of a tag assigned to the resource.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildCreateIpamPoolRequest.Builder ipamScopeId(String ipamScopeId)
The ID of the scope in which you would like to create the IPAM pool.
ipamScopeId - The ID of the scope in which you would like to create the IPAM pool.CreateIpamPoolRequest.Builder locale(String locale)
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 do not choose a locale, resources in Regions others than the IPAM's home region cannot use CIDRs from this pool.
Possible values: Any Amazon Web Services Region, such as us-east-1.
locale - 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 do not choose a locale, resources in Regions others than the IPAM's home region
cannot use CIDRs from this pool.
Possible values: Any Amazon Web Services Region, such as us-east-1.
CreateIpamPoolRequest.Builder sourceIpamPoolId(String sourceIpamPoolId)
The ID of the source IPAM pool. Use this option to create a pool within an existing pool. Note that the CIDR you provision for the pool within the source pool must be available in the source pool's CIDR range.
sourceIpamPoolId - The ID of the source IPAM pool. Use this option to create a pool within an existing pool. Note that
the CIDR you provision for the pool within the source pool must be available in the source pool's CIDR
range.CreateIpamPoolRequest.Builder description(String description)
A description for the IPAM pool.
description - A description for the IPAM pool.CreateIpamPoolRequest.Builder addressFamily(String addressFamily)
The IP protocol assigned to this IPAM pool. You must choose either IPv4 or IPv6 protocol for a pool.
addressFamily - The IP protocol assigned to this IPAM pool. You must choose either IPv4 or IPv6 protocol for a pool.AddressFamily,
AddressFamilyCreateIpamPoolRequest.Builder addressFamily(AddressFamily addressFamily)
The IP protocol assigned to this IPAM pool. You must choose either IPv4 or IPv6 protocol for a pool.
addressFamily - The IP protocol assigned to this IPAM pool. You must choose either IPv4 or IPv6 protocol for a pool.AddressFamily,
AddressFamilyCreateIpamPoolRequest.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.
CreateIpamPoolRequest.Builder publiclyAdvertisable(Boolean publiclyAdvertisable)
Determines if the pool is publicly advertisable. This option is not available for pools with AddressFamily
set to ipv4.
publiclyAdvertisable - Determines if the pool is publicly advertisable. This option is not available for pools with
AddressFamily set to ipv4.CreateIpamPoolRequest.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.CreateIpamPoolRequest.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.CreateIpamPoolRequest.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.CreateIpamPoolRequest.Builder allocationResourceTags(Collection<RequestIpamResourceTag> 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.CreateIpamPoolRequest.Builder allocationResourceTags(RequestIpamResourceTag... 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.CreateIpamPoolRequest.Builder allocationResourceTags(Consumer<RequestIpamResourceTag.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 theRequestIpamResourceTag.Builder avoiding the need to create
one manually via RequestIpamResourceTag.builder().
When the Consumer completes,
SdkBuilder.build() is called
immediately and its result is passed to #allocationResourceTags(List.
allocationResourceTags - a consumer that will call methods on
RequestIpamResourceTag.Builder#allocationResourceTags(java.util.Collection) CreateIpamPoolRequest.Builder tagSpecifications(Collection<TagSpecification> tagSpecifications)
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.
tagSpecifications - 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.CreateIpamPoolRequest.Builder tagSpecifications(TagSpecification... tagSpecifications)
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.
tagSpecifications - 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.CreateIpamPoolRequest.Builder tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications)
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.
TagSpecification.Builder avoiding the need to create one
manually via TagSpecification.builder().
When the Consumer completes,
SdkBuilder.build() is called immediately and
its result is passed to #tagSpecifications(List.
tagSpecifications - a consumer that will call methods on
TagSpecification.Builder#tagSpecifications(java.util.Collection) CreateIpamPoolRequest.Builder clientToken(String clientToken)
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For
more information, see Ensuring
Idempotency.CreateIpamPoolRequest.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,
IpamPoolAwsServiceCreateIpamPoolRequest.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,
IpamPoolAwsServiceCreateIpamPoolRequest.Builder publicIpSource(String 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 if PublicIpSource is amazon. For information on increasing the default
limit, see Quotas for your IPAM
in the Amazon VPC IPAM User Guide.
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 if PublicIpSource is amazon. For information on increasing
the default limit, see Quotas
for your IPAM in the Amazon VPC IPAM User Guide.IpamPoolPublicIpSource,
IpamPoolPublicIpSourceCreateIpamPoolRequest.Builder publicIpSource(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 if PublicIpSource is amazon. For information on increasing the default
limit, see Quotas for your IPAM
in the Amazon VPC IPAM User Guide.
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 if PublicIpSource is amazon. For information on increasing
the default limit, see Quotas
for your IPAM in the Amazon VPC IPAM User Guide.IpamPoolPublicIpSource,
IpamPoolPublicIpSourceCreateIpamPoolRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderCreateIpamPoolRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2023. All rights reserved.