Oracle Cloud Infrastructure v2.30.0, Apr 14 25

Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi

oci.ObjectStorage.PrivateEndpoint

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi

Create PrivateEndpoint Resource

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

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[_objectstorage.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,
                    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.

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.

TypeScript
Python
Go
C#
Java
YAML

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", 
        {
            { "string", 
            {
                { "string", "string" },
            } },
        } },
    },
    PrivateEndpointIp = "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"),
	State:             pulumi.String("string"),
	AdditionalPrefixes: pulumi.StringArray{
		pulumi.String("string"),
	},
})

var exampleprivateEndpointResourceResourceFromObjectStorageprivateEndpoint = new PrivateEndpoint("exampleprivateEndpointResourceResourceFromObjectStorageprivateEndpoint", 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")
    .state("string")
    .additionalPrefixes("string")
    .build());

exampleprivate_endpoint_resource_resource_from_object_storageprivate_endpoint = oci.object_storage.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",
    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",
    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
    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:

AccessTargets List<PrivateEndpointAccessTarget>
CompartmentId string
Namespace string
Prefix string
SubnetId string
AdditionalPrefixes List<string>
DefinedTags Dictionary<string, string>
Fqdns Dictionary<string, ImmutableDictionary<string, ImmutableDictionary<string, string>>>
FreeformTags Dictionary<string, string>
Name string
NsgIds List<string>
PrivateEndpointIp string
State string

AccessTargets []PrivateEndpointAccessTargetArgs
CompartmentId string
Namespace string
Prefix string
SubnetId string
AdditionalPrefixes []string
DefinedTags map[string]string
Fqdns map[string]map[string]map[string]string
FreeformTags map[string]string
Name string
NsgIds []string
PrivateEndpointIp string
State string

accessTargets List<PrivateEndpointAccessTarget>
compartmentId String
namespace String
prefix String
subnetId String
additionalPrefixes List<String>
definedTags Map<String,String>
fqdns Map<String,Map<String,Map<String,String>>>
freeformTags Map<String,String>
name String
nsgIds List<String>
privateEndpointIp String
state String

accessTargets PrivateEndpointAccessTarget[]
compartmentId string
namespace string
prefix string
subnetId string
additionalPrefixes string[]
definedTags {[key: string]: string}
fqdns {[key: string]: {[key: string]: {[key: string]: string}}}
freeformTags {[key: string]: string}
name string
nsgIds string[]
privateEndpointIp string
state string

access_targets Sequence[objectstorage.PrivateEndpointAccessTargetArgs]
compartment_id str
namespace str
prefix str
subnet_id str
additional_prefixes Sequence[str]
defined_tags Mapping[str, str]
fqdns Mapping[str, Mapping[str, Mapping[str, str]]]
freeform_tags Mapping[str, str]
name str
nsg_ids Sequence[str]
private_endpoint_ip str
state str

accessTargets List<Property Map>
compartmentId String
namespace String
prefix String
subnetId String
additionalPrefixes List<String>
definedTags Map<String>
fqdns Map<Map<Map<String>>>
freeformTags Map<String>
name String
nsgIds List<String>
privateEndpointIp String
state String

Outputs

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

CreatedBy string
Etag string
Id string: The provider-assigned unique ID for this managed resource.
TimeCreated string
TimeModified string

CreatedBy string
Etag string
Id string: The provider-assigned unique ID for this managed resource.
TimeCreated string
TimeModified string

createdBy String
etag String
id String: The provider-assigned unique ID for this managed resource.
timeCreated String
timeModified String

createdBy string
etag string
id string: The provider-assigned unique ID for this managed resource.
timeCreated string
timeModified string

created_by str
etag str
id str: The provider-assigned unique ID for this managed resource.
time_created str
time_modified str

createdBy String
etag String
id String: The provider-assigned unique ID for this managed resource.
timeCreated String
timeModified String

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.

TypeScript
Python
Go
C#
Java
YAML

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[_objectstorage.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,
        state: Optional[str] = None,
        subnet_id: Optional[str] = None,
        time_created: Optional[str] = None,
        time_modified: Optional[str] = None) -> PrivateEndpoint

func 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}

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.

The following state arguments are supported:

AccessTargets List<PrivateEndpointAccessTarget>
AdditionalPrefixes List<string>
CompartmentId string
CreatedBy string
DefinedTags Dictionary<string, string>
Etag string
Fqdns Dictionary<string, ImmutableDictionary<string, ImmutableDictionary<string, string>>>
FreeformTags Dictionary<string, string>
Name string
Namespace string
NsgIds List<string>
Prefix string
PrivateEndpointIp string
State string
SubnetId string
TimeCreated string
TimeModified string

AccessTargets []PrivateEndpointAccessTargetArgs
AdditionalPrefixes []string
CompartmentId string
CreatedBy string
DefinedTags map[string]string
Etag string
Fqdns map[string]map[string]map[string]string
FreeformTags map[string]string
Name string
Namespace string
NsgIds []string
Prefix string
PrivateEndpointIp string
State string
SubnetId string
TimeCreated string
TimeModified string

accessTargets List<PrivateEndpointAccessTarget>
additionalPrefixes List<String>
compartmentId String
createdBy String
definedTags Map<String,String>
etag String
fqdns Map<String,Map<String,Map<String,String>>>
freeformTags Map<String,String>
name String
namespace String
nsgIds List<String>
prefix String
privateEndpointIp String
state String
subnetId String
timeCreated String
timeModified String

accessTargets PrivateEndpointAccessTarget[]
additionalPrefixes string[]
compartmentId string
createdBy string
definedTags {[key: string]: string}
etag string
fqdns {[key: string]: {[key: string]: {[key: string]: string}}}
freeformTags {[key: string]: string}
name string
namespace string
nsgIds string[]
prefix string
privateEndpointIp string
state string
subnetId string
timeCreated string
timeModified string

access_targets Sequence[objectstorage.PrivateEndpointAccessTargetArgs]
additional_prefixes Sequence[str]
compartment_id str
created_by str
defined_tags Mapping[str, str]
etag str
fqdns Mapping[str, Mapping[str, Mapping[str, str]]]
freeform_tags Mapping[str, str]
name str
namespace str
nsg_ids Sequence[str]
prefix str
private_endpoint_ip str
state str
subnet_id str
time_created str
time_modified str

accessTargets List<Property Map>
additionalPrefixes List<String>
compartmentId String
createdBy String
definedTags Map<String>
etag String
fqdns Map<Map<Map<String>>>
freeformTags Map<String>
name String
namespace String
nsgIds List<String>
prefix String
privateEndpointIp String
state String
subnetId String
timeCreated String
timeModified String

Supporting Types

PrivateEndpointAccessTarget
, PrivateEndpointAccessTargetArgs

Bucket string
CompartmentId string
Namespace string

Bucket string
CompartmentId string
Namespace string

bucket String
compartmentId String
namespace String

bucket string
compartmentId string
namespace string

bucket str
compartment_id str
namespace str

bucket String
compartmentId String
namespace String

Package Details

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

Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi

pulumi/pulumi-oci

oci.ObjectStorage.PrivateEndpoint

On this page

On this page

Create PrivateEndpoint Resource

Constructor syntax

Parameters

Constructor example

PrivateEndpoint Resource Properties

Inputs

Outputs

Look up Existing PrivateEndpoint Resource

Supporting Types

PrivateEndpointAccessTarget
, PrivateEndpointAccessTargetArgs

Package Details

On this page

On this page

oci.ObjectStorage.PrivateEndpoint

On this page

On this page

Create PrivateEndpoint Resource

Constructor syntax

Parameters

Constructor example

PrivateEndpoint Resource Properties

Inputs

Outputs

Look up Existing PrivateEndpoint Resource

Supporting Types

PrivateEndpointAccessTarget, PrivateEndpointAccessTargetArgs

Package Details

On this page

On this page

PrivateEndpointAccessTarget
, PrivateEndpointAccessTargetArgs