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.AllocateIpamPoolCidrRequest

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface AllocateIpamPoolCidrRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<String>`	`allowedCidrs()`	Include a particular CIDR range that can be returned by the pool.
`static AllocateIpamPoolCidrRequest.Builder`	`builder()`
`String`	`cidr()`	The CIDR you would like to allocate from the IPAM pool.
`String`	`clientToken()`	A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`String`	`description()`	A description for the allocation.
`List<String>`	`disallowedCidrs()`	Exclude a particular CIDR range from being returned by the pool.
`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)`
`boolean`	`hasAllowedCidrs()`	For responses, this returns true if the service returned a value for the AllowedCidrs property.
`boolean`	`hasDisallowedCidrs()`	For responses, this returns true if the service returned a value for the DisallowedCidrs property.
`int`	`hashCode()`
`String`	`ipamPoolId()`	The ID of the IPAM pool from which you would like to allocate a CIDR.
`Integer`	`netmaskLength()`	The netmask length of the CIDR you would like to allocate from the IPAM pool.
`Boolean`	`previewNextCidr()`	A preview of the next available CIDR in a pool.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AllocateIpamPoolCidrRequest.Builder>`	`serializableBuilderClass()`
`AllocateIpamPoolCidrRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

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 from which you would like to allocate a CIDR.
    
    Returns:
    
    The ID of the IPAM pool from which you would like to allocate a CIDR.
  - cidr
```
public final String 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:
    
    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.
  - netmaskLength
```
public final Integer 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:
    
    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.
  - 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.
  - description
```
public final String description()
```
    A description for the allocation.
    
    Returns:
    
    A description for the allocation.
  - previewNextCidr
```
public final Boolean previewNextCidr()
```
    A preview of the next available CIDR in a pool.
    
    Returns:
    
    A preview of the next available CIDR in a pool.
  - hasAllowedCidrs
```
public final boolean hasAllowedCidrs()
```
    For responses, this returns true if the service returned a value for the AllowedCidrs property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - allowedCidrs
```
public final List<String> allowedCidrs()
```
    Include a particular CIDR range that can be returned by the pool. Allowed CIDRs are only allowed if using netmask length for allocation.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAllowedCidrs() method.
    
    Returns:
    
    Include a particular CIDR range that can be returned by the pool. Allowed CIDRs are only allowed if using netmask length for allocation.
  - hasDisallowedCidrs
```
public final boolean hasDisallowedCidrs()
```
    For responses, this returns true if the service returned a value for the DisallowedCidrs property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - disallowedCidrs
```
public final List<String> disallowedCidrs()
```
    Exclude a particular CIDR range from being returned by the pool. Disallowed CIDRs are only allowed if using netmask length for allocation.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDisallowedCidrs() method.
    
    Returns:
    
    Exclude a particular CIDR range from being returned by the pool. Disallowed CIDRs are only allowed if using netmask length for allocation.
  - toBuilder
```
public AllocateIpamPoolCidrRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AllocateIpamPoolCidrRequest.Builder,AllocateIpamPoolCidrRequest>
    
    Specified by:
    
    toBuilder in class Ec2Request
  - builder
```
public static AllocateIpamPoolCidrRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AllocateIpamPoolCidrRequest.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

Class AllocateIpamPoolCidrRequest

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

netmaskLength

clientToken

description

previewNextCidr

hasAllowedCidrs

allowedCidrs

hasDisallowedCidrs

disallowedCidrs

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields