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

Class CreateIpamPoolRequest

    • Method Detail

      • dryRun

        public final 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.

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

      • ipamScopeId

        public final String ipamScopeId()

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

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

      • locale

        public final 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.

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

      • sourceIpamPoolId

        public final 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.

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

      • description

        public final String description()

        A description for the IPAM pool.

        Returns:
        A description for the IPAM pool.

      • addressFamily

        public final AddressFamily addressFamily()

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

        If the service returns an enum value that is not available in the current SDK version, addressFamily will return AddressFamily.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from addressFamilyAsString().

        Returns:
        The IP protocol assigned to this IPAM pool. You must choose either IPv4 or IPv6 protocol for a pool.
        See Also:
        AddressFamily

      • addressFamilyAsString

        public final String addressFamilyAsString()

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

        If the service returns an enum value that is not available in the current SDK version, addressFamily will return AddressFamily.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from addressFamilyAsString().

        Returns:
        The IP protocol assigned to this IPAM pool. You must choose either IPv4 or IPv6 protocol for a pool.
        See Also:
        AddressFamily

      • autoImport

        public final 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.

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

      • publiclyAdvertisable

        public final Boolean publiclyAdvertisable()

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

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

      • allocationMinNetmaskLength

        public final 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.

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

      • allocationMaxNetmaskLength

        public final 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.

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

      • allocationDefaultNetmaskLength

        public final 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.

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

      • hasAllocationResourceTags

        public final boolean hasAllocationResourceTags()
        For responses, this returns true if the service returned a value for the AllocationResourceTags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • allocationResourceTags

        public final List<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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAllocationResourceTags() method.

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

      • hasTagSpecifications

        public final boolean hasTagSpecifications()
        For responses, this returns true if the service returned a value for the TagSpecifications property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • tagSpecifications

        public final List<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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTagSpecifications() method.

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

      • clientToken

        public final String clientToken()

        A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

        Returns:
        A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

      • awsService

        public final 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.

        If the service returns an enum value that is not available in the current SDK version, awsService will return IpamPoolAwsService.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from awsServiceAsString().

        Returns:
        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.
        See Also:
        IpamPoolAwsService

      • awsServiceAsString

        public final String awsServiceAsString()

        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.

        If the service returns an enum value that is not available in the current SDK version, awsService will return IpamPoolAwsService.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from awsServiceAsString().

        Returns:
        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.
        See Also:
        IpamPoolAwsService

      • publicIpSource

        public final 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.

        If the service returns an enum value that is not available in the current SDK version, publicIpSource will return IpamPoolPublicIpSource.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from publicIpSourceAsString().

        Returns:
        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.
        See Also:
        IpamPoolPublicIpSource

      • publicIpSourceAsString

        public final String publicIpSourceAsString()

        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.

        If the service returns an enum value that is not available in the current SDK version, publicIpSource will return IpamPoolPublicIpSource.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from publicIpSourceAsString().

        Returns:
        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.
        See Also:
        IpamPoolPublicIpSource

      • sourceResource

        public final IpamPoolSourceResourceRequest sourceResource()

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

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

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object