PublicIpPool

class oci.core.models.PublicIpPool(**kwargs)

Bases: object

A public IP pool is a set of public IP addresses represented as one or more IPv4 CIDR blocks. Resources like load balancers and compute instances can be allocated public IP addresses from a public IP pool.

Attributes

LIFECYCLE_STATE_ACTIVE A constant which can be used with the lifecycle_state property of a PublicIpPool.
LIFECYCLE_STATE_DELETED A constant which can be used with the lifecycle_state property of a PublicIpPool.
LIFECYCLE_STATE_DELETING A constant which can be used with the lifecycle_state property of a PublicIpPool.
LIFECYCLE_STATE_INACTIVE A constant which can be used with the lifecycle_state property of a PublicIpPool.
LIFECYCLE_STATE_UPDATING A constant which can be used with the lifecycle_state property of a PublicIpPool.
cidr_blocks Gets the cidr_blocks of this PublicIpPool.
compartment_id [Required] Gets the compartment_id of this PublicIpPool.
defined_tags Gets the defined_tags of this PublicIpPool.
display_name Gets the display_name of this PublicIpPool.
freeform_tags Gets the freeform_tags of this PublicIpPool.
id [Required] Gets the id of this PublicIpPool.
lifecycle_state Gets the lifecycle_state of this PublicIpPool.
time_created [Required] Gets the time_created of this PublicIpPool.

Methods

__init__(**kwargs) Initializes a new PublicIpPool object with values from keyword arguments.
LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a PublicIpPool. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a PublicIpPool. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a PublicIpPool. This constant has a value of “DELETING”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

A constant which can be used with the lifecycle_state property of a PublicIpPool. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a PublicIpPool. This constant has a value of “UPDATING”

__init__(**kwargs)

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

Parameters:
  • cidr_blocks (list[str]) – The value to assign to the cidr_blocks property of this PublicIpPool.
  • compartment_id (str) – The value to assign to the compartment_id property of this PublicIpPool.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this PublicIpPool.
  • display_name (str) – The value to assign to the display_name property of this PublicIpPool.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this PublicIpPool.
  • id (str) – The value to assign to the id property of this PublicIpPool.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this PublicIpPool. Allowed values for this property are: “INACTIVE”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, ‘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 PublicIpPool.
cidr_blocks

Gets the cidr_blocks of this PublicIpPool. The CIDR blocks added to this pool. This could be all or a portion of a BYOIP CIDR block.

Returns:The cidr_blocks of this PublicIpPool.
Return type:list[str]
compartment_id

[Required] Gets the compartment_id of this PublicIpPool. The OCID of the compartment containing this pool.

Returns:The compartment_id of this PublicIpPool.
Return type:str
defined_tags

Gets the defined_tags of this PublicIpPool. 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 PublicIpPool.
Return type:dict(str, dict(str, object))
display_name

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

Returns:The display_name of this PublicIpPool.
Return type:str
freeform_tags

Gets the freeform_tags of this PublicIpPool. 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 PublicIpPool.
Return type:dict(str, str)
id

[Required] Gets the id of this PublicIpPool. The OCID of the public IP pool.

Returns:The id of this PublicIpPool.
Return type:str
lifecycle_state

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

Allowed values for this property are: “INACTIVE”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The lifecycle_state of this PublicIpPool.
Return type:str
time_created

[Required] Gets the time_created of this PublicIpPool. The date and time the public IP pool was created, in the format defined by RFC3339.

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

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