Package software.amazon.awssdk.services.ec2.model

Interface IpamPool.Builder

    • Method Detail

      • ownerId

        IpamPool.Builder ownerId​(String ownerId)

        The Amazon Web Services account ID of the owner of the IPAM pool.

        Parameters:
        ownerId - The Amazon Web Services account ID of the owner of the IPAM pool.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • ipamPoolId

        IpamPool.Builder ipamPoolId​(String ipamPoolId)

        The ID of the IPAM pool.

        Parameters:
        ipamPoolId - The ID of the IPAM pool.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sourceIpamPoolId

        IpamPool.Builder sourceIpamPoolId​(String sourceIpamPoolId)

        The ID of the source IPAM pool. You can use this option to create an IPAM pool within an existing source pool.

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

      • ipamPoolArn

        IpamPool.Builder ipamPoolArn​(String ipamPoolArn)

        The Amazon Resource Name (ARN) of the IPAM pool.

        Parameters:
        ipamPoolArn - The Amazon Resource Name (ARN) of the IPAM pool.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • ipamScopeArn

        IpamPool.Builder ipamScopeArn​(String ipamScopeArn)

        The ARN of the scope of the IPAM pool.

        Parameters:
        ipamScopeArn - The ARN of the scope of the IPAM pool.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • ipamScopeType

        IpamPool.Builder ipamScopeType​(String ipamScopeType)

        In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.

        Parameters:
        ipamScopeType - In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        IpamScopeType, IpamScopeType

      • ipamScopeType

        IpamPool.Builder ipamScopeType​(IpamScopeType ipamScopeType)

        In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.

        Parameters:
        ipamScopeType - In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        IpamScopeType, IpamScopeType

      • ipamArn

        IpamPool.Builder ipamArn​(String ipamArn)

        The ARN of the IPAM.

        Parameters:
        ipamArn - The ARN of the IPAM.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • ipamRegion

        IpamPool.Builder ipamRegion​(String ipamRegion)

        The Amazon Web Services Region of the IPAM pool.

        Parameters:
        ipamRegion - The Amazon Web Services Region of the IPAM pool.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • locale

        IpamPool.Builder locale​(String locale)

        The locale of the IPAM pool.

        The locale for the pool should be one of the following:

        • An Amazon Web Services Region where you want this IPAM pool to be available for allocations.

        • The network border group for an Amazon Web Services 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 Amazon Web Services Region for locale that has not been configured as an operating Region for the IPAM, you'll get an error.

        Parameters:
        locale - The locale of the IPAM pool.

        The locale for the pool should be one of the following:

        • An Amazon Web Services Region where you want this IPAM pool to be available for allocations.

        • The network border group for an Amazon Web Services 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 Amazon Web Services Region for locale that has not been configured as an operating Region for the IPAM, you'll get an error.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • poolDepth

        IpamPool.Builder poolDepth​(Integer poolDepth)

        The depth of pools in your IPAM pool. The pool depth quota is 10. For more information, see Quotas in IPAM in the Amazon VPC IPAM User Guide.

        Parameters:
        poolDepth - The depth of pools in your IPAM pool. The pool depth quota is 10. For more information, see Quotas in IPAM in the Amazon VPC IPAM User Guide.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • state

        IpamPool.Builder state​(String state)

        The state of the IPAM pool.

        Parameters:
        state - The state of the IPAM pool.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        IpamPoolState, IpamPoolState

      • stateMessage

        IpamPool.Builder stateMessage​(String stateMessage)

        The state message.

        Parameters:
        stateMessage - The state message.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        IpamPool.Builder description​(String description)

        The description of the IPAM pool.

        Parameters:
        description - The description of the IPAM pool.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • autoImport

        IpamPool.Builder autoImport​(Boolean 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.

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

      • publiclyAdvertisable

        IpamPool.Builder publiclyAdvertisable​(Boolean publiclyAdvertisable)

        Determines if a pool is publicly advertisable. This option is not available for pools with AddressFamily set to ipv4.

        Parameters:
        publiclyAdvertisable - Determines if a pool is publicly advertisable. This option is not available for pools with AddressFamily set to ipv4.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • addressFamily

        IpamPool.Builder addressFamily​(String addressFamily)

        The address family of the pool.

        Parameters:
        addressFamily - The address family of the pool.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AddressFamily, AddressFamily

      • addressFamily

        IpamPool.Builder addressFamily​(AddressFamily addressFamily)

        The address family of the pool.

        Parameters:
        addressFamily - The address family of the pool.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AddressFamily, AddressFamily

      • allocationMinNetmaskLength

        IpamPool.Builder allocationMinNetmaskLength​(Integer 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.

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

      • allocationMaxNetmaskLength

        IpamPool.Builder allocationMaxNetmaskLength​(Integer 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.

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

      • allocationDefaultNetmaskLength

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

      • allocationResourceTags

        IpamPool.Builder allocationResourceTags​(Collection<IpamResourceTag> 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.

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

      • allocationResourceTags

        IpamPool.Builder allocationResourceTags​(IpamResourceTag... 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.

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

      • allocationResourceTags

        IpamPool.Builder allocationResourceTags​(Consumer<IpamResourceTag.Builder>... 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.

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

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #allocationResourceTags(List).

        Parameters:
        allocationResourceTags - a consumer that will call methods on IpamResourceTag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #allocationResourceTags(java.util.Collection)

      • tags

        IpamPool.Builder tags​(Collection<Tag> 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.

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

      • tags

        IpamPool.Builder tags​(Tag... 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.

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

      • tags

        IpamPool.Builder tags​(Consumer<Tag.Builder>... 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.

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

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

        Parameters:
        tags - a consumer that will call methods on Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tags(java.util.Collection)

      • awsService

        IpamPool.Builder awsService​(String awsService)

        Limits which service in Amazon Web Services that the pool can be used in. "ec2", for example, allows users to use space for Elastic IP addresses and VPCs.

        Parameters:
        awsService - Limits which service in Amazon Web Services that the pool can be used in. "ec2", for example, allows users to use space for Elastic IP addresses and VPCs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        IpamPoolAwsService, IpamPoolAwsService

      • awsService

        IpamPool.Builder awsService​(IpamPoolAwsService awsService)

        Limits which service in Amazon Web Services that the pool can be used in. "ec2", for example, allows users to use space for Elastic IP addresses and VPCs.

        Parameters:
        awsService - Limits which service in Amazon Web Services that the pool can be used in. "ec2", for example, allows users to use space for Elastic IP addresses and VPCs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        IpamPoolAwsService, IpamPoolAwsService

      • publicIpSource

        IpamPool.Builder publicIpSource​(String 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.

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

      • publicIpSource

        IpamPool.Builder publicIpSource​(IpamPoolPublicIpSource 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.

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

      • sourceResource

        IpamPool.Builder sourceResource​(IpamPoolSourceResource sourceResource)

        The resource used to provision CIDRs to a resource planning pool.

        Parameters:
        sourceResource - The resource used to provision CIDRs to a resource planning pool.
        Returns:
        Returns a reference to this object so that method calls can be chained together.