Package software.amazon.awscdk.services.ec2

Class CfnIPAMAllocation.Builder

java.lang.Object
software.amazon.awscdk.services.ec2.CfnIPAMAllocation.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnIPAMAllocation>
Enclosing class:
CfnIPAMAllocation
@Stability(Stable) public static final class CfnIPAMAllocation.Builder extends Object implements software.amazon.jsii.Builder<CfnIPAMAllocation>
A fluent builder for CfnIPAMAllocation.

  • Method Details

    • create

      @Stability(Stable) public static CfnIPAMAllocation.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnIPAMAllocation.Builder.

    • ipamPoolId

      @Stability(Stable) public CfnIPAMAllocation.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. This parameter is required.
      Returns:
      this

    • cidr

      @Stability(Stable) public CfnIPAMAllocation.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:. This parameter is required.
      Returns:
      this

    • description

      @Stability(Stable) public CfnIPAMAllocation.Builder description(String description)
      A description for the allocation.

      Parameters:
      description - A description for the allocation. This parameter is required.
      Returns:
      this

    • netmaskLength

      @Stability(Stable) public CfnIPAMAllocation.Builder netmaskLength(Number 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:. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public CfnIPAMAllocation build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnIPAMAllocation>
      Returns:
      a newly built instance of CfnIPAMAllocation.