EC2 / Client / create_ipam

create_ipam#

EC2.Client.create_ipam(**kwargs)#

Create an IPAM. Amazon VPC IP Address Manager (IPAM) is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization.

For more information, see Create an IPAM in the Amazon VPC IPAM User Guide.

Request Syntax

response = client.create_ipam(
    DryRun=True|False,
    Description='string',
    OperatingRegions=[
        {
            'RegionName': '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'|'ipam-external-resource-verification-token',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    ClientToken='string',
    Tier='free'|'advanced',
    EnablePrivateGua=True|False
)

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.
Description (string) – A description for the IPAM.
OperatingRegions (list) –
The operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
- (dict) –
  
  Add an operating Region to an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
  
  For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
  - RegionName (string) –
    
    The name of the operating Region.
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.
Tier (string) – IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab.
EnablePrivateGua (boolean) – Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default.

Return type:

dict

Returns:

Response Syntax

{
    'Ipam': {
        'OwnerId': 'string',
        'IpamId': 'string',
        'IpamArn': 'string',
        'IpamRegion': 'string',
        'PublicDefaultScopeId': 'string',
        'PrivateDefaultScopeId': 'string',
        'ScopeCount': 123,
        'Description': 'string',
        'OperatingRegions': [
            {
                'RegionName': 'string'
            },
        ],
        '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',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'DefaultResourceDiscoveryId': 'string',
        'DefaultResourceDiscoveryAssociationId': 'string',
        'ResourceDiscoveryAssociationCount': 123,
        'StateMessage': 'string',
        'Tier': 'free'|'advanced',
        'EnablePrivateGua': True|False
    }
}

Response Structure

(dict) –
- Ipam (dict) –
  
  Information about the IPAM created.
  - OwnerId (string) –
    
    The Amazon Web Services account ID of the owner of the IPAM.
  - IpamId (string) –
    
    The ID of the IPAM.
  - IpamArn (string) –
    
    The Amazon Resource Name (ARN) of the IPAM.
  - IpamRegion (string) –
    
    The Amazon Web Services Region of the IPAM.
  - PublicDefaultScopeId (string) –
    
    The ID of the IPAM’s default public scope.
  - PrivateDefaultScopeId (string) –
    
    The ID of the IPAM’s default private scope.
  - ScopeCount (integer) –
    
    The number of scopes in the IPAM. The scope quota is 5. For more information on quotas, see Quotas in IPAM in the Amazon VPC IPAM User Guide.
  - Description (string) –
    
    The description for the IPAM.
  - OperatingRegions (list) –
    
    The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
    
    For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
    - (dict) –
      
      The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
      
      For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
      - RegionName (string) –
        
        The name of the operating Region.
  - State (string) –
    
    The state of the IPAM.
  - 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.
  - DefaultResourceDiscoveryId (string) –
    
    The IPAM’s default resource discovery ID.
  - DefaultResourceDiscoveryAssociationId (string) –
    
    The IPAM’s default resource discovery association ID.
  - ResourceDiscoveryAssociationCount (integer) –
    
    The IPAM’s resource discovery association count.
  - StateMessage (string) –
    
    The state message.
  - Tier (string) –
    
    IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab.
  - EnablePrivateGua (boolean) –
    
    Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default.