Viewing docs for Oracle Cloud Infrastructure v4.20.0
published on Wednesday, Jul 15, 2026 by Pulumi
published on Wednesday, Jul 15, 2026 by Pulumi
Viewing docs for Oracle Cloud Infrastructure v4.20.0
published on Wednesday, Jul 15, 2026 by Pulumi
published on Wednesday, Jul 15, 2026 by Pulumi
This resource provides the Private Endpoint resource in Oracle Cloud Infrastructure Object Storage service. It enables private network access from a specified subnet to Object Storage without traversing the public internet.
Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/object_storage/private_endpoint
Creates an Object Storage Private Endpoint in a specified subnet, with access scoping for namespace, compartment, and bucket.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const pe = new oci.objectstorage.PrivateEndpoint("pe", {
compartmentId: compartmentOcid,
namespace: namespaceName,
name: peName,
subnetId: testSubnet1.id,
prefix: dnsPrefix,
accessTargets: [{
namespace: "*",
compartmentId: "*",
bucket: "*",
}],
});
import pulumi
import pulumi_oci as oci
pe = oci.objectstorage.PrivateEndpoint("pe",
compartment_id=compartment_ocid,
namespace=namespace_name,
name=pe_name,
subnet_id=test_subnet1["id"],
prefix=dns_prefix,
access_targets=[{
"namespace": "*",
"compartment_id": "*",
"bucket": "*",
}])
package main
import (
"github.com/pulumi/pulumi-oci/sdk/v4/go/oci/objectstorage"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := objectstorage.NewPrivateEndpoint(ctx, "pe", &objectstorage.PrivateEndpointArgs{
CompartmentId: pulumi.Any(compartmentOcid),
Namespace: pulumi.Any(namespaceName),
Name: pulumi.Any(peName),
SubnetId: pulumi.Any(testSubnet1.Id),
Prefix: pulumi.Any(dnsPrefix),
AccessTargets: objectstorage.PrivateEndpointAccessTargetArray{
&objectstorage.PrivateEndpointAccessTargetArgs{
Namespace: pulumi.String("*"),
CompartmentId: pulumi.String("*"),
Bucket: pulumi.String("*"),
},
},
})
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 pe = new Oci.ObjectStorage.PrivateEndpoint("pe", new()
{
CompartmentId = compartmentOcid,
Namespace = namespaceName,
Name = peName,
SubnetId = testSubnet1.Id,
Prefix = dnsPrefix,
AccessTargets = new[]
{
new Oci.ObjectStorage.Inputs.PrivateEndpointAccessTargetArgs
{
Namespace = "*",
CompartmentId = "*",
Bucket = "*",
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.ObjectStorage.PrivateEndpoint;
import com.pulumi.oci.ObjectStorage.PrivateEndpointArgs;
import com.pulumi.oci.ObjectStorage.inputs.PrivateEndpointAccessTargetArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 pe = new PrivateEndpoint("pe", PrivateEndpointArgs.builder()
.compartmentId(compartmentOcid)
.namespace(namespaceName)
.name(peName)
.subnetId(testSubnet1.id())
.prefix(dnsPrefix)
.accessTargets(PrivateEndpointAccessTargetArgs.builder()
.namespace("*")
.compartmentId("*")
.bucket("*")
.build())
.build());
}
}
resources:
pe:
type: oci:ObjectStorage:PrivateEndpoint
properties:
compartmentId: ${compartmentOcid}
namespace: ${namespaceName}
name: ${peName}
subnetId: ${testSubnet1.id}
prefix: ${dnsPrefix}
accessTargets:
- namespace: '*'
compartmentId: '*'
bucket: '*'
pulumi {
required_providers {
oci = {
source = "pulumi/oci"
}
}
}
resource "oci_objectstorage_privateendpoint" "pe" {
compartment_id = compartmentOcid
namespace = namespaceName
name = peName
subnet_id = testSubnet1.id
prefix = dnsPrefix
access_targets {
namespace = "*"
compartment_id = "*"
bucket = "*"
}
}
Create PrivateEndpoint Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new PrivateEndpoint(name: string, args: PrivateEndpointArgs, opts?: CustomResourceOptions);@overload
def PrivateEndpoint(resource_name: str,
args: PrivateEndpointArgs,
opts: Optional[ResourceOptions] = None)
@overload
def PrivateEndpoint(resource_name: str,
opts: Optional[ResourceOptions] = None,
namespace: Optional[str] = None,
subnet_id: Optional[str] = None,
compartment_id: Optional[str] = None,
access_targets: Optional[Sequence[PrivateEndpointAccessTargetArgs]] = None,
prefix: Optional[str] = None,
defined_tags: Optional[Mapping[str, str]] = None,
name: Optional[str] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
nsg_ids: Optional[Sequence[str]] = None,
fqdns: Optional[Mapping[str, Mapping[str, Mapping[str, str]]]] = None,
private_endpoint_ip: Optional[str] = None,
security_attributes: Optional[Mapping[str, str]] = None,
state: Optional[str] = None,
additional_prefixes: Optional[Sequence[str]] = None)func NewPrivateEndpoint(ctx *Context, name string, args PrivateEndpointArgs, opts ...ResourceOption) (*PrivateEndpoint, error)public PrivateEndpoint(string name, PrivateEndpointArgs args, CustomResourceOptions? opts = null)
public PrivateEndpoint(String name, PrivateEndpointArgs args)
public PrivateEndpoint(String name, PrivateEndpointArgs args, CustomResourceOptions options)
type: oci:ObjectStorage:PrivateEndpoint
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "oci_object_storage_private_endpoint" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args PrivateEndpointArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args PrivateEndpointArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args PrivateEndpointArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PrivateEndpointArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args PrivateEndpointArgs
- 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 exampleprivateEndpointResourceResourceFromObjectStorageprivateEndpoint = new Oci.ObjectStorage.PrivateEndpoint("exampleprivateEndpointResourceResourceFromObjectStorageprivateEndpoint", new()
{
Namespace = "string",
SubnetId = "string",
CompartmentId = "string",
AccessTargets = new[]
{
new Oci.ObjectStorage.Inputs.PrivateEndpointAccessTargetArgs
{
Bucket = "string",
CompartmentId = "string",
Namespace = "string",
},
},
Prefix = "string",
DefinedTags =
{
{ "string", "string" },
},
Name = "string",
FreeformTags =
{
{ "string", "string" },
},
NsgIds = new[]
{
"string",
},
Fqdns =
{
{ "string", new InputMap<InputMap<string>>
{
{ "string", new InputMap<string>
{
{ "string", "string" },
} },
} },
},
PrivateEndpointIp = "string",
SecurityAttributes =
{
{ "string", "string" },
},
State = "string",
AdditionalPrefixes = new[]
{
"string",
},
});
example, err := objectstorage.NewPrivateEndpoint(ctx, "exampleprivateEndpointResourceResourceFromObjectStorageprivateEndpoint", &objectstorage.PrivateEndpointArgs{
Namespace: pulumi.String("string"),
SubnetId: pulumi.String("string"),
CompartmentId: pulumi.String("string"),
AccessTargets: objectstorage.PrivateEndpointAccessTargetArray{
&objectstorage.PrivateEndpointAccessTargetArgs{
Bucket: pulumi.String("string"),
CompartmentId: pulumi.String("string"),
Namespace: pulumi.String("string"),
},
},
Prefix: pulumi.String("string"),
DefinedTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
Name: pulumi.String("string"),
FreeformTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
NsgIds: pulumi.StringArray{
pulumi.String("string"),
},
Fqdns: pulumi.StringMapMapMap{
"string": pulumi.StringMapMap{
"string": pulumi.StringMap{
"string": pulumi.String("string"),
},
},
},
PrivateEndpointIp: pulumi.String("string"),
SecurityAttributes: pulumi.StringMap{
"string": pulumi.String("string"),
},
State: pulumi.String("string"),
AdditionalPrefixes: pulumi.StringArray{
pulumi.String("string"),
},
})
resource "oci_object_storage_private_endpoint" "exampleprivateEndpointResourceResourceFromObjectStorageprivateEndpoint" {
lifecycle {
create_before_destroy = true
}
namespace = "string"
subnet_id = "string"
compartment_id = "string"
access_targets {
bucket = "string"
compartment_id = "string"
namespace = "string"
}
prefix = "string"
defined_tags = {
"string" = "string"
}
name = "string"
freeform_tags = {
"string" = "string"
}
nsg_ids = ["string"]
fqdns = {
"string" = {
"string" = {
"string" = "string"
}
}
}
private_endpoint_ip = "string"
security_attributes = {
"string" = "string"
}
state = "string"
additional_prefixes = ["string"]
}
var exampleprivateEndpointResourceResourceFromObjectStorageprivateEndpoint = new com.pulumi.oci.ObjectStorage.PrivateEndpoint("exampleprivateEndpointResourceResourceFromObjectStorageprivateEndpoint", com.pulumi.oci.ObjectStorage.PrivateEndpointArgs.builder()
.namespace("string")
.subnetId("string")
.compartmentId("string")
.accessTargets(PrivateEndpointAccessTargetArgs.builder()
.bucket("string")
.compartmentId("string")
.namespace("string")
.build())
.prefix("string")
.definedTags(Map.of("string", "string"))
.name("string")
.freeformTags(Map.of("string", "string"))
.nsgIds("string")
.fqdns(Map.of("string", Map.of("string", Map.of("string", "string"))))
.privateEndpointIp("string")
.securityAttributes(Map.of("string", "string"))
.state("string")
.additionalPrefixes("string")
.build());
exampleprivate_endpoint_resource_resource_from_object_storageprivate_endpoint = oci.objectstorage.PrivateEndpoint("exampleprivateEndpointResourceResourceFromObjectStorageprivateEndpoint",
namespace="string",
subnet_id="string",
compartment_id="string",
access_targets=[{
"bucket": "string",
"compartment_id": "string",
"namespace": "string",
}],
prefix="string",
defined_tags={
"string": "string",
},
name="string",
freeform_tags={
"string": "string",
},
nsg_ids=["string"],
fqdns={
"string": {
"string": {
"string": "string",
},
},
},
private_endpoint_ip="string",
security_attributes={
"string": "string",
},
state="string",
additional_prefixes=["string"])
const exampleprivateEndpointResourceResourceFromObjectStorageprivateEndpoint = new oci.objectstorage.PrivateEndpoint("exampleprivateEndpointResourceResourceFromObjectStorageprivateEndpoint", {
namespace: "string",
subnetId: "string",
compartmentId: "string",
accessTargets: [{
bucket: "string",
compartmentId: "string",
namespace: "string",
}],
prefix: "string",
definedTags: {
string: "string",
},
name: "string",
freeformTags: {
string: "string",
},
nsgIds: ["string"],
fqdns: {
string: {
string: {
string: "string",
},
},
},
privateEndpointIp: "string",
securityAttributes: {
string: "string",
},
state: "string",
additionalPrefixes: ["string"],
});
type: oci:ObjectStorage:PrivateEndpoint
properties:
accessTargets:
- bucket: string
compartmentId: string
namespace: string
additionalPrefixes:
- string
compartmentId: string
definedTags:
string: string
fqdns:
string:
string:
string: string
freeformTags:
string: string
name: string
namespace: string
nsgIds:
- string
prefix: string
privateEndpointIp: string
securityAttributes:
string: string
state: string
subnetId: string
PrivateEndpoint 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 PrivateEndpoint resource accepts the following input properties:
- Access
Targets List<PrivateEndpoint Access Target> - (Updatable) When you create a private endpoint, you can restrict access to certain Object Storage resources by specifying access targets (limit of 10). Each access target consists of the following required parameters: namespace, compartmentId and bucket.
- Compartment
Id string - The ID of the compartment in which to create the private endpoint.
- Namespace string
- The Object Storage namespace used for the request.
- Prefix string
- The DNS prefix value is part of the URL used to access Object Storage. The DNS prefix is a case-insensitive string using alpha-numeric characters (no special characters). It must be unique within the VCN.
- Subnet
Id string The ID of the subnet that the private endpoint VNIC will be created and reside in.
** 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
- Additional
Prefixes List<string> - A list of additional prefixes that you can provide along with any other prefix. These resulting endpointFqdn's are added to the customer VCN's DNS record.
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - Fqdns
Dictionary<string, Immutable
Dictionary<string, Immutable Dictionary<string, string>>> - The object representing FQDN details formed using prefix and additionalPrefixes.
- Dictionary<string, string>
- (Updatable) 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"} - Name string
- The name of the private endpoint. Valid characters are uppercase or lowercase letters, numbers, hyphens, and periods. Private Endpoint names must be unique within an Object Storage namespace. Avoid entering confidential information. example: Example: my-pe1
- Nsg
Ids List<string> - A list of the OCIDs of the network security groups (NSGs) to add the private endpoint's VNIC to. For more information about NSGs, see NetworkSecurityGroup.
- Private
Endpoint stringIp - The private IP address that is to be assigned to this private endpoint. If it's not available, an error is returned. If you do not provide a value, an available IP address in the subnet is automatically chosen. If you do not provide a value, an available IP address in the subnet is automatically chosen.
- Security
Attributes Dictionary<string, string> - State string
- The lifecycle state of the private endpoint resource.
- Access
Targets []PrivateEndpoint Access Target Args - (Updatable) When you create a private endpoint, you can restrict access to certain Object Storage resources by specifying access targets (limit of 10). Each access target consists of the following required parameters: namespace, compartmentId and bucket.
- Compartment
Id string - The ID of the compartment in which to create the private endpoint.
- Namespace string
- The Object Storage namespace used for the request.
- Prefix string
- The DNS prefix value is part of the URL used to access Object Storage. The DNS prefix is a case-insensitive string using alpha-numeric characters (no special characters). It must be unique within the VCN.
- Subnet
Id string The ID of the subnet that the private endpoint VNIC will be created and reside in.
** 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
- Additional
Prefixes []string - A list of additional prefixes that you can provide along with any other prefix. These resulting endpointFqdn's are added to the customer VCN's DNS record.
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - Fqdns map[string]map[string]map[string]string
- The object representing FQDN details formed using prefix and additionalPrefixes.
- map[string]string
- (Updatable) 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"} - Name string
- The name of the private endpoint. Valid characters are uppercase or lowercase letters, numbers, hyphens, and periods. Private Endpoint names must be unique within an Object Storage namespace. Avoid entering confidential information. example: Example: my-pe1
- Nsg
Ids []string - A list of the OCIDs of the network security groups (NSGs) to add the private endpoint's VNIC to. For more information about NSGs, see NetworkSecurityGroup.
- Private
Endpoint stringIp - The private IP address that is to be assigned to this private endpoint. If it's not available, an error is returned. If you do not provide a value, an available IP address in the subnet is automatically chosen. If you do not provide a value, an available IP address in the subnet is automatically chosen.
- Security
Attributes map[string]string - State string
- The lifecycle state of the private endpoint resource.
- access_
targets list(object) - (Updatable) When you create a private endpoint, you can restrict access to certain Object Storage resources by specifying access targets (limit of 10). Each access target consists of the following required parameters: namespace, compartmentId and bucket.
- compartment_
id string - The ID of the compartment in which to create the private endpoint.
- namespace string
- The Object Storage namespace used for the request.
- prefix string
- The DNS prefix value is part of the URL used to access Object Storage. The DNS prefix is a case-insensitive string using alpha-numeric characters (no special characters). It must be unique within the VCN.
- subnet_
id string The ID of the subnet that the private endpoint VNIC will be created and reside in.
** 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
- additional_
prefixes list(string) - A list of additional prefixes that you can provide along with any other prefix. These resulting endpointFqdn's are added to the customer VCN's DNS record.
- map(string)
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - fqdns map(map(map(string)))
- The object representing FQDN details formed using prefix and additionalPrefixes.
- map(string)
- (Updatable) 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"} - name string
- The name of the private endpoint. Valid characters are uppercase or lowercase letters, numbers, hyphens, and periods. Private Endpoint names must be unique within an Object Storage namespace. Avoid entering confidential information. example: Example: my-pe1
- nsg_
ids list(string) - A list of the OCIDs of the network security groups (NSGs) to add the private endpoint's VNIC to. For more information about NSGs, see NetworkSecurityGroup.
- private_
endpoint_ stringip - The private IP address that is to be assigned to this private endpoint. If it's not available, an error is returned. If you do not provide a value, an available IP address in the subnet is automatically chosen. If you do not provide a value, an available IP address in the subnet is automatically chosen.
- security_
attributes map(string) - state string
- The lifecycle state of the private endpoint resource.
- access
Targets List<PrivateEndpoint Access Target> - (Updatable) When you create a private endpoint, you can restrict access to certain Object Storage resources by specifying access targets (limit of 10). Each access target consists of the following required parameters: namespace, compartmentId and bucket.
- compartment
Id String - The ID of the compartment in which to create the private endpoint.
- namespace String
- The Object Storage namespace used for the request.
- prefix String
- The DNS prefix value is part of the URL used to access Object Storage. The DNS prefix is a case-insensitive string using alpha-numeric characters (no special characters). It must be unique within the VCN.
- subnet
Id String The ID of the subnet that the private endpoint VNIC will be created and reside in.
** 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
- additional
Prefixes List<String> - A list of additional prefixes that you can provide along with any other prefix. These resulting endpointFqdn's are added to the customer VCN's DNS record.
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - fqdns Map<String,Map<String,Map<String,String>>>
- The object representing FQDN details formed using prefix and additionalPrefixes.
- Map<String,String>
- (Updatable) 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"} - name String
- The name of the private endpoint. Valid characters are uppercase or lowercase letters, numbers, hyphens, and periods. Private Endpoint names must be unique within an Object Storage namespace. Avoid entering confidential information. example: Example: my-pe1
- nsg
Ids List<String> - A list of the OCIDs of the network security groups (NSGs) to add the private endpoint's VNIC to. For more information about NSGs, see NetworkSecurityGroup.
- private
Endpoint StringIp - The private IP address that is to be assigned to this private endpoint. If it's not available, an error is returned. If you do not provide a value, an available IP address in the subnet is automatically chosen. If you do not provide a value, an available IP address in the subnet is automatically chosen.
- security
Attributes Map<String,String> - state String
- The lifecycle state of the private endpoint resource.
- access
Targets PrivateEndpoint Access Target[] - (Updatable) When you create a private endpoint, you can restrict access to certain Object Storage resources by specifying access targets (limit of 10). Each access target consists of the following required parameters: namespace, compartmentId and bucket.
- compartment
Id string - The ID of the compartment in which to create the private endpoint.
- namespace string
- The Object Storage namespace used for the request.
- prefix string
- The DNS prefix value is part of the URL used to access Object Storage. The DNS prefix is a case-insensitive string using alpha-numeric characters (no special characters). It must be unique within the VCN.
- subnet
Id string The ID of the subnet that the private endpoint VNIC will be created and reside in.
** 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
- additional
Prefixes string[] - A list of additional prefixes that you can provide along with any other prefix. These resulting endpointFqdn's are added to the customer VCN's DNS record.
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - fqdns {[key: string]: {[key: string]: {[key: string]: string}}}
- The object representing FQDN details formed using prefix and additionalPrefixes.
- {[key: string]: string}
- (Updatable) 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"} - name string
- The name of the private endpoint. Valid characters are uppercase or lowercase letters, numbers, hyphens, and periods. Private Endpoint names must be unique within an Object Storage namespace. Avoid entering confidential information. example: Example: my-pe1
- nsg
Ids string[] - A list of the OCIDs of the network security groups (NSGs) to add the private endpoint's VNIC to. For more information about NSGs, see NetworkSecurityGroup.
- private
Endpoint stringIp - The private IP address that is to be assigned to this private endpoint. If it's not available, an error is returned. If you do not provide a value, an available IP address in the subnet is automatically chosen. If you do not provide a value, an available IP address in the subnet is automatically chosen.
- security
Attributes {[key: string]: string} - state string
- The lifecycle state of the private endpoint resource.
- access_
targets Sequence[PrivateEndpoint Access Target Args] - (Updatable) When you create a private endpoint, you can restrict access to certain Object Storage resources by specifying access targets (limit of 10). Each access target consists of the following required parameters: namespace, compartmentId and bucket.
- compartment_
id str - The ID of the compartment in which to create the private endpoint.
- namespace str
- The Object Storage namespace used for the request.
- prefix str
- The DNS prefix value is part of the URL used to access Object Storage. The DNS prefix is a case-insensitive string using alpha-numeric characters (no special characters). It must be unique within the VCN.
- subnet_
id str The ID of the subnet that the private endpoint VNIC will be created and reside in.
** 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
- additional_
prefixes Sequence[str] - A list of additional prefixes that you can provide along with any other prefix. These resulting endpointFqdn's are added to the customer VCN's DNS record.
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - fqdns Mapping[str, Mapping[str, Mapping[str, str]]]
- The object representing FQDN details formed using prefix and additionalPrefixes.
- Mapping[str, str]
- (Updatable) 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"} - name str
- The name of the private endpoint. Valid characters are uppercase or lowercase letters, numbers, hyphens, and periods. Private Endpoint names must be unique within an Object Storage namespace. Avoid entering confidential information. example: Example: my-pe1
- nsg_
ids Sequence[str] - A list of the OCIDs of the network security groups (NSGs) to add the private endpoint's VNIC to. For more information about NSGs, see NetworkSecurityGroup.
- private_
endpoint_ strip - The private IP address that is to be assigned to this private endpoint. If it's not available, an error is returned. If you do not provide a value, an available IP address in the subnet is automatically chosen. If you do not provide a value, an available IP address in the subnet is automatically chosen.
- security_
attributes Mapping[str, str] - state str
- The lifecycle state of the private endpoint resource.
- access
Targets List<Property Map> - (Updatable) When you create a private endpoint, you can restrict access to certain Object Storage resources by specifying access targets (limit of 10). Each access target consists of the following required parameters: namespace, compartmentId and bucket.
- compartment
Id String - The ID of the compartment in which to create the private endpoint.
- namespace String
- The Object Storage namespace used for the request.
- prefix String
- The DNS prefix value is part of the URL used to access Object Storage. The DNS prefix is a case-insensitive string using alpha-numeric characters (no special characters). It must be unique within the VCN.
- subnet
Id String The ID of the subnet that the private endpoint VNIC will be created and reside in.
** 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
- additional
Prefixes List<String> - A list of additional prefixes that you can provide along with any other prefix. These resulting endpointFqdn's are added to the customer VCN's DNS record.
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - fqdns Map<Map<Map<String>>>
- The object representing FQDN details formed using prefix and additionalPrefixes.
- Map<String>
- (Updatable) 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"} - name String
- The name of the private endpoint. Valid characters are uppercase or lowercase letters, numbers, hyphens, and periods. Private Endpoint names must be unique within an Object Storage namespace. Avoid entering confidential information. example: Example: my-pe1
- nsg
Ids List<String> - A list of the OCIDs of the network security groups (NSGs) to add the private endpoint's VNIC to. For more information about NSGs, see NetworkSecurityGroup.
- private
Endpoint StringIp - The private IP address that is to be assigned to this private endpoint. If it's not available, an error is returned. If you do not provide a value, an available IP address in the subnet is automatically chosen. If you do not provide a value, an available IP address in the subnet is automatically chosen.
- security
Attributes Map<String> - state String
- The lifecycle state of the private endpoint resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the PrivateEndpoint resource produces the following output properties:
- Created
By string - The OCID of the user who created the private endpoint.
- Etag string
- The entity tag for the Private Endpoint.
- Id string
- The provider-assigned unique ID for this managed resource.
- Time
Created string - The date and time the private endpoint was created, as described in RFC 2616.
- Time
Modified string - The date and time the private endpoint was updated, as described in RFC 2616.
- Created
By string - The OCID of the user who created the private endpoint.
- Etag string
- The entity tag for the Private Endpoint.
- Id string
- The provider-assigned unique ID for this managed resource.
- Time
Created string - The date and time the private endpoint was created, as described in RFC 2616.
- Time
Modified string - The date and time the private endpoint was updated, as described in RFC 2616.
- created_
by string - The OCID of the user who created the private endpoint.
- etag string
- The entity tag for the Private Endpoint.
- id string
- The provider-assigned unique ID for this managed resource.
- time_
created string - The date and time the private endpoint was created, as described in RFC 2616.
- time_
modified string - The date and time the private endpoint was updated, as described in RFC 2616.
- created
By String - The OCID of the user who created the private endpoint.
- etag String
- The entity tag for the Private Endpoint.
- id String
- The provider-assigned unique ID for this managed resource.
- time
Created String - The date and time the private endpoint was created, as described in RFC 2616.
- time
Modified String - The date and time the private endpoint was updated, as described in RFC 2616.
- created
By string - The OCID of the user who created the private endpoint.
- etag string
- The entity tag for the Private Endpoint.
- id string
- The provider-assigned unique ID for this managed resource.
- time
Created string - The date and time the private endpoint was created, as described in RFC 2616.
- time
Modified string - The date and time the private endpoint was updated, as described in RFC 2616.
- created_
by str - The OCID of the user who created the private endpoint.
- etag str
- The entity tag for the Private Endpoint.
- id str
- The provider-assigned unique ID for this managed resource.
- time_
created str - The date and time the private endpoint was created, as described in RFC 2616.
- time_
modified str - The date and time the private endpoint was updated, as described in RFC 2616.
- created
By String - The OCID of the user who created the private endpoint.
- etag String
- The entity tag for the Private Endpoint.
- id String
- The provider-assigned unique ID for this managed resource.
- time
Created String - The date and time the private endpoint was created, as described in RFC 2616.
- time
Modified String - The date and time the private endpoint was updated, as described in RFC 2616.
Look up Existing PrivateEndpoint Resource
Get an existing PrivateEndpoint 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?: PrivateEndpointState, opts?: CustomResourceOptions): PrivateEndpoint@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
access_targets: Optional[Sequence[PrivateEndpointAccessTargetArgs]] = None,
additional_prefixes: Optional[Sequence[str]] = None,
compartment_id: Optional[str] = None,
created_by: Optional[str] = None,
defined_tags: Optional[Mapping[str, str]] = None,
etag: Optional[str] = None,
fqdns: Optional[Mapping[str, Mapping[str, Mapping[str, str]]]] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
name: Optional[str] = None,
namespace: Optional[str] = None,
nsg_ids: Optional[Sequence[str]] = None,
prefix: Optional[str] = None,
private_endpoint_ip: Optional[str] = None,
security_attributes: Optional[Mapping[str, str]] = None,
state: Optional[str] = None,
subnet_id: Optional[str] = None,
time_created: Optional[str] = None,
time_modified: Optional[str] = None) -> PrivateEndpointfunc GetPrivateEndpoint(ctx *Context, name string, id IDInput, state *PrivateEndpointState, opts ...ResourceOption) (*PrivateEndpoint, error)public static PrivateEndpoint Get(string name, Input<string> id, PrivateEndpointState? state, CustomResourceOptions? opts = null)public static PrivateEndpoint get(String name, Output<String> id, PrivateEndpointState state, CustomResourceOptions options)resources: _: type: oci:ObjectStorage:PrivateEndpoint get: id: ${id}import {
to = oci_object_storage_private_endpoint.example
id = "${id}"
}
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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.
- Access
Targets List<PrivateEndpoint Access Target> - (Updatable) When you create a private endpoint, you can restrict access to certain Object Storage resources by specifying access targets (limit of 10). Each access target consists of the following required parameters: namespace, compartmentId and bucket.
- Additional
Prefixes List<string> - A list of additional prefixes that you can provide along with any other prefix. These resulting endpointFqdn's are added to the customer VCN's DNS record.
- Compartment
Id string - The ID of the compartment in which to create the private endpoint.
- Created
By string - The OCID of the user who created the private endpoint.
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - Etag string
- The entity tag for the Private Endpoint.
- Fqdns
Dictionary<string, Immutable
Dictionary<string, Immutable Dictionary<string, string>>> - The object representing FQDN details formed using prefix and additionalPrefixes.
- Dictionary<string, string>
- (Updatable) 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"} - Name string
- The name of the private endpoint. Valid characters are uppercase or lowercase letters, numbers, hyphens, and periods. Private Endpoint names must be unique within an Object Storage namespace. Avoid entering confidential information. example: Example: my-pe1
- Namespace string
- The Object Storage namespace used for the request.
- Nsg
Ids List<string> - A list of the OCIDs of the network security groups (NSGs) to add the private endpoint's VNIC to. For more information about NSGs, see NetworkSecurityGroup.
- Prefix string
- The DNS prefix value is part of the URL used to access Object Storage. The DNS prefix is a case-insensitive string using alpha-numeric characters (no special characters). It must be unique within the VCN.
- Private
Endpoint stringIp - The private IP address that is to be assigned to this private endpoint. If it's not available, an error is returned. If you do not provide a value, an available IP address in the subnet is automatically chosen. If you do not provide a value, an available IP address in the subnet is automatically chosen.
- Security
Attributes Dictionary<string, string> - State string
- The lifecycle state of the private endpoint resource.
- Subnet
Id string The ID of the subnet that the private endpoint VNIC will be created and reside in.
** 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
- Time
Created string - The date and time the private endpoint was created, as described in RFC 2616.
- Time
Modified string - The date and time the private endpoint was updated, as described in RFC 2616.
- Access
Targets []PrivateEndpoint Access Target Args - (Updatable) When you create a private endpoint, you can restrict access to certain Object Storage resources by specifying access targets (limit of 10). Each access target consists of the following required parameters: namespace, compartmentId and bucket.
- Additional
Prefixes []string - A list of additional prefixes that you can provide along with any other prefix. These resulting endpointFqdn's are added to the customer VCN's DNS record.
- Compartment
Id string - The ID of the compartment in which to create the private endpoint.
- Created
By string - The OCID of the user who created the private endpoint.
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - Etag string
- The entity tag for the Private Endpoint.
- Fqdns map[string]map[string]map[string]string
- The object representing FQDN details formed using prefix and additionalPrefixes.
- map[string]string
- (Updatable) 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"} - Name string
- The name of the private endpoint. Valid characters are uppercase or lowercase letters, numbers, hyphens, and periods. Private Endpoint names must be unique within an Object Storage namespace. Avoid entering confidential information. example: Example: my-pe1
- Namespace string
- The Object Storage namespace used for the request.
- Nsg
Ids []string - A list of the OCIDs of the network security groups (NSGs) to add the private endpoint's VNIC to. For more information about NSGs, see NetworkSecurityGroup.
- Prefix string
- The DNS prefix value is part of the URL used to access Object Storage. The DNS prefix is a case-insensitive string using alpha-numeric characters (no special characters). It must be unique within the VCN.
- Private
Endpoint stringIp - The private IP address that is to be assigned to this private endpoint. If it's not available, an error is returned. If you do not provide a value, an available IP address in the subnet is automatically chosen. If you do not provide a value, an available IP address in the subnet is automatically chosen.
- Security
Attributes map[string]string - State string
- The lifecycle state of the private endpoint resource.
- Subnet
Id string The ID of the subnet that the private endpoint VNIC will be created and reside in.
** 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
- Time
Created string - The date and time the private endpoint was created, as described in RFC 2616.
- Time
Modified string - The date and time the private endpoint was updated, as described in RFC 2616.
- access_
targets list(object) - (Updatable) When you create a private endpoint, you can restrict access to certain Object Storage resources by specifying access targets (limit of 10). Each access target consists of the following required parameters: namespace, compartmentId and bucket.
- additional_
prefixes list(string) - A list of additional prefixes that you can provide along with any other prefix. These resulting endpointFqdn's are added to the customer VCN's DNS record.
- compartment_
id string - The ID of the compartment in which to create the private endpoint.
- created_
by string - The OCID of the user who created the private endpoint.
- map(string)
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - etag string
- The entity tag for the Private Endpoint.
- fqdns map(map(map(string)))
- The object representing FQDN details formed using prefix and additionalPrefixes.
- map(string)
- (Updatable) 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"} - name string
- The name of the private endpoint. Valid characters are uppercase or lowercase letters, numbers, hyphens, and periods. Private Endpoint names must be unique within an Object Storage namespace. Avoid entering confidential information. example: Example: my-pe1
- namespace string
- The Object Storage namespace used for the request.
- nsg_
ids list(string) - A list of the OCIDs of the network security groups (NSGs) to add the private endpoint's VNIC to. For more information about NSGs, see NetworkSecurityGroup.
- prefix string
- The DNS prefix value is part of the URL used to access Object Storage. The DNS prefix is a case-insensitive string using alpha-numeric characters (no special characters). It must be unique within the VCN.
- private_
endpoint_ stringip - The private IP address that is to be assigned to this private endpoint. If it's not available, an error is returned. If you do not provide a value, an available IP address in the subnet is automatically chosen. If you do not provide a value, an available IP address in the subnet is automatically chosen.
- security_
attributes map(string) - state string
- The lifecycle state of the private endpoint resource.
- subnet_
id string The ID of the subnet that the private endpoint VNIC will be created and reside in.
** 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
- time_
created string - The date and time the private endpoint was created, as described in RFC 2616.
- time_
modified string - The date and time the private endpoint was updated, as described in RFC 2616.
- access
Targets List<PrivateEndpoint Access Target> - (Updatable) When you create a private endpoint, you can restrict access to certain Object Storage resources by specifying access targets (limit of 10). Each access target consists of the following required parameters: namespace, compartmentId and bucket.
- additional
Prefixes List<String> - A list of additional prefixes that you can provide along with any other prefix. These resulting endpointFqdn's are added to the customer VCN's DNS record.
- compartment
Id String - The ID of the compartment in which to create the private endpoint.
- created
By String - The OCID of the user who created the private endpoint.
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - etag String
- The entity tag for the Private Endpoint.
- fqdns Map<String,Map<String,Map<String,String>>>
- The object representing FQDN details formed using prefix and additionalPrefixes.
- Map<String,String>
- (Updatable) 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"} - name String
- The name of the private endpoint. Valid characters are uppercase or lowercase letters, numbers, hyphens, and periods. Private Endpoint names must be unique within an Object Storage namespace. Avoid entering confidential information. example: Example: my-pe1
- namespace String
- The Object Storage namespace used for the request.
- nsg
Ids List<String> - A list of the OCIDs of the network security groups (NSGs) to add the private endpoint's VNIC to. For more information about NSGs, see NetworkSecurityGroup.
- prefix String
- The DNS prefix value is part of the URL used to access Object Storage. The DNS prefix is a case-insensitive string using alpha-numeric characters (no special characters). It must be unique within the VCN.
- private
Endpoint StringIp - The private IP address that is to be assigned to this private endpoint. If it's not available, an error is returned. If you do not provide a value, an available IP address in the subnet is automatically chosen. If you do not provide a value, an available IP address in the subnet is automatically chosen.
- security
Attributes Map<String,String> - state String
- The lifecycle state of the private endpoint resource.
- subnet
Id String The ID of the subnet that the private endpoint VNIC will be created and reside in.
** 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
- time
Created String - The date and time the private endpoint was created, as described in RFC 2616.
- time
Modified String - The date and time the private endpoint was updated, as described in RFC 2616.
- access
Targets PrivateEndpoint Access Target[] - (Updatable) When you create a private endpoint, you can restrict access to certain Object Storage resources by specifying access targets (limit of 10). Each access target consists of the following required parameters: namespace, compartmentId and bucket.
- additional
Prefixes string[] - A list of additional prefixes that you can provide along with any other prefix. These resulting endpointFqdn's are added to the customer VCN's DNS record.
- compartment
Id string - The ID of the compartment in which to create the private endpoint.
- created
By string - The OCID of the user who created the private endpoint.
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - etag string
- The entity tag for the Private Endpoint.
- fqdns {[key: string]: {[key: string]: {[key: string]: string}}}
- The object representing FQDN details formed using prefix and additionalPrefixes.
- {[key: string]: string}
- (Updatable) 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"} - name string
- The name of the private endpoint. Valid characters are uppercase or lowercase letters, numbers, hyphens, and periods. Private Endpoint names must be unique within an Object Storage namespace. Avoid entering confidential information. example: Example: my-pe1
- namespace string
- The Object Storage namespace used for the request.
- nsg
Ids string[] - A list of the OCIDs of the network security groups (NSGs) to add the private endpoint's VNIC to. For more information about NSGs, see NetworkSecurityGroup.
- prefix string
- The DNS prefix value is part of the URL used to access Object Storage. The DNS prefix is a case-insensitive string using alpha-numeric characters (no special characters). It must be unique within the VCN.
- private
Endpoint stringIp - The private IP address that is to be assigned to this private endpoint. If it's not available, an error is returned. If you do not provide a value, an available IP address in the subnet is automatically chosen. If you do not provide a value, an available IP address in the subnet is automatically chosen.
- security
Attributes {[key: string]: string} - state string
- The lifecycle state of the private endpoint resource.
- subnet
Id string The ID of the subnet that the private endpoint VNIC will be created and reside in.
** 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
- time
Created string - The date and time the private endpoint was created, as described in RFC 2616.
- time
Modified string - The date and time the private endpoint was updated, as described in RFC 2616.
- access_
targets Sequence[PrivateEndpoint Access Target Args] - (Updatable) When you create a private endpoint, you can restrict access to certain Object Storage resources by specifying access targets (limit of 10). Each access target consists of the following required parameters: namespace, compartmentId and bucket.
- additional_
prefixes Sequence[str] - A list of additional prefixes that you can provide along with any other prefix. These resulting endpointFqdn's are added to the customer VCN's DNS record.
- compartment_
id str - The ID of the compartment in which to create the private endpoint.
- created_
by str - The OCID of the user who created the private endpoint.
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - etag str
- The entity tag for the Private Endpoint.
- fqdns Mapping[str, Mapping[str, Mapping[str, str]]]
- The object representing FQDN details formed using prefix and additionalPrefixes.
- Mapping[str, str]
- (Updatable) 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"} - name str
- The name of the private endpoint. Valid characters are uppercase or lowercase letters, numbers, hyphens, and periods. Private Endpoint names must be unique within an Object Storage namespace. Avoid entering confidential information. example: Example: my-pe1
- namespace str
- The Object Storage namespace used for the request.
- nsg_
ids Sequence[str] - A list of the OCIDs of the network security groups (NSGs) to add the private endpoint's VNIC to. For more information about NSGs, see NetworkSecurityGroup.
- prefix str
- The DNS prefix value is part of the URL used to access Object Storage. The DNS prefix is a case-insensitive string using alpha-numeric characters (no special characters). It must be unique within the VCN.
- private_
endpoint_ strip - The private IP address that is to be assigned to this private endpoint. If it's not available, an error is returned. If you do not provide a value, an available IP address in the subnet is automatically chosen. If you do not provide a value, an available IP address in the subnet is automatically chosen.
- security_
attributes Mapping[str, str] - state str
- The lifecycle state of the private endpoint resource.
- subnet_
id str The ID of the subnet that the private endpoint VNIC will be created and reside in.
** 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
- time_
created str - The date and time the private endpoint was created, as described in RFC 2616.
- time_
modified str - The date and time the private endpoint was updated, as described in RFC 2616.
- access
Targets List<Property Map> - (Updatable) When you create a private endpoint, you can restrict access to certain Object Storage resources by specifying access targets (limit of 10). Each access target consists of the following required parameters: namespace, compartmentId and bucket.
- additional
Prefixes List<String> - A list of additional prefixes that you can provide along with any other prefix. These resulting endpointFqdn's are added to the customer VCN's DNS record.
- compartment
Id String - The ID of the compartment in which to create the private endpoint.
- created
By String - The OCID of the user who created the private endpoint.
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - etag String
- The entity tag for the Private Endpoint.
- fqdns Map<Map<Map<String>>>
- The object representing FQDN details formed using prefix and additionalPrefixes.
- Map<String>
- (Updatable) 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"} - name String
- The name of the private endpoint. Valid characters are uppercase or lowercase letters, numbers, hyphens, and periods. Private Endpoint names must be unique within an Object Storage namespace. Avoid entering confidential information. example: Example: my-pe1
- namespace String
- The Object Storage namespace used for the request.
- nsg
Ids List<String> - A list of the OCIDs of the network security groups (NSGs) to add the private endpoint's VNIC to. For more information about NSGs, see NetworkSecurityGroup.
- prefix String
- The DNS prefix value is part of the URL used to access Object Storage. The DNS prefix is a case-insensitive string using alpha-numeric characters (no special characters). It must be unique within the VCN.
- private
Endpoint StringIp - The private IP address that is to be assigned to this private endpoint. If it's not available, an error is returned. If you do not provide a value, an available IP address in the subnet is automatically chosen. If you do not provide a value, an available IP address in the subnet is automatically chosen.
- security
Attributes Map<String> - state String
- The lifecycle state of the private endpoint resource.
- subnet
Id String The ID of the subnet that the private endpoint VNIC will be created and reside in.
** 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
- time
Created String - The date and time the private endpoint was created, as described in RFC 2616.
- time
Modified String - The date and time the private endpoint was updated, as described in RFC 2616.
Supporting Types
PrivateEndpointAccessTarget, PrivateEndpointAccessTargetArgs
- Bucket string
- (Updatable) Specifies what namespace/buckets within the allowed compartments the private endpoint can access. You can configure either a single bucket or all buckets within the allowed compartments.
- Compartment
Id string - (Updatable) Specifies what namespace/compartments the private endpoint can access. You can configure either a single compartment or all compartments.
- Namespace string
- (Updatable) Specifies the target namespace that's to be allowed to egress from the private endpoint.
- Bucket string
- (Updatable) Specifies what namespace/buckets within the allowed compartments the private endpoint can access. You can configure either a single bucket or all buckets within the allowed compartments.
- Compartment
Id string - (Updatable) Specifies what namespace/compartments the private endpoint can access. You can configure either a single compartment or all compartments.
- Namespace string
- (Updatable) Specifies the target namespace that's to be allowed to egress from the private endpoint.
- bucket string
- (Updatable) Specifies what namespace/buckets within the allowed compartments the private endpoint can access. You can configure either a single bucket or all buckets within the allowed compartments.
- compartment_
id string - (Updatable) Specifies what namespace/compartments the private endpoint can access. You can configure either a single compartment or all compartments.
- namespace string
- (Updatable) Specifies the target namespace that's to be allowed to egress from the private endpoint.
- bucket String
- (Updatable) Specifies what namespace/buckets within the allowed compartments the private endpoint can access. You can configure either a single bucket or all buckets within the allowed compartments.
- compartment
Id String - (Updatable) Specifies what namespace/compartments the private endpoint can access. You can configure either a single compartment or all compartments.
- namespace String
- (Updatable) Specifies the target namespace that's to be allowed to egress from the private endpoint.
- bucket string
- (Updatable) Specifies what namespace/buckets within the allowed compartments the private endpoint can access. You can configure either a single bucket or all buckets within the allowed compartments.
- compartment
Id string - (Updatable) Specifies what namespace/compartments the private endpoint can access. You can configure either a single compartment or all compartments.
- namespace string
- (Updatable) Specifies the target namespace that's to be allowed to egress from the private endpoint.
- bucket str
- (Updatable) Specifies what namespace/buckets within the allowed compartments the private endpoint can access. You can configure either a single bucket or all buckets within the allowed compartments.
- compartment_
id str - (Updatable) Specifies what namespace/compartments the private endpoint can access. You can configure either a single compartment or all compartments.
- namespace str
- (Updatable) Specifies the target namespace that's to be allowed to egress from the private endpoint.
- bucket String
- (Updatable) Specifies what namespace/buckets within the allowed compartments the private endpoint can access. You can configure either a single bucket or all buckets within the allowed compartments.
- compartment
Id String - (Updatable) Specifies what namespace/compartments the private endpoint can access. You can configure either a single compartment or all compartments.
- namespace String
- (Updatable) Specifies the target namespace that's to be allowed to egress from the private endpoint.
Import
Private endpoints can be imported using the namespaceName and the name of the private endpoint.
$ pulumi import oci:ObjectStorage/privateEndpoint:PrivateEndpoint test_pe "n/{namespaceName}/pe/{peName}"
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
ociTerraform Provider.
Viewing docs for Oracle Cloud Infrastructure v4.20.0
published on Wednesday, Jul 15, 2026 by Pulumi
published on Wednesday, Jul 15, 2026 by Pulumi