Interface ModifyIpamPoolRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<ModifyIpamPoolRequest.Builder,ModifyIpamPoolRequest>, Ec2Request.Builder, SdkBuilder<ModifyIpamPoolRequest.Builder,ModifyIpamPoolRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
ModifyIpamPoolRequest
public static interface ModifyIpamPoolRequest.Builder extends Ec2Request.Builder, SdkPojo, CopyableBuilder<ModifyIpamPoolRequest.Builder,ModifyIpamPoolRequest>

  • Method Details

    • dryRun

      ModifyIpamPoolRequest.Builder dryRun(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • ipamPoolId

      ModifyIpamPoolRequest.Builder ipamPoolId(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.

    • description

      ModifyIpamPoolRequest.Builder description(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.

    • autoImport

      ModifyIpamPoolRequest.Builder autoImport(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.

    • allocationMinNetmaskLength

      ModifyIpamPoolRequest.Builder allocationMinNetmaskLength(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.

    • allocationMaxNetmaskLength

      ModifyIpamPoolRequest.Builder allocationMaxNetmaskLength(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.

    • allocationDefaultNetmaskLength

      ModifyIpamPoolRequest.Builder allocationDefaultNetmaskLength(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.

    • clearAllocationDefaultNetmaskLength

      ModifyIpamPoolRequest.Builder clearAllocationDefaultNetmaskLength(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.

    • addAllocationResourceTags

      ModifyIpamPoolRequest.Builder addAllocationResourceTags(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.

    • addAllocationResourceTags

      ModifyIpamPoolRequest.Builder addAllocationResourceTags(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.

    • addAllocationResourceTags

      ModifyIpamPoolRequest.Builder addAllocationResourceTags(Consumer<RequestIpamResourceTag.Builder>... 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.

      This is a convenience method that creates an instance of the RequestIpamResourceTag.Builder avoiding the need to create one manually via RequestIpamResourceTag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to addAllocationResourceTags(List<RequestIpamResourceTag>).

      Parameters:
      addAllocationResourceTags - a consumer that will call methods on RequestIpamResourceTag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • removeAllocationResourceTags

      ModifyIpamPoolRequest.Builder removeAllocationResourceTags(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.

    • removeAllocationResourceTags

      ModifyIpamPoolRequest.Builder removeAllocationResourceTags(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.

    • removeAllocationResourceTags

      ModifyIpamPoolRequest.Builder removeAllocationResourceTags(Consumer<RequestIpamResourceTag.Builder>... removeAllocationResourceTags)

      Remove tag allocation rules from a pool.

      This is a convenience method that creates an instance of the RequestIpamResourceTag.Builder avoiding the need to create one manually via RequestIpamResourceTag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to removeAllocationResourceTags(List<RequestIpamResourceTag>).

      Parameters:
      removeAllocationResourceTags - a consumer that will call methods on RequestIpamResourceTag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      ModifyIpamPoolRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      ModifyIpamPoolRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.