Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
oci.DataSafe.getDataSafePrivateEndpoints
Explore with Pulumi AI
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
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testDataSafePrivateEndpoints = oci.DataSafe.getDataSafePrivateEndpoints({
compartmentId: compartmentId,
accessLevel: dataSafePrivateEndpointAccessLevel,
compartmentIdInSubtree: dataSafePrivateEndpointCompartmentIdInSubtree,
displayName: dataSafePrivateEndpointDisplayName,
state: dataSafePrivateEndpointState,
vcnId: testVcn.id,
});
import pulumi
import pulumi_oci as oci
test_data_safe_private_endpoints = oci.DataSafe.get_data_safe_private_endpoints(compartment_id=compartment_id,
access_level=data_safe_private_endpoint_access_level,
compartment_id_in_subtree=data_safe_private_endpoint_compartment_id_in_subtree,
display_name=data_safe_private_endpoint_display_name,
state=data_safe_private_endpoint_state,
vcn_id=test_vcn["id"])
package main
import (
"github.com/pulumi/pulumi-oci/sdk/v2/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: compartmentId,
AccessLevel: pulumi.StringRef(dataSafePrivateEndpointAccessLevel),
CompartmentIdInSubtree: pulumi.BoolRef(dataSafePrivateEndpointCompartmentIdInSubtree),
DisplayName: pulumi.StringRef(dataSafePrivateEndpointDisplayName),
State: pulumi.StringRef(dataSafePrivateEndpointState),
VcnId: pulumi.StringRef(testVcn.Id),
}, nil)
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 testDataSafePrivateEndpoints = Oci.DataSafe.GetDataSafePrivateEndpoints.Invoke(new()
{
CompartmentId = compartmentId,
AccessLevel = dataSafePrivateEndpointAccessLevel,
CompartmentIdInSubtree = dataSafePrivateEndpointCompartmentIdInSubtree,
DisplayName = dataSafePrivateEndpointDisplayName,
State = dataSafePrivateEndpointState,
VcnId = testVcn.Id,
});
});
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(compartmentId)
.accessLevel(dataSafePrivateEndpointAccessLevel)
.compartmentIdInSubtree(dataSafePrivateEndpointCompartmentIdInSubtree)
.displayName(dataSafePrivateEndpointDisplayName)
.state(dataSafePrivateEndpointState)
.vcnId(testVcn.id())
.build());
}
}
variables:
testDataSafePrivateEndpoints:
fn::invoke:
Function: oci:DataSafe:getDataSafePrivateEndpoints
Arguments:
compartmentId: ${compartmentId}
accessLevel: ${dataSafePrivateEndpointAccessLevel}
compartmentIdInSubtree: ${dataSafePrivateEndpointCompartmentIdInSubtree}
displayName: ${dataSafePrivateEndpointDisplayName}
state: ${dataSafePrivateEndpointState}
vcnId: ${testVcn.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:
- Compartment
Id string - A filter to return only resources that match the specified compartment OCID.
- Access
Level 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.
- Compartment
Id boolIn Subtree - 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 string - A filter to return only resources that match the specified display name.
- Filters
List<Get
Data Safe Private Endpoints Filter> - State string
- A filter to return only resources that match the specified lifecycle state.
- Vcn
Id string - A filter to return only resources that match the specified VCN OCID.
- Compartment
Id string - A filter to return only resources that match the specified compartment OCID.
- Access
Level 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.
- Compartment
Id boolIn Subtree - 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 string - A filter to return only resources that match the specified display name.
- Filters
[]Get
Data Safe Private Endpoints Filter - State string
- A filter to return only resources that match the specified lifecycle state.
- Vcn
Id string - A filter to return only resources that match the specified VCN OCID.
- compartment
Id String - A filter to return only resources that match the specified compartment OCID.
- access
Level 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.
- compartment
Id BooleanIn Subtree - 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 String - A filter to return only resources that match the specified display name.
- filters
List<Get
Private Endpoints Filter> - state String
- A filter to return only resources that match the specified lifecycle state.
- vcn
Id String - A filter to return only resources that match the specified VCN OCID.
- compartment
Id string - A filter to return only resources that match the specified compartment OCID.
- access
Level 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.
- compartment
Id booleanIn Subtree - 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 string - A filter to return only resources that match the specified display name.
- filters
Get
Data Safe Private Endpoints Filter[] - state string
- A filter to return only resources that match the specified lifecycle state.
- vcn
Id 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_ boolin_ subtree - 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
Sequence[datasafe.
Get Data Safe Private Endpoints Filter] - 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.
- compartment
Id String - A filter to return only resources that match the specified compartment OCID.
- access
Level 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.
- compartment
Id BooleanIn Subtree - 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 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.
- vcn
Id String - A filter to return only resources that match the specified VCN OCID.
getDataSafePrivateEndpoints Result
The following output properties are available:
- Compartment
Id string - The OCID of the compartment.
- Data
Safe List<GetPrivate Endpoints Data Safe Private Endpoints Data Safe Private Endpoint> - The list of data_safe_private_endpoints.
- Id string
- The provider-assigned unique ID for this managed resource.
- Access
Level string - Compartment
Id boolIn Subtree - Display
Name string - The display name of the private endpoint.
- Filters
List<Get
Data Safe Private Endpoints Filter> - State string
- The current state of the private endpoint.
- Vcn
Id string - The OCID of the VCN.
- Compartment
Id string - The OCID of the compartment.
- Data
Safe []GetPrivate Endpoints Data Safe Private Endpoints Data Safe Private Endpoint - The list of data_safe_private_endpoints.
- Id string
- The provider-assigned unique ID for this managed resource.
- Access
Level string - Compartment
Id boolIn Subtree - Display
Name string - The display name of the private endpoint.
- Filters
[]Get
Data Safe Private Endpoints Filter - State string
- The current state of the private endpoint.
- Vcn
Id string - The OCID of the VCN.
- compartment
Id String - The OCID of the compartment.
- data
Safe List<GetPrivate Endpoints Private Endpoints Private Endpoint> - The list of data_safe_private_endpoints.
- id String
- The provider-assigned unique ID for this managed resource.
- access
Level String - compartment
Id BooleanIn Subtree - display
Name String - The display name of the private endpoint.
- filters
List<Get
Private Endpoints Filter> - state String
- The current state of the private endpoint.
- vcn
Id String - The OCID of the VCN.
- compartment
Id string - The OCID of the compartment.
- data
Safe GetPrivate Endpoints Data Safe Private Endpoints Data Safe Private Endpoint[] - The list of data_safe_private_endpoints.
- id string
- The provider-assigned unique ID for this managed resource.
- access
Level string - compartment
Id booleanIn Subtree - display
Name string - The display name of the private endpoint.
- filters
Get
Data Safe Private Endpoints Filter[] - state string
- The current state of the private endpoint.
- vcn
Id string - The OCID of the VCN.
- compartment_
id str - The OCID of the compartment.
- data_
safe_ Sequence[datasafe.private_ endpoints Get Data Safe Private Endpoints Data Safe Private Endpoint] - The list of data_safe_private_endpoints.
- id str
- The provider-assigned unique ID for this managed resource.
- access_
level str - compartment_
id_ boolin_ subtree - display_
name str - The display name of the private endpoint.
- filters
Sequence[datasafe.
Get Data Safe Private Endpoints Filter] - state str
- The current state of the private endpoint.
- vcn_
id str - The OCID of the VCN.
- compartment
Id String - The OCID of the compartment.
- data
Safe List<Property Map>Private Endpoints - The list of data_safe_private_endpoints.
- id String
- The provider-assigned unique ID for this managed resource.
- access
Level String - compartment
Id BooleanIn Subtree - display
Name String - The display name of the private endpoint.
- filters List<Property Map>
- state String
- The current state of the private endpoint.
- vcn
Id String - The OCID of the VCN.
Supporting Types
GetDataSafePrivateEndpointsDataSafePrivateEndpoint
- Compartment
Id string - A filter to return only resources that match the specified compartment OCID.
- Dictionary<string, string>
- 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.
- Display
Name string - A filter to return only resources that match the specified display name.
- Endpoint
Fqdn string - The three-label fully qualified domain name (FQDN) of the private endpoint. The customer VCN's DNS records are updated with this FQDN.
- Dictionary<string, string>
- 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.
- Nsg
Ids List<string> - The OCIDs of the network security groups that the private endpoint belongs to.
- Private
Endpoint stringId - The OCID of the underlying private endpoint.
- Private
Endpoint stringIp - The private IP address of the private endpoint.
- State string
- A filter to return only resources that match the specified lifecycle state.
- Subnet
Id string - The OCID of the subnet.
- Dictionary<string, string>
- 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 string - The date and time the private endpoint was created, in the format defined by RFC3339.
- Vcn
Id string - A filter to return only resources that match the specified VCN OCID.
- Compartment
Id string - A filter to return only resources that match the specified compartment OCID.
- map[string]string
- 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.
- Display
Name string - A filter to return only resources that match the specified display name.
- Endpoint
Fqdn string - The three-label fully qualified domain name (FQDN) of the private endpoint. The customer VCN's DNS records are updated with this FQDN.
- map[string]string
- 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.
- Nsg
Ids []string - The OCIDs of the network security groups that the private endpoint belongs to.
- Private
Endpoint stringId - The OCID of the underlying private endpoint.
- Private
Endpoint stringIp - The private IP address of the private endpoint.
- State string
- A filter to return only resources that match the specified lifecycle state.
- Subnet
Id string - The OCID of the subnet.
- map[string]string
- 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 string - The date and time the private endpoint was created, in the format defined by RFC3339.
- Vcn
Id string - A filter to return only resources that match the specified VCN OCID.
- compartment
Id String - A filter to return only resources that match the specified compartment OCID.
- Map<String,String>
- 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.
- display
Name String - A filter to return only resources that match the specified display name.
- endpoint
Fqdn String - The three-label fully qualified domain name (FQDN) of the private endpoint. The customer VCN's DNS records are updated with this FQDN.
- Map<String,String>
- 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.
- nsg
Ids List<String> - The OCIDs of the network security groups that the private endpoint belongs to.
- private
Endpoint StringId - The OCID of the underlying private endpoint.
- private
Endpoint StringIp - The private IP address of the private endpoint.
- state String
- A filter to return only resources that match the specified lifecycle state.
- subnet
Id String - The OCID of the subnet.
- Map<String,String>
- 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 String - The date and time the private endpoint was created, in the format defined by RFC3339.
- vcn
Id String - A filter to return only resources that match the specified VCN OCID.
- compartment
Id string - A filter to return only resources that match the specified compartment OCID.
- {[key: string]: string}
- 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.
- display
Name string - A filter to return only resources that match the specified display name.
- endpoint
Fqdn string - The three-label fully qualified domain name (FQDN) of the private endpoint. The customer VCN's DNS records are updated with this FQDN.
- {[key: string]: string}
- 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.
- nsg
Ids string[] - The OCIDs of the network security groups that the private endpoint belongs to.
- private
Endpoint stringId - The OCID of the underlying private endpoint.
- private
Endpoint stringIp - The private IP address of the private endpoint.
- state string
- A filter to return only resources that match the specified lifecycle state.
- subnet
Id string - The OCID of the subnet.
- {[key: string]: string}
- 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 string - The date and time the private endpoint was created, in the format defined by RFC3339.
- vcn
Id 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.
- Mapping[str, str]
- 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.
- Mapping[str, str]
- 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_ strid - The OCID of the underlying private endpoint.
- private_
endpoint_ strip - 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.
- Mapping[str, str]
- 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.
- compartment
Id String - A filter to return only resources that match the specified compartment OCID.
- Map<String>
- 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.
- display
Name String - A filter to return only resources that match the specified display name.
- endpoint
Fqdn String - The three-label fully qualified domain name (FQDN) of the private endpoint. The customer VCN's DNS records are updated with this FQDN.
- Map<String>
- 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.
- nsg
Ids List<String> - The OCIDs of the network security groups that the private endpoint belongs to.
- private
Endpoint StringId - The OCID of the underlying private endpoint.
- private
Endpoint StringIp - The private IP address of the private endpoint.
- state String
- A filter to return only resources that match the specified lifecycle state.
- subnet
Id String - The OCID of the subnet.
- Map<String>
- 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 String - The date and time the private endpoint was created, in the format defined by RFC3339.
- vcn
Id String - A filter to return only resources that match the specified VCN OCID.
GetDataSafePrivateEndpointsFilter
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.