Oracle Cloud Infrastructure

v0.5.0 published on Monday, Sep 12, 2022 by Pulumi

getDataSafePrivateEndpoints

This data source provides the list of Data Safe Private Endpoints in Oracle Cloud Infrastructure Data Safe service.

Gets a list of Data Safe private endpoints.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testDataSafePrivateEndpoints = Oci.DataSafe.GetDataSafePrivateEndpoints.Invoke(new()
    {
        CompartmentId = @var.Compartment_id,
        AccessLevel = @var.Data_safe_private_endpoint_access_level,
        CompartmentIdInSubtree = @var.Data_safe_private_endpoint_compartment_id_in_subtree,
        DisplayName = @var.Data_safe_private_endpoint_display_name,
        State = @var.Data_safe_private_endpoint_state,
        VcnId = oci_core_vcn.Test_vcn.Id,
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := DataSafe.GetDataSafePrivateEndpoints(ctx, &datasafe.GetDataSafePrivateEndpointsArgs{
			CompartmentId:          _var.Compartment_id,
			AccessLevel:            pulumi.StringRef(_var.Data_safe_private_endpoint_access_level),
			CompartmentIdInSubtree: pulumi.BoolRef(_var.Data_safe_private_endpoint_compartment_id_in_subtree),
			DisplayName:            pulumi.StringRef(_var.Data_safe_private_endpoint_display_name),
			State:                  pulumi.StringRef(_var.Data_safe_private_endpoint_state),
			VcnId:                  pulumi.StringRef(oci_core_vcn.Test_vcn.Id),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DataSafe.DataSafeFunctions;
import com.pulumi.oci.DataSafe.inputs.GetDataSafePrivateEndpointsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testDataSafePrivateEndpoints = DataSafeFunctions.getDataSafePrivateEndpoints(GetDataSafePrivateEndpointsArgs.builder()
            .compartmentId(var_.compartment_id())
            .accessLevel(var_.data_safe_private_endpoint_access_level())
            .compartmentIdInSubtree(var_.data_safe_private_endpoint_compartment_id_in_subtree())
            .displayName(var_.data_safe_private_endpoint_display_name())
            .state(var_.data_safe_private_endpoint_state())
            .vcnId(oci_core_vcn.test_vcn().id())
            .build());

    }
}
import pulumi
import pulumi_oci as oci

test_data_safe_private_endpoints = oci.DataSafe.get_data_safe_private_endpoints(compartment_id=var["compartment_id"],
    access_level=var["data_safe_private_endpoint_access_level"],
    compartment_id_in_subtree=var["data_safe_private_endpoint_compartment_id_in_subtree"],
    display_name=var["data_safe_private_endpoint_display_name"],
    state=var["data_safe_private_endpoint_state"],
    vcn_id=oci_core_vcn["test_vcn"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testDataSafePrivateEndpoints = oci.DataSafe.getDataSafePrivateEndpoints({
    compartmentId: _var.compartment_id,
    accessLevel: _var.data_safe_private_endpoint_access_level,
    compartmentIdInSubtree: _var.data_safe_private_endpoint_compartment_id_in_subtree,
    displayName: _var.data_safe_private_endpoint_display_name,
    state: _var.data_safe_private_endpoint_state,
    vcnId: oci_core_vcn.test_vcn.id,
});
variables:
  testDataSafePrivateEndpoints:
    Fn::Invoke:
      Function: oci:DataSafe:getDataSafePrivateEndpoints
      Arguments:
        compartmentId: ${var.compartment_id}
        accessLevel: ${var.data_safe_private_endpoint_access_level}
        compartmentIdInSubtree: ${var.data_safe_private_endpoint_compartment_id_in_subtree}
        displayName: ${var.data_safe_private_endpoint_display_name}
        state: ${var.data_safe_private_endpoint_state}
        vcnId: ${oci_core_vcn.test_vcn.id}

Using getDataSafePrivateEndpoints

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 getDataSafePrivateEndpoints(args: GetDataSafePrivateEndpointsArgs, opts?: InvokeOptions): Promise<GetDataSafePrivateEndpointsResult>
function getDataSafePrivateEndpointsOutput(args: GetDataSafePrivateEndpointsOutputArgs, opts?: InvokeOptions): Output<GetDataSafePrivateEndpointsResult>
def get_data_safe_private_endpoints(access_level: Optional[str] = None,
                                    compartment_id: Optional[str] = None,
                                    compartment_id_in_subtree: Optional[bool] = None,
                                    display_name: Optional[str] = None,
                                    filters: Optional[Sequence[_datasafe.GetDataSafePrivateEndpointsFilter]] = None,
                                    state: Optional[str] = None,
                                    vcn_id: Optional[str] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetDataSafePrivateEndpointsResult
def get_data_safe_private_endpoints_output(access_level: Optional[pulumi.Input[str]] = None,
                                    compartment_id: Optional[pulumi.Input[str]] = None,
                                    compartment_id_in_subtree: Optional[pulumi.Input[bool]] = None,
                                    display_name: Optional[pulumi.Input[str]] = None,
                                    filters: Optional[pulumi.Input[Sequence[pulumi.Input[_datasafe.GetDataSafePrivateEndpointsFilterArgs]]]] = None,
                                    state: Optional[pulumi.Input[str]] = None,
                                    vcn_id: Optional[pulumi.Input[str]] = None,
                                    opts: Optional[InvokeOptions] = None) -> Output[GetDataSafePrivateEndpointsResult]
func GetDataSafePrivateEndpoints(ctx *Context, args *GetDataSafePrivateEndpointsArgs, opts ...InvokeOption) (*GetDataSafePrivateEndpointsResult, error)
func GetDataSafePrivateEndpointsOutput(ctx *Context, args *GetDataSafePrivateEndpointsOutputArgs, opts ...InvokeOption) GetDataSafePrivateEndpointsResultOutput

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

public static class GetDataSafePrivateEndpoints 
{
    public static Task<GetDataSafePrivateEndpointsResult> InvokeAsync(GetDataSafePrivateEndpointsArgs args, InvokeOptions? opts = null)
    public static Output<GetDataSafePrivateEndpointsResult> Invoke(GetDataSafePrivateEndpointsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetDataSafePrivateEndpointsResult> getDataSafePrivateEndpoints(GetDataSafePrivateEndpointsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: oci:DataSafe/getDataSafePrivateEndpoints:getDataSafePrivateEndpoints
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string

A filter to return only resources that match the specified compartment OCID.

AccessLevel string

Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.

CompartmentIdInSubtree bool

Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.

DisplayName string

A filter to return only resources that match the specified display name.

Filters List<GetDataSafePrivateEndpointsFilter>
State string

A filter to return only resources that match the specified lifecycle state.

VcnId string

A filter to return only resources that match the specified VCN OCID.

CompartmentId string

A filter to return only resources that match the specified compartment OCID.

AccessLevel string

Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.

CompartmentIdInSubtree bool

Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.

DisplayName string

A filter to return only resources that match the specified display name.

Filters []GetDataSafePrivateEndpointsFilter
State string

A filter to return only resources that match the specified lifecycle state.

VcnId string

A filter to return only resources that match the specified VCN OCID.

compartmentId String

A filter to return only resources that match the specified compartment OCID.

accessLevel String

Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.

compartmentIdInSubtree Boolean

Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.

displayName String

A filter to return only resources that match the specified display name.

filters List<GetPrivateEndpointsFilter>
state String

A filter to return only resources that match the specified lifecycle state.

vcnId String

A filter to return only resources that match the specified VCN OCID.

compartmentId string

A filter to return only resources that match the specified compartment OCID.

accessLevel string

Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.

compartmentIdInSubtree boolean

Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.

displayName string

A filter to return only resources that match the specified display name.

filters GetDataSafePrivateEndpointsFilter[]
state string

A filter to return only resources that match the specified lifecycle state.

vcnId string

A filter to return only resources that match the specified VCN OCID.

compartment_id str

A filter to return only resources that match the specified compartment OCID.

access_level str

Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.

compartment_id_in_subtree bool

Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.

display_name str

A filter to return only resources that match the specified display name.

filters GetDataSafePrivateEndpointsFilter]
state str

A filter to return only resources that match the specified lifecycle state.

vcn_id str

A filter to return only resources that match the specified VCN OCID.

compartmentId String

A filter to return only resources that match the specified compartment OCID.

accessLevel String

Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.

compartmentIdInSubtree Boolean

Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.

displayName String

A filter to return only resources that match the specified display name.

filters List<Property Map>
state String

A filter to return only resources that match the specified lifecycle state.

vcnId String

A filter to return only resources that match the specified VCN OCID.

getDataSafePrivateEndpoints Result

The following output properties are available:

CompartmentId string

The OCID of the compartment.

DataSafePrivateEndpoints List<GetDataSafePrivateEndpointsDataSafePrivateEndpoint>

The list of data_safe_private_endpoints.

Id string

The provider-assigned unique ID for this managed resource.

AccessLevel string
CompartmentIdInSubtree bool
DisplayName string

The display name of the private endpoint.

Filters List<GetDataSafePrivateEndpointsFilter>
State string

The current state of the private endpoint.

VcnId string

The OCID of the VCN.

CompartmentId string

The OCID of the compartment.

DataSafePrivateEndpoints []GetDataSafePrivateEndpointsDataSafePrivateEndpoint

The list of data_safe_private_endpoints.

Id string

The provider-assigned unique ID for this managed resource.

AccessLevel string
CompartmentIdInSubtree bool
DisplayName string

The display name of the private endpoint.

Filters []GetDataSafePrivateEndpointsFilter
State string

The current state of the private endpoint.

VcnId string

The OCID of the VCN.

compartmentId String

The OCID of the compartment.

dataSafePrivateEndpoints List<GetPrivateEndpointsPrivateEndpoint>

The list of data_safe_private_endpoints.

id String

The provider-assigned unique ID for this managed resource.

accessLevel String
compartmentIdInSubtree Boolean
displayName String

The display name of the private endpoint.

filters List<GetPrivateEndpointsFilter>
state String

The current state of the private endpoint.

vcnId String

The OCID of the VCN.

compartmentId string

The OCID of the compartment.

dataSafePrivateEndpoints GetDataSafePrivateEndpointsDataSafePrivateEndpoint[]

The list of data_safe_private_endpoints.

id string

The provider-assigned unique ID for this managed resource.

accessLevel string
compartmentIdInSubtree boolean
displayName string

The display name of the private endpoint.

filters GetDataSafePrivateEndpointsFilter[]
state string

The current state of the private endpoint.

vcnId string

The OCID of the VCN.

compartment_id str

The OCID of the compartment.

data_safe_private_endpoints GetDataSafePrivateEndpointsDataSafePrivateEndpoint]

The list of data_safe_private_endpoints.

id str

The provider-assigned unique ID for this managed resource.

access_level str
compartment_id_in_subtree bool
display_name str

The display name of the private endpoint.

filters GetDataSafePrivateEndpointsFilter]
state str

The current state of the private endpoint.

vcn_id str

The OCID of the VCN.

compartmentId String

The OCID of the compartment.

dataSafePrivateEndpoints List<Property Map>

The list of data_safe_private_endpoints.

id String

The provider-assigned unique ID for this managed resource.

accessLevel String
compartmentIdInSubtree Boolean
displayName String

The display name of the private endpoint.

filters List<Property Map>
state String

The current state of the private endpoint.

vcnId String

The OCID of the VCN.

Supporting Types

GetDataSafePrivateEndpointsDataSafePrivateEndpoint

CompartmentId string

A filter to return only resources that match the specified compartment OCID.

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

The description of the private endpoint.

DisplayName string

A filter to return only resources that match the specified display name.

EndpointFqdn string

The three-label fully qualified domain name (FQDN) of the private endpoint. The customer VCN's DNS records are updated with this FQDN.

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 the Data Safe private endpoint.

NsgIds List<string>

The OCIDs of the network security groups that the private endpoint belongs to.

PrivateEndpointId string

The OCID of the underlying private endpoint.

PrivateEndpointIp string

The private IP address of the private endpoint.

State string

A filter to return only resources that match the specified lifecycle state.

SubnetId string

The OCID of the subnet.

SystemTags Dictionary<string, object>

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

TimeCreated string

The date and time the private endpoint was created, in the format defined by RFC3339.

VcnId string

A filter to return only resources that match the specified VCN OCID.

CompartmentId string

A filter to return only resources that match the specified compartment OCID.

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

The description of the private endpoint.

DisplayName string

A filter to return only resources that match the specified display name.

EndpointFqdn string

The three-label fully qualified domain name (FQDN) of the private endpoint. The customer VCN's DNS records are updated with this FQDN.

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 the Data Safe private endpoint.

NsgIds []string

The OCIDs of the network security groups that the private endpoint belongs to.

PrivateEndpointId string

The OCID of the underlying private endpoint.

PrivateEndpointIp string

The private IP address of the private endpoint.

State string

A filter to return only resources that match the specified lifecycle state.

SubnetId string

The OCID of the subnet.

SystemTags map[string]interface{}

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

TimeCreated string

The date and time the private endpoint was created, in the format defined by RFC3339.

VcnId string

A filter to return only resources that match the specified VCN OCID.

compartmentId String

A filter to return only resources that match the specified compartment OCID.

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

The description of the private endpoint.

displayName String

A filter to return only resources that match the specified display name.

endpointFqdn String

The three-label fully qualified domain name (FQDN) of the private endpoint. The customer VCN's DNS records are updated with this FQDN.

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 the Data Safe private endpoint.

nsgIds List<String>

The OCIDs of the network security groups that the private endpoint belongs to.

privateEndpointId String

The OCID of the underlying private endpoint.

privateEndpointIp String

The private IP address of the private endpoint.

state String

A filter to return only resources that match the specified lifecycle state.

subnetId String

The OCID of the subnet.

systemTags Map<String,Object>

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

timeCreated String

The date and time the private endpoint was created, in the format defined by RFC3339.

vcnId String

A filter to return only resources that match the specified VCN OCID.

compartmentId string

A filter to return only resources that match the specified compartment OCID.

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

The description of the private endpoint.

displayName string

A filter to return only resources that match the specified display name.

endpointFqdn string

The three-label fully qualified domain name (FQDN) of the private endpoint. The customer VCN's DNS records are updated with this FQDN.

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 the Data Safe private endpoint.

nsgIds string[]

The OCIDs of the network security groups that the private endpoint belongs to.

privateEndpointId string

The OCID of the underlying private endpoint.

privateEndpointIp string

The private IP address of the private endpoint.

state string

A filter to return only resources that match the specified lifecycle state.

subnetId string

The OCID of the subnet.

systemTags {[key: string]: any}

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

timeCreated string

The date and time the private endpoint was created, in the format defined by RFC3339.

vcnId string

A filter to return only resources that match the specified VCN OCID.

compartment_id str

A filter to return only resources that match the specified compartment OCID.

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

The description of the private endpoint.

display_name str

A filter to return only resources that match the specified display name.

endpoint_fqdn str

The three-label fully qualified domain name (FQDN) of the private endpoint. The customer VCN's DNS records are updated with this FQDN.

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 the Data Safe private endpoint.

nsg_ids Sequence[str]

The OCIDs of the network security groups that the private endpoint belongs to.

private_endpoint_id str

The OCID of the underlying private endpoint.

private_endpoint_ip str

The private IP address of the private endpoint.

state str

A filter to return only resources that match the specified lifecycle state.

subnet_id str

The OCID of the subnet.

system_tags Mapping[str, Any]

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

time_created str

The date and time the private endpoint was created, in the format defined by RFC3339.

vcn_id str

A filter to return only resources that match the specified VCN OCID.

compartmentId String

A filter to return only resources that match the specified compartment OCID.

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

The description of the private endpoint.

displayName String

A filter to return only resources that match the specified display name.

endpointFqdn String

The three-label fully qualified domain name (FQDN) of the private endpoint. The customer VCN's DNS records are updated with this FQDN.

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 the Data Safe private endpoint.

nsgIds List<String>

The OCIDs of the network security groups that the private endpoint belongs to.

privateEndpointId String

The OCID of the underlying private endpoint.

privateEndpointIp String

The private IP address of the private endpoint.

state String

A filter to return only resources that match the specified lifecycle state.

subnetId String

The OCID of the subnet.

systemTags Map<Any>

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

timeCreated String

The date and time the private endpoint was created, in the format defined by RFC3339.

vcnId String

A filter to return only resources that match the specified VCN OCID.

GetDataSafePrivateEndpointsFilter

Name string
Values List<string>
Regex bool
Name string
Values []string
Regex bool
name String
values List<String>
regex Boolean
name string
values string[]
regex boolean
name str
values Sequence[str]
regex bool
name String
values List<String>
regex Boolean

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.