PublicIp¶

class oci.core.models.PublicIp(**kwargs)¶

Bases: object

A public IP is a conceptual term that refers to a public IP address and related properties. The publicIp object is the API representation of a public IP.

There are two types of public IPs: 1. Ephemeral 2. Reserved

For more information and comparison of the two types, see Public IP Addresses.

Attributes

`ASSIGNED_ENTITY_TYPE_NAT_GATEWAY`	A constant which can be used with the assigned_entity_type property of a PublicIp.
`ASSIGNED_ENTITY_TYPE_PRIVATE_IP`	A constant which can be used with the assigned_entity_type property of a PublicIp.
`LIFECYCLE_STATE_ASSIGNED`	A constant which can be used with the lifecycle_state property of a PublicIp.
`LIFECYCLE_STATE_ASSIGNING`	A constant which can be used with the lifecycle_state property of a PublicIp.
`LIFECYCLE_STATE_AVAILABLE`	A constant which can be used with the lifecycle_state property of a PublicIp.
`LIFECYCLE_STATE_PROVISIONING`	A constant which can be used with the lifecycle_state property of a PublicIp.
`LIFECYCLE_STATE_TERMINATED`	A constant which can be used with the lifecycle_state property of a PublicIp.
`LIFECYCLE_STATE_TERMINATING`	A constant which can be used with the lifecycle_state property of a PublicIp.
`LIFECYCLE_STATE_UNASSIGNED`	A constant which can be used with the lifecycle_state property of a PublicIp.
`LIFECYCLE_STATE_UNASSIGNING`	A constant which can be used with the lifecycle_state property of a PublicIp.
`LIFETIME_EPHEMERAL`	A constant which can be used with the lifetime property of a PublicIp.
`LIFETIME_RESERVED`	A constant which can be used with the lifetime property of a PublicIp.
`SCOPE_AVAILABILITY_DOMAIN`	A constant which can be used with the scope property of a PublicIp.
`SCOPE_REGION`	A constant which can be used with the scope property of a PublicIp.
`assigned_entity_id`	Gets the assigned_entity_id of this PublicIp.
`assigned_entity_type`	Gets the assigned_entity_type of this PublicIp.
`availability_domain`	Gets the availability_domain of this PublicIp.
`compartment_id`	Gets the compartment_id of this PublicIp.
`defined_tags`	Gets the defined_tags of this PublicIp.
`display_name`	Gets the display_name of this PublicIp.
`freeform_tags`	Gets the freeform_tags of this PublicIp.
`id`	Gets the id of this PublicIp.
`ip_address`	Gets the ip_address of this PublicIp.
`lifecycle_state`	Gets the lifecycle_state of this PublicIp.
`lifetime`	Gets the lifetime of this PublicIp.
`private_ip_id`	Gets the private_ip_id of this PublicIp.
`public_ip_pool_id`	Gets the public_ip_pool_id of this PublicIp.
`scope`	Gets the scope of this PublicIp.
`time_created`	Gets the time_created of this PublicIp.

Methods

__init__(**kwargs) Initializes a new PublicIp object with values from keyword arguments.

ASSIGNED_ENTITY_TYPE_NAT_GATEWAY = 'NAT_GATEWAY'¶: A constant which can be used with the assigned_entity_type property of a PublicIp. This constant has a value of “NAT_GATEWAY”

ASSIGNED_ENTITY_TYPE_PRIVATE_IP = 'PRIVATE_IP'¶: A constant which can be used with the assigned_entity_type property of a PublicIp. This constant has a value of “PRIVATE_IP”

LIFECYCLE_STATE_ASSIGNED = 'ASSIGNED'¶: A constant which can be used with the lifecycle_state property of a PublicIp. This constant has a value of “ASSIGNED”

LIFECYCLE_STATE_ASSIGNING = 'ASSIGNING'¶: A constant which can be used with the lifecycle_state property of a PublicIp. This constant has a value of “ASSIGNING”

LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'¶: A constant which can be used with the lifecycle_state property of a PublicIp. This constant has a value of “AVAILABLE”

LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'¶: A constant which can be used with the lifecycle_state property of a PublicIp. This constant has a value of “PROVISIONING”

LIFECYCLE_STATE_TERMINATED = 'TERMINATED'¶: A constant which can be used with the lifecycle_state property of a PublicIp. This constant has a value of “TERMINATED”

LIFECYCLE_STATE_TERMINATING = 'TERMINATING'¶: A constant which can be used with the lifecycle_state property of a PublicIp. This constant has a value of “TERMINATING”

LIFECYCLE_STATE_UNASSIGNED = 'UNASSIGNED'¶: A constant which can be used with the lifecycle_state property of a PublicIp. This constant has a value of “UNASSIGNED”

LIFECYCLE_STATE_UNASSIGNING = 'UNASSIGNING'¶: A constant which can be used with the lifecycle_state property of a PublicIp. This constant has a value of “UNASSIGNING”

LIFETIME_EPHEMERAL = 'EPHEMERAL'¶: A constant which can be used with the lifetime property of a PublicIp. This constant has a value of “EPHEMERAL”

LIFETIME_RESERVED = 'RESERVED'¶: A constant which can be used with the lifetime property of a PublicIp. This constant has a value of “RESERVED”

SCOPE_AVAILABILITY_DOMAIN = 'AVAILABILITY_DOMAIN'¶: A constant which can be used with the scope property of a PublicIp. This constant has a value of “AVAILABILITY_DOMAIN”

SCOPE_REGION = 'REGION'¶: A constant which can be used with the scope property of a PublicIp. This constant has a value of “REGION”

__init__(**kwargs)¶

Initializes a new PublicIp object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

assigned_entity_id (str) – The value to assign to the assigned_entity_id property of this PublicIp.
assigned_entity_type (str) – The value to assign to the assigned_entity_type property of this PublicIp. Allowed values for this property are: “PRIVATE_IP”, “NAT_GATEWAY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
availability_domain (str) – The value to assign to the availability_domain property of this PublicIp.
compartment_id (str) – The value to assign to the compartment_id property of this PublicIp.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this PublicIp.
display_name (str) – The value to assign to the display_name property of this PublicIp.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this PublicIp.
id (str) – The value to assign to the id property of this PublicIp.
ip_address (str) – The value to assign to the ip_address property of this PublicIp.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this PublicIp. Allowed values for this property are: “PROVISIONING”, “AVAILABLE”, “ASSIGNING”, “ASSIGNED”, “UNASSIGNING”, “UNASSIGNED”, “TERMINATING”, “TERMINATED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifetime (str) – The value to assign to the lifetime property of this PublicIp. Allowed values for this property are: “EPHEMERAL”, “RESERVED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
private_ip_id (str) – The value to assign to the private_ip_id property of this PublicIp.
scope (str) – The value to assign to the scope property of this PublicIp. Allowed values for this property are: “REGION”, “AVAILABILITY_DOMAIN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_created (datetime) – The value to assign to the time_created property of this PublicIp.
public_ip_pool_id (str) – The value to assign to the public_ip_pool_id property of this PublicIp.

assigned_entity_id¶

Gets the assigned_entity_id of this PublicIp. The OCID of the entity the public IP is assigned to, or in the process of being assigned to.

Returns:	The assigned_entity_id of this PublicIp.
Return type:	str

assigned_entity_type¶

Gets the assigned_entity_type of this PublicIp. The type of entity the public IP is assigned to, or in the process of being assigned to.

Allowed values for this property are: “PRIVATE_IP”, “NAT_GATEWAY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The assigned_entity_type of this PublicIp.
Return type:	str

availability_domain¶

Gets the availability_domain of this PublicIp. The public IP’s availability domain. This property is set only for ephemeral public IPs that are assigned to a private IP (that is, when the scope of the public IP is set to AVAILABILITY_DOMAIN). The value is the availability domain of the assigned private IP.

Example: Uocm:PHX-AD-1

Returns:	The availability_domain of this PublicIp.
Return type:	str

compartment_id¶

Gets the compartment_id of this PublicIp. The OCID of the compartment containing the public IP. For an ephemeral public IP, this is the compartment of its assigned entity (which can be a private IP or a regional entity such as a NAT gateway). For a reserved public IP that is currently assigned, its compartment can be different from the assigned private IP’s.

Returns:	The compartment_id of this PublicIp.
Return type:	str

defined_tags¶

Gets the defined_tags of this PublicIp. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {“Operations”: {“CostCenter”: “42”}}

Returns:	The defined_tags of this PublicIp.
Return type:	dict(str, dict(str, object))

display_name¶

Gets the display_name of this PublicIp. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns:	The display_name of this PublicIp.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this PublicIp. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {“Department”: “Finance”}

Returns:	The freeform_tags of this PublicIp.
Return type:	dict(str, str)

id¶

Gets the id of this PublicIp. The public IP’s Oracle ID (OCID).

Returns:	The id of this PublicIp.
Return type:	str

ip_address¶

Gets the ip_address of this PublicIp. The public IP address of the publicIp object.

Example: 203.0.113.2

Returns:	The ip_address of this PublicIp.
Return type:	str

lifecycle_state¶

Gets the lifecycle_state of this PublicIp. The public IP’s current state.

Allowed values for this property are: “PROVISIONING”, “AVAILABLE”, “ASSIGNING”, “ASSIGNED”, “UNASSIGNING”, “UNASSIGNED”, “TERMINATING”, “TERMINATED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this PublicIp.
Return type:	str

lifetime¶

Gets the lifetime of this PublicIp. Defines when the public IP is deleted and released back to Oracle’s public IP pool.

EPHEMERAL: The lifetime is tied to the lifetime of its assigned entity. An ephemeral

public IP must always be assigned to an entity. If the assigned entity is a private IP, the ephemeral public IP is automatically deleted when the private IP is deleted, when the VNIC is terminated, or when the instance is terminated. If the assigned entity is a NatGateway, the ephemeral public IP is automatically deleted when the NAT gateway is terminated.

RESERVED: You control the public IP’s lifetime. You can delete a reserved public IP

whenever you like. It does not need to be assigned to a private IP at all times.

For more information and comparison of the two types, see Public IP Addresses.

Allowed values for this property are: “EPHEMERAL”, “RESERVED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifetime of this PublicIp.
Return type:	str

private_ip_id¶

Gets the private_ip_id of this PublicIp. Deprecated. Use assignedEntityId instead.

The OCID of the private IP that the public IP is currently assigned to, or in the process of being assigned to.

Note: This is null if the public IP is not assigned to a private IP, or is in the process of being assigned to one.

Returns:	The private_ip_id of this PublicIp.
Return type:	str

public_ip_pool_id¶

Gets the public_ip_pool_id of this PublicIp. The OCID of the pool object created in the current tenancy.

Returns:	The public_ip_pool_id of this PublicIp.
Return type:	str

scope¶

Gets the scope of this PublicIp. Whether the public IP is regional or specific to a particular availability domain.

REGION: The public IP exists within a region and is assigned to a regional entity

(such as a NatGateway), or can be assigned to a private IP in any availability domain in the region. Reserved public IPs and ephemeral public IPs assigned to a regional entity have scope = REGION.

AVAILABILITY_DOMAIN: The public IP exists within the availability domain of the entity

it’s assigned to, which is specified by the availabilityDomain property of the public IP object. Ephemeral public IPs that are assigned to private IPs have scope = AVAILABILITY_DOMAIN.

Allowed values for this property are: “REGION”, “AVAILABILITY_DOMAIN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The scope of this PublicIp.
Return type:	str

time_created¶

Gets the time_created of this PublicIp. The date and time the public IP was created, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns:	The time_created of this PublicIp.
Return type:	datetime