CreatePublicIpDetails

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

Bases: object

CreatePublicIpDetails model.

LIFETIME_EPHEMERAL = 'EPHEMERAL'

A constant which can be used with the lifetime property of a CreatePublicIpDetails. This constant has a value of "EPHEMERAL"

LIFETIME_RESERVED = 'RESERVED'

A constant which can be used with the lifetime property of a CreatePublicIpDetails. This constant has a value of "RESERVED"

__init__(**kwargs)

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

Parameters:
  • compartment_id (str) -- The value to assign to the compartment_id property of this CreatePublicIpDetails.
  • defined_tags (dict(str, dict(str, object))) -- The value to assign to the defined_tags property of this CreatePublicIpDetails.
  • display_name (str) -- The value to assign to the display_name property of this CreatePublicIpDetails.
  • freeform_tags (dict(str, str)) -- The value to assign to the freeform_tags property of this CreatePublicIpDetails.
  • lifetime (str) -- The value to assign to the lifetime property of this CreatePublicIpDetails. Allowed values for this property are: "EPHEMERAL", "RESERVED"
  • private_ip_id (str) -- The value to assign to the private_ip_id property of this CreatePublicIpDetails.
compartment_id

[Required] Gets the compartment_id of this CreatePublicIpDetails. The OCID of the compartment to contain the public IP. For ephemeral public IPs, you must set this to the private IP's compartment OCID.

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

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

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

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

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

[Required] Gets the lifetime of this CreatePublicIpDetails. Defines when the public IP is deleted and released back to the Oracle Cloud Infrastructure public IP pool. For more information, see Public IP Addresses.

Allowed values for this property are: "EPHEMERAL", "RESERVED"

Returns:The lifetime of this CreatePublicIpDetails.
Return type:str
private_ip_id

Gets the private_ip_id of this CreatePublicIpDetails. The OCID of the private IP to assign the public IP to.

Required for an ephemeral public IP because it must always be assigned to a private IP (specifically a primary private IP).

Optional for a reserved public IP. If you don't provide it, the public IP is created but not assigned to a private IP. You can later assign the public IP with update_public_ip().

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