Class DeleteIpamRequest

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.DeleteIpamRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DeleteIpamRequest.Builder,DeleteIpamRequest>
@Generated("software.amazon.awssdk:codegen") public final class DeleteIpamRequest extends Ec2Request implements ToCopyableBuilder<DeleteIpamRequest.Builder,DeleteIpamRequest>

  • Method Details

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

    • ipamId

      public final String ipamId()

      The ID of the IPAM to delete.

      Returns:
      The ID of the IPAM to delete.

    • cascade

      public final 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.

      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.

    • toBuilder

      public DeleteIpamRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DeleteIpamRequest.Builder,DeleteIpamRequest>
      Specified by:
      toBuilder in class Ec2Request
      Returns:
      a builder for type T

    • builder

      public static DeleteIpamRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DeleteIpamRequest.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.