java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.ec2.model.Ec2Request
    - - software.amazon.awssdk.services.ec2.model.ProvisionIpamPoolCidrRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<ProvisionIpamPoolCidrRequest.Builder,ProvisionIpamPoolCidrRequest>

@Generated("software.amazon.awssdk:codegen")
public final class ProvisionIpamPoolCidrRequest
extends Ec2Request
implements ToCopyableBuilder<ProvisionIpamPoolCidrRequest.Builder,ProvisionIpamPoolCidrRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ProvisionIpamPoolCidrRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ProvisionIpamPoolCidrRequest.Builder`	`builder()`
`String`	`cidr()`	The CIDR you want to assign to the IPAM pool.
`IpamCidrAuthorizationContext`	`cidrAuthorizationContext()`	A signed document that proves that you are authorized to bring a specified IP address range to Amazon using BYOIP.
`String`	`clientToken()`	A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`Boolean`	`dryRun()`	A check for whether you have the required permissions for the action without actually making the request and provides an error response.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`ipamExternalResourceVerificationTokenId()`	Verification token ID.
`String`	`ipamPoolId()`	The ID of the IPAM pool to which you want to assign a CIDR.
`Integer`	`netmaskLength()`	The netmask length of the CIDR you'd like to provision to a pool.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ProvisionIpamPoolCidrRequest.Builder>`	`serializableBuilderClass()`
`ProvisionIpamPoolCidrRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`VerificationMethod`	`verificationMethod()`	The method for verifying control of a public IP address range.
`String`	`verificationMethodAsString()`	The method for verifying control of a public IP address range.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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
  - dryRun
```
public final Boolean 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 is UnauthorizedOperation.
    
    Returns:
    
    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 is UnauthorizedOperation.
  - ipamPoolId
```
public final String ipamPoolId()
```
    The ID of the IPAM pool to which you want to assign a CIDR.
    
    Returns:
    
    The ID of the IPAM pool to which you want to assign a CIDR.
  - cidr
```
public final String 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:
    
    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.
  - cidrAuthorizationContext
```
public final 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.
    
    Returns:
    
    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.
  - netmaskLength
```
public final Integer 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:
    
    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.
  - clientToken
```
public final String clientToken()
```
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
    
    Returns:
    
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
  - verificationMethod
```
public final VerificationMethod verificationMethod()
```
    The method for verifying control of a public IP address range. Defaults to remarks-x509 if not specified. This option only applies to IPv4 and IPv6 pools in the public scope.
    
    If the service returns an enum value that is not available in the current SDK version, verificationMethod will return VerificationMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from verificationMethodAsString().
    
    Returns:
    
    The method for verifying control of a public IP address range. Defaults to remarks-x509 if not specified. This option only applies to IPv4 and IPv6 pools in the public scope.
    
    See Also:
    
    VerificationMethod
  - verificationMethodAsString
```
public final String verificationMethodAsString()
```
    The method for verifying control of a public IP address range. Defaults to remarks-x509 if not specified. This option only applies to IPv4 and IPv6 pools in the public scope.
    
    If the service returns an enum value that is not available in the current SDK version, verificationMethod will return VerificationMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from verificationMethodAsString().
    
    Returns:
    
    The method for verifying control of a public IP address range. Defaults to remarks-x509 if not specified. This option only applies to IPv4 and IPv6 pools in the public scope.
    
    See Also:
    
    VerificationMethod
  - ipamExternalResourceVerificationTokenId
```
public final String ipamExternalResourceVerificationTokenId()
```
    Verification token ID. This option only applies to IPv4 and IPv6 pools in the public scope.
    
    Returns:
    
    Verification token ID. This option only applies to IPv4 and IPv6 pools in the public scope.
  - toBuilder
```
public ProvisionIpamPoolCidrRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ProvisionIpamPoolCidrRequest.Builder,ProvisionIpamPoolCidrRequest>
    
    Specified by:
    
    toBuilder in class Ec2Request
  - builder
```
public static ProvisionIpamPoolCidrRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ProvisionIpamPoolCidrRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class ProvisionIpamPoolCidrRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

dryRun

ipamPoolId

cidr

cidrAuthorizationContext

netmaskLength

clientToken

verificationMethod

verificationMethodAsString

ipamExternalResourceVerificationTokenId

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField