EC2 / Client / create_ipam_prefix_list_resolver_target

create_ipam_prefix_list_resolver_target¶

EC2.Client.create_ipam_prefix_list_resolver_target(**kwargs)¶

Creates an IPAM prefix list resolver target.

An IPAM prefix list resolver target is an association between a specific customer-managed prefix list and an IPAM prefix list resolver. The target enables the resolver to synchronize CIDRs selected by its rules into the specified prefix list, which can then be referenced in Amazon Web Services resources.

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

Request Syntax

response = client.create_ipam_prefix_list_resolver_target(
    DryRun=True|False,
    IpamPrefixListResolverId='string',
    PrefixListId='string',
    PrefixListRegion='string',
    DesiredVersion=123,
    TrackLatestVersion=True|False,
    TagSpecifications=[
        {
            '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-metering-policy'|'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'|'vpc-encryption-control'|'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-policy'|'ipam-prefix-list-resolver-target'|'secondary-interface'|'secondary-network'|'secondary-subnet'|'capacity-manager-data-export'|'vpn-concentrator',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    ClientToken='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 that will manage the synchronization of CIDRs to the target prefix list.
PrefixListId (string) –
[REQUIRED]

The ID of the managed prefix list that will be synchronized with CIDRs selected by the IPAM prefix list resolver. This prefix list becomes an IPAM managed prefix list.

An IPAM-managed prefix list is a customer-managed prefix list that has been associated with an IPAM prefix list resolver target. When a prefix list becomes IPAM managed, its CIDRs are automatically synchronized based on the IPAM prefix list resolver’s CIDR selection rules, and direct CIDR modifications are restricted.
PrefixListRegion (string) –
[REQUIRED]

The Amazon Web Services Region where the prefix list is located. This is required when referencing a prefix list in a different Region.
DesiredVersion (integer) – The specific version of the prefix list to target. If not specified, the resolver will target the latest version.
TrackLatestVersion (boolean) –
[REQUIRED]

Indicates whether the resolver target should automatically track the latest version of the prefix list. When enabled, the target will always synchronize with the most current version of the prefix list.

Choose this for automatic updates when you want your prefix lists to stay current with infrastructure changes without manual intervention.
TagSpecifications (list) –
The tags to apply to the IPAM prefix list resolver target during creation. Tags help you organize and manage your Amazon Web Services resources.
- (dict) –
  
  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.
  - Tags (list) –
    
    The tags to apply to the resource.
    - (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.
ClientToken (string) –
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'IpamPrefixListResolverTarget': {
        'IpamPrefixListResolverTargetId': 'string',
        'IpamPrefixListResolverTargetArn': 'string',
        'IpamPrefixListResolverId': 'string',
        'OwnerId': 'string',
        'PrefixListId': 'string',
        'PrefixListRegion': 'string',
        'DesiredVersion': 123,
        'LastSyncedVersion': 123,
        'TrackLatestVersion': True|False,
        'StateMessage': 'string',
        'State': 'create-in-progress'|'create-complete'|'create-failed'|'modify-in-progress'|'modify-complete'|'modify-failed'|'sync-in-progress'|'sync-complete'|'sync-failed'|'delete-in-progress'|'delete-complete'|'delete-failed'|'isolate-in-progress'|'isolate-complete'|'restore-in-progress',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

(dict) –
- IpamPrefixListResolverTarget (dict) –
  
  Information about the IPAM prefix list resolver target that was created.
  - IpamPrefixListResolverTargetId (string) –
    
    The ID of the IPAM prefix list resolver target.
  - IpamPrefixListResolverTargetArn (string) –
    
    The Amazon Resource Name (ARN) of the IPAM prefix list resolver target.
  - IpamPrefixListResolverId (string) –
    
    The ID of the IPAM prefix list resolver associated with this target.
  - OwnerId (string) –
    
    The ID of the Amazon Web Services account that owns the IPAM prefix list resolver target.
  - PrefixListId (string) –
    
    The ID of the managed prefix list associated with this target.
  - PrefixListRegion (string) –
    
    The Amazon Web Services Region where the prefix list associated with this target is located.
  - DesiredVersion (integer) –
    
    The desired version of the prefix list that this target should synchronize with.
  - LastSyncedVersion (integer) –
    
    The version of the prefix list that was last successfully synchronized by this target.
  - TrackLatestVersion (boolean) –
    
    Indicates whether this target automatically tracks the latest version of the prefix list.
  - StateMessage (string) –
    
    A message describing the current state of the IPAM prefix list resolver target, including any error information.
  - State (string) –
    
    The current state of the IPAM prefix list resolver target. 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 target.
    - (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.