1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Database
  5. getExternalDatabaseConnector
Oracle Cloud Infrastructure v2.3.0 published on Wednesday, Jul 17, 2024 by Pulumi

oci.Database.getExternalDatabaseConnector

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.3.0 published on Wednesday, Jul 17, 2024 by Pulumi

    This data source provides details about a specific External Database Connector resource in Oracle Cloud Infrastructure Database service.

    Gets information about the specified external database connector.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testExternalDatabaseConnector = oci.Database.getExternalDatabaseConnector({
        externalDatabaseConnectorId: testExternalDatabaseConnectorOciDatabaseExternalDatabaseConnector.id,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_external_database_connector = oci.Database.get_external_database_connector(external_database_connector_id=test_external_database_connector_oci_database_external_database_connector["id"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/Database"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Database.GetExternalDatabaseConnector(ctx, &database.GetExternalDatabaseConnectorArgs{
    			ExternalDatabaseConnectorId: testExternalDatabaseConnectorOciDatabaseExternalDatabaseConnector.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 testExternalDatabaseConnector = Oci.Database.GetExternalDatabaseConnector.Invoke(new()
        {
            ExternalDatabaseConnectorId = testExternalDatabaseConnectorOciDatabaseExternalDatabaseConnector.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.Database.DatabaseFunctions;
    import com.pulumi.oci.Database.inputs.GetExternalDatabaseConnectorArgs;
    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 testExternalDatabaseConnector = DatabaseFunctions.getExternalDatabaseConnector(GetExternalDatabaseConnectorArgs.builder()
                .externalDatabaseConnectorId(testExternalDatabaseConnectorOciDatabaseExternalDatabaseConnector.id())
                .build());
    
        }
    }
    
    variables:
      testExternalDatabaseConnector:
        fn::invoke:
          Function: oci:Database:getExternalDatabaseConnector
          Arguments:
            externalDatabaseConnectorId: ${testExternalDatabaseConnectorOciDatabaseExternalDatabaseConnector.id}
    

    Using getExternalDatabaseConnector

    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 getExternalDatabaseConnector(args: GetExternalDatabaseConnectorArgs, opts?: InvokeOptions): Promise<GetExternalDatabaseConnectorResult>
    function getExternalDatabaseConnectorOutput(args: GetExternalDatabaseConnectorOutputArgs, opts?: InvokeOptions): Output<GetExternalDatabaseConnectorResult>
    def get_external_database_connector(external_database_connector_id: Optional[str] = None,
                                        opts: Optional[InvokeOptions] = None) -> GetExternalDatabaseConnectorResult
    def get_external_database_connector_output(external_database_connector_id: Optional[pulumi.Input[str]] = None,
                                        opts: Optional[InvokeOptions] = None) -> Output[GetExternalDatabaseConnectorResult]
    func GetExternalDatabaseConnector(ctx *Context, args *GetExternalDatabaseConnectorArgs, opts ...InvokeOption) (*GetExternalDatabaseConnectorResult, error)
    func GetExternalDatabaseConnectorOutput(ctx *Context, args *GetExternalDatabaseConnectorOutputArgs, opts ...InvokeOption) GetExternalDatabaseConnectorResultOutput

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

    public static class GetExternalDatabaseConnector 
    {
        public static Task<GetExternalDatabaseConnectorResult> InvokeAsync(GetExternalDatabaseConnectorArgs args, InvokeOptions? opts = null)
        public static Output<GetExternalDatabaseConnectorResult> Invoke(GetExternalDatabaseConnectorInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetExternalDatabaseConnectorResult> getExternalDatabaseConnector(GetExternalDatabaseConnectorArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:Database/getExternalDatabaseConnector:getExternalDatabaseConnector
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ExternalDatabaseConnectorId string
    The OCID of the external database connector resource (ExternalDatabaseConnectorId).
    ExternalDatabaseConnectorId string
    The OCID of the external database connector resource (ExternalDatabaseConnectorId).
    externalDatabaseConnectorId String
    The OCID of the external database connector resource (ExternalDatabaseConnectorId).
    externalDatabaseConnectorId string
    The OCID of the external database connector resource (ExternalDatabaseConnectorId).
    external_database_connector_id str
    The OCID of the external database connector resource (ExternalDatabaseConnectorId).
    externalDatabaseConnectorId String
    The OCID of the external database connector resource (ExternalDatabaseConnectorId).

    getExternalDatabaseConnector Result

    The following output properties are available:

    CompartmentId string
    The OCID of the compartment.
    ConnectionCredentials List<GetExternalDatabaseConnectorConnectionCredential>
    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<GetExternalDatabaseConnectorConnectionString>
    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
    The user-friendly name for the external database connector. The name does not have to be unique.
    ExternalDatabaseConnectorId string
    ExternalDatabaseId string
    The OCID of the external database resource.
    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
    The current lifecycle state of the external database connector resource.
    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 OCID of the compartment.
    ConnectionCredentials []GetExternalDatabaseConnectorConnectionCredential
    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 []GetExternalDatabaseConnectorConnectionString
    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
    The user-friendly name for the external database connector. The name does not have to be unique.
    ExternalDatabaseConnectorId string
    ExternalDatabaseId string
    The OCID of the external database resource.
    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
    The current lifecycle state of the external database connector resource.
    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 OCID of the compartment.
    connectionCredentials List<GetExternalConnectorConnectionCredential>
    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<GetExternalConnectorConnectionString>
    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
    The user-friendly name for the external database connector. The name does not have to be unique.
    externalDatabaseConnectorId String
    externalDatabaseId String
    The OCID of the external database resource.
    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
    The current lifecycle state of the external database connector resource.
    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 OCID of the compartment.
    connectionCredentials GetExternalDatabaseConnectorConnectionCredential[]
    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 GetExternalDatabaseConnectorConnectionString[]
    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
    The user-friendly name for the external database connector. The name does not have to be unique.
    externalDatabaseConnectorId string
    externalDatabaseId string
    The OCID of the external database resource.
    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
    The current lifecycle state of the external database connector resource.
    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 OCID of the compartment.
    connection_credentials Sequence[database.GetExternalDatabaseConnectorConnectionCredential]
    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 Sequence[database.GetExternalDatabaseConnectorConnectionString]
    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
    The user-friendly name for the external database connector. The name does not have to be unique.
    external_database_connector_id str
    external_database_id str
    The OCID of the external database resource.
    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
    The current lifecycle state of the external database connector resource.
    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 OCID of the compartment.
    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
    The user-friendly name for the external database connector. The name does not have to be unique.
    externalDatabaseConnectorId String
    externalDatabaseId String
    The OCID of the external database resource.
    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
    The current lifecycle state of the external database connector resource.
    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.

    Supporting Types

    GetExternalDatabaseConnectorConnectionCredential

    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.
    SslSecretId string
    The OCID of the Oracle Cloud Infrastructure secret.
    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.
    SslSecretId string
    The OCID of the Oracle Cloud Infrastructure secret.
    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.
    sslSecretId String
    The OCID of the Oracle Cloud Infrastructure secret.
    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.
    sslSecretId string
    The OCID of the Oracle Cloud Infrastructure secret.
    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.
    ssl_secret_id str
    The OCID of the Oracle Cloud Infrastructure secret.
    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.
    sslSecretId String
    The OCID of the Oracle Cloud Infrastructure secret.
    username String
    The username that will be used to connect to the database.

    GetExternalDatabaseConnectorConnectionString

    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.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.3.0 published on Wednesday, Jul 17, 2024 by Pulumi