com.amazonaws.services.ec2.model

Class ModifyIpamPoolRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.ModifyIpamPoolRequest

All Implemented Interfaces:

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

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

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ModifyIpamPoolRequest()

Method Summary

Modifier and Type	Method and Description
ModifyIpamPoolRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<RequestIpamResourceTag>	getAddAllocationResourceTags() Add tag allocation rules to a pool.
Integer	getAllocationDefaultNetmaskLength() The default netmask length for allocations added to this pool.
Integer	getAllocationMaxNetmaskLength() The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant.
Integer	getAllocationMinNetmaskLength() The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant.
Boolean	getAutoImport() If true, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM.
Boolean	getClearAllocationDefaultNetmaskLength() Clear the default netmask length allocation rule for this pool.
String	getDescription() The description of the IPAM pool you want to modify.
Request<ModifyIpamPoolRequest>	getDryRunRequest() This method is intended for internal use only.
String	getIpamPoolId() The ID of the IPAM pool you want to modify.
List<RequestIpamResourceTag>	getRemoveAllocationResourceTags() Remove tag allocation rules from a pool.
int	hashCode()
Boolean	isAutoImport() If true, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM.
Boolean	isClearAllocationDefaultNetmaskLength() Clear the default netmask length allocation rule for this pool.
void	setAddAllocationResourceTags(Collection<RequestIpamResourceTag> addAllocationResourceTags) Add tag allocation rules to a pool.
void	setAllocationDefaultNetmaskLength(Integer allocationDefaultNetmaskLength) The default netmask length for allocations added to this pool.
void	setAllocationMaxNetmaskLength(Integer allocationMaxNetmaskLength) The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant.
void	setAllocationMinNetmaskLength(Integer allocationMinNetmaskLength) The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant.
void	setAutoImport(Boolean autoImport) If true, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM.
void	setClearAllocationDefaultNetmaskLength(Boolean clearAllocationDefaultNetmaskLength) Clear the default netmask length allocation rule for this pool.
void	setDescription(String description) The description of the IPAM pool you want to modify.
void	setIpamPoolId(String ipamPoolId) The ID of the IPAM pool you want to modify.
void	setRemoveAllocationResourceTags(Collection<RequestIpamResourceTag> removeAllocationResourceTags) Remove tag allocation rules from a pool.
String	toString() Returns a string representation of this object.
ModifyIpamPoolRequest	withAddAllocationResourceTags(Collection<RequestIpamResourceTag> addAllocationResourceTags) Add tag allocation rules to a pool.
ModifyIpamPoolRequest	withAddAllocationResourceTags(RequestIpamResourceTag... addAllocationResourceTags) Add tag allocation rules to a pool.
ModifyIpamPoolRequest	withAllocationDefaultNetmaskLength(Integer allocationDefaultNetmaskLength) The default netmask length for allocations added to this pool.
ModifyIpamPoolRequest	withAllocationMaxNetmaskLength(Integer allocationMaxNetmaskLength) The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant.
ModifyIpamPoolRequest	withAllocationMinNetmaskLength(Integer allocationMinNetmaskLength) The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant.
ModifyIpamPoolRequest	withAutoImport(Boolean autoImport) If true, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM.
ModifyIpamPoolRequest	withClearAllocationDefaultNetmaskLength(Boolean clearAllocationDefaultNetmaskLength) Clear the default netmask length allocation rule for this pool.
ModifyIpamPoolRequest	withDescription(String description) The description of the IPAM pool you want to modify.
ModifyIpamPoolRequest	withIpamPoolId(String ipamPoolId) The ID of the IPAM pool you want to modify.
ModifyIpamPoolRequest	withRemoveAllocationResourceTags(Collection<RequestIpamResourceTag> removeAllocationResourceTags) Remove tag allocation rules from a pool.
ModifyIpamPoolRequest	withRemoveAllocationResourceTags(RequestIpamResourceTag... removeAllocationResourceTags) Remove tag allocation rules from 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

ModifyIpamPoolRequest

public ModifyIpamPoolRequest()

Method Detail

setIpamPoolId

public void setIpamPoolId(String ipamPoolId)

The ID of the IPAM pool you want to modify.

Parameters:

ipamPoolId - The ID of the IPAM pool you want to modify.

getIpamPoolId

public String getIpamPoolId()

The ID of the IPAM pool you want to modify.

Returns:

The ID of the IPAM pool you want to modify.

withIpamPoolId

public ModifyIpamPoolRequest withIpamPoolId(String ipamPoolId)

The ID of the IPAM pool you want to modify.

Parameters:

ipamPoolId - The ID of the IPAM pool you want to modify.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDescription

public void setDescription(String description)

The description of the IPAM pool you want to modify.

Parameters:

description - The description of the IPAM pool you want to modify.

getDescription

public String getDescription()

The description of the IPAM pool you want to modify.

Returns:

The description of the IPAM pool you want to modify.

withDescription

public ModifyIpamPoolRequest withDescription(String description)

The description of the IPAM pool you want to modify.

Parameters:

description - The description of the IPAM pool you want to modify.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAutoImport

public void setAutoImport(Boolean autoImport)

If true, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.

A locale must be set on the pool for this feature to work.

Parameters:

autoImport - If true, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.

A locale must be set on the pool for this feature to work.

getAutoImport

public Boolean getAutoImport()

If true, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.

A locale must be set on the pool for this feature to work.

Returns:

If true, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.

A locale must be set on the pool for this feature to work.

withAutoImport

public ModifyIpamPoolRequest withAutoImport(Boolean autoImport)

If true, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.

A locale must be set on the pool for this feature to work.

Parameters:

autoImport - If true, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.

A locale must be set on the pool for this feature to work.

Returns:

Returns a reference to this object so that method calls can be chained together.

isAutoImport

public Boolean isAutoImport()

If true, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.

A locale must be set on the pool for this feature to work.

Returns:

If true, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.

A locale must be set on the pool for this feature to work.

setAllocationMinNetmaskLength

public void setAllocationMinNetmaskLength(Integer allocationMinNetmaskLength)

The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. The minimum netmask length must be less than the maximum netmask length.

Parameters:

allocationMinNetmaskLength - The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. The minimum netmask length must be less than the maximum netmask length.

getAllocationMinNetmaskLength

public Integer getAllocationMinNetmaskLength()

The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. The minimum netmask length must be less than the maximum netmask length.

Returns:

The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. The minimum netmask length must be less than the maximum netmask length.

withAllocationMinNetmaskLength

public ModifyIpamPoolRequest withAllocationMinNetmaskLength(Integer allocationMinNetmaskLength)

The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. The minimum netmask length must be less than the maximum netmask length.

Parameters:

allocationMinNetmaskLength - The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. The minimum netmask length must be less than the maximum netmask length.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAllocationMaxNetmaskLength

public void setAllocationMaxNetmaskLength(Integer allocationMaxNetmaskLength)

The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.The maximum netmask length must be greater than the minimum netmask length.

Parameters:

allocationMaxNetmaskLength - The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.The maximum netmask length must be greater than the minimum netmask length.

getAllocationMaxNetmaskLength

public Integer getAllocationMaxNetmaskLength()

The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.The maximum netmask length must be greater than the minimum netmask length.

Returns:

The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.The maximum netmask length must be greater than the minimum netmask length.

withAllocationMaxNetmaskLength

public ModifyIpamPoolRequest withAllocationMaxNetmaskLength(Integer allocationMaxNetmaskLength)

The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.The maximum netmask length must be greater than the minimum netmask length.

Parameters:

allocationMaxNetmaskLength - The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.The maximum netmask length must be greater than the minimum netmask length.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAllocationDefaultNetmaskLength

public void setAllocationDefaultNetmaskLength(Integer allocationDefaultNetmaskLength)

The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.

Parameters:

allocationDefaultNetmaskLength - The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.

getAllocationDefaultNetmaskLength

public Integer getAllocationDefaultNetmaskLength()

The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.

Returns:

The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.

withAllocationDefaultNetmaskLength

public ModifyIpamPoolRequest withAllocationDefaultNetmaskLength(Integer allocationDefaultNetmaskLength)

The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.

Parameters:

allocationDefaultNetmaskLength - The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.

Returns:

Returns a reference to this object so that method calls can be chained together.

setClearAllocationDefaultNetmaskLength

public void setClearAllocationDefaultNetmaskLength(Boolean clearAllocationDefaultNetmaskLength)

Clear the default netmask length allocation rule for this pool.

Parameters:

clearAllocationDefaultNetmaskLength - Clear the default netmask length allocation rule for this pool.

getClearAllocationDefaultNetmaskLength

public Boolean getClearAllocationDefaultNetmaskLength()

Clear the default netmask length allocation rule for this pool.

Returns:

Clear the default netmask length allocation rule for this pool.

withClearAllocationDefaultNetmaskLength

public ModifyIpamPoolRequest withClearAllocationDefaultNetmaskLength(Boolean clearAllocationDefaultNetmaskLength)

Clear the default netmask length allocation rule for this pool.

Parameters:

clearAllocationDefaultNetmaskLength - Clear the default netmask length allocation rule for this pool.

Returns:

Returns a reference to this object so that method calls can be chained together.

isClearAllocationDefaultNetmaskLength

public Boolean isClearAllocationDefaultNetmaskLength()

Clear the default netmask length allocation rule for this pool.

Returns:

Clear the default netmask length allocation rule for this pool.

getAddAllocationResourceTags

public List<RequestIpamResourceTag> getAddAllocationResourceTags()

Add tag allocation rules to a pool. For more information about allocation rules, see Create a top-level pool in the Amazon VPC IPAM User Guide.

Returns:

Add tag allocation rules to a pool. For more information about allocation rules, see Create a top-level pool in the Amazon VPC IPAM User Guide.

setAddAllocationResourceTags

public void setAddAllocationResourceTags(Collection<RequestIpamResourceTag> addAllocationResourceTags)

Add tag allocation rules to a pool. For more information about allocation rules, see Create a top-level pool in the Amazon VPC IPAM User Guide.

Parameters:

addAllocationResourceTags - Add tag allocation rules to a pool. For more information about allocation rules, see Create a top-level pool in the Amazon VPC IPAM User Guide.

withAddAllocationResourceTags

public ModifyIpamPoolRequest withAddAllocationResourceTags(RequestIpamResourceTag... addAllocationResourceTags)

Add tag allocation rules to a pool. For more information about allocation rules, see Create a top-level pool in the Amazon VPC IPAM User Guide.

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

Parameters:

addAllocationResourceTags - Add tag allocation rules to a pool. For more information about allocation rules, see Create a top-level pool in the Amazon VPC IPAM User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

withAddAllocationResourceTags

public ModifyIpamPoolRequest withAddAllocationResourceTags(Collection<RequestIpamResourceTag> addAllocationResourceTags)

Add tag allocation rules to a pool. For more information about allocation rules, see Create a top-level pool in the Amazon VPC IPAM User Guide.

Parameters:

addAllocationResourceTags - Add tag allocation rules to a pool. For more information about allocation rules, see Create a top-level pool in the Amazon VPC IPAM User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

getRemoveAllocationResourceTags

public List<RequestIpamResourceTag> getRemoveAllocationResourceTags()

Remove tag allocation rules from a pool.

Returns:

Remove tag allocation rules from a pool.

setRemoveAllocationResourceTags

public void setRemoveAllocationResourceTags(Collection<RequestIpamResourceTag> removeAllocationResourceTags)

Remove tag allocation rules from a pool.

Parameters:

removeAllocationResourceTags - Remove tag allocation rules from a pool.

withRemoveAllocationResourceTags

public ModifyIpamPoolRequest withRemoveAllocationResourceTags(RequestIpamResourceTag... removeAllocationResourceTags)

Remove tag allocation rules from a pool.

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

Parameters:

removeAllocationResourceTags - Remove tag allocation rules from a pool.

Returns:

Returns a reference to this object so that method calls can be chained together.

withRemoveAllocationResourceTags

public ModifyIpamPoolRequest withRemoveAllocationResourceTags(Collection<RequestIpamResourceTag> removeAllocationResourceTags)

Remove tag allocation rules from a pool.

Parameters:

removeAllocationResourceTags - Remove tag allocation rules from a pool.

Returns:

Returns a reference to this object so that method calls can be chained together.

getDryRunRequest

public Request<ModifyIpamPoolRequest> 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<ModifyIpamPoolRequest>

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 ModifyIpamPoolRequest 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()