EC2 / Client / modify_ipam_prefix_list_resolver

modify_ipam_prefix_list_resolver

EC2.Client.modify_ipam_prefix_list_resolver(**kwargs)

Modifies an IPAM prefix list resolver. You can update the description and CIDR selection rules. Changes to rules will trigger re-evaluation and potential updates to associated prefix lists.

See also: AWS API Documentation

Request Syntax

response = client.modify_ipam_prefix_list_resolver(
    DryRun=True|False,
    IpamPrefixListResolverId='string',
    Description='string',
    Rules=[
        {
            'RuleType': 'static-cidr'|'ipam-resource-cidr'|'ipam-pool-cidr',
            'StaticCidr': 'string',
            'IpamScopeId': 'string',
            'ResourceType': 'vpc'|'subnet'|'eip'|'public-ipv4-pool'|'ipv6-pool'|'eni'|'anycast-ip-list',
            'Conditions': [
                {
                    'Operation': 'equals'|'not-equals'|'subnet-of',
                    'IpamPoolId': 'string',
                    'ResourceId': 'string',
                    'ResourceOwner': 'string',
                    'ResourceRegion': 'string',
                    'ResourceTag': {
                        'Key': 'string',
                        'Value': 'string'
                    },
                    'Cidr': 'string'
                },
            ]
        },
    ]
)
Parameters:

  • DryRun (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.

  • IpamPrefixListResolverId (string) –

    [REQUIRED]

    The ID of the IPAM prefix list resolver to modify.

  • Description (string) – A new description for the IPAM prefix list resolver.

  • Rules (list) –

    The updated CIDR selection rules for the resolver. These rules replace the existing rules entirely.

    • (dict) –

      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

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

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

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

        • (dict) –

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

          • Operation (string) – [REQUIRED]

            The operation to perform when evaluating this condition.

          • 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 (dict) –

            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.

Return type:

dict

Returns:

Response Syntax

{
    'IpamPrefixListResolver': {
        'OwnerId': 'string',
        'IpamPrefixListResolverId': 'string',
        'IpamPrefixListResolverArn': 'string',
        'IpamArn': 'string',
        'IpamRegion': 'string',
        'Description': 'string',
        'AddressFamily': 'ipv4'|'ipv6',
        'State': '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': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'LastVersionCreationStatus': 'pending'|'success'|'failure',
        'LastVersionCreationStatusMessage': 'string'
    }
}

Response Structure

  • (dict) –

    • IpamPrefixListResolver (dict) –

      Information about the modified IPAM prefix list resolver.

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

      • IpamArn (string) –

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

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

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

      • Tags (list) –

        The tags assigned to the IPAM prefix list resolver.

        • (dict) –

          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.

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