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

Interface CreateIpamPoolRequest.Builder

    • Method Detail

      • dryRun

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

      • ipamScopeId

        CreateIpamPoolRequest.Builder ipamScopeId​(String ipamScopeId)

        The ID of the scope in which you would like to create the IPAM pool.

        Parameters:
        ipamScopeId - The ID of the scope in which you would like to create the IPAM pool.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • locale

        CreateIpamPoolRequest.Builder locale​(String locale)

        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.

        Possible values: Any Amazon Web Services Region or supported Amazon Web Services Local Zone. Default is none and means any locale.

        Parameters:
        locale - 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.

        Possible values: Any Amazon Web Services Region or supported Amazon Web Services Local Zone. Default is none and means any locale.

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

      • sourceIpamPoolId

        CreateIpamPoolRequest.Builder sourceIpamPoolId​(String sourceIpamPoolId)

        The ID of the source IPAM pool. Use this option to create a pool within an existing pool. Note that the CIDR you provision for the pool within the source pool must be available in the source pool's CIDR range.

        Parameters:
        sourceIpamPoolId - The ID of the source IPAM pool. Use this option to create a pool within an existing pool. Note that the CIDR you provision for the pool within the source pool must be available in the source pool's CIDR range.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        CreateIpamPoolRequest.Builder description​(String description)

        A description for the IPAM pool.

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

      • addressFamily

        CreateIpamPoolRequest.Builder addressFamily​(String addressFamily)

        The IP protocol assigned to this IPAM pool. You must choose either IPv4 or IPv6 protocol for a pool.

        Parameters:
        addressFamily - The IP protocol assigned to this IPAM pool. You must choose either IPv4 or IPv6 protocol for a pool.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AddressFamily, AddressFamily

      • addressFamily

        CreateIpamPoolRequest.Builder addressFamily​(AddressFamily addressFamily)

        The IP protocol assigned to this IPAM pool. You must choose either IPv4 or IPv6 protocol for a pool.

        Parameters:
        addressFamily - The IP protocol assigned to this IPAM pool. You must choose either IPv4 or IPv6 protocol for a pool.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AddressFamily, AddressFamily

      • autoImport

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

        CreateIpamPoolRequest.Builder publiclyAdvertisable​(Boolean publiclyAdvertisable)

        Determines if the pool is publicly advertisable. The request can only contain PubliclyAdvertisable if AddressFamily is ipv6 and PublicIpSource is byoip.

        Parameters:
        publiclyAdvertisable - Determines if the pool is publicly advertisable. The request can only contain PubliclyAdvertisable if AddressFamily is ipv6 and PublicIpSource is byoip.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • allocationMinNetmaskLength

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

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

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

        CreateIpamPoolRequest.Builder allocationResourceTags​(Collection<RequestIpamResourceTag> 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

        CreateIpamPoolRequest.Builder allocationResourceTags​(RequestIpamResourceTag... 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

        CreateIpamPoolRequest.Builder allocationResourceTags​(Consumer<RequestIpamResourceTag.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 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 #allocationResourceTags(List).

        Parameters:
        allocationResourceTags - 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:
        #allocationResourceTags(java.util.Collection)

      • tagSpecifications

        CreateIpamPoolRequest.Builder tagSpecifications​(Collection<TagSpecification> tagSpecifications)

        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:
        tagSpecifications - 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.

      • tagSpecifications

        CreateIpamPoolRequest.Builder tagSpecifications​(TagSpecification... tagSpecifications)

        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:
        tagSpecifications - 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.

      • tagSpecifications

        CreateIpamPoolRequest.Builder tagSpecifications​(Consumer<TagSpecification.Builder>... tagSpecifications)

        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 TagSpecification.Builder avoiding the need to create one manually via TagSpecification.builder().

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

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

      • clientToken

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

      • awsService

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

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

        CreateIpamPoolRequest.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 if PublicIpSource is amazon. 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 if PublicIpSource is amazon. 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

        CreateIpamPoolRequest.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 if PublicIpSource is amazon. 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 if PublicIpSource is amazon. 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

        CreateIpamPoolRequest.Builder sourceResource​(IpamPoolSourceResourceRequest 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.