AWS CLI Command Reference

[ aws . ec2 ]

create-ipam

Description

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 .

See also: AWS API Documentation

Synopsis

  create-ipam
[--dry-run | --no-dry-run]
[--description <value>]
[--operating-regions <value>]
[--tag-specifications <value>]
[--client-token <value>]
[--tier <value>]
[--enable-private-gua | --no-enable-private-gua]
[--metered-account <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--dry-run | --no-dry-run (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.

--operating-regions (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 .

Constraints:

  • min: 0
  • max: 50

(structure)

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.

Shorthand Syntax:

RegionName=string ...

JSON Syntax:

[
  {
    "RegionName": "string"
  }
  ...
]

--tag-specifications (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.

(structure)

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.

Possible values:

  • capacity-reservation
  • client-vpn-endpoint
  • customer-gateway
  • carrier-gateway
  • coip-pool
  • declarative-policies-report
  • dedicated-host
  • dhcp-options
  • egress-only-internet-gateway
  • elastic-ip
  • elastic-gpu
  • export-image-task
  • export-instance-task
  • fleet
  • fpga-image
  • host-reservation
  • image
  • image-usage-report
  • 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
  • outpost-lag
  • placement-group
  • prefix-list
  • replace-root-volume-task
  • reserved-instances
  • route-table
  • security-group
  • security-group-rule
  • service-link-virtual-interface
  • 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-metering-policy
  • 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