Skip to content

EC2  >  Structures  >  IpamPrefixListResolverRuleRequest

IpamPrefixListResolverRuleRequest

Structure Class

IpamPrefixListResolverRuleRequest dataclass

Bases: _SerdeShape

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. Only 2 of the 3 rule types support conditions - IPAM pool CIDR and Scope resource CIDR. Static CIDR rules cannot have conditions.

  • 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)

If you choose this option, choose the following:

  • IPAM scope: Select the IPAM scope to search for resources

  • Conditions:

    • Property

    • IPAM pool ID: Select an IPAM pool that contains the resources

    • CIDR (like 10.24.34.0/23)

    • Operation: Equals/Not equals

    • Value: The value on which to match the condition

  • Scope resource CIDR: CIDRs from Amazon Web Services resources like VPCs, subnets, EIPs within an IPAM scope

If you choose this option, choose the following:

  • IPAM scope: Select the IPAM scope to search for resources

  • Resource type: Select a resource, like a VPC or subnet.

  • Conditions:

    • Property:

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

    • 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

Attributes

conditions class-attribute instance-attribute

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

ipam_scope_id class-attribute instance-attribute
ipam_scope_id: str | None = ...

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

resource_type class-attribute instance-attribute
resource_type: str | None = ...

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

rule_type class-attribute instance-attribute
rule_type: str | None = ...

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.

static_cidr class-attribute instance-attribute
static_cidr: str | None = ...

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