[ aws . ec2 ]

modify-managed-prefix-list

Description

Modifies the specified managed prefix list.

Adding or removing entries in a prefix list creates a new version of the prefix list. Changing the name of the prefix list does not affect the version.

If you specify a current version number that does not match the true current version number, the request fails.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  modify-managed-prefix-list
[--dry-run | --no-dry-run]
--prefix-list-id <value>
[--current-version <value>]
[--prefix-list-name <value>]
[--add-entries <value>]
[--remove-entries <value>]
[--max-entries <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--dry-run | --no-dry-run (boolean)

Checks 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 .

--prefix-list-id (string)

The ID of the prefix list.

--current-version (long)

The current version of the prefix list.

--prefix-list-name (string)

A name for the prefix list.

--add-entries (list)

One or more entries to add to the prefix list.

(structure)

An entry for a prefix list.

Cidr -> (string)

The CIDR block.

Description -> (string)

A description for the entry.

Constraints: Up to 255 characters in length.

Shorthand Syntax:

Cidr=string,Description=string ...

JSON Syntax:

[
  {
    "Cidr": "string",
    "Description": "string"
  }
  ...
]

--remove-entries (list)

One or more entries to remove from the prefix list.

(structure)

An entry for a prefix list.

Cidr -> (string)

The CIDR block.

Shorthand Syntax:

Cidr=string ...

JSON Syntax:

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

--max-entries (integer)

The maximum number of entries for the prefix list. You cannot modify the entries of a prefix list and modify the size of a prefix list at the same time.

If any of the resources that reference the prefix list cannot support the new maximum size, the modify operation fails. Check the state message for the IDs of the first ten resources that do not support the new maximum size.

--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 modify a prefix list

The following modify-managed-prefix-list example adds an entry to the specified prefix list.

aws ec2 modify-managed-prefix-list \
    --prefix-list-id pl-0123456abcabcabc1 \
    --add-entries Cidr=10.1.0.0/16,Description=vpc-c \
    --current-version 1

Output:

{
    "PrefixList": {
        "PrefixListId": "pl-0123456abcabcabc1",
        "AddressFamily": "IPv4",
        "State": "modify-in-progress",
        "PrefixListArn": "arn:aws:ec2:us-west-2:123456789012:prefix-list/pl-0123456abcabcabc1",
        "PrefixListName": "vpc-cidrs",
        "MaxEntries": 10,
        "Version": 1,
        "OwnerId": "123456789012"
    }
}

For more information, see Managed prefix lists in the Amazon VPC User Guide.

Output

PrefixList -> (structure)

Information about the prefix list.

PrefixListId -> (string)

The ID of the prefix list.

AddressFamily -> (string)

The IP address version.

State -> (string)

The current state of the prefix list.

StateMessage -> (string)

The state message.

PrefixListArn -> (string)

The Amazon Resource Name (ARN) for the prefix list.

PrefixListName -> (string)

The name of the prefix list.

MaxEntries -> (integer)

The maximum number of entries for the prefix list.

Version -> (long)

The version of the prefix list.

Tags -> (list)

The tags for the prefix list.

(structure)

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 255 Unicode characters.

OwnerId -> (string)

The ID of the owner of the prefix list.