create_ipam_prefix_list_resolver¶
Operation¶
create_ipam_prefix_list_resolver
async
¶
create_ipam_prefix_list_resolver(request: CreateIpamPrefixListResolverInput | CreateIpamPrefixListResolverInputDict, /, *, plugins: list[Plugin] | None = None) -> CreateIpamPrefixListResolverOutput
create_ipam_prefix_list_resolver(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateIpamPrefixListResolverInputDict]) -> CreateIpamPrefixListResolverOutput
Creates an IPAM prefix list resolver.
An IPAM prefix list resolver is a component that manages the synchronization between IPAM's CIDR selection rules and customer-managed prefix lists. It automates connectivity configurations by selecting CIDRs from IPAM's database based on your business logic and synchronizing them with prefix lists used in resources such as VPC route tables and security groups.
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 |
|---|---|---|---|
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
|
Returns:
| Type | Description |
|---|---|
CreateIpamPrefixListResolverOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
CreateIpamPrefixListResolverInput
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateIpamPrefixListResolverInput structure.
Attributes¶
address_family
class-attribute
instance-attribute
¶
address_family: str | None = ...
The address family for the IPAM prefix list resolver. Valid values are
ipv4 and ipv6. You must create separate resolvers for IPv4 and IPv6
CIDRs as they cannot be mixed in the same resolver.
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.
description
class-attribute
instance-attribute
¶
description: str | None = ...
A description for the IPAM prefix list resolver to help you identify its purpose and configuration.
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_id
class-attribute
instance-attribute
¶
ipam_id: str | None = ...
The ID of the IPAM that will serve as the source of the IP address database for CIDR selection. The IPAM must be in the Advanced tier to use this feature.
rules
class-attribute
instance-attribute
¶
rules: list[IpamPrefixListResolverRuleRequest] | None = ...
The CIDR selection rules for the resolver.
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.
tag_specifications
class-attribute
instance-attribute
¶
tag_specifications: list[TagSpecification] | None = ...
The tags to apply to the IPAM prefix list resolver during creation. Tags help you organize and manage your Amazon Web Services resources.
Dictionaries¶
CreateIpamPrefixListResolverInputDict
¶
Bases: TypedDict
Dictionary form of CreateIpamPrefixListResolverInput.
Attributes¶
address_family
instance-attribute
¶
The address family for the IPAM prefix list resolver. Valid values are
ipv4 and ipv6. You must create separate resolvers for IPv4 and IPv6
CIDRs as they cannot be mixed in the same resolver.
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.
description
instance-attribute
¶
description: str | None
A description for the IPAM prefix list resolver to help you identify its purpose and configuration.
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_id
instance-attribute
¶
The ID of the IPAM that will serve as the source of the IP address database for CIDR selection. The IPAM must be in the Advanced tier to use this feature.
rules
instance-attribute
¶
The CIDR selection rules for the resolver.
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.
tag_specifications
instance-attribute
¶
tag_specifications: Sequence[TagSpecification | TagSpecificationDict] | None
The tags to apply to the IPAM prefix list resolver during creation. Tags help you organize and manage your Amazon Web Services resources.
Output¶
CreateIpamPrefixListResolverOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateIpamPrefixListResolverOutput structure.
Attributes¶
ipam_prefix_list_resolver
class-attribute
instance-attribute
¶
ipam_prefix_list_resolver: IpamPrefixListResolver | None = ...
Information about the IPAM prefix list resolver that was created.
response_metadata
class-attribute
instance-attribute
¶
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.