aws ec2 modify-ipam-scope

Modify an IPAM scope. AWS CLI reference

1 example 5 options Its page in the AWS CLI reference

Examples

from aws-cli, each command read by CmdID

To modify the description of a scope

The following modify-ipam-scope example updates the description of an IPAM scope. In this scenario, you're an IPAM delegated admin.

To complete this request, you'll need the scope ID, which you can get with describe-ipam-scopes.

aws ec2 modify-ipam-scope --ipam-scope-id ipam-scope-0d3539a30b57dcdd1 --description exampleIdentify

--ipam-scope-idThe ID of the scope you want to modify.

--descriptionThe description of the scope you want to modify.

Its output

{
    "IpamScope": {
        "OwnerId": "123456789012",
        "IpamScopeId": "ipam-scope-0d3539a30b57dcdd1",
        "IpamScopeArn": "arn:aws:ec2::123456789012:ipam-scope/ipam-scope-0d3539a30b57dcdd1",
        "IpamArn": "arn:aws:ec2::123456789012:ipam/ipam-005f921c17ebd5107",
        "IpamRegion": "us-west-2",
        "IpamScopeType": "public",
        "IsDefault": true,
        "Description": "example",
        "PoolCount": 1,
        "State": "modify-in-progress"
    }
}

For more information about scopes, see How IPAM works in the Amazon VPC IPAM User Guide.

Options

5 in the AWS CLI reference

--descriptionThe description of the scope you want to modify.

--dry-runA check for whether you have the required permissions for the action without actually making the request and provides an error response.

--external-authority-configurationThe configuration that links an Amazon VPC IPAM scope to an external authority system.

--ipam-scope-idThe ID of the scope you want to modify.

--remove-external-authority-configurationRemove the external authority configuration.