Skip to content

create_ipam_prefix_list_resolver_target

Operation

create_ipam_prefix_list_resolver_target

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.

Parameters:

Name Type Description Default
request CreateIpamPrefixListResolverTargetInput | CreateIpamPrefixListResolverTargetInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[CreateIpamPrefixListResolverTargetInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateIpamPrefixListResolverTargetOutput

An instance of CreateIpamPrefixListResolverTargetOutput.

create_ipam_prefix_list_resolver_target async

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.

Parameters:

Name Type Description Default
request CreateIpamPrefixListResolverTargetInput | CreateIpamPrefixListResolverTargetInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[CreateIpamPrefixListResolverTargetInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateIpamPrefixListResolverTargetOutput

An instance of CreateIpamPrefixListResolverTargetOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

CreateIpamPrefixListResolverTargetInputDict

Bases: TypedDict

Dictionary form of CreateIpamPrefixListResolverTargetInput.

Attributes

client_token instance-attribute
client_token: str | None

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.

desired_version instance-attribute
desired_version: int | None

The specific version of the prefix list to target. If not specified, the resolver will target the latest version.

dry_run instance-attribute
dry_run: bool | None

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 instance-attribute
ipam_prefix_list_resolver_id: Required[str]

The ID of the IPAM prefix list resolver that will manage the synchronization of CIDRs to the target prefix list.

prefix_list_id instance-attribute
prefix_list_id: Required[str]

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.

prefix_list_region instance-attribute
prefix_list_region: Required[str]

The Amazon Web Services Region where the prefix list is located. This is required when referencing a prefix list in a different Region.

tag_specifications instance-attribute
tag_specifications: Sequence[TagSpecification | TagSpecificationDict] | None

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

track_latest_version instance-attribute
track_latest_version: Required[bool]

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.

CreateIpamPrefixListResolverTargetInput dataclass

Bases: _SerdeShape

Dataclass for CreateIpamPrefixListResolverTargetInput structure.

Attributes

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

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.

desired_version class-attribute instance-attribute
desired_version: int | None = ...

The specific version of the prefix list to target. If not specified, the resolver will target the latest version.

dry_run class-attribute instance-attribute
dry_run: bool | None = ...

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 class-attribute instance-attribute
ipam_prefix_list_resolver_id: str | None = ...

The ID of the IPAM prefix list resolver that will manage the synchronization of CIDRs to the target prefix list.

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

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.

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

The Amazon Web Services Region where the prefix list is located. This is required when referencing a prefix list in a different Region.

tag_specifications class-attribute instance-attribute
tag_specifications: list[TagSpecification] | None = ...

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

track_latest_version class-attribute instance-attribute
track_latest_version: bool | None = ...

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.

Output

CreateIpamPrefixListResolverTargetOutput dataclass

Bases: _SerdeShape

Dataclass for CreateIpamPrefixListResolverTargetOutput structure.

Attributes

ipam_prefix_list_resolver_target class-attribute instance-attribute
ipam_prefix_list_resolver_target: IpamPrefixListResolverTarget | None = ...

Information about the IPAM prefix list resolver target that was created.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.