com.amazonaws.services.ec2.model

Class AllocateIpamPoolCidrRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.AllocateIpamPoolCidrRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, DryRunSupportedRequest<AllocateIpamPoolCidrRequest>, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AllocateIpamPoolCidrRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable, DryRunSupportedRequest<AllocateIpamPoolCidrRequest>

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
AllocateIpamPoolCidrRequest()

Method Summary

Modifier and Type	Method and Description
AllocateIpamPoolCidrRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<String>	getAllowedCidrs() Include a particular CIDR range that can be returned by the pool.
String	getCidr() The CIDR you would like to allocate from the IPAM pool.
String	getClientToken() A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String	getDescription() A description for the allocation.
List<String>	getDisallowedCidrs() Exclude a particular CIDR range from being returned by the pool.
Request<AllocateIpamPoolCidrRequest>	getDryRunRequest() This method is intended for internal use only.
String	getIpamPoolId() The ID of the IPAM pool from which you would like to allocate a CIDR.
Integer	getNetmaskLength() The netmask length of the CIDR you would like to allocate from the IPAM pool.
Boolean	getPreviewNextCidr() A preview of the next available CIDR in a pool.
int	hashCode()
Boolean	isPreviewNextCidr() A preview of the next available CIDR in a pool.
void	setAllowedCidrs(Collection<String> allowedCidrs) Include a particular CIDR range that can be returned by the pool.
void	setCidr(String cidr) The CIDR you would like to allocate from the IPAM pool.
void	setClientToken(String clientToken) A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
void	setDescription(String description) A description for the allocation.
void	setDisallowedCidrs(Collection<String> disallowedCidrs) Exclude a particular CIDR range from being returned by the pool.
void	setIpamPoolId(String ipamPoolId) The ID of the IPAM pool from which you would like to allocate a CIDR.
void	setNetmaskLength(Integer netmaskLength) The netmask length of the CIDR you would like to allocate from the IPAM pool.
void	setPreviewNextCidr(Boolean previewNextCidr) A preview of the next available CIDR in a pool.
String	toString() Returns a string representation of this object.
AllocateIpamPoolCidrRequest	withAllowedCidrs(Collection<String> allowedCidrs) Include a particular CIDR range that can be returned by the pool.
AllocateIpamPoolCidrRequest	withAllowedCidrs(String... allowedCidrs) Include a particular CIDR range that can be returned by the pool.
AllocateIpamPoolCidrRequest	withCidr(String cidr) The CIDR you would like to allocate from the IPAM pool.
AllocateIpamPoolCidrRequest	withClientToken(String clientToken) A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
AllocateIpamPoolCidrRequest	withDescription(String description) A description for the allocation.
AllocateIpamPoolCidrRequest	withDisallowedCidrs(Collection<String> disallowedCidrs) Exclude a particular CIDR range from being returned by the pool.
AllocateIpamPoolCidrRequest	withDisallowedCidrs(String... disallowedCidrs) Exclude a particular CIDR range from being returned by the pool.
AllocateIpamPoolCidrRequest	withIpamPoolId(String ipamPoolId) The ID of the IPAM pool from which you would like to allocate a CIDR.
AllocateIpamPoolCidrRequest	withNetmaskLength(Integer netmaskLength) The netmask length of the CIDR you would like to allocate from the IPAM pool.
AllocateIpamPoolCidrRequest	withPreviewNextCidr(Boolean previewNextCidr) A preview of the next available CIDR in a pool.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AllocateIpamPoolCidrRequest

public AllocateIpamPoolCidrRequest()

Method Detail

setIpamPoolId

public void setIpamPoolId(String 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.

getIpamPoolId

public String getIpamPoolId()

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.

withIpamPoolId

public AllocateIpamPoolCidrRequest withIpamPoolId(String 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.

setCidr

public void setCidr(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.

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.

getCidr

public String getCidr()

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.

withCidr

public AllocateIpamPoolCidrRequest withCidr(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.

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.

setNetmaskLength

public void setNetmaskLength(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.

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.

getNetmaskLength

public Integer getNetmaskLength()

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.

withNetmaskLength

public AllocateIpamPoolCidrRequest withNetmaskLength(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.

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.

setClientToken

public void setClientToken(String 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.

getClientToken

public String getClientToken()

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.

withClientToken

public AllocateIpamPoolCidrRequest withClientToken(String 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.

setDescription

public void setDescription(String description)

A description for the allocation.

Parameters:

description - A description for the allocation.

getDescription

public String getDescription()

A description for the allocation.

Returns:

A description for the allocation.

withDescription

public AllocateIpamPoolCidrRequest withDescription(String 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.

setPreviewNextCidr

public void setPreviewNextCidr(Boolean previewNextCidr)

A preview of the next available CIDR in a pool.

Parameters:

previewNextCidr - A preview of the next available CIDR in a pool.

getPreviewNextCidr

public Boolean getPreviewNextCidr()

A preview of the next available CIDR in a pool.

Returns:

A preview of the next available CIDR in a pool.

withPreviewNextCidr

public AllocateIpamPoolCidrRequest withPreviewNextCidr(Boolean 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.

isPreviewNextCidr

public Boolean isPreviewNextCidr()

A preview of the next available CIDR in a pool.

Returns:

A preview of the next available CIDR in a pool.

getAllowedCidrs

public List<String> getAllowedCidrs()

Include a particular CIDR range that can be returned by the pool. Allowed CIDRs are only allowed if using netmask length for allocation.

Returns:

Include a particular CIDR range that can be returned by the pool. Allowed CIDRs are only allowed if using netmask length for allocation.

setAllowedCidrs

public void setAllowedCidrs(Collection<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.

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.

withAllowedCidrs

public AllocateIpamPoolCidrRequest withAllowedCidrs(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.

NOTE: This method appends the values to the existing list (if any). Use setAllowedCidrs(java.util.Collection) or withAllowedCidrs(java.util.Collection) if you want to override the existing values.

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.

withAllowedCidrs

public AllocateIpamPoolCidrRequest withAllowedCidrs(Collection<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.

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.

getDisallowedCidrs

public List<String> getDisallowedCidrs()

Exclude a particular CIDR range from being returned by the pool. Disallowed CIDRs are only allowed if using netmask length for allocation.

Returns:

Exclude a particular CIDR range from being returned by the pool. Disallowed CIDRs are only allowed if using netmask length for allocation.

setDisallowedCidrs

public void setDisallowedCidrs(Collection<String> 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.

withDisallowedCidrs

public AllocateIpamPoolCidrRequest withDisallowedCidrs(String... disallowedCidrs)

Exclude a particular CIDR range from being returned by the pool. Disallowed CIDRs are only allowed if using netmask length for allocation.

NOTE: This method appends the values to the existing list (if any). Use setDisallowedCidrs(java.util.Collection) or withDisallowedCidrs(java.util.Collection) if you want to override the existing values.

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.

withDisallowedCidrs

public AllocateIpamPoolCidrRequest withDisallowedCidrs(Collection<String> 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.

getDryRunRequest

public Request<AllocateIpamPoolCidrRequest> getDryRunRequest()

This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.

Specified by:

getDryRunRequest in interface DryRunSupportedRequest<AllocateIpamPoolCidrRequest>

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public AllocateIpamPoolCidrRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()