Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DatabaseManagement
  5. ExternalMySqlDatabaseConnector
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

oci.DatabaseManagement.ExternalMySqlDatabaseConnector

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

    This resource provides the External My Sql Database Connector resource in Oracle Cloud Infrastructure Database Management service.

    Creates an external MySQL connector resource.

    Example Usage

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

const testExternalMySqlDatabaseConnector = new oci.databasemanagement.ExternalMySqlDatabaseConnector("test_external_my_sql_database_connector", {
    compartmentId: compartmentId,
    connectorDetails: {
        credentialType: externalMySqlDatabaseConnectorConnectorDetailsCredentialType,
        displayName: externalMySqlDatabaseConnectorConnectorDetailsDisplayName,
        externalDatabaseId: testExternalDatabase.id,
        hostName: externalMySqlDatabaseConnectorConnectorDetailsHostName,
        macsAgentId: testAgent.id,
        networkProtocol: externalMySqlDatabaseConnectorConnectorDetailsNetworkProtocol,
        port: externalMySqlDatabaseConnectorConnectorDetailsPort,
        sslSecretId: testSecret.id,
    },
    isTestConnectionParam: externalMySqlDatabaseConnectorIsTestConnectionParam,
});

    import pulumi
import pulumi_oci as oci

test_external_my_sql_database_connector = oci.database_management.ExternalMySqlDatabaseConnector("test_external_my_sql_database_connector",
    compartment_id=compartment_id,
    connector_details={
        "credential_type": external_my_sql_database_connector_connector_details_credential_type,
        "display_name": external_my_sql_database_connector_connector_details_display_name,
        "external_database_id": test_external_database["id"],
        "host_name": external_my_sql_database_connector_connector_details_host_name,
        "macs_agent_id": test_agent["id"],
        "network_protocol": external_my_sql_database_connector_connector_details_network_protocol,
        "port": external_my_sql_database_connector_connector_details_port,
        "ssl_secret_id": test_secret["id"],
    },
    is_test_connection_param=external_my_sql_database_connector_is_test_connection_param)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := databasemanagement.NewExternalMySqlDatabaseConnector(ctx, "test_external_my_sql_database_connector", &databasemanagement.ExternalMySqlDatabaseConnectorArgs{
			CompartmentId: pulumi.Any(compartmentId),
			ConnectorDetails: &databasemanagement.ExternalMySqlDatabaseConnectorConnectorDetailsArgs{
				CredentialType:     pulumi.Any(externalMySqlDatabaseConnectorConnectorDetailsCredentialType),
				DisplayName:        pulumi.Any(externalMySqlDatabaseConnectorConnectorDetailsDisplayName),
				ExternalDatabaseId: pulumi.Any(testExternalDatabase.Id),
				HostName:           pulumi.Any(externalMySqlDatabaseConnectorConnectorDetailsHostName),
				MacsAgentId:        pulumi.Any(testAgent.Id),
				NetworkProtocol:    pulumi.Any(externalMySqlDatabaseConnectorConnectorDetailsNetworkProtocol),
				Port:               pulumi.Any(externalMySqlDatabaseConnectorConnectorDetailsPort),
				SslSecretId:        pulumi.Any(testSecret.Id),
			},
			IsTestConnectionParam: pulumi.Any(externalMySqlDatabaseConnectorIsTestConnectionParam),
		})
		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 testExternalMySqlDatabaseConnector = new Oci.DatabaseManagement.ExternalMySqlDatabaseConnector("test_external_my_sql_database_connector", new()
    {
        CompartmentId = compartmentId,
        ConnectorDetails = new Oci.DatabaseManagement.Inputs.ExternalMySqlDatabaseConnectorConnectorDetailsArgs
        {
            CredentialType = externalMySqlDatabaseConnectorConnectorDetailsCredentialType,
            DisplayName = externalMySqlDatabaseConnectorConnectorDetailsDisplayName,
            ExternalDatabaseId = testExternalDatabase.Id,
            HostName = externalMySqlDatabaseConnectorConnectorDetailsHostName,
            MacsAgentId = testAgent.Id,
            NetworkProtocol = externalMySqlDatabaseConnectorConnectorDetailsNetworkProtocol,
            Port = externalMySqlDatabaseConnectorConnectorDetailsPort,
            SslSecretId = testSecret.Id,
        },
        IsTestConnectionParam = externalMySqlDatabaseConnectorIsTestConnectionParam,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DatabaseManagement.ExternalMySqlDatabaseConnector;
import com.pulumi.oci.DatabaseManagement.ExternalMySqlDatabaseConnectorArgs;
import com.pulumi.oci.DatabaseManagement.inputs.ExternalMySqlDatabaseConnectorConnectorDetailsArgs;
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) {
        var testExternalMySqlDatabaseConnector = new ExternalMySqlDatabaseConnector("testExternalMySqlDatabaseConnector", ExternalMySqlDatabaseConnectorArgs.builder()
            .compartmentId(compartmentId)
            .connectorDetails(ExternalMySqlDatabaseConnectorConnectorDetailsArgs.builder()
                .credentialType(externalMySqlDatabaseConnectorConnectorDetailsCredentialType)
                .displayName(externalMySqlDatabaseConnectorConnectorDetailsDisplayName)
                .externalDatabaseId(testExternalDatabase.id())
                .hostName(externalMySqlDatabaseConnectorConnectorDetailsHostName)
                .macsAgentId(testAgent.id())
                .networkProtocol(externalMySqlDatabaseConnectorConnectorDetailsNetworkProtocol)
                .port(externalMySqlDatabaseConnectorConnectorDetailsPort)
                .sslSecretId(testSecret.id())
                .build())
            .isTestConnectionParam(externalMySqlDatabaseConnectorIsTestConnectionParam)
            .build());

    }
}

    resources:
  testExternalMySqlDatabaseConnector:
    type: oci:DatabaseManagement:ExternalMySqlDatabaseConnector
    name: test_external_my_sql_database_connector
    properties:
      compartmentId: ${compartmentId}
      connectorDetails:
        credentialType: ${externalMySqlDatabaseConnectorConnectorDetailsCredentialType}
        displayName: ${externalMySqlDatabaseConnectorConnectorDetailsDisplayName}
        externalDatabaseId: ${testExternalDatabase.id}
        hostName: ${externalMySqlDatabaseConnectorConnectorDetailsHostName}
        macsAgentId: ${testAgent.id}
        networkProtocol: ${externalMySqlDatabaseConnectorConnectorDetailsNetworkProtocol}
        port: ${externalMySqlDatabaseConnectorConnectorDetailsPort}
        sslSecretId: ${testSecret.id}
      isTestConnectionParam: ${externalMySqlDatabaseConnectorIsTestConnectionParam}

    Create ExternalMySqlDatabaseConnector Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ExternalMySqlDatabaseConnector(name: string, args: ExternalMySqlDatabaseConnectorArgs, opts?: CustomResourceOptions);
    @overload
def ExternalMySqlDatabaseConnector(resource_name: str,
                                   args: ExternalMySqlDatabaseConnectorArgs,
                                   opts: Optional[ResourceOptions] = None)

@overload
def ExternalMySqlDatabaseConnector(resource_name: str,
                                   opts: Optional[ResourceOptions] = None,
                                   compartment_id: Optional[str] = None,
                                   connector_details: Optional[ExternalMySqlDatabaseConnectorConnectorDetailsArgs] = None,
                                   is_test_connection_param: Optional[bool] = None,
                                   check_connection_status_trigger: Optional[int] = None)
    func NewExternalMySqlDatabaseConnector(ctx *Context, name string, args ExternalMySqlDatabaseConnectorArgs, opts ...ResourceOption) (*ExternalMySqlDatabaseConnector, error)
    public ExternalMySqlDatabaseConnector(string name, ExternalMySqlDatabaseConnectorArgs args, CustomResourceOptions? opts = null)
    public ExternalMySqlDatabaseConnector(String name, ExternalMySqlDatabaseConnectorArgs args)
public ExternalMySqlDatabaseConnector(String name, ExternalMySqlDatabaseConnectorArgs args, CustomResourceOptions options)

    type: oci:DatabaseManagement:ExternalMySqlDatabaseConnector
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ExternalMySqlDatabaseConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ExternalMySqlDatabaseConnectorArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ExternalMySqlDatabaseConnectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ExternalMySqlDatabaseConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ExternalMySqlDatabaseConnectorArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var externalMySqlDatabaseConnectorResource = new Oci.DatabaseManagement.ExternalMySqlDatabaseConnector("externalMySqlDatabaseConnectorResource", new()
{
    CompartmentId = "string",
    ConnectorDetails = new Oci.DatabaseManagement.Inputs.ExternalMySqlDatabaseConnectorConnectorDetailsArgs
    {
        CredentialType = "string",
        DisplayName = "string",
        ExternalDatabaseId = "string",
        HostName = "string",
        MacsAgentId = "string",
        NetworkProtocol = "string",
        Port = 0,
        SslSecretId = "string",
    },
    IsTestConnectionParam = false,
    CheckConnectionStatusTrigger = 0,
});

    example, err := databasemanagement.NewExternalMySqlDatabaseConnector(ctx, "externalMySqlDatabaseConnectorResource", &databasemanagement.ExternalMySqlDatabaseConnectorArgs{
	CompartmentId: pulumi.String("string"),
	ConnectorDetails: &databasemanagement.ExternalMySqlDatabaseConnectorConnectorDetailsArgs{
		CredentialType:     pulumi.String("string"),
		DisplayName:        pulumi.String("string"),
		ExternalDatabaseId: pulumi.String("string"),
		HostName:           pulumi.String("string"),
		MacsAgentId:        pulumi.String("string"),
		NetworkProtocol:    pulumi.String("string"),
		Port:               pulumi.Int(0),
		SslSecretId:        pulumi.String("string"),
	},
	IsTestConnectionParam:        pulumi.Bool(false),
	CheckConnectionStatusTrigger: pulumi.Int(0),
})

    var externalMySqlDatabaseConnectorResource = new ExternalMySqlDatabaseConnector("externalMySqlDatabaseConnectorResource", ExternalMySqlDatabaseConnectorArgs.builder()
    .compartmentId("string")
    .connectorDetails(ExternalMySqlDatabaseConnectorConnectorDetailsArgs.builder()
        .credentialType("string")
        .displayName("string")
        .externalDatabaseId("string")
        .hostName("string")
        .macsAgentId("string")
        .networkProtocol("string")
        .port(0)
        .sslSecretId("string")
        .build())
    .isTestConnectionParam(false)
    .checkConnectionStatusTrigger(0)
    .build());

    external_my_sql_database_connector_resource = oci.database_management.ExternalMySqlDatabaseConnector("externalMySqlDatabaseConnectorResource",
    compartment_id="string",
    connector_details={
        "credential_type": "string",
        "display_name": "string",
        "external_database_id": "string",
        "host_name": "string",
        "macs_agent_id": "string",
        "network_protocol": "string",
        "port": 0,
        "ssl_secret_id": "string",
    },
    is_test_connection_param=False,
    check_connection_status_trigger=0)

    const externalMySqlDatabaseConnectorResource = new oci.databasemanagement.ExternalMySqlDatabaseConnector("externalMySqlDatabaseConnectorResource", {
    compartmentId: "string",
    connectorDetails: {
        credentialType: "string",
        displayName: "string",
        externalDatabaseId: "string",
        hostName: "string",
        macsAgentId: "string",
        networkProtocol: "string",
        port: 0,
        sslSecretId: "string",
    },
    isTestConnectionParam: false,
    checkConnectionStatusTrigger: 0,
});

    type: oci:DatabaseManagement:ExternalMySqlDatabaseConnector
properties:
    checkConnectionStatusTrigger: 0
    compartmentId: string
    connectorDetails:
        credentialType: string
        displayName: string
        externalDatabaseId: string
        hostName: string
        macsAgentId: string
        networkProtocol: string
        port: 0
        sslSecretId: string
    isTestConnectionParam: false

    ExternalMySqlDatabaseConnector Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ExternalMySqlDatabaseConnector resource accepts the following input properties:

    CompartmentId string
    (Updatable) OCID of compartment for the External MySQL Database.
    ConnectorDetails ExternalMySqlDatabaseConnectorConnectorDetails
    (Updatable) Create Details of external database connector.
    IsTestConnectionParam bool
    Parameter indicating whether database connection needs to be tested.
    CheckConnectionStatusTrigger int

    (Updatable) An optional property when incremented triggers Check Connection Status. Could be set to any integer value.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    CompartmentId string
    (Updatable) OCID of compartment for the External MySQL Database.
    ConnectorDetails ExternalMySqlDatabaseConnectorConnectorDetailsArgs
    (Updatable) Create Details of external database connector.
    IsTestConnectionParam bool
    Parameter indicating whether database connection needs to be tested.
    CheckConnectionStatusTrigger int

    (Updatable) An optional property when incremented triggers Check Connection Status. Could be set to any integer value.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId String
    (Updatable) OCID of compartment for the External MySQL Database.
    connectorDetails ExternalMySqlDatabaseConnectorConnectorDetails
    (Updatable) Create Details of external database connector.
    isTestConnectionParam Boolean
    Parameter indicating whether database connection needs to be tested.
    checkConnectionStatusTrigger Integer

    (Updatable) An optional property when incremented triggers Check Connection Status. Could be set to any integer value.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId string
    (Updatable) OCID of compartment for the External MySQL Database.
    connectorDetails ExternalMySqlDatabaseConnectorConnectorDetails
    (Updatable) Create Details of external database connector.
    isTestConnectionParam boolean
    Parameter indicating whether database connection needs to be tested.
    checkConnectionStatusTrigger number

    (Updatable) An optional property when incremented triggers Check Connection Status. Could be set to any integer value.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartment_id str
    (Updatable) OCID of compartment for the External MySQL Database.
    connector_details ExternalMySqlDatabaseConnectorConnectorDetailsArgs
    (Updatable) Create Details of external database connector.
    is_test_connection_param bool
    Parameter indicating whether database connection needs to be tested.
    check_connection_status_trigger int

    (Updatable) An optional property when incremented triggers Check Connection Status. Could be set to any integer value.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId String
    (Updatable) OCID of compartment for the External MySQL Database.
    connectorDetails Property Map
    (Updatable) Create Details of external database connector.
    isTestConnectionParam Boolean
    Parameter indicating whether database connection needs to be tested.
    checkConnectionStatusTrigger Number

    (Updatable) An optional property when incremented triggers Check Connection Status. Could be set to any integer value.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ExternalMySqlDatabaseConnector resource produces the following output properties:

    AssociatedServices string
    Oracle Cloud Infrastructure Services associated with this connector.
    ConnectionStatus string
    Connection Status
    ConnectorType string
    Connector Type.
    CredentialType string
    Credential type used to connect to database.
    ExternalDatabaseId string
    OCID of MySQL Database resource
    HostName string
    Host name for Connector.
    Id string
    The provider-assigned unique ID for this managed resource.
    MacsAgentId string
    Agent Id of the MACS agent.
    Name string
    External MySQL Database Connector Name.
    NetworkProtocol string
    Network Protocol.
    Port int
    Connector port.
    SourceDatabase string
    Name of MySQL Database.
    SourceDatabaseType string
    Type of MySQL Database.
    SslSecretId string
    OCID of the SSL secret, if TCPS with SSL is used to connect to database.
    SslSecretName string
    Name of the SSL secret, if TCPS with SSL is used to connect to database.
    State string
    Indicates lifecycle state of the resource.
    TimeConnectionStatusUpdated string
    Time when connection status was last updated.
    TimeCreated string
    Connector creation time.
    TimeUpdated string
    Connector update time.
    AssociatedServices string
    Oracle Cloud Infrastructure Services associated with this connector.
    ConnectionStatus string
    Connection Status
    ConnectorType string
    Connector Type.
    CredentialType string
    Credential type used to connect to database.
    ExternalDatabaseId string
    OCID of MySQL Database resource
    HostName string
    Host name for Connector.
    Id string
    The provider-assigned unique ID for this managed resource.
    MacsAgentId string
    Agent Id of the MACS agent.
    Name string
    External MySQL Database Connector Name.
    NetworkProtocol string
    Network Protocol.
    Port int
    Connector port.
    SourceDatabase string
    Name of MySQL Database.
    SourceDatabaseType string
    Type of MySQL Database.
    SslSecretId string
    OCID of the SSL secret, if TCPS with SSL is used to connect to database.
    SslSecretName string
    Name of the SSL secret, if TCPS with SSL is used to connect to database.
    State string
    Indicates lifecycle state of the resource.
    TimeConnectionStatusUpdated string
    Time when connection status was last updated.
    TimeCreated string
    Connector creation time.
    TimeUpdated string
    Connector update time.
    associatedServices String
    Oracle Cloud Infrastructure Services associated with this connector.
    connectionStatus String
    Connection Status
    connectorType String
    Connector Type.
    credentialType String
    Credential type used to connect to database.
    externalDatabaseId String
    OCID of MySQL Database resource
    hostName String
    Host name for Connector.
    id String
    The provider-assigned unique ID for this managed resource.
    macsAgentId String
    Agent Id of the MACS agent.
    name String
    External MySQL Database Connector Name.
    networkProtocol String
    Network Protocol.
    port Integer
    Connector port.
    sourceDatabase String
    Name of MySQL Database.
    sourceDatabaseType String
    Type of MySQL Database.
    sslSecretId String
    OCID of the SSL secret, if TCPS with SSL is used to connect to database.
    sslSecretName String
    Name of the SSL secret, if TCPS with SSL is used to connect to database.
    state String
    Indicates lifecycle state of the resource.
    timeConnectionStatusUpdated String
    Time when connection status was last updated.
    timeCreated String
    Connector creation time.
    timeUpdated String
    Connector update time.
    associatedServices string
    Oracle Cloud Infrastructure Services associated with this connector.
    connectionStatus string
    Connection Status
    connectorType string
    Connector Type.
    credentialType string
    Credential type used to connect to database.
    externalDatabaseId string
    OCID of MySQL Database resource
    hostName string
    Host name for Connector.
    id string
    The provider-assigned unique ID for this managed resource.
    macsAgentId string
    Agent Id of the MACS agent.
    name string
    External MySQL Database Connector Name.
    networkProtocol string
    Network Protocol.
    port number
    Connector port.
    sourceDatabase string
    Name of MySQL Database.
    sourceDatabaseType string
    Type of MySQL Database.
    sslSecretId string
    OCID of the SSL secret, if TCPS with SSL is used to connect to database.
    sslSecretName string
    Name of the SSL secret, if TCPS with SSL is used to connect to database.
    state string
    Indicates lifecycle state of the resource.
    timeConnectionStatusUpdated string
    Time when connection status was last updated.
    timeCreated string
    Connector creation time.
    timeUpdated string
    Connector update time.
    associated_services str
    Oracle Cloud Infrastructure Services associated with this connector.
    connection_status str
    Connection Status
    connector_type str
    Connector Type.
    credential_type str
    Credential type used to connect to database.
    external_database_id str
    OCID of MySQL Database resource
    host_name str
    Host name for Connector.
    id str
    The provider-assigned unique ID for this managed resource.
    macs_agent_id str
    Agent Id of the MACS agent.
    name str
    External MySQL Database Connector Name.
    network_protocol str
    Network Protocol.
    port int
    Connector port.
    source_database str
    Name of MySQL Database.
    source_database_type str
    Type of MySQL Database.
    ssl_secret_id str
    OCID of the SSL secret, if TCPS with SSL is used to connect to database.
    ssl_secret_name str
    Name of the SSL secret, if TCPS with SSL is used to connect to database.
    state str
    Indicates lifecycle state of the resource.
    time_connection_status_updated str
    Time when connection status was last updated.
    time_created str
    Connector creation time.
    time_updated str
    Connector update time.
    associatedServices String
    Oracle Cloud Infrastructure Services associated with this connector.
    connectionStatus String
    Connection Status
    connectorType String
    Connector Type.
    credentialType String
    Credential type used to connect to database.
    externalDatabaseId String
    OCID of MySQL Database resource
    hostName String
    Host name for Connector.
    id String
    The provider-assigned unique ID for this managed resource.
    macsAgentId String
    Agent Id of the MACS agent.
    name String
    External MySQL Database Connector Name.
    networkProtocol String
    Network Protocol.
    port Number
    Connector port.
    sourceDatabase String
    Name of MySQL Database.
    sourceDatabaseType String
    Type of MySQL Database.
    sslSecretId String
    OCID of the SSL secret, if TCPS with SSL is used to connect to database.
    sslSecretName String
    Name of the SSL secret, if TCPS with SSL is used to connect to database.
    state String
    Indicates lifecycle state of the resource.
    timeConnectionStatusUpdated String
    Time when connection status was last updated.
    timeCreated String
    Connector creation time.
    timeUpdated String
    Connector update time.

    Look up Existing ExternalMySqlDatabaseConnector Resource

    Get an existing ExternalMySqlDatabaseConnector resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ExternalMySqlDatabaseConnectorState, opts?: CustomResourceOptions): ExternalMySqlDatabaseConnector
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        associated_services: Optional[str] = None,
        check_connection_status_trigger: Optional[int] = None,
        compartment_id: Optional[str] = None,
        connection_status: Optional[str] = None,
        connector_details: Optional[ExternalMySqlDatabaseConnectorConnectorDetailsArgs] = None,
        connector_type: Optional[str] = None,
        credential_type: Optional[str] = None,
        external_database_id: Optional[str] = None,
        host_name: Optional[str] = None,
        is_test_connection_param: Optional[bool] = None,
        macs_agent_id: Optional[str] = None,
        name: Optional[str] = None,
        network_protocol: Optional[str] = None,
        port: Optional[int] = None,
        source_database: Optional[str] = None,
        source_database_type: Optional[str] = None,
        ssl_secret_id: Optional[str] = None,
        ssl_secret_name: Optional[str] = None,
        state: Optional[str] = None,
        time_connection_status_updated: Optional[str] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None) -> ExternalMySqlDatabaseConnector
    func GetExternalMySqlDatabaseConnector(ctx *Context, name string, id IDInput, state *ExternalMySqlDatabaseConnectorState, opts ...ResourceOption) (*ExternalMySqlDatabaseConnector, error)
    public static ExternalMySqlDatabaseConnector Get(string name, Input<string> id, ExternalMySqlDatabaseConnectorState? state, CustomResourceOptions? opts = null)
    public static ExternalMySqlDatabaseConnector get(String name, Output<String> id, ExternalMySqlDatabaseConnectorState state, CustomResourceOptions options)
    resources:  _:    type: oci:DatabaseManagement:ExternalMySqlDatabaseConnector    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AssociatedServices string
    Oracle Cloud Infrastructure Services associated with this connector.
    CheckConnectionStatusTrigger int

    (Updatable) An optional property when incremented triggers Check Connection Status. Could be set to any integer value.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    CompartmentId string
    (Updatable) OCID of compartment for the External MySQL Database.
    ConnectionStatus string
    Connection Status
    ConnectorDetails ExternalMySqlDatabaseConnectorConnectorDetails
    (Updatable) Create Details of external database connector.
    ConnectorType string
    Connector Type.
    CredentialType string
    Credential type used to connect to database.
    ExternalDatabaseId string
    OCID of MySQL Database resource
    HostName string
    Host name for Connector.
    IsTestConnectionParam bool
    Parameter indicating whether database connection needs to be tested.
    MacsAgentId string
    Agent Id of the MACS agent.
    Name string
    External MySQL Database Connector Name.
    NetworkProtocol string
    Network Protocol.
    Port int
    Connector port.
    SourceDatabase string
    Name of MySQL Database.
    SourceDatabaseType string
    Type of MySQL Database.
    SslSecretId string
    OCID of the SSL secret, if TCPS with SSL is used to connect to database.
    SslSecretName string
    Name of the SSL secret, if TCPS with SSL is used to connect to database.
    State string
    Indicates lifecycle state of the resource.
    TimeConnectionStatusUpdated string
    Time when connection status was last updated.
    TimeCreated string
    Connector creation time.
    TimeUpdated string
    Connector update time.
    AssociatedServices string
    Oracle Cloud Infrastructure Services associated with this connector.
    CheckConnectionStatusTrigger int

    (Updatable) An optional property when incremented triggers Check Connection Status. Could be set to any integer value.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    CompartmentId string
    (Updatable) OCID of compartment for the External MySQL Database.
    ConnectionStatus string
    Connection Status
    ConnectorDetails ExternalMySqlDatabaseConnectorConnectorDetailsArgs
    (Updatable) Create Details of external database connector.
    ConnectorType string
    Connector Type.
    CredentialType string
    Credential type used to connect to database.
    ExternalDatabaseId string
    OCID of MySQL Database resource
    HostName string
    Host name for Connector.
    IsTestConnectionParam bool
    Parameter indicating whether database connection needs to be tested.
    MacsAgentId string
    Agent Id of the MACS agent.
    Name string
    External MySQL Database Connector Name.
    NetworkProtocol string
    Network Protocol.
    Port int
    Connector port.
    SourceDatabase string
    Name of MySQL Database.
    SourceDatabaseType string
    Type of MySQL Database.
    SslSecretId string
    OCID of the SSL secret, if TCPS with SSL is used to connect to database.
    SslSecretName string
    Name of the SSL secret, if TCPS with SSL is used to connect to database.
    State string
    Indicates lifecycle state of the resource.
    TimeConnectionStatusUpdated string
    Time when connection status was last updated.
    TimeCreated string
    Connector creation time.
    TimeUpdated string
    Connector update time.
    associatedServices String
    Oracle Cloud Infrastructure Services associated with this connector.
    checkConnectionStatusTrigger Integer

    (Updatable) An optional property when incremented triggers Check Connection Status. Could be set to any integer value.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId String
    (Updatable) OCID of compartment for the External MySQL Database.
    connectionStatus String
    Connection Status
    connectorDetails ExternalMySqlDatabaseConnectorConnectorDetails
    (Updatable) Create Details of external database connector.
    connectorType String
    Connector Type.
    credentialType String
    Credential type used to connect to database.
    externalDatabaseId String
    OCID of MySQL Database resource
    hostName String
    Host name for Connector.
    isTestConnectionParam Boolean
    Parameter indicating whether database connection needs to be tested.
    macsAgentId String
    Agent Id of the MACS agent.
    name String
    External MySQL Database Connector Name.
    networkProtocol String
    Network Protocol.
    port Integer
    Connector port.
    sourceDatabase String
    Name of MySQL Database.
    sourceDatabaseType String
    Type of MySQL Database.
    sslSecretId String
    OCID of the SSL secret, if TCPS with SSL is used to connect to database.
    sslSecretName String
    Name of the SSL secret, if TCPS with SSL is used to connect to database.
    state String
    Indicates lifecycle state of the resource.
    timeConnectionStatusUpdated String
    Time when connection status was last updated.
    timeCreated String
    Connector creation time.
    timeUpdated String
    Connector update time.
    associatedServices string
    Oracle Cloud Infrastructure Services associated with this connector.
    checkConnectionStatusTrigger number

    (Updatable) An optional property when incremented triggers Check Connection Status. Could be set to any integer value.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId string
    (Updatable) OCID of compartment for the External MySQL Database.
    connectionStatus string
    Connection Status
    connectorDetails ExternalMySqlDatabaseConnectorConnectorDetails
    (Updatable) Create Details of external database connector.
    connectorType string
    Connector Type.
    credentialType string
    Credential type used to connect to database.
    externalDatabaseId string
    OCID of MySQL Database resource
    hostName string
    Host name for Connector.
    isTestConnectionParam boolean
    Parameter indicating whether database connection needs to be tested.
    macsAgentId string
    Agent Id of the MACS agent.
    name string
    External MySQL Database Connector Name.
    networkProtocol string
    Network Protocol.
    port number
    Connector port.
    sourceDatabase string
    Name of MySQL Database.
    sourceDatabaseType string
    Type of MySQL Database.
    sslSecretId string
    OCID of the SSL secret, if TCPS with SSL is used to connect to database.
    sslSecretName string
    Name of the SSL secret, if TCPS with SSL is used to connect to database.
    state string
    Indicates lifecycle state of the resource.
    timeConnectionStatusUpdated string
    Time when connection status was last updated.
    timeCreated string
    Connector creation time.
    timeUpdated string
    Connector update time.
    associated_services str
    Oracle Cloud Infrastructure Services associated with this connector.
    check_connection_status_trigger int

    (Updatable) An optional property when incremented triggers Check Connection Status. Could be set to any integer value.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartment_id str
    (Updatable) OCID of compartment for the External MySQL Database.
    connection_status str
    Connection Status
    connector_details ExternalMySqlDatabaseConnectorConnectorDetailsArgs
    (Updatable) Create Details of external database connector.
    connector_type str
    Connector Type.
    credential_type str
    Credential type used to connect to database.
    external_database_id str
    OCID of MySQL Database resource
    host_name str
    Host name for Connector.
    is_test_connection_param bool
    Parameter indicating whether database connection needs to be tested.
    macs_agent_id str
    Agent Id of the MACS agent.
    name str
    External MySQL Database Connector Name.
    network_protocol str
    Network Protocol.
    port int
    Connector port.
    source_database str
    Name of MySQL Database.
    source_database_type str
    Type of MySQL Database.
    ssl_secret_id str
    OCID of the SSL secret, if TCPS with SSL is used to connect to database.
    ssl_secret_name str
    Name of the SSL secret, if TCPS with SSL is used to connect to database.
    state str
    Indicates lifecycle state of the resource.
    time_connection_status_updated str
    Time when connection status was last updated.
    time_created str
    Connector creation time.
    time_updated str
    Connector update time.
    associatedServices String
    Oracle Cloud Infrastructure Services associated with this connector.
    checkConnectionStatusTrigger Number

    (Updatable) An optional property when incremented triggers Check Connection Status. Could be set to any integer value.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId String
    (Updatable) OCID of compartment for the External MySQL Database.
    connectionStatus String
    Connection Status
    connectorDetails Property Map
    (Updatable) Create Details of external database connector.
    connectorType String
    Connector Type.
    credentialType String
    Credential type used to connect to database.
    externalDatabaseId String
    OCID of MySQL Database resource
    hostName String
    Host name for Connector.
    isTestConnectionParam Boolean
    Parameter indicating whether database connection needs to be tested.
    macsAgentId String
    Agent Id of the MACS agent.
    name String
    External MySQL Database Connector Name.
    networkProtocol String
    Network Protocol.
    port Number
    Connector port.
    sourceDatabase String
    Name of MySQL Database.
    sourceDatabaseType String
    Type of MySQL Database.
    sslSecretId String
    OCID of the SSL secret, if TCPS with SSL is used to connect to database.
    sslSecretName String
    Name of the SSL secret, if TCPS with SSL is used to connect to database.
    state String
    Indicates lifecycle state of the resource.
    timeConnectionStatusUpdated String
    Time when connection status was last updated.
    timeCreated String
    Connector creation time.
    timeUpdated String
    Connector update time.

    Supporting Types

    ExternalMySqlDatabaseConnectorConnectorDetails, ExternalMySqlDatabaseConnectorConnectorDetailsArgs

    CredentialType string
    (Updatable) Type of the credential.
    DisplayName string
    (Updatable) External MySQL Database Connector Name.
    ExternalDatabaseId string
    (Updatable) OCID of MySQL Database resource.
    HostName string
    (Updatable) Host name for Connector.
    MacsAgentId string
    (Updatable) Agent Id of the MACS agent.
    NetworkProtocol string
    (Updatable) Protocol to be used to connect to External MySQL Database; TCP, TCP with SSL or Socket.
    Port int
    (Updatable) Port number to connect to External MySQL Database.
    SslSecretId string
    (Updatable) If using existing SSL secret to connect, OCID for the secret resource.
    CredentialType string
    (Updatable) Type of the credential.
    DisplayName string
    (Updatable) External MySQL Database Connector Name.
    ExternalDatabaseId string
    (Updatable) OCID of MySQL Database resource.
    HostName string
    (Updatable) Host name for Connector.
    MacsAgentId string
    (Updatable) Agent Id of the MACS agent.
    NetworkProtocol string
    (Updatable) Protocol to be used to connect to External MySQL Database; TCP, TCP with SSL or Socket.
    Port int
    (Updatable) Port number to connect to External MySQL Database.
    SslSecretId string
    (Updatable) If using existing SSL secret to connect, OCID for the secret resource.
    credentialType String
    (Updatable) Type of the credential.
    displayName String
    (Updatable) External MySQL Database Connector Name.
    externalDatabaseId String
    (Updatable) OCID of MySQL Database resource.
    hostName String
    (Updatable) Host name for Connector.
    macsAgentId String
    (Updatable) Agent Id of the MACS agent.
    networkProtocol String
    (Updatable) Protocol to be used to connect to External MySQL Database; TCP, TCP with SSL or Socket.
    port Integer
    (Updatable) Port number to connect to External MySQL Database.
    sslSecretId String
    (Updatable) If using existing SSL secret to connect, OCID for the secret resource.
    credentialType string
    (Updatable) Type of the credential.
    displayName string
    (Updatable) External MySQL Database Connector Name.
    externalDatabaseId string
    (Updatable) OCID of MySQL Database resource.
    hostName string
    (Updatable) Host name for Connector.
    macsAgentId string
    (Updatable) Agent Id of the MACS agent.
    networkProtocol string
    (Updatable) Protocol to be used to connect to External MySQL Database; TCP, TCP with SSL or Socket.
    port number
    (Updatable) Port number to connect to External MySQL Database.
    sslSecretId string
    (Updatable) If using existing SSL secret to connect, OCID for the secret resource.
    credential_type str
    (Updatable) Type of the credential.
    display_name str
    (Updatable) External MySQL Database Connector Name.
    external_database_id str
    (Updatable) OCID of MySQL Database resource.
    host_name str
    (Updatable) Host name for Connector.
    macs_agent_id str
    (Updatable) Agent Id of the MACS agent.
    network_protocol str
    (Updatable) Protocol to be used to connect to External MySQL Database; TCP, TCP with SSL or Socket.
    port int
    (Updatable) Port number to connect to External MySQL Database.
    ssl_secret_id str
    (Updatable) If using existing SSL secret to connect, OCID for the secret resource.
    credentialType String
    (Updatable) Type of the credential.
    displayName String
    (Updatable) External MySQL Database Connector Name.
    externalDatabaseId String
    (Updatable) OCID of MySQL Database resource.
    hostName String
    (Updatable) Host name for Connector.
    macsAgentId String
    (Updatable) Agent Id of the MACS agent.
    networkProtocol String
    (Updatable) Protocol to be used to connect to External MySQL Database; TCP, TCP with SSL or Socket.
    port Number
    (Updatable) Port number to connect to External MySQL Database.
    sslSecretId String
    (Updatable) If using existing SSL secret to connect, OCID for the secret resource.

    Import

    ExternalMySqlDatabaseConnectors can be imported using the id, e.g.

    $ pulumi import oci:DatabaseManagement/externalMySqlDatabaseConnector:ExternalMySqlDatabaseConnector test_external_my_sql_database_connector "id"

    To learn more about importing existing cloud resources, see Importing resources.

    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.33.0 published on Thursday, May 1, 2025 by Pulumi
    pulumi/pulumi-oci