Skip to content

create_ipam_routing_policy_registration

Operation

create_ipam_routing_policy_registration

Creates a routing policy registration and publishes Route Origin Authorizations (ROAs) to the RPKI for the specified CIDR prefix and ASNs.

Parameters:

Name Type Description Default
request CreateIpamRoutingPolicyRegistrationInput | CreateIpamRoutingPolicyRegistrationInputDict | 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[CreateIpamRoutingPolicyRegistrationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateIpamRoutingPolicyRegistrationOutput

An instance of CreateIpamRoutingPolicyRegistrationOutput.

create_ipam_routing_policy_registration async

Creates a routing policy registration and publishes Route Origin Authorizations (ROAs) to the RPKI for the specified CIDR prefix and ASNs.

Parameters:

Name Type Description Default
request CreateIpamRoutingPolicyRegistrationInput | CreateIpamRoutingPolicyRegistrationInputDict | 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[CreateIpamRoutingPolicyRegistrationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateIpamRoutingPolicyRegistrationOutput

An instance of CreateIpamRoutingPolicyRegistrationOutput.

Input

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

CreateIpamRoutingPolicyRegistrationInputDict

Bases: TypedDict

Dictionary form of CreateIpamRoutingPolicyRegistrationInput.

Attributes

asns instance-attribute

The Autonomous System Numbers (ASNs) authorized to originate the prefix.

cidr instance-attribute
cidr: Required[str]

The IP address prefix in CIDR notation to authorize in the ROA.

client_token instance-attribute
client_token: str | None

A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the operation ignores the request, but does not return an error.

This field is autopopulated if not provided.

description instance-attribute
description: str | None

A description for the routing policy registration.

dry_run instance-attribute
dry_run: bool | None

Checks whether you have the required permissions for the operation, 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.

force instance-attribute
force: bool | None

Forces the creation of the routing policy registration even if it conflicts with an announced route. Default: false.

ipam_internet_registry_association_id instance-attribute
ipam_internet_registry_association_id: Required[str]

The ID of the IPAM internet registry association.

max_length instance-attribute
max_length: int | None

The maximum prefix length that the ASNs are authorized to announce. Must be greater than or equal to the prefix length of the CIDR. If not specified, defaults to the prefix length of the CIDR (exact match only).

permit_more_specific_announcements instance-attribute
permit_more_specific_announcements: bool | None

Specifies whether to permit more specific route announcements than the CIDR prefix. When enabled, ASNs can announce sub-prefixes of the authorized CIDR up to the specified maximum length. Default: false.

CreateIpamRoutingPolicyRegistrationInput dataclass

Bases: _SerdeShape

Dataclass for CreateIpamRoutingPolicyRegistrationInput structure.

Attributes

asns class-attribute instance-attribute
asns: list[str] | None = ...

The Autonomous System Numbers (ASNs) authorized to originate the prefix.

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

The IP address prefix in CIDR notation to authorize in the ROA.

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

A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the operation ignores the request, but does not return an error.

This field is autopopulated if not provided.

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

A description for the routing policy registration.

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

Checks whether you have the required permissions for the operation, 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.

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

Forces the creation of the routing policy registration even if it conflicts with an announced route. Default: false.

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

The ID of the IPAM internet registry association.

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

The maximum prefix length that the ASNs are authorized to announce. Must be greater than or equal to the prefix length of the CIDR. If not specified, defaults to the prefix length of the CIDR (exact match only).

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

Specifies whether to permit more specific route announcements than the CIDR prefix. When enabled, ASNs can announce sub-prefixes of the authorized CIDR up to the specified maximum length. Default: false.

Output

CreateIpamRoutingPolicyRegistrationOutput dataclass

Bases: _SerdeShape

Dataclass for CreateIpamRoutingPolicyRegistrationOutput structure.

Attributes

ipam_routing_policy_registration_delta class-attribute instance-attribute
ipam_routing_policy_registration_delta: IpamRoutingPolicyRegistrationDelta | None = ...

Information about the routing policy registration delta created by this operation.

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.