Interface AllocateIpamPoolCidrRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<AllocateIpamPoolCidrRequest.Builder,
,AllocateIpamPoolCidrRequest> Ec2Request.Builder
,SdkBuilder<AllocateIpamPoolCidrRequest.Builder,
,AllocateIpamPoolCidrRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
AllocateIpamPoolCidrRequest
-
Method Summary
Modifier and TypeMethodDescriptionallowedCidrs
(String... allowedCidrs) Include a particular CIDR range that can be returned by the pool.allowedCidrs
(Collection<String> allowedCidrs) Include a particular CIDR range that can be returned by the pool.The CIDR you would like to allocate from the IPAM pool.clientToken
(String clientToken) A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.description
(String description) A description for the allocation.disallowedCidrs
(String... disallowedCidrs) Exclude a particular CIDR range from being returned by the pool.disallowedCidrs
(Collection<String> disallowedCidrs) Exclude a particular CIDR range from being returned by the pool.A check for whether you have the required permissions for the action without actually making the request and provides an error response.ipamPoolId
(String ipamPoolId) The ID of the IPAM pool from which you would like to allocate a CIDR.netmaskLength
(Integer netmaskLength) The netmask length of the CIDR you would like to allocate from the IPAM pool.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.previewNextCidr
(Boolean previewNextCidr) A preview of the next available CIDR in a pool.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.ec2.model.Ec2Request.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
dryRun
A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.- Parameters:
dryRun
- A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response isDryRunOperation
. Otherwise, it isUnauthorizedOperation
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ipamPoolId
The ID of the IPAM pool from which you would like to allocate a CIDR.
- Parameters:
ipamPoolId
- The ID of the IPAM pool from which you would like to allocate a CIDR.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
cidr
The CIDR you would like to allocate from the IPAM pool. Note the following:
-
If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.
-
If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.
Possible values: Any available IPv4 or IPv6 CIDR.
- Parameters:
cidr
- The CIDR you would like to allocate from the IPAM pool. Note the following:-
If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.
-
If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.
Possible values: Any available IPv4 or IPv6 CIDR.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
netmaskLength
The netmask length of the CIDR you would like to allocate from the IPAM pool. Note the following:
-
If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.
-
If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.
Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
- Parameters:
netmaskLength
- The netmask length of the CIDR you would like to allocate from the IPAM pool. Note the following:-
If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.
-
If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.
Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
- Parameters:
clientToken
- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
A description for the allocation.
- Parameters:
description
- A description for the allocation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
previewNextCidr
A preview of the next available CIDR in a pool.
- Parameters:
previewNextCidr
- A preview of the next available CIDR in a pool.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
allowedCidrs
Include a particular CIDR range that can be returned by the pool. Allowed CIDRs are only allowed if using netmask length for allocation.
- Parameters:
allowedCidrs
- Include a particular CIDR range that can be returned by the pool. Allowed CIDRs are only allowed if using netmask length for allocation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
allowedCidrs
Include a particular CIDR range that can be returned by the pool. Allowed CIDRs are only allowed if using netmask length for allocation.
- Parameters:
allowedCidrs
- Include a particular CIDR range that can be returned by the pool. Allowed CIDRs are only allowed if using netmask length for allocation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
disallowedCidrs
Exclude a particular CIDR range from being returned by the pool. Disallowed CIDRs are only allowed if using netmask length for allocation.
- Parameters:
disallowedCidrs
- Exclude a particular CIDR range from being returned by the pool. Disallowed CIDRs are only allowed if using netmask length for allocation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
disallowedCidrs
Exclude a particular CIDR range from being returned by the pool. Disallowed CIDRs are only allowed if using netmask length for allocation.
- Parameters:
disallowedCidrs
- Exclude a particular CIDR range from being returned by the pool. Disallowed CIDRs are only allowed if using netmask length for allocation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
AllocateIpamPoolCidrRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
AllocateIpamPoolCidrRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-