[ aws . ec2 ]

move-byoip-cidr-to-ipam

Description

Move an BYOIP IPv4 CIDR to IPAM from a public IPv4 pool.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  move-byoip-cidr-to-ipam
[--dry-run | --no-dry-run]
--cidr <value>
--ipam-pool-id <value>
--ipam-pool-owner <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <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 .

--cidr (string)

The BYOIP CIDR.

--ipam-pool-id (string)

The IPAM pool ID.

--ipam-pool-owner (string)

The Amazon Web Services account ID of the owner of the IPAM pool.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To transfer a BYOIP CIDR to IPAM

The following move-byoip-cidr-to-ipam example transfers a BYOIP CIDR to IPAM.

(Linux):

aws ec2 move-byoip-cidr-to-ipam \
    --region us-west-2 \
    --ipam-pool-id ipam-pool-0a03d430ca3f5c035 \
    --ipam-pool-owner 111111111111 \
    --cidr 130.137.249.0/24

(Windows):

aws ec2 move-byoip-cidr-to-ipam ^
    --region us-west-2 ^
    --ipam-pool-id ipam-pool-0a03d430ca3f5c035 ^
    --ipam-pool-owner 111111111111 ^
    --cidr 130.137.249.0/24

Output:

{
    "ByoipCidr": {
        "Cidr": "130.137.249.0/24",
        "State": "pending-transfer"
    }
}

For more information, see Tutorial: Transfer an existing BYOIP IPv4 CIDR to IPAM in the Amazon VPC IPAM User Guide.

Output

ByoipCidr -> (structure)

Information about an address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP).

Cidr -> (string)

The address range, in CIDR notation.

Description -> (string)

The description of the address range.

StatusMessage -> (string)

Upon success, contains the ID of the address pool. Otherwise, contains an error message.

State -> (string)

The state of the address pool.