Oracle Cloud Infrastructure
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:
- Private
Endpoint stringId The unique ID for a private endpoint.
- Private
Endpoint stringId The unique ID for a private endpoint.
- private
Endpoint StringId The unique ID for a private endpoint.
- private
Endpoint stringId The unique ID for a private endpoint.
- private_
endpoint_ strid The unique ID for a private endpoint.
- private
Endpoint StringId The unique ID for a private endpoint.
getPrivateEndpoint Result
The following output properties are available:
- Compartment
Id string The OCID of a compartment.
- 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.
- Display
Name string A user-friendly name. It does not have to be unique. Avoid entering confidential information.
- Dns
Zones List<string> An array of DNS zone names. Example:
[ "app.examplecorp.com", "app.examplecorp2.com" ]
- 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.
- Lifecycle
Details string The detailed messages about the lifecycle state.
- Max
Host intCount 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 List<string> An array of network security group OCIDs.
- Owner
Principal stringId The OCID of the user who created the resource.
- Owner
User stringName 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 stringId - State string
The current state of this private endpoint.
- Subnet
Id string The OCID of a subnet.
- Time
Created string The date and time a application was created, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z
- Time
Updated string The date and time a application was updated, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z
- Compartment
Id string The OCID of a compartment.
- 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.
- Display
Name string A user-friendly name. It does not have to be unique. Avoid entering confidential information.
- Dns
Zones []string An array of DNS zone names. Example:
[ "app.examplecorp.com", "app.examplecorp2.com" ]
- 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.
- Lifecycle
Details string The detailed messages about the lifecycle state.
- Max
Host intCount 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 []string An array of network security group OCIDs.
- Owner
Principal stringId The OCID of the user who created the resource.
- Owner
User stringName 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 stringId - State string
The current state of this private endpoint.
- Subnet
Id string The OCID of a subnet.
- Time
Created string The date and time a application was created, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z
- Time
Updated string The date and time a application was updated, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z
- compartment
Id String The OCID of a compartment.
- 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.
- display
Name String A user-friendly name. It does not have to be unique. Avoid entering confidential information.
- dns
Zones List<String> An array of DNS zone names. Example:
[ "app.examplecorp.com", "app.examplecorp2.com" ]
- 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.
- lifecycle
Details String The detailed messages about the lifecycle state.
- max
Host IntegerCount 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 List<String> An array of network security group OCIDs.
- owner
Principal StringId The OCID of the user who created the resource.
- owner
User StringName 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 StringId - state String
The current state of this private endpoint.
- subnet
Id String The OCID of a subnet.
- time
Created String The date and time a application was created, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z
- time
Updated String The date and time a application was updated, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z
- compartment
Id string The OCID of a compartment.
- {[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.
- display
Name string A user-friendly name. It does not have to be unique. Avoid entering confidential information.
- dns
Zones string[] An array of DNS zone names. Example:
[ "app.examplecorp.com", "app.examplecorp2.com" ]
- {[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.
- lifecycle
Details string The detailed messages about the lifecycle state.
- max
Host numberCount 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 string[] An array of network security group OCIDs.
- owner
Principal stringId The OCID of the user who created the resource.
- owner
User stringName 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 stringId - state string
The current state of this private endpoint.
- subnet
Id string The OCID of a subnet.
- time
Created string The date and time a application was created, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z
- time
Updated 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.
- 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" ]
- 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_ intcount 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_ strid The OCID of the user who created the resource.
- owner_
user_ strname 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_ strid - 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
- compartment
Id String The OCID of a compartment.
- 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.
- display
Name String A user-friendly name. It does not have to be unique. Avoid entering confidential information.
- dns
Zones List<String> An array of DNS zone names. Example:
[ "app.examplecorp.com", "app.examplecorp2.com" ]
- 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.
- lifecycle
Details String The detailed messages about the lifecycle state.
- max
Host NumberCount 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 List<String> An array of network security group OCIDs.
- owner
Principal StringId The OCID of the user who created the resource.
- owner
User StringName 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 StringId - state String
The current state of this private endpoint.
- subnet
Id String The OCID of a subnet.
- time
Created String The date and time a application was created, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z
- time
Updated 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.