Oracle Cloud Infrastructure v0.13.0, Mar 28 23

oci.DatabaseManagement.getDbManagementPrivateEndpoints

This data source provides the list of Db Management Private Endpoints in Oracle Cloud Infrastructure Database Management service.

Gets a list of Database Management private endpoints.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var testDbManagementPrivateEndpoints = Oci.DatabaseManagement.GetDbManagementPrivateEndpoints.Invoke(new()
    {
        CompartmentId = @var.Compartment_id,
        IsCluster = @var.Db_management_private_endpoint_is_cluster,
        Name = @var.Db_management_private_endpoint_name,
        State = @var.Db_management_private_endpoint_state,
        VcnId = oci_core_vcn.Test_vcn.Id,
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := DatabaseManagement.GetDbManagementPrivateEndpoints(ctx, &databasemanagement.GetDbManagementPrivateEndpointsArgs{
			CompartmentId: _var.Compartment_id,
			IsCluster:     pulumi.BoolRef(_var.Db_management_private_endpoint_is_cluster),
			Name:          pulumi.StringRef(_var.Db_management_private_endpoint_name),
			State:         pulumi.StringRef(_var.Db_management_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.DatabaseManagement.DatabaseManagementFunctions;
import com.pulumi.oci.DatabaseManagement.inputs.GetDbManagementPrivateEndpointsArgs;
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 testDbManagementPrivateEndpoints = DatabaseManagementFunctions.getDbManagementPrivateEndpoints(GetDbManagementPrivateEndpointsArgs.builder()
            .compartmentId(var_.compartment_id())
            .isCluster(var_.db_management_private_endpoint_is_cluster())
            .name(var_.db_management_private_endpoint_name())
            .state(var_.db_management_private_endpoint_state())
            .vcnId(oci_core_vcn.test_vcn().id())
            .build());

    }
}

import pulumi
import pulumi_oci as oci

test_db_management_private_endpoints = oci.DatabaseManagement.get_db_management_private_endpoints(compartment_id=var["compartment_id"],
    is_cluster=var["db_management_private_endpoint_is_cluster"],
    name=var["db_management_private_endpoint_name"],
    state=var["db_management_private_endpoint_state"],
    vcn_id=oci_core_vcn["test_vcn"]["id"])

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

const testDbManagementPrivateEndpoints = oci.DatabaseManagement.getDbManagementPrivateEndpoints({
    compartmentId: _var.compartment_id,
    isCluster: _var.db_management_private_endpoint_is_cluster,
    name: _var.db_management_private_endpoint_name,
    state: _var.db_management_private_endpoint_state,
    vcnId: oci_core_vcn.test_vcn.id,
});

variables:
  testDbManagementPrivateEndpoints:
    fn::invoke:
      Function: oci:DatabaseManagement:getDbManagementPrivateEndpoints
      Arguments:
        compartmentId: ${var.compartment_id}
        isCluster: ${var.db_management_private_endpoint_is_cluster}
        name: ${var.db_management_private_endpoint_name}
        state: ${var.db_management_private_endpoint_state}
        vcnId: ${oci_core_vcn.test_vcn.id}

Using getDbManagementPrivateEndpoints

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 getDbManagementPrivateEndpoints(args: GetDbManagementPrivateEndpointsArgs, opts?: InvokeOptions): Promise<GetDbManagementPrivateEndpointsResult>
function getDbManagementPrivateEndpointsOutput(args: GetDbManagementPrivateEndpointsOutputArgs, opts?: InvokeOptions): Output<GetDbManagementPrivateEndpointsResult>

def get_db_management_private_endpoints(compartment_id: Optional[str] = None,
                                        filters: Optional[Sequence[_databasemanagement.GetDbManagementPrivateEndpointsFilter]] = None,
                                        is_cluster: Optional[bool] = None,
                                        name: Optional[str] = None,
                                        state: Optional[str] = None,
                                        vcn_id: Optional[str] = None,
                                        opts: Optional[InvokeOptions] = None) -> GetDbManagementPrivateEndpointsResult
def get_db_management_private_endpoints_output(compartment_id: Optional[pulumi.Input[str]] = None,
                                        filters: Optional[pulumi.Input[Sequence[pulumi.Input[_databasemanagement.GetDbManagementPrivateEndpointsFilterArgs]]]] = None,
                                        is_cluster: Optional[pulumi.Input[bool]] = None,
                                        name: Optional[pulumi.Input[str]] = None,
                                        state: Optional[pulumi.Input[str]] = None,
                                        vcn_id: Optional[pulumi.Input[str]] = None,
                                        opts: Optional[InvokeOptions] = None) -> Output[GetDbManagementPrivateEndpointsResult]

func GetDbManagementPrivateEndpoints(ctx *Context, args *GetDbManagementPrivateEndpointsArgs, opts ...InvokeOption) (*GetDbManagementPrivateEndpointsResult, error)
func GetDbManagementPrivateEndpointsOutput(ctx *Context, args *GetDbManagementPrivateEndpointsOutputArgs, opts ...InvokeOption) GetDbManagementPrivateEndpointsResultOutput

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

public static class GetDbManagementPrivateEndpoints 
{
    public static Task<GetDbManagementPrivateEndpointsResult> InvokeAsync(GetDbManagementPrivateEndpointsArgs args, InvokeOptions? opts = null)
    public static Output<GetDbManagementPrivateEndpointsResult> Invoke(GetDbManagementPrivateEndpointsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDbManagementPrivateEndpointsResult> getDbManagementPrivateEndpoints(GetDbManagementPrivateEndpointsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: oci:DatabaseManagement/getDbManagementPrivateEndpoints:getDbManagementPrivateEndpoints
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string: The OCID of the compartment.
Filters List<GetDbManagementPrivateEndpointsFilter>
IsCluster bool: The option to filter Database Management private endpoints that can used for Oracle Databases in a cluster. This should be used along with the vcnId query parameter.
Name string: A filter to return only resources that match the entire name.
State string: The lifecycle state of a resource.
VcnId string: The OCID of the VCN.

CompartmentId string: The OCID of the compartment.
Filters []GetDbManagementPrivateEndpointsFilter
IsCluster bool: The option to filter Database Management private endpoints that can used for Oracle Databases in a cluster. This should be used along with the vcnId query parameter.
Name string: A filter to return only resources that match the entire name.
State string: The lifecycle state of a resource.
VcnId string: The OCID of the VCN.

compartmentId String: The OCID of the compartment.
filters List<GetDbManagementPrivateEndpointsFilter>
isCluster Boolean: The option to filter Database Management private endpoints that can used for Oracle Databases in a cluster. This should be used along with the vcnId query parameter.
name String: A filter to return only resources that match the entire name.
state String: The lifecycle state of a resource.
vcnId String: The OCID of the VCN.

compartmentId string: The OCID of the compartment.
filters GetDbManagementPrivateEndpointsFilter[]
isCluster boolean: The option to filter Database Management private endpoints that can used for Oracle Databases in a cluster. This should be used along with the vcnId query parameter.
name string: A filter to return only resources that match the entire name.
state string: The lifecycle state of a resource.
vcnId string: The OCID of the VCN.

compartment_id str: The OCID of the compartment.
filters GetDbManagementPrivateEndpointsFilter]
is_cluster bool: The option to filter Database Management private endpoints that can used for Oracle Databases in a cluster. This should be used along with the vcnId query parameter.
name str: A filter to return only resources that match the entire name.
state str: The lifecycle state of a resource.
vcn_id str: The OCID of the VCN.

compartmentId String: The OCID of the compartment.
filters List<Property Map>
isCluster Boolean: The option to filter Database Management private endpoints that can used for Oracle Databases in a cluster. This should be used along with the vcnId query parameter.
name String: A filter to return only resources that match the entire name.
state String: The lifecycle state of a resource.
vcnId String: The OCID of the VCN.

getDbManagementPrivateEndpoints Result

The following output properties are available:

CompartmentId string: The OCID of the compartment.
DbManagementPrivateEndpointCollections List<GetDbManagementPrivateEndpointsDbManagementPrivateEndpointCollection>: The list of db_management_private_endpoint_collection.
Id string: The provider-assigned unique ID for this managed resource.
Filters List<GetDbManagementPrivateEndpointsFilter>
IsCluster bool: Specifies whether the Database Management private endpoint can be used for Oracle Databases in a cluster.
Name string: The display name of the Database Management private endpoint.
State string: The current lifecycle state of the Database Management private endpoint.
VcnId string: The OCID of the VCN.

CompartmentId string: The OCID of the compartment.
DbManagementPrivateEndpointCollections []GetDbManagementPrivateEndpointsDbManagementPrivateEndpointCollection: The list of db_management_private_endpoint_collection.
Id string: The provider-assigned unique ID for this managed resource.
Filters []GetDbManagementPrivateEndpointsFilter
IsCluster bool: Specifies whether the Database Management private endpoint can be used for Oracle Databases in a cluster.
Name string: The display name of the Database Management private endpoint.
State string: The current lifecycle state of the Database Management private endpoint.
VcnId string: The OCID of the VCN.

compartmentId String: The OCID of the compartment.
dbManagementPrivateEndpointCollections List<GetDbManagementPrivateEndpointsDbManagementPrivateEndpointCollection>: The list of db_management_private_endpoint_collection.
id String: The provider-assigned unique ID for this managed resource.
filters List<GetDbManagementPrivateEndpointsFilter>
isCluster Boolean: Specifies whether the Database Management private endpoint can be used for Oracle Databases in a cluster.
name String: The display name of the Database Management private endpoint.
state String: The current lifecycle state of the Database Management private endpoint.
vcnId String: The OCID of the VCN.

compartmentId string: The OCID of the compartment.
dbManagementPrivateEndpointCollections GetDbManagementPrivateEndpointsDbManagementPrivateEndpointCollection[]: The list of db_management_private_endpoint_collection.
id string: The provider-assigned unique ID for this managed resource.
filters GetDbManagementPrivateEndpointsFilter[]
isCluster boolean: Specifies whether the Database Management private endpoint can be used for Oracle Databases in a cluster.
name string: The display name of the Database Management private endpoint.
state string: The current lifecycle state of the Database Management private endpoint.
vcnId string: The OCID of the VCN.

compartment_id str: The OCID of the compartment.
db_management_private_endpoint_collections GetDbManagementPrivateEndpointsDbManagementPrivateEndpointCollection]: The list of db_management_private_endpoint_collection.
id str: The provider-assigned unique ID for this managed resource.
filters GetDbManagementPrivateEndpointsFilter]
is_cluster bool: Specifies whether the Database Management private endpoint can be used for Oracle Databases in a cluster.
name str: The display name of the Database Management private endpoint.
state str: The current lifecycle state of the Database Management private endpoint.
vcn_id str: The OCID of the VCN.

compartmentId String: The OCID of the compartment.
dbManagementPrivateEndpointCollections List<Property Map>: The list of db_management_private_endpoint_collection.
id String: The provider-assigned unique ID for this managed resource.
filters List<Property Map>
isCluster Boolean: Specifies whether the Database Management private endpoint can be used for Oracle Databases in a cluster.
name String: The display name of the Database Management private endpoint.
state String: The current lifecycle state of the Database Management private endpoint.
vcnId String: The OCID of the VCN.

Supporting Types

GetDbManagementPrivateEndpointsDbManagementPrivateEndpointCollection

Items List<GetDbManagementPrivateEndpointsDbManagementPrivateEndpointCollectionItem>

Items []GetDbManagementPrivateEndpointsDbManagementPrivateEndpointCollectionItem

items List<GetDbManagementPrivateEndpointsDbManagementPrivateEndpointCollectionItem>

items GetDbManagementPrivateEndpointsDbManagementPrivateEndpointCollectionItem[]

items GetDbManagementPrivateEndpointsDbManagementPrivateEndpointCollectionItem]

items List<Property Map>

GetDbManagementPrivateEndpointsDbManagementPrivateEndpointCollectionItem

CompartmentId string: The OCID of the compartment.
Description string: The description of the Database Management private endpoint.
Id string: The OCID of the Database Management private endpoint.
IsCluster bool: The option to filter Database Management private endpoints that can used for Oracle Databases in a cluster. This should be used along with the vcnId query parameter.
Name string: A filter to return only resources that match the entire name.
NsgIds List<string>: The OCIDs of the Network Security Groups to which the Database Management private endpoint belongs.
PrivateIp string: The IP addresses assigned to the Database Management private endpoint.
State string: The lifecycle state of a resource.
SubnetId string: The OCID of the subnet.
TimeCreated string: The date and time the Database Managament private endpoint was created, in the format defined by RFC3339.
VcnId string: The OCID of the VCN.

CompartmentId string: The OCID of the compartment.
Description string: The description of the Database Management private endpoint.
Id string: The OCID of the Database Management private endpoint.
IsCluster bool: The option to filter Database Management private endpoints that can used for Oracle Databases in a cluster. This should be used along with the vcnId query parameter.
Name string: A filter to return only resources that match the entire name.
NsgIds []string: The OCIDs of the Network Security Groups to which the Database Management private endpoint belongs.
PrivateIp string: The IP addresses assigned to the Database Management private endpoint.
State string: The lifecycle state of a resource.
SubnetId string: The OCID of the subnet.
TimeCreated string: The date and time the Database Managament private endpoint was created, in the format defined by RFC3339.
VcnId string: The OCID of the VCN.

compartmentId String: The OCID of the compartment.
description String: The description of the Database Management private endpoint.
id String: The OCID of the Database Management private endpoint.
isCluster Boolean: The option to filter Database Management private endpoints that can used for Oracle Databases in a cluster. This should be used along with the vcnId query parameter.
name String: A filter to return only resources that match the entire name.
nsgIds List<String>: The OCIDs of the Network Security Groups to which the Database Management private endpoint belongs.
privateIp String: The IP addresses assigned to the Database Management private endpoint.
state String: The lifecycle state of a resource.
subnetId String: The OCID of the subnet.
timeCreated String: The date and time the Database Managament private endpoint was created, in the format defined by RFC3339.
vcnId String: The OCID of the VCN.

compartmentId string: The OCID of the compartment.
description string: The description of the Database Management private endpoint.
id string: The OCID of the Database Management private endpoint.
isCluster boolean: The option to filter Database Management private endpoints that can used for Oracle Databases in a cluster. This should be used along with the vcnId query parameter.
name string: A filter to return only resources that match the entire name.
nsgIds string[]: The OCIDs of the Network Security Groups to which the Database Management private endpoint belongs.
privateIp string: The IP addresses assigned to the Database Management private endpoint.
state string: The lifecycle state of a resource.
subnetId string: The OCID of the subnet.
timeCreated string: The date and time the Database Managament private endpoint was created, in the format defined by RFC3339.
vcnId string: The OCID of the VCN.

compartment_id str: The OCID of the compartment.
description str: The description of the Database Management private endpoint.
id str: The OCID of the Database Management private endpoint.
is_cluster bool: The option to filter Database Management private endpoints that can used for Oracle Databases in a cluster. This should be used along with the vcnId query parameter.
name str: A filter to return only resources that match the entire name.
nsg_ids Sequence[str]: The OCIDs of the Network Security Groups to which the Database Management private endpoint belongs.
private_ip str: The IP addresses assigned to the Database Management private endpoint.
state str: The lifecycle state of a resource.
subnet_id str: The OCID of the subnet.
time_created str: The date and time the Database Managament private endpoint was created, in the format defined by RFC3339.
vcn_id str: The OCID of the VCN.

compartmentId String: The OCID of the compartment.
description String: The description of the Database Management private endpoint.
id String: The OCID of the Database Management private endpoint.
isCluster Boolean: The option to filter Database Management private endpoints that can used for Oracle Databases in a cluster. This should be used along with the vcnId query parameter.
name String: A filter to return only resources that match the entire name.
nsgIds List<String>: The OCIDs of the Network Security Groups to which the Database Management private endpoint belongs.
privateIp String: The IP addresses assigned to the Database Management private endpoint.
state String: The lifecycle state of a resource.
subnetId String: The OCID of the subnet.
timeCreated String: The date and time the Database Managament private endpoint was created, in the format defined by RFC3339.
vcnId String: The OCID of the VCN.

GetDbManagementPrivateEndpointsFilter

Name string: A filter to return only resources that match the entire name.
Values List<string>
Regex bool

Name string: A filter to return only resources that match the entire name.
Values []string
Regex bool

name String: A filter to return only resources that match the entire name.
values List<String>
regex Boolean

name string: A filter to return only resources that match the entire name.
values string[]
regex boolean

name str: A filter to return only resources that match the entire name.
values Sequence[str]
regex bool

name String: A filter to return only resources that match the entire name.
values List<String>
regex Boolean

Package Details

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