com.amazonaws.services.ec2.model

Class DeleteIpamRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.DeleteIpamRequest

All Implemented Interfaces:

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

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

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DeleteIpamRequest()

Method Summary

Modifier and Type	Method and Description
DeleteIpamRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Boolean	getCascade() Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes.
Request<DeleteIpamRequest>	getDryRunRequest() This method is intended for internal use only.
String	getIpamId() The ID of the IPAM to delete.
int	hashCode()
Boolean	isCascade() Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes.
void	setCascade(Boolean cascade) Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes.
void	setIpamId(String ipamId) The ID of the IPAM to delete.
String	toString() Returns a string representation of this object.
DeleteIpamRequest	withCascade(Boolean cascade) Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes.
DeleteIpamRequest	withIpamId(String ipamId) The ID of the IPAM to delete.

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

DeleteIpamRequest

public DeleteIpamRequest()

Method Detail

setIpamId

public void setIpamId(String ipamId)

The ID of the IPAM to delete.

Parameters:

ipamId - The ID of the IPAM to delete.

getIpamId

public String getIpamId()

The ID of the IPAM to delete.

Returns:

The ID of the IPAM to delete.

withIpamId

public DeleteIpamRequest withIpamId(String ipamId)

The ID of the IPAM to delete.

Parameters:

ipamId - The ID of the IPAM to delete.

Returns:

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

setCascade

public void setCascade(Boolean cascade)

Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes. You cannot delete the IPAM with this option if there is a pool in your public scope. If you use this option, IPAM does the following:

• Deallocates any CIDRs allocated to VPC resources (such as VPCs) in pools in private scopes.

  No VPC resources are deleted as a result of enabling this option. The CIDR associated with the resource will no longer be allocated from an IPAM pool, but the CIDR itself will remain unchanged.

• Deprovisions all IPv4 CIDRs provisioned to IPAM pools in private scopes.

• Deletes all IPAM pools in private scopes.

• Deletes all non-default private scopes in the IPAM.

• Deletes the default public and private scopes and the IPAM.

Parameters:

cascade - Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes. You cannot delete the IPAM with this option if there is a pool in your public scope. If you use this option, IPAM does the following:

• Deallocates any CIDRs allocated to VPC resources (such as VPCs) in pools in private scopes.

  No VPC resources are deleted as a result of enabling this option. The CIDR associated with the resource will no longer be allocated from an IPAM pool, but the CIDR itself will remain unchanged.

• Deprovisions all IPv4 CIDRs provisioned to IPAM pools in private scopes.

• Deletes all IPAM pools in private scopes.

• Deletes all non-default private scopes in the IPAM.

• Deletes the default public and private scopes and the IPAM.

getCascade

public Boolean getCascade()

Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes. You cannot delete the IPAM with this option if there is a pool in your public scope. If you use this option, IPAM does the following:

• Deallocates any CIDRs allocated to VPC resources (such as VPCs) in pools in private scopes.

  No VPC resources are deleted as a result of enabling this option. The CIDR associated with the resource will no longer be allocated from an IPAM pool, but the CIDR itself will remain unchanged.

• Deprovisions all IPv4 CIDRs provisioned to IPAM pools in private scopes.

• Deletes all IPAM pools in private scopes.

• Deletes all non-default private scopes in the IPAM.

• Deletes the default public and private scopes and the IPAM.

Returns:

Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes. You cannot delete the IPAM with this option if there is a pool in your public scope. If you use this option, IPAM does the following:

• Deallocates any CIDRs allocated to VPC resources (such as VPCs) in pools in private scopes.

  No VPC resources are deleted as a result of enabling this option. The CIDR associated with the resource will no longer be allocated from an IPAM pool, but the CIDR itself will remain unchanged.

• Deprovisions all IPv4 CIDRs provisioned to IPAM pools in private scopes.

• Deletes all IPAM pools in private scopes.

• Deletes all non-default private scopes in the IPAM.

• Deletes the default public and private scopes and the IPAM.

withCascade

public DeleteIpamRequest withCascade(Boolean cascade)

Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes. You cannot delete the IPAM with this option if there is a pool in your public scope. If you use this option, IPAM does the following:

• Deallocates any CIDRs allocated to VPC resources (such as VPCs) in pools in private scopes.

  No VPC resources are deleted as a result of enabling this option. The CIDR associated with the resource will no longer be allocated from an IPAM pool, but the CIDR itself will remain unchanged.

• Deprovisions all IPv4 CIDRs provisioned to IPAM pools in private scopes.

• Deletes all IPAM pools in private scopes.

• Deletes all non-default private scopes in the IPAM.

• Deletes the default public and private scopes and the IPAM.

Parameters:

cascade - Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes. You cannot delete the IPAM with this option if there is a pool in your public scope. If you use this option, IPAM does the following:

• Deallocates any CIDRs allocated to VPC resources (such as VPCs) in pools in private scopes.

  No VPC resources are deleted as a result of enabling this option. The CIDR associated with the resource will no longer be allocated from an IPAM pool, but the CIDR itself will remain unchanged.

• Deprovisions all IPv4 CIDRs provisioned to IPAM pools in private scopes.

• Deletes all IPAM pools in private scopes.

• Deletes all non-default private scopes in the IPAM.

• Deletes the default public and private scopes and the IPAM.

Returns:

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

isCascade

public Boolean isCascade()

Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes. You cannot delete the IPAM with this option if there is a pool in your public scope. If you use this option, IPAM does the following:

• Deallocates any CIDRs allocated to VPC resources (such as VPCs) in pools in private scopes.

  No VPC resources are deleted as a result of enabling this option. The CIDR associated with the resource will no longer be allocated from an IPAM pool, but the CIDR itself will remain unchanged.

• Deprovisions all IPv4 CIDRs provisioned to IPAM pools in private scopes.

• Deletes all IPAM pools in private scopes.

• Deletes all non-default private scopes in the IPAM.

• Deletes the default public and private scopes and the IPAM.

Returns:

Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes. You cannot delete the IPAM with this option if there is a pool in your public scope. If you use this option, IPAM does the following:

• Deallocates any CIDRs allocated to VPC resources (such as VPCs) in pools in private scopes.

  No VPC resources are deleted as a result of enabling this option. The CIDR associated with the resource will no longer be allocated from an IPAM pool, but the CIDR itself will remain unchanged.

• Deprovisions all IPv4 CIDRs provisioned to IPAM pools in private scopes.

• Deletes all IPAM pools in private scopes.

• Deletes all non-default private scopes in the IPAM.

• Deletes the default public and private scopes and the IPAM.

getDryRunRequest

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

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