Oracle Cloud Infrastructure

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

getExternalDatabaseConnectors

This data source provides the list of External Database Connectors in Oracle Cloud Infrastructure Database service.

Gets a list of the external database connectors in the specified compartment.

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testExternalDatabaseConnectors = Output.Create(Oci.Database.GetExternalDatabaseConnectors.InvokeAsync(new Oci.Database.GetExternalDatabaseConnectorsArgs
        {
            CompartmentId = @var.Compartment_id,
            ExternalDatabaseId = oci_database_database.Test_database.Id,
            DisplayName = @var.External_database_connector_display_name,
            State = @var.External_database_connector_state,
        }));
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Database.GetExternalDatabaseConnectors(ctx, &database.GetExternalDatabaseConnectorsArgs{
			CompartmentId:      _var.Compartment_id,
			ExternalDatabaseId: oci_database_database.Test_database.Id,
			DisplayName:        pulumi.StringRef(_var.External_database_connector_display_name),
			State:              pulumi.StringRef(_var.External_database_connector_state),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_external_database_connectors = oci.Database.get_external_database_connectors(compartment_id=var["compartment_id"],
    external_database_id=oci_database_database["test_database"]["id"],
    display_name=var["external_database_connector_display_name"],
    state=var["external_database_connector_state"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testExternalDatabaseConnectors = oci.Database.getExternalDatabaseConnectors({
    compartmentId: _var.compartment_id,
    externalDatabaseId: oci_database_database.test_database.id,
    displayName: _var.external_database_connector_display_name,
    state: _var.external_database_connector_state,
});

Coming soon!

Using getExternalDatabaseConnectors

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 getExternalDatabaseConnectors(args: GetExternalDatabaseConnectorsArgs, opts?: InvokeOptions): Promise<GetExternalDatabaseConnectorsResult>
function getExternalDatabaseConnectorsOutput(args: GetExternalDatabaseConnectorsOutputArgs, opts?: InvokeOptions): Output<GetExternalDatabaseConnectorsResult>
def get_external_database_connectors(compartment_id: Optional[str] = None,
                                     display_name: Optional[str] = None,
                                     external_database_id: Optional[str] = None,
                                     filters: Optional[Sequence[_database.GetExternalDatabaseConnectorsFilter]] = None,
                                     state: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetExternalDatabaseConnectorsResult
def get_external_database_connectors_output(compartment_id: Optional[pulumi.Input[str]] = None,
                                     display_name: Optional[pulumi.Input[str]] = None,
                                     external_database_id: Optional[pulumi.Input[str]] = None,
                                     filters: Optional[pulumi.Input[Sequence[pulumi.Input[_database.GetExternalDatabaseConnectorsFilterArgs]]]] = None,
                                     state: Optional[pulumi.Input[str]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[GetExternalDatabaseConnectorsResult]
func GetExternalDatabaseConnectors(ctx *Context, args *GetExternalDatabaseConnectorsArgs, opts ...InvokeOption) (*GetExternalDatabaseConnectorsResult, error)
func GetExternalDatabaseConnectorsOutput(ctx *Context, args *GetExternalDatabaseConnectorsOutputArgs, opts ...InvokeOption) GetExternalDatabaseConnectorsResultOutput

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

public static class GetExternalDatabaseConnectors 
{
    public static Task<GetExternalDatabaseConnectorsResult> InvokeAsync(GetExternalDatabaseConnectorsArgs args, InvokeOptions? opts = null)
    public static Output<GetExternalDatabaseConnectorsResult> Invoke(GetExternalDatabaseConnectorsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetExternalDatabaseConnectorsResult> getExternalDatabaseConnectors(GetExternalDatabaseConnectorsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: oci:Database/getExternalDatabaseConnectors:getExternalDatabaseConnectors
  Arguments:
    # Arguments dictionary

The following arguments are supported:

CompartmentId string

The compartment OCID.

ExternalDatabaseId string

The OCID of the external database whose connectors will be listed.

DisplayName string

A filter to return only resources that match the entire display name given. The match is not case sensitive.

Filters List<GetExternalDatabaseConnectorsFilter>
State string

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

CompartmentId string

The compartment OCID.

ExternalDatabaseId string

The OCID of the external database whose connectors will be listed.

DisplayName string

A filter to return only resources that match the entire display name given. The match is not case sensitive.

Filters []GetExternalDatabaseConnectorsFilter
State string

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

compartmentId String

The compartment OCID.

externalDatabaseId String

The OCID of the external database whose connectors will be listed.

displayName String

A filter to return only resources that match the entire display name given. The match is not case sensitive.

filters List<GetExternalConnectorsFilter>
state String

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

compartmentId string

The compartment OCID.

externalDatabaseId string

The OCID of the external database whose connectors will be listed.

displayName string

A filter to return only resources that match the entire display name given. The match is not case sensitive.

filters GetExternalDatabaseConnectorsFilter[]
state string

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

compartment_id str

The compartment OCID.

external_database_id str

The OCID of the external database whose connectors will be listed.

display_name str

A filter to return only resources that match the entire display name given. The match is not case sensitive.

filters GetExternalDatabaseConnectorsFilter]
state str

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

compartmentId String

The compartment OCID.

externalDatabaseId String

The OCID of the external database whose connectors will be listed.

displayName String

A filter to return only resources that match the entire display name given. The match is not case sensitive.

filters List<Property Map>
state String

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

getExternalDatabaseConnectors Result

The following output properties are available:

CompartmentId string

The OCID of the compartment.

ExternalDatabaseConnectors List<GetExternalDatabaseConnectorsExternalDatabaseConnector>

The list of external_database_connectors.

ExternalDatabaseId string

The OCID of the external database resource.

Id string

The provider-assigned unique ID for this managed resource.

DisplayName string

The user-friendly name for the external database connector. The name does not have to be unique.

Filters List<GetExternalDatabaseConnectorsFilter>
State string

The current lifecycle state of the external database connector resource.

CompartmentId string

The OCID of the compartment.

ExternalDatabaseConnectors []GetExternalDatabaseConnectorsExternalDatabaseConnector

The list of external_database_connectors.

ExternalDatabaseId string

The OCID of the external database resource.

Id string

The provider-assigned unique ID for this managed resource.

DisplayName string

The user-friendly name for the external database connector. The name does not have to be unique.

Filters []GetExternalDatabaseConnectorsFilter
State string

The current lifecycle state of the external database connector resource.

compartmentId String

The OCID of the compartment.

externalDatabaseConnectors List<GetExternalConnectorsExternalConnector>

The list of external_database_connectors.

externalDatabaseId String

The OCID of the external database resource.

id String

The provider-assigned unique ID for this managed resource.

displayName String

The user-friendly name for the external database connector. The name does not have to be unique.

filters List<GetExternalConnectorsFilter>
state String

The current lifecycle state of the external database connector resource.

compartmentId string

The OCID of the compartment.

externalDatabaseConnectors GetExternalDatabaseConnectorsExternalDatabaseConnector[]

The list of external_database_connectors.

externalDatabaseId string

The OCID of the external database resource.

id string

The provider-assigned unique ID for this managed resource.

displayName string

The user-friendly name for the external database connector. The name does not have to be unique.

filters GetExternalDatabaseConnectorsFilter[]
state string

The current lifecycle state of the external database connector resource.

compartment_id str

The OCID of the compartment.

external_database_connectors GetExternalDatabaseConnectorsExternalDatabaseConnector]

The list of external_database_connectors.

external_database_id str

The OCID of the external database resource.

id str

The provider-assigned unique ID for this managed resource.

display_name str

The user-friendly name for the external database connector. The name does not have to be unique.

filters GetExternalDatabaseConnectorsFilter]
state str

The current lifecycle state of the external database connector resource.

compartmentId String

The OCID of the compartment.

externalDatabaseConnectors List<Property Map>

The list of external_database_connectors.

externalDatabaseId String

The OCID of the external database resource.

id String

The provider-assigned unique ID for this managed resource.

displayName String

The user-friendly name for the external database connector. The name does not have to be unique.

filters List<Property Map>
state String

The current lifecycle state of the external database connector resource.

Supporting Types

GetExternalDatabaseConnectorsExternalDatabaseConnector

CompartmentId string

The compartment OCID.

ConnectionCredentials List<GetExternalDatabaseConnectorsExternalDatabaseConnectorConnectionCredential>

Credentials used to connect to the database. Currently only the DETAILS type is supported for creating MACS connector crendentials.

ConnectionStatus string

The status of connectivity to the external database.

ConnectionStrings List<GetExternalDatabaseConnectorsExternalDatabaseConnectorConnectionString>

The Oracle Database connection string.

ConnectorAgentId string

The ID of the agent used for the external database connector.

ConnectorType string

The type of connector used by the external database resource.

DefinedTags Dictionary<string, object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DisplayName string

A filter to return only resources that match the entire display name given. The match is not case sensitive.

ExternalDatabaseId string

The OCID of the external database whose connectors will be listed.

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 external database connector.

LifecycleDetails string

Additional information about the current lifecycle state.

State string

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

TimeConnectionStatusLastUpdated string

The date and time the connectionStatus of this external connector was last updated.

TimeCreated string

The date and time the external connector was created.

CompartmentId string

The compartment OCID.

ConnectionCredentials []GetExternalDatabaseConnectorsExternalDatabaseConnectorConnectionCredential

Credentials used to connect to the database. Currently only the DETAILS type is supported for creating MACS connector crendentials.

ConnectionStatus string

The status of connectivity to the external database.

ConnectionStrings []GetExternalDatabaseConnectorsExternalDatabaseConnectorConnectionString

The Oracle Database connection string.

ConnectorAgentId string

The ID of the agent used for the external database connector.

ConnectorType string

The type of connector used by the external database resource.

DefinedTags map[string]interface{}

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DisplayName string

A filter to return only resources that match the entire display name given. The match is not case sensitive.

ExternalDatabaseId string

The OCID of the external database whose connectors will be listed.

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 external database connector.

LifecycleDetails string

Additional information about the current lifecycle state.

State string

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

TimeConnectionStatusLastUpdated string

The date and time the connectionStatus of this external connector was last updated.

TimeCreated string

The date and time the external connector was created.

compartmentId String

The compartment OCID.

connectionCredentials List<GetExternalConnectorsExternalConnectorConnectionCredential>

Credentials used to connect to the database. Currently only the DETAILS type is supported for creating MACS connector crendentials.

connectionStatus String

The status of connectivity to the external database.

connectionStrings List<GetExternalConnectorsExternalConnectorConnectionString>

The Oracle Database connection string.

connectorAgentId String

The ID of the agent used for the external database connector.

connectorType String

The type of connector used by the external database resource.

definedTags Map<String,Object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

displayName String

A filter to return only resources that match the entire display name given. The match is not case sensitive.

externalDatabaseId String

The OCID of the external database whose connectors will be listed.

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 external database connector.

lifecycleDetails String

Additional information about the current lifecycle state.

state String

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

timeConnectionStatusLastUpdated String

The date and time the connectionStatus of this external connector was last updated.

timeCreated String

The date and time the external connector was created.

compartmentId string

The compartment OCID.

connectionCredentials GetExternalDatabaseConnectorsExternalDatabaseConnectorConnectionCredential[]

Credentials used to connect to the database. Currently only the DETAILS type is supported for creating MACS connector crendentials.

connectionStatus string

The status of connectivity to the external database.

connectionStrings GetExternalDatabaseConnectorsExternalDatabaseConnectorConnectionString[]

The Oracle Database connection string.

connectorAgentId string

The ID of the agent used for the external database connector.

connectorType string

The type of connector used by the external database resource.

definedTags {[key: string]: any}

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

displayName string

A filter to return only resources that match the entire display name given. The match is not case sensitive.

externalDatabaseId string

The OCID of the external database whose connectors will be listed.

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 external database connector.

lifecycleDetails string

Additional information about the current lifecycle state.

state string

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

timeConnectionStatusLastUpdated string

The date and time the connectionStatus of this external connector was last updated.

timeCreated string

The date and time the external connector was created.

compartment_id str

The compartment OCID.

connection_credentials GetExternalDatabaseConnectorsExternalDatabaseConnectorConnectionCredential]

Credentials used to connect to the database. Currently only the DETAILS type is supported for creating MACS connector crendentials.

connection_status str

The status of connectivity to the external database.

connection_strings GetExternalDatabaseConnectorsExternalDatabaseConnectorConnectionString]

The Oracle Database connection string.

connector_agent_id str

The ID of the agent used for the external database connector.

connector_type str

The type of connector used by the external database resource.

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.

display_name str

A filter to return only resources that match the entire display name given. The match is not case sensitive.

external_database_id str

The OCID of the external database whose connectors will be listed.

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 external database connector.

lifecycle_details str

Additional information about the current lifecycle state.

state str

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

time_connection_status_last_updated str

The date and time the connectionStatus of this external connector was last updated.

time_created str

The date and time the external connector was created.

compartmentId String

The compartment OCID.

connectionCredentials List<Property Map>

Credentials used to connect to the database. Currently only the DETAILS type is supported for creating MACS connector crendentials.

connectionStatus String

The status of connectivity to the external database.

connectionStrings List<Property Map>

The Oracle Database connection string.

connectorAgentId String

The ID of the agent used for the external database connector.

connectorType String

The type of connector used by the external database resource.

definedTags Map<Any>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

displayName String

A filter to return only resources that match the entire display name given. The match is not case sensitive.

externalDatabaseId String

The OCID of the external database whose connectors will be listed.

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 external database connector.

lifecycleDetails String

Additional information about the current lifecycle state.

state String

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

timeConnectionStatusLastUpdated String

The date and time the connectionStatus of this external connector was last updated.

timeCreated String

The date and time the external connector was created.

GetExternalDatabaseConnectorsExternalDatabaseConnectorConnectionCredential

CredentialName string

The name of the credential information that used to connect to the database. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. IMPORTANT - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name.

CredentialType string

The type of credential used to connect to the database.

Password string

The password that will be used to connect to the database.

Role string

The role of the user that will be connecting to the database.

Username string

The username that will be used to connect to the database.

CredentialName string

The name of the credential information that used to connect to the database. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. IMPORTANT - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name.

CredentialType string

The type of credential used to connect to the database.

Password string

The password that will be used to connect to the database.

Role string

The role of the user that will be connecting to the database.

Username string

The username that will be used to connect to the database.

credentialName String

The name of the credential information that used to connect to the database. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. IMPORTANT - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name.

credentialType String

The type of credential used to connect to the database.

password String

The password that will be used to connect to the database.

role String

The role of the user that will be connecting to the database.

username String

The username that will be used to connect to the database.

credentialName string

The name of the credential information that used to connect to the database. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. IMPORTANT - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name.

credentialType string

The type of credential used to connect to the database.

password string

The password that will be used to connect to the database.

role string

The role of the user that will be connecting to the database.

username string

The username that will be used to connect to the database.

credential_name str

The name of the credential information that used to connect to the database. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. IMPORTANT - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name.

credential_type str

The type of credential used to connect to the database.

password str

The password that will be used to connect to the database.

role str

The role of the user that will be connecting to the database.

username str

The username that will be used to connect to the database.

credentialName String

The name of the credential information that used to connect to the database. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. IMPORTANT - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name.

credentialType String

The type of credential used to connect to the database.

password String

The password that will be used to connect to the database.

role String

The role of the user that will be connecting to the database.

username String

The username that will be used to connect to the database.

GetExternalDatabaseConnectorsExternalDatabaseConnectorConnectionString

Hostname string

The host name of the database.

Port int

The port used to connect to the database.

Protocol string

The protocol used to connect to the database.

Service string

The name of the service alias used to connect to the database.

Hostname string

The host name of the database.

Port int

The port used to connect to the database.

Protocol string

The protocol used to connect to the database.

Service string

The name of the service alias used to connect to the database.

hostname String

The host name of the database.

port Integer

The port used to connect to the database.

protocol String

The protocol used to connect to the database.

service String

The name of the service alias used to connect to the database.

hostname string

The host name of the database.

port number

The port used to connect to the database.

protocol string

The protocol used to connect to the database.

service string

The name of the service alias used to connect to the database.

hostname str

The host name of the database.

port int

The port used to connect to the database.

protocol str

The protocol used to connect to the database.

service str

The name of the service alias used to connect to the database.

hostname String

The host name of the database.

port Number

The port used to connect to the database.

protocol String

The protocol used to connect to the database.

service String

The name of the service alias used to connect to the database.

GetExternalDatabaseConnectorsFilter

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.