enable_ipam_internet_registry_association¶
Operation¶
enable_ipam_internet_registry_association
¶
enable_ipam_internet_registry_association(request: EnableIpamInternetRegistryAssociationInput | EnableIpamInternetRegistryAssociationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[EnableIpamInternetRegistryAssociationInputDict]) -> EnableIpamInternetRegistryAssociationOutput
Enables Resource Public Key Infrastructure (RPKI) on an existing IPAM internet registry association by providing BGP Public Key Infrastructure (BPKI) certificate details. After enabling, you can create Route Origin Authorizations (ROAs) for prefixes registered with the internet registry.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
EnableIpamInternetRegistryAssociationInput | EnableIpamInternetRegistryAssociationInputDict | 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[EnableIpamInternetRegistryAssociationInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
EnableIpamInternetRegistryAssociationOutput
|
An instance of |
enable_ipam_internet_registry_association
async
¶
enable_ipam_internet_registry_association(request: EnableIpamInternetRegistryAssociationInput | EnableIpamInternetRegistryAssociationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[EnableIpamInternetRegistryAssociationInputDict]) -> EnableIpamInternetRegistryAssociationOutput
Enables Resource Public Key Infrastructure (RPKI) on an existing IPAM internet registry association by providing BGP Public Key Infrastructure (BPKI) certificate details. After enabling, you can create Route Origin Authorizations (ROAs) for prefixes registered with the internet registry.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
EnableIpamInternetRegistryAssociationInput | EnableIpamInternetRegistryAssociationInputDict | 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[EnableIpamInternetRegistryAssociationInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
EnableIpamInternetRegistryAssociationOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
EnableIpamInternetRegistryAssociationInputDict
¶
Bases: TypedDict
Dictionary form of EnableIpamInternetRegistryAssociationInput.
Attributes¶
child_handle
instance-attribute
¶
The child handle for the BPKI certificate hierarchy from the Parent Response XML.
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.
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.
ipam_internet_registry_association_id
instance-attribute
¶
The ID of the IPAM internet registry association to enable.
parent_bpki_ta
instance-attribute
¶
The parent BPKI Trust Anchor certificate in PEM format from the Parent Response XML.
parent_handle
instance-attribute
¶
The parent handle for the BPKI certificate hierarchy from the Parent Response XML.
rpki_version
instance-attribute
¶
The RPKI version to use from the Parent Response XML.
EnableIpamInternetRegistryAssociationInput
dataclass
¶
Bases: _SerdeShape
Dataclass for EnableIpamInternetRegistryAssociationInput structure.
Attributes¶
child_handle
class-attribute
instance-attribute
¶
child_handle: str | None = ...
The child handle for the BPKI certificate hierarchy from the Parent Response XML.
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.
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.
ipam_internet_registry_association_id
class-attribute
instance-attribute
¶
ipam_internet_registry_association_id: str | None = ...
The ID of the IPAM internet registry association to enable.
parent_bpki_ta
class-attribute
instance-attribute
¶
parent_bpki_ta: str | None = ...
The parent BPKI Trust Anchor certificate in PEM format from the Parent Response XML.
parent_handle
class-attribute
instance-attribute
¶
parent_handle: str | None = ...
The parent handle for the BPKI certificate hierarchy from the Parent Response XML.
Output¶
EnableIpamInternetRegistryAssociationOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for EnableIpamInternetRegistryAssociationOutput structure.
Attributes¶
ipam_internet_registry_association
class-attribute
instance-attribute
¶
ipam_internet_registry_association: IpamInternetRegistryAssociation | None = ...
Information about the enabled internet registry association.
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.