EC2 / Client / create_ipam_pool

create_ipam_pool#

EC2.Client.create_ipam_pool(**kwargs)#

Create an IP address pool for Amazon VPC IP Address Manager (IPAM). In IPAM, a pool is a collection of contiguous IP addresses CIDRs. Pools enable you to organize your IP addresses according to your routing and security needs. For example, if you have separate routing and security needs for development and production applications, you can create a pool for each.

For more information, see Create a top-level pool in the Amazon VPC IPAM User Guide.

Request Syntax

response = client.create_ipam_pool(
    DryRun=True|False,
    IpamScopeId='string',
    Locale='string',
    SourceIpamPoolId='string',
    Description='string',
    AddressFamily='ipv4'|'ipv6',
    AutoImport=True|False,
    PubliclyAdvertisable=True|False,
    AllocationMinNetmaskLength=123,
    AllocationMaxNetmaskLength=123,
    AllocationDefaultNetmaskLength=123,
    AllocationResourceTags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    TagSpecifications=[
        {
            'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    ClientToken='string',
    AwsService='ec2',
    PublicIpSource='amazon'|'byoip'
)

Parameters:

DryRun (boolean) – 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 (string) –
[REQUIRED]

The ID of the scope in which you would like to create the IPAM pool.
Locale (string) –
In IPAM, the locale is the Amazon Web Services Region where you want to make an IPAM pool available for allocations. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot modify it. If you do not choose a locale, resources in Regions others than the IPAM’s home region cannot use CIDRs from this pool.

Possible values: Any Amazon Web Services Region, such as us-east-1.
SourceIpamPoolId (string) – 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 (string) – A description for the IPAM pool.
AddressFamily (string) –
[REQUIRED]

The IP protocol assigned to this IPAM pool. You must choose either IPv4 or IPv6 protocol for a pool.
AutoImport (boolean) –
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 (boolean) – Determines if the pool is publicly advertisable. This option is not available for pools with AddressFamily set to ipv4.
AllocationMinNetmaskLength (integer) – 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 (integer) – 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 (integer) – 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.
AllocationResourceTags (list) –
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.
- (dict) –
  
  A tag on an IPAM resource.
  - Key (string) –
    
    The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
  - Value (string) –
    
    The value for the tag.
TagSpecifications (list) –
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.
- (dict) –
  
  The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.
  
  Note
  The Valid Values lists all the resource types that can be tagged. However, the action you’re using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you’re using, you’ll get an error.
  - ResourceType (string) –
    
    The type of resource to tag on creation.
  - Tags (list) –
    
    The tags to apply to the resource.
    - (dict) –
      
      Describes a tag.
      - Key (string) –
        
        The key of the tag.
        
        Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
      - Value (string) –
        
        The value of the tag.
        
        Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
ClientToken (string) –
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

This field is autopopulated if not provided.
AwsService (string) – 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.
PublicIpSource (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'IpamPool': {
        'OwnerId': 'string',
        'IpamPoolId': 'string',
        'SourceIpamPoolId': 'string',
        'IpamPoolArn': 'string',
        'IpamScopeArn': 'string',
        'IpamScopeType': 'public'|'private',
        'IpamArn': 'string',
        'IpamRegion': 'string',
        'Locale': 'string',
        'PoolDepth': 123,
        'State': 'create-in-progress'|'create-complete'|'create-failed'|'modify-in-progress'|'modify-complete'|'modify-failed'|'delete-in-progress'|'delete-complete'|'delete-failed'|'isolate-in-progress'|'isolate-complete'|'restore-in-progress',
        'StateMessage': 'string',
        'Description': 'string',
        'AutoImport': True|False,
        'PubliclyAdvertisable': True|False,
        'AddressFamily': 'ipv4'|'ipv6',
        'AllocationMinNetmaskLength': 123,
        'AllocationMaxNetmaskLength': 123,
        'AllocationDefaultNetmaskLength': 123,
        'AllocationResourceTags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'AwsService': 'ec2',
        'PublicIpSource': 'amazon'|'byoip'
    }
}

Response Structure

(dict) –
- IpamPool (dict) –
  
  Information about the IPAM pool created.
  - OwnerId (string) –
    
    The Amazon Web Services account ID of the owner of the IPAM pool.
  - IpamPoolId (string) –
    
    The ID of the IPAM pool.
  - SourceIpamPoolId (string) –
    
    The ID of the source IPAM pool. You can use this option to create an IPAM pool within an existing source pool.
  - IpamPoolArn (string) –
    
    The Amazon Resource Name (ARN) of the IPAM pool.
  - IpamScopeArn (string) –
    
    The ARN of the scope of the IPAM pool.
  - IpamScopeType (string) –
    
    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.
  - IpamArn (string) –
    
    The ARN of the IPAM.
  - IpamRegion (string) –
    
    The Amazon Web Services Region of the IPAM pool.
  - Locale (string) –
    
    The locale of the IPAM pool. In IPAM, the locale is the Amazon Web Services Region where you want to make an IPAM pool available for allocations. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot modify it. 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.
  - PoolDepth (integer) –
    
    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.
  - State (string) –
    
    The state of the IPAM pool.
  - StateMessage (string) –
    
    A message related to the failed creation of an IPAM pool.
  - Description (string) –
    
    The description of the IPAM pool.
  - AutoImport (boolean) –
    
    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 (boolean) –
    
    Determines if a pool is publicly advertisable. This option is not available for pools with AddressFamily set to ipv4.
  - AddressFamily (string) –
    
    The address family of the pool.
  - AllocationMinNetmaskLength (integer) –
    
    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 (integer) –
    
    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 (integer) –
    
    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.
  - AllocationResourceTags (list) –
    
    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.
    - (dict) –
      
      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.
      - Key (string) –
        
        The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
      - Value (string) –
        
        The value of the tag.
  - Tags (list) –
    
    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.
    - (dict) –
      
      Describes a tag.
      - Key (string) –
        
        The key of the tag.
        
        Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
      - Value (string) –
        
        The value of the tag.
        
        Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
  - AwsService (string) –
    
    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.
  - PublicIpSource (string) –
    
    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.