Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DatabaseManagement
  5. CloudDbSystemConnector
Oracle Cloud Infrastructure v3.7.0 published on Saturday, Sep 13, 2025 by Pulumi
pulumi/pulumi-oci

oci.DatabaseManagement.CloudDbSystemConnector

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v3.7.0 published on Saturday, Sep 13, 2025 by Pulumi
pulumi/pulumi-oci

    This resource provides the Cloud Db System Connector resource in Oracle Cloud Infrastructure Database Management service.

    Creates a new cloud connector.

    Example Usage

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

const testCloudDbSystemConnector = new oci.databasemanagement.CloudDbSystemConnector("test_cloud_db_system_connector", {
    cloudDbSystemId: testCloudDbSystem.id,
    connectorType: cloudDbSystemConnectorConnectorType,
    displayName: cloudDbSystemConnectorDisplayName,
});

    import pulumi
import pulumi_oci as oci

test_cloud_db_system_connector = oci.databasemanagement.CloudDbSystemConnector("test_cloud_db_system_connector",
    cloud_db_system_id=test_cloud_db_system["id"],
    connector_type=cloud_db_system_connector_connector_type,
    display_name=cloud_db_system_connector_display_name)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := databasemanagement.NewCloudDbSystemConnector(ctx, "test_cloud_db_system_connector", &databasemanagement.CloudDbSystemConnectorArgs{
			CloudDbSystemId: pulumi.Any(testCloudDbSystem.Id),
			ConnectorType:   pulumi.Any(cloudDbSystemConnectorConnectorType),
			DisplayName:     pulumi.Any(cloudDbSystemConnectorDisplayName),
		})
		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 testCloudDbSystemConnector = new Oci.DatabaseManagement.CloudDbSystemConnector("test_cloud_db_system_connector", new()
    {
        CloudDbSystemId = testCloudDbSystem.Id,
        ConnectorType = cloudDbSystemConnectorConnectorType,
        DisplayName = cloudDbSystemConnectorDisplayName,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DatabaseManagement.CloudDbSystemConnector;
import com.pulumi.oci.DatabaseManagement.CloudDbSystemConnectorArgs;
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 testCloudDbSystemConnector = new CloudDbSystemConnector("testCloudDbSystemConnector", CloudDbSystemConnectorArgs.builder()
            .cloudDbSystemId(testCloudDbSystem.id())
            .connectorType(cloudDbSystemConnectorConnectorType)
            .displayName(cloudDbSystemConnectorDisplayName)
            .build());

    }
}

    resources:
  testCloudDbSystemConnector:
    type: oci:DatabaseManagement:CloudDbSystemConnector
    name: test_cloud_db_system_connector
    properties:
      cloudDbSystemId: ${testCloudDbSystem.id}
      connectorType: ${cloudDbSystemConnectorConnectorType}
      displayName: ${cloudDbSystemConnectorDisplayName}

    Create CloudDbSystemConnector Resource

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

    Constructor syntax

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

@overload
def CloudDbSystemConnector(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           cloud_db_system_id: Optional[str] = None,
                           connector_type: Optional[str] = None,
                           agent_id: Optional[str] = None,
                           connection_infos: Optional[Sequence[CloudDbSystemConnectorConnectionInfoArgs]] = None,
                           defined_tags: Optional[Mapping[str, str]] = None,
                           display_name: Optional[str] = None,
                           freeform_tags: Optional[Mapping[str, str]] = None)
    func NewCloudDbSystemConnector(ctx *Context, name string, args CloudDbSystemConnectorArgs, opts ...ResourceOption) (*CloudDbSystemConnector, error)
    public CloudDbSystemConnector(string name, CloudDbSystemConnectorArgs args, CustomResourceOptions? opts = null)
    public CloudDbSystemConnector(String name, CloudDbSystemConnectorArgs args)
public CloudDbSystemConnector(String name, CloudDbSystemConnectorArgs args, CustomResourceOptions options)

    type: oci:DatabaseManagement:CloudDbSystemConnector
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 CloudDbSystemConnectorArgs
    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 CloudDbSystemConnectorArgs
    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 CloudDbSystemConnectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CloudDbSystemConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CloudDbSystemConnectorArgs
    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 cloudDbSystemConnectorResource = new Oci.DatabaseManagement.CloudDbSystemConnector("cloudDbSystemConnectorResource", new()
{
    CloudDbSystemId = "string",
    ConnectorType = "string",
    AgentId = "string",
    ConnectionInfos = new[]
    {
        new Oci.DatabaseManagement.Inputs.CloudDbSystemConnectorConnectionInfoArgs
        {
            ComponentType = "string",
            ConnectionCredentials = new[]
            {
                new Oci.DatabaseManagement.Inputs.CloudDbSystemConnectorConnectionInfoConnectionCredentialArgs
                {
                    CredentialName = "string",
                    CredentialType = "string",
                    NamedCredentialId = "string",
                    PasswordSecretId = "string",
                    Role = "string",
                    SslSecretId = "string",
                    UserName = "string",
                },
            },
            ConnectionStrings = new[]
            {
                new Oci.DatabaseManagement.Inputs.CloudDbSystemConnectorConnectionInfoConnectionStringArgs
                {
                    HostName = "string",
                    Hosts = new[]
                    {
                        "string",
                    },
                    Port = 0,
                    Protocol = "string",
                    Service = "string",
                },
            },
        },
    },
    DefinedTags = 
    {
        { "string", "string" },
    },
    DisplayName = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
});

    example, err := databasemanagement.NewCloudDbSystemConnector(ctx, "cloudDbSystemConnectorResource", &databasemanagement.CloudDbSystemConnectorArgs{
	CloudDbSystemId: pulumi.String("string"),
	ConnectorType:   pulumi.String("string"),
	AgentId:         pulumi.String("string"),
	ConnectionInfos: databasemanagement.CloudDbSystemConnectorConnectionInfoArray{
		&databasemanagement.CloudDbSystemConnectorConnectionInfoArgs{
			ComponentType: pulumi.String("string"),
			ConnectionCredentials: databasemanagement.CloudDbSystemConnectorConnectionInfoConnectionCredentialArray{
				&databasemanagement.CloudDbSystemConnectorConnectionInfoConnectionCredentialArgs{
					CredentialName:    pulumi.String("string"),
					CredentialType:    pulumi.String("string"),
					NamedCredentialId: pulumi.String("string"),
					PasswordSecretId:  pulumi.String("string"),
					Role:              pulumi.String("string"),
					SslSecretId:       pulumi.String("string"),
					UserName:          pulumi.String("string"),
				},
			},
			ConnectionStrings: databasemanagement.CloudDbSystemConnectorConnectionInfoConnectionStringArray{
				&databasemanagement.CloudDbSystemConnectorConnectionInfoConnectionStringArgs{
					HostName: pulumi.String("string"),
					Hosts: pulumi.StringArray{
						pulumi.String("string"),
					},
					Port:     pulumi.Int(0),
					Protocol: pulumi.String("string"),
					Service:  pulumi.String("string"),
				},
			},
		},
	},
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	DisplayName: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var cloudDbSystemConnectorResource = new CloudDbSystemConnector("cloudDbSystemConnectorResource", CloudDbSystemConnectorArgs.builder()
    .cloudDbSystemId("string")
    .connectorType("string")
    .agentId("string")
    .connectionInfos(CloudDbSystemConnectorConnectionInfoArgs.builder()
        .componentType("string")
        .connectionCredentials(CloudDbSystemConnectorConnectionInfoConnectionCredentialArgs.builder()
            .credentialName("string")
            .credentialType("string")
            .namedCredentialId("string")
            .passwordSecretId("string")
            .role("string")
            .sslSecretId("string")
            .userName("string")
            .build())
        .connectionStrings(CloudDbSystemConnectorConnectionInfoConnectionStringArgs.builder()
            .hostName("string")
            .hosts("string")
            .port(0)
            .protocol("string")
            .service("string")
            .build())
        .build())
    .definedTags(Map.of("string", "string"))
    .displayName("string")
    .freeformTags(Map.of("string", "string"))
    .build());

    cloud_db_system_connector_resource = oci.databasemanagement.CloudDbSystemConnector("cloudDbSystemConnectorResource",
    cloud_db_system_id="string",
    connector_type="string",
    agent_id="string",
    connection_infos=[{
        "component_type": "string",
        "connection_credentials": [{
            "credential_name": "string",
            "credential_type": "string",
            "named_credential_id": "string",
            "password_secret_id": "string",
            "role": "string",
            "ssl_secret_id": "string",
            "user_name": "string",
        }],
        "connection_strings": [{
            "host_name": "string",
            "hosts": ["string"],
            "port": 0,
            "protocol": "string",
            "service": "string",
        }],
    }],
    defined_tags={
        "string": "string",
    },
    display_name="string",
    freeform_tags={
        "string": "string",
    })

    const cloudDbSystemConnectorResource = new oci.databasemanagement.CloudDbSystemConnector("cloudDbSystemConnectorResource", {
    cloudDbSystemId: "string",
    connectorType: "string",
    agentId: "string",
    connectionInfos: [{
        componentType: "string",
        connectionCredentials: [{
            credentialName: "string",
            credentialType: "string",
            namedCredentialId: "string",
            passwordSecretId: "string",
            role: "string",
            sslSecretId: "string",
            userName: "string",
        }],
        connectionStrings: [{
            hostName: "string",
            hosts: ["string"],
            port: 0,
            protocol: "string",
            service: "string",
        }],
    }],
    definedTags: {
        string: "string",
    },
    displayName: "string",
    freeformTags: {
        string: "string",
    },
});

    type: oci:DatabaseManagement:CloudDbSystemConnector
properties:
    agentId: string
    cloudDbSystemId: string
    connectionInfos:
        - componentType: string
          connectionCredentials:
            - credentialName: string
              credentialType: string
              namedCredentialId: string
              passwordSecretId: string
              role: string
              sslSecretId: string
              userName: string
          connectionStrings:
            - hostName: string
              hosts:
                - string
              port: 0
              protocol: string
              service: string
    connectorType: string
    definedTags:
        string: string
    displayName: string
    freeformTags:
        string: string

    CloudDbSystemConnector 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 CloudDbSystemConnector resource accepts the following input properties:

    CloudDbSystemId string
    The OCID of the cloud DB system.
    ConnectorType string
    (Updatable) The type of connector.
    AgentId string
    The OCID of the management agent used for the cloud DB system connector.
    ConnectionInfos List<CloudDbSystemConnectorConnectionInfo>
    The connection details required to connect to a cloud DB system component.
    DefinedTags Dictionary<string, string>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string

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

    ** 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

    FreeformTags Dictionary<string, string>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    CloudDbSystemId string
    The OCID of the cloud DB system.
    ConnectorType string
    (Updatable) The type of connector.
    AgentId string
    The OCID of the management agent used for the cloud DB system connector.
    ConnectionInfos []CloudDbSystemConnectorConnectionInfoArgs
    The connection details required to connect to a cloud DB system component.
    DefinedTags map[string]string
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string

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

    ** 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

    FreeformTags map[string]string
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    cloudDbSystemId String
    The OCID of the cloud DB system.
    connectorType String
    (Updatable) The type of connector.
    agentId String
    The OCID of the management agent used for the cloud DB system connector.
    connectionInfos List<CloudDbSystemConnectorConnectionInfo>
    The connection details required to connect to a cloud DB system component.
    definedTags Map<String,String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String

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

    ** 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

    freeformTags Map<String,String>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    cloudDbSystemId string
    The OCID of the cloud DB system.
    connectorType string
    (Updatable) The type of connector.
    agentId string
    The OCID of the management agent used for the cloud DB system connector.
    connectionInfos CloudDbSystemConnectorConnectionInfo[]
    The connection details required to connect to a cloud DB system component.
    definedTags {[key: string]: string}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName string

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

    ** 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

    freeformTags {[key: string]: string}
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    cloud_db_system_id str
    The OCID of the cloud DB system.
    connector_type str
    (Updatable) The type of connector.
    agent_id str
    The OCID of the management agent used for the cloud DB system connector.
    connection_infos Sequence[CloudDbSystemConnectorConnectionInfoArgs]
    The connection details required to connect to a cloud DB system component.
    defined_tags Mapping[str, str]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    display_name str

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

    ** 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

    freeform_tags Mapping[str, str]
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    cloudDbSystemId String
    The OCID of the cloud DB system.
    connectorType String
    (Updatable) The type of connector.
    agentId String
    The OCID of the management agent used for the cloud DB system connector.
    connectionInfos List<Property Map>
    The connection details required to connect to a cloud DB system component.
    definedTags Map<String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String

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

    ** 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

    freeformTags Map<String>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

    Outputs

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

    CompartmentId string
    The OCID of the compartment.
    ConnectionFailureMessage string
    The error message indicating the reason for connection failure or null if the connection was successful.
    ConnectionStatus string
    The status of connectivity to the cloud DB system component.
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    Additional information about the current lifecycle state.
    State string
    The current lifecycle state of the cloud DB system connector.
    SystemTags Dictionary<string, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeConnectionStatusLastUpdated string
    The date and time the connectionStatus of the cloud DB system connector was last updated.
    TimeCreated string
    The date and time the cloud DB system connector was created.
    TimeUpdated string
    The date and time the cloud DB system connector was last updated.
    CompartmentId string
    The OCID of the compartment.
    ConnectionFailureMessage string
    The error message indicating the reason for connection failure or null if the connection was successful.
    ConnectionStatus string
    The status of connectivity to the cloud DB system component.
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    Additional information about the current lifecycle state.
    State string
    The current lifecycle state of the cloud DB system connector.
    SystemTags map[string]string
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeConnectionStatusLastUpdated string
    The date and time the connectionStatus of the cloud DB system connector was last updated.
    TimeCreated string
    The date and time the cloud DB system connector was created.
    TimeUpdated string
    The date and time the cloud DB system connector was last updated.
    compartmentId String
    The OCID of the compartment.
    connectionFailureMessage String
    The error message indicating the reason for connection failure or null if the connection was successful.
    connectionStatus String
    The status of connectivity to the cloud DB system component.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    Additional information about the current lifecycle state.
    state String
    The current lifecycle state of the cloud DB system connector.
    systemTags Map<String,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeConnectionStatusLastUpdated String
    The date and time the connectionStatus of the cloud DB system connector was last updated.
    timeCreated String
    The date and time the cloud DB system connector was created.
    timeUpdated String
    The date and time the cloud DB system connector was last updated.
    compartmentId string
    The OCID of the compartment.
    connectionFailureMessage string
    The error message indicating the reason for connection failure or null if the connection was successful.
    connectionStatus string
    The status of connectivity to the cloud DB system component.
    id string
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails string
    Additional information about the current lifecycle state.
    state string
    The current lifecycle state of the cloud DB system connector.
    systemTags {[key: string]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeConnectionStatusLastUpdated string
    The date and time the connectionStatus of the cloud DB system connector was last updated.
    timeCreated string
    The date and time the cloud DB system connector was created.
    timeUpdated string
    The date and time the cloud DB system connector was last updated.
    compartment_id str
    The OCID of the compartment.
    connection_failure_message str
    The error message indicating the reason for connection failure or null if the connection was successful.
    connection_status str
    The status of connectivity to the cloud DB system component.
    id str
    The provider-assigned unique ID for this managed resource.
    lifecycle_details str
    Additional information about the current lifecycle state.
    state str
    The current lifecycle state of the cloud DB system connector.
    system_tags Mapping[str, str]
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_connection_status_last_updated str
    The date and time the connectionStatus of the cloud DB system connector was last updated.
    time_created str
    The date and time the cloud DB system connector was created.
    time_updated str
    The date and time the cloud DB system connector was last updated.
    compartmentId String
    The OCID of the compartment.
    connectionFailureMessage String
    The error message indicating the reason for connection failure or null if the connection was successful.
    connectionStatus String
    The status of connectivity to the cloud DB system component.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    Additional information about the current lifecycle state.
    state String
    The current lifecycle state of the cloud DB system connector.
    systemTags Map<String>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeConnectionStatusLastUpdated String
    The date and time the connectionStatus of the cloud DB system connector was last updated.
    timeCreated String
    The date and time the cloud DB system connector was created.
    timeUpdated String
    The date and time the cloud DB system connector was last updated.

    Look up Existing CloudDbSystemConnector Resource

    Get an existing CloudDbSystemConnector 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?: CloudDbSystemConnectorState, opts?: CustomResourceOptions): CloudDbSystemConnector
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        agent_id: Optional[str] = None,
        cloud_db_system_id: Optional[str] = None,
        compartment_id: Optional[str] = None,
        connection_failure_message: Optional[str] = None,
        connection_infos: Optional[Sequence[CloudDbSystemConnectorConnectionInfoArgs]] = None,
        connection_status: Optional[str] = None,
        connector_type: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        lifecycle_details: Optional[str] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        time_connection_status_last_updated: Optional[str] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None) -> CloudDbSystemConnector
    func GetCloudDbSystemConnector(ctx *Context, name string, id IDInput, state *CloudDbSystemConnectorState, opts ...ResourceOption) (*CloudDbSystemConnector, error)
    public static CloudDbSystemConnector Get(string name, Input<string> id, CloudDbSystemConnectorState? state, CustomResourceOptions? opts = null)
    public static CloudDbSystemConnector get(String name, Output<String> id, CloudDbSystemConnectorState state, CustomResourceOptions options)
    resources:  _:    type: oci:DatabaseManagement:CloudDbSystemConnector    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:
    AgentId string
    The OCID of the management agent used for the cloud DB system connector.
    CloudDbSystemId string
    The OCID of the cloud DB system.
    CompartmentId string
    The OCID of the compartment.
    ConnectionFailureMessage string
    The error message indicating the reason for connection failure or null if the connection was successful.
    ConnectionInfos List<CloudDbSystemConnectorConnectionInfo>
    The connection details required to connect to a cloud DB system component.
    ConnectionStatus string
    The status of connectivity to the cloud DB system component.
    ConnectorType string
    (Updatable) The type of connector.
    DefinedTags Dictionary<string, string>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string

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

    ** 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

    FreeformTags Dictionary<string, string>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    LifecycleDetails string
    Additional information about the current lifecycle state.
    State string
    The current lifecycle state of the cloud DB system connector.
    SystemTags Dictionary<string, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeConnectionStatusLastUpdated string
    The date and time the connectionStatus of the cloud DB system connector was last updated.
    TimeCreated string
    The date and time the cloud DB system connector was created.
    TimeUpdated string
    The date and time the cloud DB system connector was last updated.
    AgentId string
    The OCID of the management agent used for the cloud DB system connector.
    CloudDbSystemId string
    The OCID of the cloud DB system.
    CompartmentId string
    The OCID of the compartment.
    ConnectionFailureMessage string
    The error message indicating the reason for connection failure or null if the connection was successful.
    ConnectionInfos []CloudDbSystemConnectorConnectionInfoArgs
    The connection details required to connect to a cloud DB system component.
    ConnectionStatus string
    The status of connectivity to the cloud DB system component.
    ConnectorType string
    (Updatable) The type of connector.
    DefinedTags map[string]string
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string

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

    ** 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

    FreeformTags map[string]string
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    LifecycleDetails string
    Additional information about the current lifecycle state.
    State string
    The current lifecycle state of the cloud DB system connector.
    SystemTags map[string]string
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeConnectionStatusLastUpdated string
    The date and time the connectionStatus of the cloud DB system connector was last updated.
    TimeCreated string
    The date and time the cloud DB system connector was created.
    TimeUpdated string
    The date and time the cloud DB system connector was last updated.
    agentId String
    The OCID of the management agent used for the cloud DB system connector.
    cloudDbSystemId String
    The OCID of the cloud DB system.
    compartmentId String
    The OCID of the compartment.
    connectionFailureMessage String
    The error message indicating the reason for connection failure or null if the connection was successful.
    connectionInfos List<CloudDbSystemConnectorConnectionInfo>
    The connection details required to connect to a cloud DB system component.
    connectionStatus String
    The status of connectivity to the cloud DB system component.
    connectorType String
    (Updatable) The type of connector.
    definedTags Map<String,String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String

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

    ** 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

    freeformTags Map<String,String>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    lifecycleDetails String
    Additional information about the current lifecycle state.
    state String
    The current lifecycle state of the cloud DB system connector.
    systemTags Map<String,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeConnectionStatusLastUpdated String
    The date and time the connectionStatus of the cloud DB system connector was last updated.
    timeCreated String
    The date and time the cloud DB system connector was created.
    timeUpdated String
    The date and time the cloud DB system connector was last updated.
    agentId string
    The OCID of the management agent used for the cloud DB system connector.
    cloudDbSystemId string
    The OCID of the cloud DB system.
    compartmentId string
    The OCID of the compartment.
    connectionFailureMessage string
    The error message indicating the reason for connection failure or null if the connection was successful.
    connectionInfos CloudDbSystemConnectorConnectionInfo[]
    The connection details required to connect to a cloud DB system component.
    connectionStatus string
    The status of connectivity to the cloud DB system component.
    connectorType string
    (Updatable) The type of connector.
    definedTags {[key: string]: string}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName string

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

    ** 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

    freeformTags {[key: string]: string}
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    lifecycleDetails string
    Additional information about the current lifecycle state.
    state string
    The current lifecycle state of the cloud DB system connector.
    systemTags {[key: string]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeConnectionStatusLastUpdated string
    The date and time the connectionStatus of the cloud DB system connector was last updated.
    timeCreated string
    The date and time the cloud DB system connector was created.
    timeUpdated string
    The date and time the cloud DB system connector was last updated.
    agent_id str
    The OCID of the management agent used for the cloud DB system connector.
    cloud_db_system_id str
    The OCID of the cloud DB system.
    compartment_id str
    The OCID of the compartment.
    connection_failure_message str
    The error message indicating the reason for connection failure or null if the connection was successful.
    connection_infos Sequence[CloudDbSystemConnectorConnectionInfoArgs]
    The connection details required to connect to a cloud DB system component.
    connection_status str
    The status of connectivity to the cloud DB system component.
    connector_type str
    (Updatable) The type of connector.
    defined_tags Mapping[str, str]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    display_name str

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

    ** 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

    freeform_tags Mapping[str, str]
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    lifecycle_details str
    Additional information about the current lifecycle state.
    state str
    The current lifecycle state of the cloud DB system connector.
    system_tags Mapping[str, str]
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_connection_status_last_updated str
    The date and time the connectionStatus of the cloud DB system connector was last updated.
    time_created str
    The date and time the cloud DB system connector was created.
    time_updated str
    The date and time the cloud DB system connector was last updated.
    agentId String
    The OCID of the management agent used for the cloud DB system connector.
    cloudDbSystemId String
    The OCID of the cloud DB system.
    compartmentId String
    The OCID of the compartment.
    connectionFailureMessage String
    The error message indicating the reason for connection failure or null if the connection was successful.
    connectionInfos List<Property Map>
    The connection details required to connect to a cloud DB system component.
    connectionStatus String
    The status of connectivity to the cloud DB system component.
    connectorType String
    (Updatable) The type of connector.
    definedTags Map<String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String

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

    ** 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

    freeformTags Map<String>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    lifecycleDetails String
    Additional information about the current lifecycle state.
    state String
    The current lifecycle state of the cloud DB system connector.
    systemTags Map<String>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeConnectionStatusLastUpdated String
    The date and time the connectionStatus of the cloud DB system connector was last updated.
    timeCreated String
    The date and time the cloud DB system connector was created.
    timeUpdated String
    The date and time the cloud DB system connector was last updated.

    Supporting Types

    CloudDbSystemConnectorConnectionInfo, CloudDbSystemConnectorConnectionInfoArgs

    ComponentType string
    The component type.
    ConnectionCredentials List<CloudDbSystemConnectorConnectionInfoConnectionCredential>
    The credentials used to connect to the Cloud ASM instance. Currently only the DETAILS type is supported for creating MACS connector credentials.
    ConnectionStrings List<CloudDbSystemConnectorConnectionInfoConnectionString>
    The Oracle Database connection string.
    ComponentType string
    The component type.
    ConnectionCredentials []CloudDbSystemConnectorConnectionInfoConnectionCredential
    The credentials used to connect to the Cloud ASM instance. Currently only the DETAILS type is supported for creating MACS connector credentials.
    ConnectionStrings []CloudDbSystemConnectorConnectionInfoConnectionString
    The Oracle Database connection string.
    componentType String
    The component type.
    connectionCredentials List<CloudDbSystemConnectorConnectionInfoConnectionCredential>
    The credentials used to connect to the Cloud ASM instance. Currently only the DETAILS type is supported for creating MACS connector credentials.
    connectionStrings List<CloudDbSystemConnectorConnectionInfoConnectionString>
    The Oracle Database connection string.
    componentType string
    The component type.
    connectionCredentials CloudDbSystemConnectorConnectionInfoConnectionCredential[]
    The credentials used to connect to the Cloud ASM instance. Currently only the DETAILS type is supported for creating MACS connector credentials.
    connectionStrings CloudDbSystemConnectorConnectionInfoConnectionString[]
    The Oracle Database connection string.
    component_type str
    The component type.
    connection_credentials Sequence[CloudDbSystemConnectorConnectionInfoConnectionCredential]
    The credentials used to connect to the Cloud ASM instance. Currently only the DETAILS type is supported for creating MACS connector credentials.
    connection_strings Sequence[CloudDbSystemConnectorConnectionInfoConnectionString]
    The Oracle Database connection string.
    componentType String
    The component type.
    connectionCredentials List<Property Map>
    The credentials used to connect to the Cloud ASM instance. Currently only the DETAILS type is supported for creating MACS connector credentials.
    connectionStrings List<Property Map>
    The Oracle Database connection string.

    CloudDbSystemConnectorConnectionInfoConnectionCredential, CloudDbSystemConnectorConnectionInfoConnectionCredentialArgs

    CredentialName string
    The name of the credential information that used to connect to the DB system resource. 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 ASM instance.
    NamedCredentialId string
    The OCID of the Named Credential where the database password metadata is stored.
    PasswordSecretId string
    The OCID of the secret containing the user password.
    Role string
    The role of the user connecting to the ASM instance.
    SslSecretId string
    The OCID of the secret containing the SSL keystore and truststore details.
    UserName string
    The user name used to connect to the ASM instance.
    CredentialName string
    The name of the credential information that used to connect to the DB system resource. 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 ASM instance.
    NamedCredentialId string
    The OCID of the Named Credential where the database password metadata is stored.
    PasswordSecretId string
    The OCID of the secret containing the user password.
    Role string
    The role of the user connecting to the ASM instance.
    SslSecretId string
    The OCID of the secret containing the SSL keystore and truststore details.
    UserName string
    The user name used to connect to the ASM instance.
    credentialName String
    The name of the credential information that used to connect to the DB system resource. 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 ASM instance.
    namedCredentialId String
    The OCID of the Named Credential where the database password metadata is stored.
    passwordSecretId String
    The OCID of the secret containing the user password.
    role String
    The role of the user connecting to the ASM instance.
    sslSecretId String
    The OCID of the secret containing the SSL keystore and truststore details.
    userName String
    The user name used to connect to the ASM instance.
    credentialName string
    The name of the credential information that used to connect to the DB system resource. 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 ASM instance.
    namedCredentialId string
    The OCID of the Named Credential where the database password metadata is stored.
    passwordSecretId string
    The OCID of the secret containing the user password.
    role string
    The role of the user connecting to the ASM instance.
    sslSecretId string
    The OCID of the secret containing the SSL keystore and truststore details.
    userName string
    The user name used to connect to the ASM instance.
    credential_name str
    The name of the credential information that used to connect to the DB system resource. 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 ASM instance.
    named_credential_id str
    The OCID of the Named Credential where the database password metadata is stored.
    password_secret_id str
    The OCID of the secret containing the user password.
    role str
    The role of the user connecting to the ASM instance.
    ssl_secret_id str
    The OCID of the secret containing the SSL keystore and truststore details.
    user_name str
    The user name used to connect to the ASM instance.
    credentialName String
    The name of the credential information that used to connect to the DB system resource. 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 ASM instance.
    namedCredentialId String
    The OCID of the Named Credential where the database password metadata is stored.
    passwordSecretId String
    The OCID of the secret containing the user password.
    role String
    The role of the user connecting to the ASM instance.
    sslSecretId String
    The OCID of the secret containing the SSL keystore and truststore details.
    userName String
    The user name used to connect to the ASM instance.

    CloudDbSystemConnectorConnectionInfoConnectionString, CloudDbSystemConnectorConnectionInfoConnectionStringArgs

    HostName string
    The host name of the database or the SCAN name in case of a RAC database.
    Hosts List<string>
    The list of host names of the ASM instances.
    Port int
    The port used to connect to the ASM instance.
    Protocol string
    The protocol used to connect to the ASM instance.
    Service string
    The service name of the ASM instance.
    HostName string
    The host name of the database or the SCAN name in case of a RAC database.
    Hosts []string
    The list of host names of the ASM instances.
    Port int
    The port used to connect to the ASM instance.
    Protocol string
    The protocol used to connect to the ASM instance.
    Service string
    The service name of the ASM instance.
    hostName String
    The host name of the database or the SCAN name in case of a RAC database.
    hosts List<String>
    The list of host names of the ASM instances.
    port Integer
    The port used to connect to the ASM instance.
    protocol String
    The protocol used to connect to the ASM instance.
    service String
    The service name of the ASM instance.
    hostName string
    The host name of the database or the SCAN name in case of a RAC database.
    hosts string[]
    The list of host names of the ASM instances.
    port number
    The port used to connect to the ASM instance.
    protocol string
    The protocol used to connect to the ASM instance.
    service string
    The service name of the ASM instance.
    host_name str
    The host name of the database or the SCAN name in case of a RAC database.
    hosts Sequence[str]
    The list of host names of the ASM instances.
    port int
    The port used to connect to the ASM instance.
    protocol str
    The protocol used to connect to the ASM instance.
    service str
    The service name of the ASM instance.
    hostName String
    The host name of the database or the SCAN name in case of a RAC database.
    hosts List<String>
    The list of host names of the ASM instances.
    port Number
    The port used to connect to the ASM instance.
    protocol String
    The protocol used to connect to the ASM instance.
    service String
    The service name of the ASM instance.

    Import

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

    $ pulumi import oci:DatabaseManagement/cloudDbSystemConnector:CloudDbSystemConnector test_cloud_db_system_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 v3.7.0 published on Saturday, Sep 13, 2025 by Pulumi
    pulumi/pulumi-oci