Package software.amazon.awscdk.services.ec2

Class CfnIPAMPoolProps.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • addressFamily

      @Stability(Stable) public CfnIPAMPoolProps.Builder addressFamily(String addressFamily)
      Sets the value of CfnIPAMPoolProps.getAddressFamily()
      Parameters:
      addressFamily - The address family of the pool. This parameter is required.
      Returns:
      this

    • ipamScopeId

      @Stability(Stable) public CfnIPAMPoolProps.Builder ipamScopeId(String ipamScopeId)
      Sets the value of CfnIPAMPoolProps.getIpamScopeId()
      Parameters:
      ipamScopeId - The ID of the scope in which you would like to create the IPAM pool. This parameter is required.
      Returns:
      this

    • allocationDefaultNetmaskLength

      @Stability(Stable) public CfnIPAMPoolProps.Builder allocationDefaultNetmaskLength(Number allocationDefaultNetmaskLength)
      Sets the value of CfnIPAMPoolProps.getAllocationDefaultNetmaskLength()
      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:
      this

    • allocationMaxNetmaskLength

      @Stability(Stable) public CfnIPAMPoolProps.Builder allocationMaxNetmaskLength(Number allocationMaxNetmaskLength)
      Sets the value of CfnIPAMPoolProps.getAllocationMaxNetmaskLength()
      Parameters:
      allocationMaxNetmaskLength - The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
      Returns:
      this

    • allocationMinNetmaskLength

      @Stability(Stable) public CfnIPAMPoolProps.Builder allocationMinNetmaskLength(Number allocationMinNetmaskLength)
      Sets the value of CfnIPAMPoolProps.getAllocationMinNetmaskLength()
      Parameters:
      allocationMinNetmaskLength - The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
      Returns:
      this

    • allocationResourceTags

      @Stability(Stable) public CfnIPAMPoolProps.Builder allocationResourceTags(IResolvable allocationResourceTags)
      Sets the value of CfnIPAMPoolProps.getAllocationResourceTags()
      Parameters:
      allocationResourceTags - Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.
      Returns:
      this

    • allocationResourceTags

      @Stability(Stable) public CfnIPAMPoolProps.Builder allocationResourceTags(List<? extends Object> allocationResourceTags)
      Sets the value of CfnIPAMPoolProps.getAllocationResourceTags()
      Parameters:
      allocationResourceTags - Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.
      Returns:
      this

    • autoImport

      @Stability(Stable) public CfnIPAMPoolProps.Builder autoImport(Boolean autoImport)
      Sets the value of CfnIPAMPoolProps.getAutoImport()
      Parameters:
      autoImport - If selected, 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:
      this

    • autoImport

      @Stability(Stable) public CfnIPAMPoolProps.Builder autoImport(IResolvable autoImport)
      Sets the value of CfnIPAMPoolProps.getAutoImport()
      Parameters:
      autoImport - If selected, 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:
      this

    • awsService

      @Stability(Stable) public CfnIPAMPoolProps.Builder awsService(String awsService)
      Sets the value of CfnIPAMPoolProps.getAwsService()
      Parameters:
      awsService - Limits which service in AWS that the pool can be used in. "ec2", for example, allows users to use space for Elastic IP addresses and VPCs.
      Returns:
      this

    • description

      @Stability(Stable) public CfnIPAMPoolProps.Builder description(String description)
      Sets the value of CfnIPAMPoolProps.getDescription()
      Parameters:
      description - The description of the IPAM pool.
      Returns:
      this

    • locale

      @Stability(Stable) public CfnIPAMPoolProps.Builder locale(String locale)
      Sets the value of CfnIPAMPoolProps.getLocale()
      Parameters:
      locale - The locale of the IPAM pool. The locale for the pool should be one of the following:

      • An AWS Region where you want this IPAM pool to be available for allocations.
      • The network border group for an AWS Local Zone where you want this IPAM pool to be available for allocations ( supported Local Zones ). This option is only available for IPAM IPv4 pools in the public scope.

      If you choose an AWS Region for locale that has not been configured as an operating Region for the IPAM, you'll get an error.

      Returns:
      this

    • provisionedCidrs

      @Stability(Stable) public CfnIPAMPoolProps.Builder provisionedCidrs(IResolvable provisionedCidrs)
      Sets the value of CfnIPAMPoolProps.getProvisionedCidrs()
      Parameters:
      provisionedCidrs - Information about the CIDRs provisioned to an IPAM pool.
      Returns:
      this

    • provisionedCidrs

      @Stability(Stable) public CfnIPAMPoolProps.Builder provisionedCidrs(List<? extends Object> provisionedCidrs)
      Sets the value of CfnIPAMPoolProps.getProvisionedCidrs()
      Parameters:
      provisionedCidrs - Information about the CIDRs provisioned to an IPAM pool.
      Returns:
      this

    • publicIpSource

      @Stability(Stable) public CfnIPAMPoolProps.Builder publicIpSource(String publicIpSource)
      Sets the value of CfnIPAMPoolProps.getPublicIpSource()
      Parameters:
      publicIpSource - The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is BYOIP . For more information, see Create IPv6 pools in the Amazon VPC IPAM User Guide . By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool. For information on increasing the default limit, see Quotas for your IPAM in the Amazon VPC IPAM User Guide .
      Returns:
      this

    • publiclyAdvertisable

      @Stability(Stable) public CfnIPAMPoolProps.Builder publiclyAdvertisable(Boolean publiclyAdvertisable)
      Sets the value of CfnIPAMPoolProps.getPubliclyAdvertisable()
      Parameters:
      publiclyAdvertisable - Determines if a pool is publicly advertisable. This option is not available for pools with AddressFamily set to ipv4 .
      Returns:
      this

    • publiclyAdvertisable

      @Stability(Stable) public CfnIPAMPoolProps.Builder publiclyAdvertisable(IResolvable publiclyAdvertisable)
      Sets the value of CfnIPAMPoolProps.getPubliclyAdvertisable()
      Parameters:
      publiclyAdvertisable - Determines if a pool is publicly advertisable. This option is not available for pools with AddressFamily set to ipv4 .
      Returns:
      this

    • sourceIpamPoolId

      @Stability(Stable) public CfnIPAMPoolProps.Builder sourceIpamPoolId(String sourceIpamPoolId)
      Sets the value of CfnIPAMPoolProps.getSourceIpamPoolId()
      Parameters:
      sourceIpamPoolId - The ID of the source IPAM pool. You can use this option to create an IPAM pool within an existing source pool.
      Returns:
      this

    • sourceResource

      @Stability(Stable) public CfnIPAMPoolProps.Builder sourceResource(IResolvable sourceResource)
      Sets the value of CfnIPAMPoolProps.getSourceResource()
      Parameters:
      sourceResource - The resource used to provision CIDRs to a resource planning pool.
      Returns:
      this

    • sourceResource

      @Stability(Stable) public CfnIPAMPoolProps.Builder sourceResource(CfnIPAMPool.SourceResourceProperty sourceResource)
      Sets the value of CfnIPAMPoolProps.getSourceResource()
      Parameters:
      sourceResource - The resource used to provision CIDRs to a resource planning pool.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnIPAMPoolProps.Builder tags(List<? extends CfnTag> tags)
      Sets the value of CfnIPAMPoolProps.getTags()
      Parameters:
      tags - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA , specify tag:Owner for the filter name and TeamA for the filter value.
      Returns:
      this

    • build

      @Stability(Stable) public CfnIPAMPoolProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnIPAMPoolProps>
      Returns:
      a new instance of CfnIPAMPoolProps
      Throws:
      NullPointerException - if any required attribute was not provided