Interface ProvisionIpamPoolCidrRequest.Builder
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<ProvisionIpamPoolCidrRequest.Builder,,ProvisionIpamPoolCidrRequest> Ec2Request.Builder,SdkBuilder<ProvisionIpamPoolCidrRequest.Builder,,ProvisionIpamPoolCidrRequest> SdkPojo,SdkRequest.Builder
- Enclosing class:
ProvisionIpamPoolCidrRequest
-
Method Summary
Modifier and TypeMethodDescriptionThe CIDR you want to assign to the IPAM pool.cidrAuthorizationContext(Consumer<IpamCidrAuthorizationContext.Builder> cidrAuthorizationContext) A signed document that proves that you are authorized to bring a specified IP address range to Amazon using BYOIP.cidrAuthorizationContext(IpamCidrAuthorizationContext cidrAuthorizationContext) A signed document that proves that you are authorized to bring a specified IP address range to Amazon using BYOIP.clientToken(String clientToken) A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.A check for whether you have the required permissions for the action without actually making the request and provides an error response.ipamExternalResourceVerificationTokenId(String ipamExternalResourceVerificationTokenId) Verification token ID.ipamPoolId(String ipamPoolId) The ID of the IPAM pool to which you want to assign a CIDR.netmaskLength(Integer netmaskLength) The netmask length of the CIDR you'd like to provision to a pool.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.verificationMethod(String verificationMethod) The method for verifying control of a public IP address range.verificationMethod(VerificationMethod verificationMethod) The method for verifying control of a public IP address range.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.services.ec2.model.Ec2Request.Builder
buildMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods 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 to which you want to assign a CIDR.
- Parameters:
ipamPoolId- The ID of the IPAM pool to which you want to assign a CIDR.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
cidr
The CIDR you want to assign to the IPAM pool. Either "NetmaskLength" or "Cidr" is required. This value will be null if you specify "NetmaskLength" and will be filled in during the provisioning process.
- Parameters:
cidr- The CIDR you want to assign to the IPAM pool. Either "NetmaskLength" or "Cidr" is required. This value will be null if you specify "NetmaskLength" and will be filled in during the provisioning process.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
cidrAuthorizationContext
ProvisionIpamPoolCidrRequest.Builder cidrAuthorizationContext(IpamCidrAuthorizationContext cidrAuthorizationContext) A signed document that proves that you are authorized to bring a specified IP address range to Amazon using BYOIP. This option only applies to IPv4 and IPv6 pools in the public scope.
- Parameters:
cidrAuthorizationContext- A signed document that proves that you are authorized to bring a specified IP address range to Amazon using BYOIP. This option only applies to IPv4 and IPv6 pools in the public scope.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
cidrAuthorizationContext
default ProvisionIpamPoolCidrRequest.Builder cidrAuthorizationContext(Consumer<IpamCidrAuthorizationContext.Builder> cidrAuthorizationContext) A signed document that proves that you are authorized to bring a specified IP address range to Amazon using BYOIP. This option only applies to IPv4 and IPv6 pools in the public scope.
This is a convenience method that creates an instance of theIpamCidrAuthorizationContext.Builderavoiding the need to create one manually viaIpamCidrAuthorizationContext.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tocidrAuthorizationContext(IpamCidrAuthorizationContext).- Parameters:
cidrAuthorizationContext- a consumer that will call methods onIpamCidrAuthorizationContext.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
netmaskLength
The netmask length of the CIDR you'd like to provision to a pool. Can be used for provisioning Amazon-provided IPv6 CIDRs to top-level pools and for provisioning CIDRs to pools with source pools. Cannot be used to provision BYOIP CIDRs to top-level pools. Either "NetmaskLength" or "Cidr" is required.
- Parameters:
netmaskLength- The netmask length of the CIDR you'd like to provision to a pool. Can be used for provisioning Amazon-provided IPv6 CIDRs to top-level pools and for provisioning CIDRs to pools with source pools. Cannot be used to provision BYOIP CIDRs to top-level pools. Either "NetmaskLength" or "Cidr" is required.- 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.
-
verificationMethod
The method for verifying control of a public IP address range. Defaults to
remarks-x509if not specified. This option only applies to IPv4 and IPv6 pools in the public scope.- Parameters:
verificationMethod- The method for verifying control of a public IP address range. Defaults toremarks-x509if not specified. This option only applies to IPv4 and IPv6 pools in the public scope.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
verificationMethod
The method for verifying control of a public IP address range. Defaults to
remarks-x509if not specified. This option only applies to IPv4 and IPv6 pools in the public scope.- Parameters:
verificationMethod- The method for verifying control of a public IP address range. Defaults toremarks-x509if not specified. This option only applies to IPv4 and IPv6 pools in the public scope.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
ipamExternalResourceVerificationTokenId
ProvisionIpamPoolCidrRequest.Builder ipamExternalResourceVerificationTokenId(String ipamExternalResourceVerificationTokenId) Verification token ID. This option only applies to IPv4 and IPv6 pools in the public scope.
- Parameters:
ipamExternalResourceVerificationTokenId- Verification token ID. This option only applies to IPv4 and IPv6 pools in the public scope.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
ProvisionIpamPoolCidrRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
overrideConfiguration- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
ProvisionIpamPoolCidrRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
builderConsumer- AConsumerto which an emptyAwsRequestOverrideConfiguration.Builderwill be given.- Returns:
- This object for method chaining.
-