oci.Core.getPublicIps
Explore with Pulumi AI
This data source provides the list of Public Ips in Oracle Cloud Infrastructure Core service.
Lists the PublicIp objects in the specified compartment. You can filter the list by using query parameters.
To list your reserved public IPs:
- Set
scope
=REGION
(required) - Leave the
availabilityDomain
parameter empty - Set
lifetime
=RESERVED
To list the ephemeral public IPs assigned to a regional entity such as a NAT gateway:
- Set
scope
=REGION
(required) - Leave the
availabilityDomain
parameter empty - Set
lifetime
=EPHEMERAL
To list the ephemeral public IPs assigned to private IPs:
- Set
scope
=AVAILABILITY_DOMAIN
(required) - Set the
availabilityDomain
parameter to the desired availability domain (required) - Set
lifetime
=EPHEMERAL
Note: An ephemeral public IP assigned to a private IP is always in the same availability domain and compartment as the private IP.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testPublicIps = oci.Core.getPublicIps({
compartmentId: compartmentId,
scope: publicIpScope,
availabilityDomain: publicIpAvailabilityDomain,
lifetime: publicIpLifetime,
publicIpPoolId: testPublicIpPool.id,
});
import pulumi
import pulumi_oci as oci
test_public_ips = oci.Core.get_public_ips(compartment_id=compartment_id,
scope=public_ip_scope,
availability_domain=public_ip_availability_domain,
lifetime=public_ip_lifetime,
public_ip_pool_id=test_public_ip_pool["id"])
package main
import (
"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/core"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := core.GetPublicIps(ctx, &core.GetPublicIpsArgs{
CompartmentId: compartmentId,
Scope: publicIpScope,
AvailabilityDomain: pulumi.StringRef(publicIpAvailabilityDomain),
Lifetime: pulumi.StringRef(publicIpLifetime),
PublicIpPoolId: pulumi.StringRef(testPublicIpPool.Id),
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() =>
{
var testPublicIps = Oci.Core.GetPublicIps.Invoke(new()
{
CompartmentId = compartmentId,
Scope = publicIpScope,
AvailabilityDomain = publicIpAvailabilityDomain,
Lifetime = publicIpLifetime,
PublicIpPoolId = testPublicIpPool.Id,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Core.CoreFunctions;
import com.pulumi.oci.Core.inputs.GetPublicIpsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var testPublicIps = CoreFunctions.getPublicIps(GetPublicIpsArgs.builder()
.compartmentId(compartmentId)
.scope(publicIpScope)
.availabilityDomain(publicIpAvailabilityDomain)
.lifetime(publicIpLifetime)
.publicIpPoolId(testPublicIpPool.id())
.build());
}
}
variables:
testPublicIps:
fn::invoke:
function: oci:Core:getPublicIps
arguments:
compartmentId: ${compartmentId}
scope: ${publicIpScope}
availabilityDomain: ${publicIpAvailabilityDomain}
lifetime: ${publicIpLifetime}
publicIpPoolId: ${testPublicIpPool.id}
Using getPublicIps
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getPublicIps(args: GetPublicIpsArgs, opts?: InvokeOptions): Promise<GetPublicIpsResult>
function getPublicIpsOutput(args: GetPublicIpsOutputArgs, opts?: InvokeOptions): Output<GetPublicIpsResult>
def get_public_ips(availability_domain: Optional[str] = None,
compartment_id: Optional[str] = None,
filters: Optional[Sequence[_core.GetPublicIpsFilter]] = None,
lifetime: Optional[str] = None,
public_ip_pool_id: Optional[str] = None,
scope: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetPublicIpsResult
def get_public_ips_output(availability_domain: Optional[pulumi.Input[str]] = None,
compartment_id: Optional[pulumi.Input[str]] = None,
filters: Optional[pulumi.Input[Sequence[pulumi.Input[_core.GetPublicIpsFilterArgs]]]] = None,
lifetime: Optional[pulumi.Input[str]] = None,
public_ip_pool_id: Optional[pulumi.Input[str]] = None,
scope: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetPublicIpsResult]
func GetPublicIps(ctx *Context, args *GetPublicIpsArgs, opts ...InvokeOption) (*GetPublicIpsResult, error)
func GetPublicIpsOutput(ctx *Context, args *GetPublicIpsOutputArgs, opts ...InvokeOption) GetPublicIpsResultOutput
> Note: This function is named GetPublicIps
in the Go SDK.
public static class GetPublicIps
{
public static Task<GetPublicIpsResult> InvokeAsync(GetPublicIpsArgs args, InvokeOptions? opts = null)
public static Output<GetPublicIpsResult> Invoke(GetPublicIpsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetPublicIpsResult> getPublicIps(GetPublicIpsArgs args, InvokeOptions options)
public static Output<GetPublicIpsResult> getPublicIps(GetPublicIpsArgs args, InvokeOptions options)
fn::invoke:
function: oci:Core/getPublicIps:getPublicIps
arguments:
# arguments dictionary
The following arguments are supported:
- Compartment
Id This property is required. string - The OCID of the compartment.
- Scope
This property is required. string - 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 havescope
=REGION
, as do ephemeral public IPs assigned to a regional entity.AVAILABILITY_DOMAIN
: The public IP exists within the availability domain of the entity it's assigned to, which is specified by theavailabilityDomain
property of the public IP object. Ephemeral public IPs that are assigned to private IPs havescope
=AVAILABILITY_DOMAIN
.
- Availability
Domain string - The name of the availability domain. Example:
Uocm:PHX-AD-1
- Filters
Changes to this property will trigger replacement.
Public Ips Filter> - Lifetime string
- A filter to return only public IPs that match given lifetime.
- Public
Ip stringPool Id - A filter to return only resources that belong to the given public IP pool.
- Compartment
Id This property is required. string - The OCID of the compartment.
- Scope
This property is required. string - 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 havescope
=REGION
, as do ephemeral public IPs assigned to a regional entity.AVAILABILITY_DOMAIN
: The public IP exists within the availability domain of the entity it's assigned to, which is specified by theavailabilityDomain
property of the public IP object. Ephemeral public IPs that are assigned to private IPs havescope
=AVAILABILITY_DOMAIN
.
- Availability
Domain string - The name of the availability domain. Example:
Uocm:PHX-AD-1
- Filters
Changes to this property will trigger replacement.
Public Ips Filter - Lifetime string
- A filter to return only public IPs that match given lifetime.
- Public
Ip stringPool Id - A filter to return only resources that belong to the given public IP pool.
- compartment
Id This property is required. String - The OCID of the compartment.
- scope
This property is required. String - 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 havescope
=REGION
, as do ephemeral public IPs assigned to a regional entity.AVAILABILITY_DOMAIN
: The public IP exists within the availability domain of the entity it's assigned to, which is specified by theavailabilityDomain
property of the public IP object. Ephemeral public IPs that are assigned to private IPs havescope
=AVAILABILITY_DOMAIN
.
- availability
Domain String - The name of the availability domain. Example:
Uocm:PHX-AD-1
- filters
Changes to this property will trigger replacement.
Public Ips Filter> - lifetime String
- A filter to return only public IPs that match given lifetime.
- public
Ip StringPool Id - A filter to return only resources that belong to the given public IP pool.
- compartment
Id This property is required. string - The OCID of the compartment.
- scope
This property is required. string - 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 havescope
=REGION
, as do ephemeral public IPs assigned to a regional entity.AVAILABILITY_DOMAIN
: The public IP exists within the availability domain of the entity it's assigned to, which is specified by theavailabilityDomain
property of the public IP object. Ephemeral public IPs that are assigned to private IPs havescope
=AVAILABILITY_DOMAIN
.
- availability
Domain string - The name of the availability domain. Example:
Uocm:PHX-AD-1
- filters
Changes to this property will trigger replacement.
Public Ips Filter[] - lifetime string
- A filter to return only public IPs that match given lifetime.
- public
Ip stringPool Id - A filter to return only resources that belong to the given public IP pool.
- compartment_
id This property is required. str - The OCID of the compartment.
- scope
This property is required. str - 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 havescope
=REGION
, as do ephemeral public IPs assigned to a regional entity.AVAILABILITY_DOMAIN
: The public IP exists within the availability domain of the entity it's assigned to, which is specified by theavailabilityDomain
property of the public IP object. Ephemeral public IPs that are assigned to private IPs havescope
=AVAILABILITY_DOMAIN
.
- availability_
domain str - The name of the availability domain. Example:
Uocm:PHX-AD-1
- filters
Changes to this property will trigger replacement.
Get Public Ips Filter] - lifetime str
- A filter to return only public IPs that match given lifetime.
- public_
ip_ strpool_ id - A filter to return only resources that belong to the given public IP pool.
- compartment
Id This property is required. String - The OCID of the compartment.
- scope
This property is required. String - 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 havescope
=REGION
, as do ephemeral public IPs assigned to a regional entity.AVAILABILITY_DOMAIN
: The public IP exists within the availability domain of the entity it's assigned to, which is specified by theavailabilityDomain
property of the public IP object. Ephemeral public IPs that are assigned to private IPs havescope
=AVAILABILITY_DOMAIN
.
- availability
Domain String - The name of the availability domain. Example:
Uocm:PHX-AD-1
- filters
Changes to this property will trigger replacement.
- lifetime String
- A filter to return only public IPs that match given lifetime.
- public
Ip StringPool Id - A filter to return only resources that belong to the given public IP pool.
getPublicIps Result
The following output properties are available:
- Compartment
Id string - 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.
- Id string
- The provider-assigned unique ID for this managed resource.
- Public
Ips List<GetPublic Ips Public Ip> - The list of public_ips.
- Scope string
- 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 havescope
=REGION
.AVAILABILITY_DOMAIN
: The public IP exists within the availability domain of the entity it's assigned to, which is specified by theavailabilityDomain
property of the public IP object. Ephemeral public IPs that are assigned to private IPs havescope
=AVAILABILITY_DOMAIN
.
- Availability
Domain string - 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
- Filters
List<Get
Public Ips Filter> - Lifetime string
- 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.
- Public
Ip stringPool Id - The OCID of the pool object created in the current tenancy.
- Compartment
Id string - 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.
- Id string
- The provider-assigned unique ID for this managed resource.
- Public
Ips []GetPublic Ips Public Ip - The list of public_ips.
- Scope string
- 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 havescope
=REGION
.AVAILABILITY_DOMAIN
: The public IP exists within the availability domain of the entity it's assigned to, which is specified by theavailabilityDomain
property of the public IP object. Ephemeral public IPs that are assigned to private IPs havescope
=AVAILABILITY_DOMAIN
.
- Availability
Domain string - 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
- Filters
[]Get
Public Ips Filter - Lifetime string
- 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.
- Public
Ip stringPool Id - The OCID of the pool object created in the current tenancy.
- compartment
Id String - 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.
- id String
- The provider-assigned unique ID for this managed resource.
- public
Ips List<GetPublic Ips Public Ip> - The list of public_ips.
- scope String
- 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 havescope
=REGION
.AVAILABILITY_DOMAIN
: The public IP exists within the availability domain of the entity it's assigned to, which is specified by theavailabilityDomain
property of the public IP object. Ephemeral public IPs that are assigned to private IPs havescope
=AVAILABILITY_DOMAIN
.
- availability
Domain String - 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
- filters
List<Get
Public Ips Filter> - lifetime String
- 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.
- public
Ip StringPool Id - The OCID of the pool object created in the current tenancy.
- compartment
Id string - 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.
- id string
- The provider-assigned unique ID for this managed resource.
- public
Ips GetPublic Ips Public Ip[] - The list of public_ips.
- scope string
- 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 havescope
=REGION
.AVAILABILITY_DOMAIN
: The public IP exists within the availability domain of the entity it's assigned to, which is specified by theavailabilityDomain
property of the public IP object. Ephemeral public IPs that are assigned to private IPs havescope
=AVAILABILITY_DOMAIN
.
- availability
Domain string - 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
- filters
Get
Public Ips Filter[] - lifetime string
- 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.
- public
Ip stringPool Id - The OCID of the pool object created in the current tenancy.
- compartment_
id str - 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.
- id str
- The provider-assigned unique ID for this managed resource.
- public_
ips Sequence[core.Get Public Ips Public Ip] - The list of public_ips.
- scope str
- 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 havescope
=REGION
.AVAILABILITY_DOMAIN
: The public IP exists within the availability domain of the entity it's assigned to, which is specified by theavailabilityDomain
property of the public IP object. Ephemeral public IPs that are assigned to private IPs havescope
=AVAILABILITY_DOMAIN
.
- availability_
domain str - 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
- filters
Sequence[core.
Get Public Ips Filter] - lifetime str
- 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.
- public_
ip_ strpool_ id - The OCID of the pool object created in the current tenancy.
- compartment
Id String - 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.
- id String
- The provider-assigned unique ID for this managed resource.
- public
Ips List<Property Map> - The list of public_ips.
- scope String
- 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 havescope
=REGION
.AVAILABILITY_DOMAIN
: The public IP exists within the availability domain of the entity it's assigned to, which is specified by theavailabilityDomain
property of the public IP object. Ephemeral public IPs that are assigned to private IPs havescope
=AVAILABILITY_DOMAIN
.
- availability
Domain String - 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
- filters List<Property Map>
- lifetime String
- 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.
- public
Ip StringPool Id - The OCID of the pool object created in the current tenancy.
Supporting Types
GetPublicIpsFilter
GetPublicIpsPublicIp
- Assigned
Entity Id This property is required. string - The OCID of the entity the public IP is assigned to, or in the process of being assigned to.
- Assigned
Entity Type This property is required. string - The type of entity the public IP is assigned to, or in the process of being assigned to.
- Availability
Domain This property is required. string - The name of the availability domain. Example:
Uocm:PHX-AD-1
- Compartment
Id This property is required. string - The OCID of the compartment.
This property is required. Dictionary<string, string>- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- Display
Name This property is required. string - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
This property is required. Dictionary<string, string>- 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"}
- Id
This property is required. string - The public IP's Oracle ID (OCID).
- Ip
Address This property is required. string - The public IP address of the
publicIp
object. Example:203.0.113.2
- Lifetime
This property is required. string - A filter to return only public IPs that match given lifetime.
- Private
Ip Id This property is required. string - Deprecated. Use
assignedEntityId
instead. - Public
Ip Pool Id This property is required. string - A filter to return only resources that belong to the given public IP pool.
- Scope
This property is required. string - 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 havescope
=REGION
, as do ephemeral public IPs assigned to a regional entity.AVAILABILITY_DOMAIN
: The public IP exists within the availability domain of the entity it's assigned to, which is specified by theavailabilityDomain
property of the public IP object. Ephemeral public IPs that are assigned to private IPs havescope
=AVAILABILITY_DOMAIN
.
- State
This property is required. string - The public IP's current state.
- Time
Created This property is required. string - The date and time the public IP was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- Assigned
Entity Id This property is required. string - The OCID of the entity the public IP is assigned to, or in the process of being assigned to.
- Assigned
Entity Type This property is required. string - The type of entity the public IP is assigned to, or in the process of being assigned to.
- Availability
Domain This property is required. string - The name of the availability domain. Example:
Uocm:PHX-AD-1
- Compartment
Id This property is required. string - The OCID of the compartment.
This property is required. map[string]string- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- Display
Name This property is required. string - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
This property is required. map[string]string- 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"}
- Id
This property is required. string - The public IP's Oracle ID (OCID).
- Ip
Address This property is required. string - The public IP address of the
publicIp
object. Example:203.0.113.2
- Lifetime
This property is required. string - A filter to return only public IPs that match given lifetime.
- Private
Ip Id This property is required. string - Deprecated. Use
assignedEntityId
instead. - Public
Ip Pool Id This property is required. string - A filter to return only resources that belong to the given public IP pool.
- Scope
This property is required. string - 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 havescope
=REGION
, as do ephemeral public IPs assigned to a regional entity.AVAILABILITY_DOMAIN
: The public IP exists within the availability domain of the entity it's assigned to, which is specified by theavailabilityDomain
property of the public IP object. Ephemeral public IPs that are assigned to private IPs havescope
=AVAILABILITY_DOMAIN
.
- State
This property is required. string - The public IP's current state.
- Time
Created This property is required. string - The date and time the public IP was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- assigned
Entity Id This property is required. String - The OCID of the entity the public IP is assigned to, or in the process of being assigned to.
- assigned
Entity Type This property is required. String - The type of entity the public IP is assigned to, or in the process of being assigned to.
- availability
Domain This property is required. String - The name of the availability domain. Example:
Uocm:PHX-AD-1
- compartment
Id This property is required. String - The OCID of the compartment.
This property is required. Map<String,String>- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- display
Name This property is required. String - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
This property is required. Map<String,String>- 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"}
- id
This property is required. String - The public IP's Oracle ID (OCID).
- ip
Address This property is required. String - The public IP address of the
publicIp
object. Example:203.0.113.2
- lifetime
This property is required. String - A filter to return only public IPs that match given lifetime.
- private
Ip Id This property is required. String - Deprecated. Use
assignedEntityId
instead. - public
Ip Pool Id This property is required. String - A filter to return only resources that belong to the given public IP pool.
- scope
This property is required. String - 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 havescope
=REGION
, as do ephemeral public IPs assigned to a regional entity.AVAILABILITY_DOMAIN
: The public IP exists within the availability domain of the entity it's assigned to, which is specified by theavailabilityDomain
property of the public IP object. Ephemeral public IPs that are assigned to private IPs havescope
=AVAILABILITY_DOMAIN
.
- state
This property is required. String - The public IP's current state.
- time
Created This property is required. String - The date and time the public IP was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- assigned
Entity Id This property is required. string - The OCID of the entity the public IP is assigned to, or in the process of being assigned to.
- assigned
Entity Type This property is required. string - The type of entity the public IP is assigned to, or in the process of being assigned to.
- availability
Domain This property is required. string - The name of the availability domain. Example:
Uocm:PHX-AD-1
- compartment
Id This property is required. string - The OCID of the compartment.
This property is required. {[key: string]: string}- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- display
Name This property is required. string - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
This property is required. {[key: string]: string}- 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"}
- id
This property is required. string - The public IP's Oracle ID (OCID).
- ip
Address This property is required. string - The public IP address of the
publicIp
object. Example:203.0.113.2
- lifetime
This property is required. string - A filter to return only public IPs that match given lifetime.
- private
Ip Id This property is required. string - Deprecated. Use
assignedEntityId
instead. - public
Ip Pool Id This property is required. string - A filter to return only resources that belong to the given public IP pool.
- scope
This property is required. string - 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 havescope
=REGION
, as do ephemeral public IPs assigned to a regional entity.AVAILABILITY_DOMAIN
: The public IP exists within the availability domain of the entity it's assigned to, which is specified by theavailabilityDomain
property of the public IP object. Ephemeral public IPs that are assigned to private IPs havescope
=AVAILABILITY_DOMAIN
.
- state
This property is required. string - The public IP's current state.
- time
Created This property is required. string - The date and time the public IP was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- assigned_
entity_ id This property is required. str - The OCID of the entity the public IP is assigned to, or in the process of being assigned to.
- assigned_
entity_ type This property is required. str - The type of entity the public IP is assigned to, or in the process of being assigned to.
- availability_
domain This property is required. str - The name of the availability domain. Example:
Uocm:PHX-AD-1
- compartment_
id This property is required. str - The OCID of the compartment.
This property is required. Mapping[str, str]- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- display_
name This property is required. str - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
This property is required. Mapping[str, str]- 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"}
- id
This property is required. str - The public IP's Oracle ID (OCID).
- ip_
address This property is required. str - The public IP address of the
publicIp
object. Example:203.0.113.2
- lifetime
This property is required. str - A filter to return only public IPs that match given lifetime.
- private_
ip_ id This property is required. str - Deprecated. Use
assignedEntityId
instead. - public_
ip_ pool_ id This property is required. str - A filter to return only resources that belong to the given public IP pool.
- scope
This property is required. str - 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 havescope
=REGION
, as do ephemeral public IPs assigned to a regional entity.AVAILABILITY_DOMAIN
: The public IP exists within the availability domain of the entity it's assigned to, which is specified by theavailabilityDomain
property of the public IP object. Ephemeral public IPs that are assigned to private IPs havescope
=AVAILABILITY_DOMAIN
.
- state
This property is required. str - The public IP's current state.
- time_
created This property is required. str - The date and time the public IP was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- assigned
Entity Id This property is required. String - The OCID of the entity the public IP is assigned to, or in the process of being assigned to.
- assigned
Entity Type This property is required. String - The type of entity the public IP is assigned to, or in the process of being assigned to.
- availability
Domain This property is required. String - The name of the availability domain. Example:
Uocm:PHX-AD-1
- compartment
Id This property is required. String - The OCID of the compartment.
This property is required. Map<String>- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- display
Name This property is required. String - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
This property is required. Map<String>- 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"}
- id
This property is required. String - The public IP's Oracle ID (OCID).
- ip
Address This property is required. String - The public IP address of the
publicIp
object. Example:203.0.113.2
- lifetime
This property is required. String - A filter to return only public IPs that match given lifetime.
- private
Ip Id This property is required. String - Deprecated. Use
assignedEntityId
instead. - public
Ip Pool Id This property is required. String - A filter to return only resources that belong to the given public IP pool.
- scope
This property is required. String - 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 havescope
=REGION
, as do ephemeral public IPs assigned to a regional entity.AVAILABILITY_DOMAIN
: The public IP exists within the availability domain of the entity it's assigned to, which is specified by theavailabilityDomain
property of the public IP object. Ephemeral public IPs that are assigned to private IPs havescope
=AVAILABILITY_DOMAIN
.
- state
This property is required. String - The public IP's current state.
- time
Created This property is required. String - The date and time the public IP was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.