Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CreatePublicIpDetails

Properties

compartmentId

compartmentId: string

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.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {@code {"foo-namespace": {"bar-key": "value"}}}

Optional displayName

displayName: undefined | string

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Optional freeformTags

freeformTags: undefined | object

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {@code {"bar-key": "value"}}

lifetime

lifetime: Lifetime

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.

Optional privateIpId

privateIpId: undefined | string

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 {@link #updatePublicIp(UpdatePublicIpRequest) updatePublicIp}.

Optional publicIpPoolId

publicIpPoolId: undefined | string

The OCID of the public IP pool.

Functions

getDeserializedJsonObj

getJsonObj