1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Core
  5. PublicIpPoolCapacity
Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi

oci.Core.PublicIpPoolCapacity

Explore with Pulumi AI

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testPublicIpPoolCapacity = new oci.core.PublicIpPoolCapacity("test_public_ip_pool_capacity", {
    publicIpPoolId: publicIpPoolId,
    byoipId: byoipId,
    cidrBlock: cidrBlock,
});
Copy
import pulumi
import pulumi_oci as oci

test_public_ip_pool_capacity = oci.core.PublicIpPoolCapacity("test_public_ip_pool_capacity",
    public_ip_pool_id=public_ip_pool_id,
    byoip_id=byoip_id,
    cidr_block=cidr_block)
Copy
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.NewPublicIpPoolCapacity(ctx, "test_public_ip_pool_capacity", &core.PublicIpPoolCapacityArgs{
			PublicIpPoolId: pulumi.Any(publicIpPoolId),
			ByoipId:        pulumi.Any(byoipId),
			CidrBlock:      pulumi.Any(cidrBlock),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testPublicIpPoolCapacity = new Oci.Core.PublicIpPoolCapacity("test_public_ip_pool_capacity", new()
    {
        PublicIpPoolId = publicIpPoolId,
        ByoipId = byoipId,
        CidrBlock = cidrBlock,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Core.PublicIpPoolCapacity;
import com.pulumi.oci.Core.PublicIpPoolCapacityArgs;
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) {
        var testPublicIpPoolCapacity = new PublicIpPoolCapacity("testPublicIpPoolCapacity", PublicIpPoolCapacityArgs.builder()
            .publicIpPoolId(publicIpPoolId)
            .byoipId(byoipId)
            .cidrBlock(cidrBlock)
            .build());

    }
}
Copy
resources:
  testPublicIpPoolCapacity:
    type: oci:Core:PublicIpPoolCapacity
    name: test_public_ip_pool_capacity
    properties:
      publicIpPoolId: ${publicIpPoolId}
      byoipId: ${byoipId}
      cidrBlock: ${cidrBlock}
Copy

Create PublicIpPoolCapacity Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new PublicIpPoolCapacity(name: string, args: PublicIpPoolCapacityArgs, opts?: CustomResourceOptions);
@overload
def PublicIpPoolCapacity(resource_name: str,
                         args: PublicIpPoolCapacityArgs,
                         opts: Optional[ResourceOptions] = None)

@overload
def PublicIpPoolCapacity(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         byoip_id: Optional[str] = None,
                         cidr_block: Optional[str] = None,
                         public_ip_pool_id: Optional[str] = None)
func NewPublicIpPoolCapacity(ctx *Context, name string, args PublicIpPoolCapacityArgs, opts ...ResourceOption) (*PublicIpPoolCapacity, error)
public PublicIpPoolCapacity(string name, PublicIpPoolCapacityArgs args, CustomResourceOptions? opts = null)
public PublicIpPoolCapacity(String name, PublicIpPoolCapacityArgs args)
public PublicIpPoolCapacity(String name, PublicIpPoolCapacityArgs args, CustomResourceOptions options)
type: oci:Core:PublicIpPoolCapacity
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. PublicIpPoolCapacityArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. PublicIpPoolCapacityArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. PublicIpPoolCapacityArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. PublicIpPoolCapacityArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. PublicIpPoolCapacityArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var publicIpPoolCapacityResource = new Oci.Core.PublicIpPoolCapacity("publicIpPoolCapacityResource", new()
{
    ByoipId = "string",
    CidrBlock = "string",
    PublicIpPoolId = "string",
});
Copy
example, err := Core.NewPublicIpPoolCapacity(ctx, "publicIpPoolCapacityResource", &Core.PublicIpPoolCapacityArgs{
	ByoipId:        pulumi.String("string"),
	CidrBlock:      pulumi.String("string"),
	PublicIpPoolId: pulumi.String("string"),
})
Copy
var publicIpPoolCapacityResource = new PublicIpPoolCapacity("publicIpPoolCapacityResource", PublicIpPoolCapacityArgs.builder()
    .byoipId("string")
    .cidrBlock("string")
    .publicIpPoolId("string")
    .build());
Copy
public_ip_pool_capacity_resource = oci.core.PublicIpPoolCapacity("publicIpPoolCapacityResource",
    byoip_id="string",
    cidr_block="string",
    public_ip_pool_id="string")
Copy
const publicIpPoolCapacityResource = new oci.core.PublicIpPoolCapacity("publicIpPoolCapacityResource", {
    byoipId: "string",
    cidrBlock: "string",
    publicIpPoolId: "string",
});
Copy
type: oci:Core:PublicIpPoolCapacity
properties:
    byoipId: string
    cidrBlock: string
    publicIpPoolId: string
Copy

PublicIpPoolCapacity Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The PublicIpPoolCapacity resource accepts the following input properties:

ByoipId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the Byoip Range Id object to which the cidr block belongs.
CidrBlock
This property is required.
Changes to this property will trigger replacement.
string

The CIDR IP address range to be added to the Public Ip Pool. Example: 10.0.1.0/24

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

PublicIpPoolId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the pool object created by the current tenancy
ByoipId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the Byoip Range Id object to which the cidr block belongs.
CidrBlock
This property is required.
Changes to this property will trigger replacement.
string

The CIDR IP address range to be added to the Public Ip Pool. Example: 10.0.1.0/24

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

PublicIpPoolId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the pool object created by the current tenancy
byoipId
This property is required.
Changes to this property will trigger replacement.
String
The OCID of the Byoip Range Id object to which the cidr block belongs.
cidrBlock
This property is required.
Changes to this property will trigger replacement.
String

The CIDR IP address range to be added to the Public Ip Pool. Example: 10.0.1.0/24

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

publicIpPoolId
This property is required.
Changes to this property will trigger replacement.
String
The OCID of the pool object created by the current tenancy
byoipId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the Byoip Range Id object to which the cidr block belongs.
cidrBlock
This property is required.
Changes to this property will trigger replacement.
string

The CIDR IP address range to be added to the Public Ip Pool. Example: 10.0.1.0/24

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

publicIpPoolId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the pool object created by the current tenancy
byoip_id
This property is required.
Changes to this property will trigger replacement.
str
The OCID of the Byoip Range Id object to which the cidr block belongs.
cidr_block
This property is required.
Changes to this property will trigger replacement.
str

The CIDR IP address range to be added to the Public Ip Pool. Example: 10.0.1.0/24

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

public_ip_pool_id
This property is required.
Changes to this property will trigger replacement.
str
The OCID of the pool object created by the current tenancy
byoipId
This property is required.
Changes to this property will trigger replacement.
String
The OCID of the Byoip Range Id object to which the cidr block belongs.
cidrBlock
This property is required.
Changes to this property will trigger replacement.
String

The CIDR IP address range to be added to the Public Ip Pool. Example: 10.0.1.0/24

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

publicIpPoolId
This property is required.
Changes to this property will trigger replacement.
String
The OCID of the pool object created by the current tenancy

Outputs

All input properties are implicitly available as output properties. Additionally, the PublicIpPoolCapacity resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing PublicIpPoolCapacity Resource

Get an existing PublicIpPoolCapacity resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: PublicIpPoolCapacityState, opts?: CustomResourceOptions): PublicIpPoolCapacity
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        byoip_id: Optional[str] = None,
        cidr_block: Optional[str] = None,
        public_ip_pool_id: Optional[str] = None) -> PublicIpPoolCapacity
func GetPublicIpPoolCapacity(ctx *Context, name string, id IDInput, state *PublicIpPoolCapacityState, opts ...ResourceOption) (*PublicIpPoolCapacity, error)
public static PublicIpPoolCapacity Get(string name, Input<string> id, PublicIpPoolCapacityState? state, CustomResourceOptions? opts = null)
public static PublicIpPoolCapacity get(String name, Output<String> id, PublicIpPoolCapacityState state, CustomResourceOptions options)
resources:  _:    type: oci:Core:PublicIpPoolCapacity    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
ByoipId Changes to this property will trigger replacement. string
The OCID of the Byoip Range Id object to which the cidr block belongs.
CidrBlock Changes to this property will trigger replacement. string

The CIDR IP address range to be added to the Public Ip Pool. Example: 10.0.1.0/24

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

PublicIpPoolId Changes to this property will trigger replacement. string
The OCID of the pool object created by the current tenancy
ByoipId Changes to this property will trigger replacement. string
The OCID of the Byoip Range Id object to which the cidr block belongs.
CidrBlock Changes to this property will trigger replacement. string

The CIDR IP address range to be added to the Public Ip Pool. Example: 10.0.1.0/24

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

PublicIpPoolId Changes to this property will trigger replacement. string
The OCID of the pool object created by the current tenancy
byoipId Changes to this property will trigger replacement. String
The OCID of the Byoip Range Id object to which the cidr block belongs.
cidrBlock Changes to this property will trigger replacement. String

The CIDR IP address range to be added to the Public Ip Pool. Example: 10.0.1.0/24

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

publicIpPoolId Changes to this property will trigger replacement. String
The OCID of the pool object created by the current tenancy
byoipId Changes to this property will trigger replacement. string
The OCID of the Byoip Range Id object to which the cidr block belongs.
cidrBlock Changes to this property will trigger replacement. string

The CIDR IP address range to be added to the Public Ip Pool. Example: 10.0.1.0/24

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

publicIpPoolId Changes to this property will trigger replacement. string
The OCID of the pool object created by the current tenancy
byoip_id Changes to this property will trigger replacement. str
The OCID of the Byoip Range Id object to which the cidr block belongs.
cidr_block Changes to this property will trigger replacement. str

The CIDR IP address range to be added to the Public Ip Pool. Example: 10.0.1.0/24

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

public_ip_pool_id Changes to this property will trigger replacement. str
The OCID of the pool object created by the current tenancy
byoipId Changes to this property will trigger replacement. String
The OCID of the Byoip Range Id object to which the cidr block belongs.
cidrBlock Changes to this property will trigger replacement. String

The CIDR IP address range to be added to the Public Ip Pool. Example: 10.0.1.0/24

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

publicIpPoolId Changes to this property will trigger replacement. String
The OCID of the pool object created by the current tenancy

Import

PublicIpPoolCapacity can be imported using the id, e.g.

$ pulumi import oci:Core/publicIpPoolCapacity:PublicIpPoolCapacity test_public_ip_pool_capacity "publicIpPoolId/{publicIpPoolId}/byoipId/{byoipId}/cidrBlock/{cidrBlock}"
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes
This Pulumi package is based on the oci Terraform Provider.