Interface AllocateIpamPoolCidrRequest.Builder

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

  • Method Details

    • dryRun

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

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

    • cidr

      AllocateIpamPoolCidrRequest.Builder cidr(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.

    • netmaskLength

      AllocateIpamPoolCidrRequest.Builder netmaskLength(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.

    • clientToken

      AllocateIpamPoolCidrRequest.Builder clientToken(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.

    • description

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

    • previewNextCidr

      AllocateIpamPoolCidrRequest.Builder previewNextCidr(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.

    • allowedCidrs

      AllocateIpamPoolCidrRequest.Builder allowedCidrs(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.

    • allowedCidrs

      AllocateIpamPoolCidrRequest.Builder allowedCidrs(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.

    • disallowedCidrs

      AllocateIpamPoolCidrRequest.Builder disallowedCidrs(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.

    • disallowedCidrs

      AllocateIpamPoolCidrRequest.Builder disallowedCidrs(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.

    • overrideConfiguration

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

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