get-ipam-prefix-list-resolver-rules¶

Description¶

Retrieves the CIDR selection rules for an IPAM prefix list resolver. Use this operation to view the business logic that determines which CIDRs are selected for synchronization with prefix lists.

Synopsis¶

  get-ipam-prefix-list-resolver-rules
[--dry-run | --no-dry-run]
--ipam-prefix-list-resolver-id <value>
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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-prefix-list-resolver-id (string) [required]

The ID of the IPAM prefix list resolver whose rules you want to retrieve.

--filters (list)

One or more filters to limit the results.

(structure)

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

If you specify multiple filters, the filters are joined with an AND , and the request returns only results that match all of the specified filters.

For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide .

Name -> (string)

The name of the filter. Filter names are case-sensitive.

Values -> (list)

The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR , and the request returns all results that match any of the specified values.

(string)

Shorthand Syntax:

Name=string,Values=string,string ...

JSON Syntax:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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

Rules -> (list)

The CIDR selection rules for the IPAM prefix list resolver.

(structure)

Describes a CIDR selection rule.

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.

RuleType -> (string)

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 within a CIDR selection rule. Conditions define the criteria for selecting CIDRs from IPAM’s database based on resource attributes.

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)

The operation to perform when evaluating this condition. Valid values include equals , not-equals , contains , and not-contains .

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 of the tag.

Cidr -> (string)

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

NextToken -> (string)

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Table of Contents

Feedback

User Guide