create-ipam-prefix-list-resolver¶

Description¶

Creates an IPAM prefix list resolver.

An IPAM prefix list resolver is a component that manages the synchronization between IPAM’s CIDR selection rules and customer-managed prefix lists. It automates connectivity configurations by selecting CIDRs from IPAM’s database based on your business logic and synchronizing them with prefix lists used in resources such as VPC route tables and security groups.

For more information about IPAM prefix list resolver, see Automate prefix list updates with IPAM in the Amazon VPC IPAM User Guide .

Synopsis¶

  create-ipam-prefix-list-resolver
[--dry-run | --no-dry-run]
--ipam-id <value>
[--description <value>]
--address-family <value>
[--rules <value>]
[--tag-specifications <value>]
[--client-token <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]

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 .

--ipam-id (string) [required]

The ID of the IPAM that will serve as the source of the IP address database for CIDR selection. The IPAM must be in the Advanced tier to use this feature.

--description (string)

A description for the IPAM prefix list resolver to help you identify its purpose and configuration.

--address-family (string) [required]

The address family for the IPAM prefix list resolver. Valid values are ipv4 and ipv6 . You must create separate resolvers for IPv4 and IPv6 CIDRs as they cannot be mixed in the same resolver.

Possible values:

ipv4

ipv6

--rules (list)

The CIDR selection rules for the resolver.

CIDR selection rules define the business logic for selecting CIDRs from IPAM. If a CIDR matches any of the rules, it will be included. If a rule has multiple conditions, the CIDR has to match every condition of that rule. You can create a prefix list resolver without any CIDR selection rules, but it will generate empty versions (containing no CIDRs) until you add rules.

(structure)

Describes a CIDR selection rule to include in a request. This is used when creating or modifying resolver rules.

CIDR selection rules define the business logic for selecting CIDRs from IPAM. If a CIDR matches any of the rules, it will be included. If a rule has multiple conditions, the CIDR has to match every condition of that rule. You can create a prefix list resolver without any CIDR selection rules, but it will generate empty versions (containing no CIDRs) until you add rules.

There are three rule types:

Static CIDR : A fixed list of CIDRs that do not change (like a manual list replicated across Regions).

IPAM pool CIDR : CIDRs from specific IPAM pools (like all CIDRs from your IPAM production pool).

Scope resource CIDR : CIDRs for Amazon Web Services resources like VPCs, subnets, and EIPs within a specific IPAM scope.

Condition availability by resource type:

Only 2 of the 3 rule types support conditions - IPAM pool CIDR and Scope resource CIDR . Static CIDR rules cannot have conditions.

Condition available for the IPAM pool CIDR resource type:

Property:

IPAM Pool ID

CIDR (like 10.24.34.0/23)

Operation: Equals/Not equals

Value: The value on which to match the condition

Conditions for the Scope resource CIDR resource type:

Property:

Resource ID: The unique ID of a resource (like vpc-1234567890abcdef0)

Resource type (like VPC or Subnet)

Resource owner (like 111122223333)

Resource region (like us-east-1)

Resource tag (like key: name, value: dev-vpc-1)

CIDR (like 10.24.34.0/23)

Operation: Equals/Not equals

Value: The value on which to match the condition

When setting conditions for a rule, one or more conditions is required.

RuleType -> (string) [required]

The type of CIDR selection rule. Valid values include include for selecting CIDRs that match the conditions, and exclude for excluding CIDRs that match the conditions.

Possible values:

static-cidr

ipam-resource-cidr

ipam-pool-cidr

StaticCidr -> (string)

A fixed list of CIDRs that do not change (like a manual list replicated across Regions).

IpamScopeId -> (string)

The ID of the IPAM scope from which to select CIDRs. This determines whether to select from public or private IP address space.

ResourceType -> (string)

For rules of type ipam-resource-cidr , this is the resource type.

Possible values:

vpc

subnet

eip

public-ipv4-pool

ipv6-pool

eni

Conditions -> (list)

The conditions that determine which CIDRs are selected by this rule. Conditions specify criteria such as resource type, tags, account IDs, and Regions.

(structure)

Describes a condition used when creating or modifying resolver rules.

CIDR selection rules define the business logic for selecting CIDRs from IPAM. If a CIDR matches any of the rules, it will be included. If a rule has multiple conditions, the CIDR has to match every condition of that rule. You can create a prefix list resolver without any CIDR selection rules, but it will generate empty versions (containing no CIDRs) until you add rules.

There are three rule types:

Static CIDR : A fixed list of CIDRs that do not change (like a manual list replicated across Regions).

IPAM pool CIDR : CIDRs from specific IPAM pools (like all CIDRs from your IPAM production pool).

Scope resource CIDR : CIDRs for Amazon Web Services resources like VPCs, subnets, and EIPs within a specific IPAM scope.

Condition availability by resource type:

Only 2 of the 3 rule types support conditions - IPAM pool CIDR and Scope resource CIDR . Static CIDR rules cannot have conditions.

Condition available for the IPAM pool CIDR resource type:

Property:

IPAM Pool ID

CIDR (like 10.24.34.0/23)

Operation: Equals/Not equals

Value: The value on which to match the condition

Conditions for the Scope resource CIDR resource type:

Property:

Resource ID: The unique ID of a resource (like vpc-1234567890abcdef0)

Resource type (like VPC or Subnet)

Resource owner (like 111122223333)

Resource region (like us-east-1)

Resource tag (like key: name, value: dev-vpc-1)

CIDR (like 10.24.34.0/23)

Operation: Equals/Not equals

Value: The value on which to match the condition

When setting conditions for a rule, one or more conditions is required.

Operation -> (string) [required]

The operation to perform when evaluating this condition.

Possible values:

equals

not-equals

subnet-of

IpamPoolId -> (string)

The ID of the IPAM pool to match against. This condition selects CIDRs that belong to the specified IPAM pool.

ResourceId -> (string)

The ID of the Amazon Web Services resource to match against. This condition selects CIDRs associated with the specified resource.

ResourceOwner -> (string)

The Amazon Web Services account ID that owns the resources to match against. This condition selects CIDRs from resources owned by the specified account.

ResourceRegion -> (string)

The Amazon Web Services Region where the resources are located. This condition selects CIDRs from resources in the specified Region.

ResourceTag -> (structure)

A tag key-value pair to match against. This condition selects CIDRs from resources that have the specified tag.

Key -> (string)

The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

Value -> (string)

The value for the tag.

Cidr -> (string)

A CIDR block to match against. This condition selects CIDRs that fall within or match the specified CIDR range.

JSON Syntax:

[
  {
    "RuleType": "static-cidr"|"ipam-resource-cidr"|"ipam-pool-cidr",
    "StaticCidr": "string",
    "IpamScopeId": "string",
    "ResourceType": "vpc"|"subnet"|"eip"|"public-ipv4-pool"|"ipv6-pool"|"eni",
    "Conditions": [
      {
        "Operation": "equals"|"not-equals"|"subnet-of",
        "IpamPoolId": "string",
        "ResourceId": "string",
        "ResourceOwner": "string",
        "ResourceRegion": "string",
        "ResourceTag": {
          "Key": "string",
          "Value": "string"
        },
        "Cidr": "string"
      }
      ...
    ]
  }
  ...
]

--tag-specifications (list)

The tags to apply to the IPAM prefix list resolver during creation. Tags help you organize and manage your Amazon Web Services resources.

(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-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

route-server

route-server-endpoint

route-server-peer

ipam-resource-discovery

ipam-resource-discovery-association

instance-connect-endpoint

verified-access-endpoint-target

ipam-external-resource-verification-token

capacity-block

mac-modification-task

ipam-prefix-list-resolver

ipam-prefix-list-resolver-target

capacity-manager-data-export

Tags -> (list)

The tags to apply to the resource.

(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 256 Unicode characters.

Shorthand Syntax:

ResourceType=string,Tags=[{Key=string,Value=string},{Key=string,Value=string}] ...

JSON Syntax:

[
  {
    "ResourceType": "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-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"|"route-server"|"route-server-endpoint"|"route-server-peer"|"ipam-resource-discovery"|"ipam-resource-discovery-association"|"instance-connect-endpoint"|"verified-access-endpoint-target"|"ipam-external-resource-verification-token"|"capacity-block"|"mac-modification-task"|"ipam-prefix-list-resolver"|"ipam-prefix-list-resolver-target"|"capacity-manager-data-export",
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
      ...
    ]
  }
  ...
]

--client-token (string)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency .

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output¶

IpamPrefixListResolver -> (structure)

Information about the IPAM prefix list resolver that was created.

OwnerId -> (string)

The ID of the Amazon Web Services account that owns the IPAM prefix list resolver.

IpamPrefixListResolverId -> (string)

The ID of the IPAM prefix list resolver.

IpamPrefixListResolverArn -> (string)

The Amazon Resource Name (ARN) of the IPAM prefix list resolver.

Constraints:

min: 1

max: 1283

IpamArn -> (string)

The Amazon Resource Name (ARN) of the IPAM associated with this resolver.

Constraints:

min: 1

max: 1283

IpamRegion -> (string)

The Amazon Web Services Region where the associated IPAM is located.

Description -> (string)

The description of the IPAM prefix list resolver.

AddressFamily -> (string)

The address family (IPv4 or IPv6) for the IPAM prefix list resolver.

Possible values:

ipv4

ipv6

State -> (string)

The current state of the IPAM prefix list resolver. Valid values include create-in-progress , create-complete , create-failed , modify-in-progress , modify-complete , modify-failed , delete-in-progress , delete-complete , and delete-failed .

Possible values:

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 -> (list)

The tags assigned to the IPAM prefix list resolver.

(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 256 Unicode characters.

LastVersionCreationStatus -> (string)

The status for the last time a version was created.

Each version is a snapshot of what CIDRs matched your rules at that moment in time. The version number increments every time the CIDR list changes due to infrastructure changes.

Possible values:

pending

success

failure

LastVersionCreationStatusMessage -> (string)

The status message for the last time a version was created.

Each version is a snapshot of what CIDRs matched your rules at that moment in time. The version number increments every time the CIDR list changes due to infrastructure changes.

Table of Contents

Feedback

User Guide