Oracle Cloud Infrastructure

Pulumi Official

Package maintained by Pulumi

v0.1.1 published on Tuesday, May 3, 2022 by Pulumi

getPrivateEndpoint

This data source provides details about a specific Private Endpoint resource in Oracle Cloud Infrastructure Data Flow service.

Retrieves an private endpoint using a privateEndpointId.

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testPrivateEndpoint = Output.Create(Oci.DataFlow.GetPrivateEndpoint.InvokeAsync(new Oci.DataFlow.GetPrivateEndpointArgs
        {
            PrivateEndpointId = oci_dataflow_private_endpoint.Test_private_endpoint.Id,
        }));
    }

}

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/go/oci/DataFlow"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := DataFlow.GetPrivateEndpoint(ctx, &dataflow.GetPrivateEndpointArgs{
			PrivateEndpointId: oci_dataflow_private_endpoint.Test_private_endpoint.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_private_endpoint = oci.DataFlow.get_private_endpoint(private_endpoint_id=oci_dataflow_private_endpoint["test_private_endpoint"]["id"])

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

const testPrivateEndpoint = oci.DataFlow.getPrivateEndpoint({
    privateEndpointId: oci_dataflow_private_endpoint.test_private_endpoint.id,
});

Coming soon!

Using getPrivateEndpoint

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getPrivateEndpoint(args: GetPrivateEndpointArgs, opts?: InvokeOptions): Promise<GetPrivateEndpointResult>
function getPrivateEndpointOutput(args: GetPrivateEndpointOutputArgs, opts?: InvokeOptions): Output<GetPrivateEndpointResult>

def get_private_endpoint(private_endpoint_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetPrivateEndpointResult
def get_private_endpoint_output(private_endpoint_id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetPrivateEndpointResult]

func GetPrivateEndpoint(ctx *Context, args *GetPrivateEndpointArgs, opts ...InvokeOption) (*GetPrivateEndpointResult, error)
func GetPrivateEndpointOutput(ctx *Context, args *GetPrivateEndpointOutputArgs, opts ...InvokeOption) GetPrivateEndpointResultOutput

> Note: This function is named GetPrivateEndpoint in the Go SDK.

public static class GetPrivateEndpoint 
{
    public static Task<GetPrivateEndpointResult> InvokeAsync(GetPrivateEndpointArgs args, InvokeOptions? opts = null)
    public static Output<GetPrivateEndpointResult> Invoke(GetPrivateEndpointInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPrivateEndpointResult> getPrivateEndpoint(GetPrivateEndpointArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

Fn::Invoke:
  Function: oci:DataFlow/getPrivateEndpoint:getPrivateEndpoint
  Arguments:
    # Arguments dictionary

The following arguments are supported:

PrivateEndpointId string: The unique ID for a private endpoint.

PrivateEndpointId string: The unique ID for a private endpoint.

privateEndpointId String: The unique ID for a private endpoint.

privateEndpointId string: The unique ID for a private endpoint.

private_endpoint_id str: The unique ID for a private endpoint.

privateEndpointId String: The unique ID for a private endpoint.

getPrivateEndpoint Result

The following output properties are available:

CompartmentId string: The OCID of a compartment.
DefinedTags Dictionary<string, object>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
Description string: A user-friendly description. Avoid entering confidential information.
DisplayName string: A user-friendly name. It does not have to be unique. Avoid entering confidential information.
DnsZones List<string>: An array of DNS zone names. Example: [ "app.examplecorp.com", "app.examplecorp2.com" ]
FreeformTags Dictionary<string, object>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
Id string: The OCID of a private endpoint.
LifecycleDetails string: The detailed messages about the lifecycle state.
MaxHostCount int: The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512.
NsgIds List<string>: An array of network security group OCIDs.
OwnerPrincipalId string: The OCID of the user who created the resource.
OwnerUserName string: The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.
PrivateEndpointId string
State string: The current state of this private endpoint.
SubnetId string: The OCID of a subnet.
TimeCreated string: The date and time a application was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
TimeUpdated string: The date and time a application was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

CompartmentId string: The OCID of a compartment.
DefinedTags map[string]interface{}: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
Description string: A user-friendly description. Avoid entering confidential information.
DisplayName string: A user-friendly name. It does not have to be unique. Avoid entering confidential information.
DnsZones []string: An array of DNS zone names. Example: [ "app.examplecorp.com", "app.examplecorp2.com" ]
FreeformTags map[string]interface{}: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
Id string: The OCID of a private endpoint.
LifecycleDetails string: The detailed messages about the lifecycle state.
MaxHostCount int: The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512.
NsgIds []string: An array of network security group OCIDs.
OwnerPrincipalId string: The OCID of the user who created the resource.
OwnerUserName string: The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.
PrivateEndpointId string
State string: The current state of this private endpoint.
SubnetId string: The OCID of a subnet.
TimeCreated string: The date and time a application was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
TimeUpdated string: The date and time a application was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

compartmentId String: The OCID of a compartment.
definedTags Map<String,Object>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description String: A user-friendly description. Avoid entering confidential information.
displayName String: A user-friendly name. It does not have to be unique. Avoid entering confidential information.
dnsZones List<String>: An array of DNS zone names. Example: [ "app.examplecorp.com", "app.examplecorp2.com" ]
freeformTags Map<String,Object>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id String: The OCID of a private endpoint.
lifecycleDetails String: The detailed messages about the lifecycle state.
maxHostCount Integer: The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512.
nsgIds List<String>: An array of network security group OCIDs.
ownerPrincipalId String: The OCID of the user who created the resource.
ownerUserName String: The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.
privateEndpointId String
state String: The current state of this private endpoint.
subnetId String: The OCID of a subnet.
timeCreated String: The date and time a application was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
timeUpdated String: The date and time a application was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

compartmentId string: The OCID of a compartment.
definedTags {[key: string]: any}: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description string: A user-friendly description. Avoid entering confidential information.
displayName string: A user-friendly name. It does not have to be unique. Avoid entering confidential information.
dnsZones string[]: An array of DNS zone names. Example: [ "app.examplecorp.com", "app.examplecorp2.com" ]
freeformTags {[key: string]: any}: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id string: The OCID of a private endpoint.
lifecycleDetails string: The detailed messages about the lifecycle state.
maxHostCount number: The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512.
nsgIds string[]: An array of network security group OCIDs.
ownerPrincipalId string: The OCID of the user who created the resource.
ownerUserName string: The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.
privateEndpointId string
state string: The current state of this private endpoint.
subnetId string: The OCID of a subnet.
timeCreated string: The date and time a application was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
timeUpdated string: The date and time a application was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

compartment_id str: The OCID of a compartment.
defined_tags Mapping[str, Any]: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description str: A user-friendly description. Avoid entering confidential information.
display_name str: A user-friendly name. It does not have to be unique. Avoid entering confidential information.
dns_zones Sequence[str]: An array of DNS zone names. Example: [ "app.examplecorp.com", "app.examplecorp2.com" ]
freeform_tags Mapping[str, Any]: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id str: The OCID of a private endpoint.
lifecycle_details str: The detailed messages about the lifecycle state.
max_host_count int: The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512.
nsg_ids Sequence[str]: An array of network security group OCIDs.
owner_principal_id str: The OCID of the user who created the resource.
owner_user_name str: The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.
private_endpoint_id str
state str: The current state of this private endpoint.
subnet_id str: The OCID of a subnet.
time_created str: The date and time a application was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
time_updated str: The date and time a application was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

compartmentId String: The OCID of a compartment.
definedTags Map<Any>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description String: A user-friendly description. Avoid entering confidential information.
displayName String: A user-friendly name. It does not have to be unique. Avoid entering confidential information.
dnsZones List<String>: An array of DNS zone names. Example: [ "app.examplecorp.com", "app.examplecorp2.com" ]
freeformTags Map<Any>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id String: The OCID of a private endpoint.
lifecycleDetails String: The detailed messages about the lifecycle state.
maxHostCount Number: The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512.
nsgIds List<String>: An array of network security group OCIDs.
ownerPrincipalId String: The OCID of the user who created the resource.
ownerUserName String: The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.
privateEndpointId String
state String: The current state of this private endpoint.
subnetId String: The OCID of a subnet.
timeCreated String: The date and time a application was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
timeUpdated String: The date and time a application was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

Package Details

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