Docs Packages
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DatabaseManagement
  5. ExternalDbSystemConnector
Oracle Cloud Infrastructure v1.32.0 published on Thursday, Apr 18, 2024 by Pulumi
pulumi/pulumi-oci

oci.DatabaseManagement.ExternalDbSystemConnector

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.32.0 published on Thursday, Apr 18, 2024 by Pulumi
pulumi/pulumi-oci

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

    Creates a new external connector.

    Example Usage

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

const testExternalDbSystemConnector = new oci.databasemanagement.ExternalDbSystemConnector("testExternalDbSystemConnector", {
    connectorType: _var.external_db_system_connector_connector_type,
    externalDbSystemId: oci_database_management_external_db_system.test_external_db_system.id,
    displayName: _var.external_db_system_connector_display_name,
});

    import pulumi
import pulumi_oci as oci

test_external_db_system_connector = oci.database_management.ExternalDbSystemConnector("testExternalDbSystemConnector",
    connector_type=var["external_db_system_connector_connector_type"],
    external_db_system_id=oci_database_management_external_db_system["test_external_db_system"]["id"],
    display_name=var["external_db_system_connector_display_name"])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := DatabaseManagement.NewExternalDbSystemConnector(ctx, "testExternalDbSystemConnector", &DatabaseManagement.ExternalDbSystemConnectorArgs{
			ConnectorType:      pulumi.Any(_var.External_db_system_connector_connector_type),
			ExternalDbSystemId: pulumi.Any(oci_database_management_external_db_system.Test_external_db_system.Id),
			DisplayName:        pulumi.Any(_var.External_db_system_connector_display_name),
		})
		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 testExternalDbSystemConnector = new Oci.DatabaseManagement.ExternalDbSystemConnector("testExternalDbSystemConnector", new()
    {
        ConnectorType = @var.External_db_system_connector_connector_type,
        ExternalDbSystemId = oci_database_management_external_db_system.Test_external_db_system.Id,
        DisplayName = @var.External_db_system_connector_display_name,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DatabaseManagement.ExternalDbSystemConnector;
import com.pulumi.oci.DatabaseManagement.ExternalDbSystemConnectorArgs;
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 testExternalDbSystemConnector = new ExternalDbSystemConnector("testExternalDbSystemConnector", ExternalDbSystemConnectorArgs.builder()        
            .connectorType(var_.external_db_system_connector_connector_type())
            .externalDbSystemId(oci_database_management_external_db_system.test_external_db_system().id())
            .displayName(var_.external_db_system_connector_display_name())
            .build());

    }
}

    resources:
  testExternalDbSystemConnector:
    type: oci:DatabaseManagement:ExternalDbSystemConnector
    properties:
      #Required
      connectorType: ${var.external_db_system_connector_connector_type}
      externalDbSystemId: ${oci_database_management_external_db_system.test_external_db_system.id}
      #Optional
      displayName: ${var.external_db_system_connector_display_name}

    Create ExternalDbSystemConnector Resource

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

    Constructor syntax

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

@overload
def ExternalDbSystemConnector(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              connector_type: Optional[str] = None,
                              external_db_system_id: Optional[str] = None,
                              agent_id: Optional[str] = None,
                              connection_infos: Optional[Sequence[_databasemanagement.ExternalDbSystemConnectorConnectionInfoArgs]] = None,
                              defined_tags: Optional[Mapping[str, Any]] = None,
                              display_name: Optional[str] = None,
                              freeform_tags: Optional[Mapping[str, Any]] = None)
    func NewExternalDbSystemConnector(ctx *Context, name string, args ExternalDbSystemConnectorArgs, opts ...ResourceOption) (*ExternalDbSystemConnector, error)
    public ExternalDbSystemConnector(string name, ExternalDbSystemConnectorArgs args, CustomResourceOptions? opts = null)
    public ExternalDbSystemConnector(String name, ExternalDbSystemConnectorArgs args)
public ExternalDbSystemConnector(String name, ExternalDbSystemConnectorArgs args, CustomResourceOptions options)

    type: oci:DatabaseManagement:ExternalDbSystemConnector
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 ExternalDbSystemConnectorArgs
    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 ExternalDbSystemConnectorArgs
    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 ExternalDbSystemConnectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ExternalDbSystemConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ExternalDbSystemConnectorArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var externalDbSystemConnectorResource = new Oci.DatabaseManagement.ExternalDbSystemConnector("externalDbSystemConnectorResource", new()
{
    ConnectorType = "string",
    ExternalDbSystemId = "string",
    AgentId = "string",
    ConnectionInfos = new[]
    {
        new Oci.DatabaseManagement.Inputs.ExternalDbSystemConnectorConnectionInfoArgs
        {
            ComponentType = "string",
            ConnectionCredentials = new[]
            {
                new Oci.DatabaseManagement.Inputs.ExternalDbSystemConnectorConnectionInfoConnectionCredentialArgs
                {
                    CredentialName = "string",
                    CredentialType = "string",
                    PasswordSecretId = "string",
                    Role = "string",
                    SslSecretId = "string",
                    UserName = "string",
                },
            },
            ConnectionStrings = new[]
            {
                new Oci.DatabaseManagement.Inputs.ExternalDbSystemConnectorConnectionInfoConnectionStringArgs
                {
                    HostName = "string",
                    Hosts = new[]
                    {
                        "string",
                    },
                    Port = 0,
                    Protocol = "string",
                    Service = "string",
                },
            },
            DatabaseCredentials = new[]
            {
                new Oci.DatabaseManagement.Inputs.ExternalDbSystemConnectorConnectionInfoDatabaseCredentialArgs
                {
                    CredentialType = "string",
                    NamedCredentialId = "string",
                    Password = "string",
                    PasswordSecretId = "string",
                    Role = "string",
                    Username = "string",
                },
            },
        },
    },
    DefinedTags = 
    {
        { "string", "any" },
    },
    DisplayName = "string",
    FreeformTags = 
    {
        { "string", "any" },
    },
});

    example, err := DatabaseManagement.NewExternalDbSystemConnector(ctx, "externalDbSystemConnectorResource", &DatabaseManagement.ExternalDbSystemConnectorArgs{
	ConnectorType:      pulumi.String("string"),
	ExternalDbSystemId: pulumi.String("string"),
	AgentId:            pulumi.String("string"),
	ConnectionInfos: databasemanagement.ExternalDbSystemConnectorConnectionInfoArray{
		&databasemanagement.ExternalDbSystemConnectorConnectionInfoArgs{
			ComponentType: pulumi.String("string"),
			ConnectionCredentials: databasemanagement.ExternalDbSystemConnectorConnectionInfoConnectionCredentialArray{
				&databasemanagement.ExternalDbSystemConnectorConnectionInfoConnectionCredentialArgs{
					CredentialName:   pulumi.String("string"),
					CredentialType:   pulumi.String("string"),
					PasswordSecretId: pulumi.String("string"),
					Role:             pulumi.String("string"),
					SslSecretId:      pulumi.String("string"),
					UserName:         pulumi.String("string"),
				},
			},
			ConnectionStrings: databasemanagement.ExternalDbSystemConnectorConnectionInfoConnectionStringArray{
				&databasemanagement.ExternalDbSystemConnectorConnectionInfoConnectionStringArgs{
					HostName: pulumi.String("string"),
					Hosts: pulumi.StringArray{
						pulumi.String("string"),
					},
					Port:     pulumi.Int(0),
					Protocol: pulumi.String("string"),
					Service:  pulumi.String("string"),
				},
			},
			DatabaseCredentials: databasemanagement.ExternalDbSystemConnectorConnectionInfoDatabaseCredentialArray{
				&databasemanagement.ExternalDbSystemConnectorConnectionInfoDatabaseCredentialArgs{
					CredentialType:    pulumi.String("string"),
					NamedCredentialId: pulumi.String("string"),
					Password:          pulumi.String("string"),
					PasswordSecretId:  pulumi.String("string"),
					Role:              pulumi.String("string"),
					Username:          pulumi.String("string"),
				},
			},
		},
	},
	DefinedTags: pulumi.Map{
		"string": pulumi.Any("any"),
	},
	DisplayName: pulumi.String("string"),
	FreeformTags: pulumi.Map{
		"string": pulumi.Any("any"),
	},
})

    var externalDbSystemConnectorResource = new ExternalDbSystemConnector("externalDbSystemConnectorResource", ExternalDbSystemConnectorArgs.builder()        
    .connectorType("string")
    .externalDbSystemId("string")
    .agentId("string")
    .connectionInfos(ExternalDbSystemConnectorConnectionInfoArgs.builder()
        .componentType("string")
        .connectionCredentials(ExternalDbSystemConnectorConnectionInfoConnectionCredentialArgs.builder()
            .credentialName("string")
            .credentialType("string")
            .passwordSecretId("string")
            .role("string")
            .sslSecretId("string")
            .userName("string")
            .build())
        .connectionStrings(ExternalDbSystemConnectorConnectionInfoConnectionStringArgs.builder()
            .hostName("string")
            .hosts("string")
            .port(0)
            .protocol("string")
            .service("string")
            .build())
        .databaseCredentials(ExternalDbSystemConnectorConnectionInfoDatabaseCredentialArgs.builder()
            .credentialType("string")
            .namedCredentialId("string")
            .password("string")
            .passwordSecretId("string")
            .role("string")
            .username("string")
            .build())
        .build())
    .definedTags(Map.of("string", "any"))
    .displayName("string")
    .freeformTags(Map.of("string", "any"))
    .build());

    external_db_system_connector_resource = oci.database_management.ExternalDbSystemConnector("externalDbSystemConnectorResource",
    connector_type="string",
    external_db_system_id="string",
    agent_id="string",
    connection_infos=[oci.database_management.ExternalDbSystemConnectorConnectionInfoArgs(
        component_type="string",
        connection_credentials=[oci.database_management.ExternalDbSystemConnectorConnectionInfoConnectionCredentialArgs(
            credential_name="string",
            credential_type="string",
            password_secret_id="string",
            role="string",
            ssl_secret_id="string",
            user_name="string",
        )],
        connection_strings=[oci.database_management.ExternalDbSystemConnectorConnectionInfoConnectionStringArgs(
            host_name="string",
            hosts=["string"],
            port=0,
            protocol="string",
            service="string",
        )],
        database_credentials=[oci.database_management.ExternalDbSystemConnectorConnectionInfoDatabaseCredentialArgs(
            credential_type="string",
            named_credential_id="string",
            password="string",
            password_secret_id="string",
            role="string",
            username="string",
        )],
    )],
    defined_tags={
        "string": "any",
    },
    display_name="string",
    freeform_tags={
        "string": "any",
    })

    const externalDbSystemConnectorResource = new oci.databasemanagement.ExternalDbSystemConnector("externalDbSystemConnectorResource", {
    connectorType: "string",
    externalDbSystemId: "string",
    agentId: "string",
    connectionInfos: [{
        componentType: "string",
        connectionCredentials: [{
            credentialName: "string",
            credentialType: "string",
            passwordSecretId: "string",
            role: "string",
            sslSecretId: "string",
            userName: "string",
        }],
        connectionStrings: [{
            hostName: "string",
            hosts: ["string"],
            port: 0,
            protocol: "string",
            service: "string",
        }],
        databaseCredentials: [{
            credentialType: "string",
            namedCredentialId: "string",
            password: "string",
            passwordSecretId: "string",
            role: "string",
            username: "string",
        }],
    }],
    definedTags: {
        string: "any",
    },
    displayName: "string",
    freeformTags: {
        string: "any",
    },
});

    type: oci:DatabaseManagement:ExternalDbSystemConnector
properties:
    agentId: string
    connectionInfos:
        - componentType: string
          connectionCredentials:
            - credentialName: string
              credentialType: string
              passwordSecretId: string
              role: string
              sslSecretId: string
              userName: string
          connectionStrings:
            - hostName: string
              hosts:
                - string
              port: 0
              protocol: string
              service: string
          databaseCredentials:
            - credentialType: string
              namedCredentialId: string
              password: string
              passwordSecretId: string
              role: string
              username: string
    connectorType: string
    definedTags:
        string: any
    displayName: string
    externalDbSystemId: string
    freeformTags:
        string: any

    ExternalDbSystemConnector Resource Properties

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

    Inputs

    The ExternalDbSystemConnector resource accepts the following input properties:

    ConnectorType string
    (Updatable) The type of connector.
    ExternalDbSystemId string

    The OCID of the external DB system.

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

    AgentId string
    The OCID of the management agent used for the external DB system connector.
    ConnectionInfos List<ExternalDbSystemConnectorConnectionInfo>
    The connection details required to connect to an external DB system component.
    DefinedTags Dictionary<string, object>
    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 external connector. The name does not have to be unique.
    FreeformTags Dictionary<string, object>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    ConnectorType string
    (Updatable) The type of connector.
    ExternalDbSystemId string

    The OCID of the external DB system.

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

    AgentId string
    The OCID of the management agent used for the external DB system connector.
    ConnectionInfos []ExternalDbSystemConnectorConnectionInfoArgs
    The connection details required to connect to an external DB system component.
    DefinedTags map[string]interface{}
    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 external connector. The name does not have to be unique.
    FreeformTags map[string]interface{}
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    connectorType String
    (Updatable) The type of connector.
    externalDbSystemId String

    The OCID of the external DB system.

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

    agentId String
    The OCID of the management agent used for the external DB system connector.
    connectionInfos List<ExternalDbSystemConnectorConnectionInfo>
    The connection details required to connect to an external DB system component.
    definedTags Map<String,Object>
    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 external connector. The name does not have to be unique.
    freeformTags Map<String,Object>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    connectorType string
    (Updatable) The type of connector.
    externalDbSystemId string

    The OCID of the external DB system.

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

    agentId string
    The OCID of the management agent used for the external DB system connector.
    connectionInfos ExternalDbSystemConnectorConnectionInfo[]
    The connection details required to connect to an external DB system component.
    definedTags {[key: string]: any}
    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 external connector. The name does not have to be unique.
    freeformTags {[key: string]: any}
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    connector_type str
    (Updatable) The type of connector.
    external_db_system_id str

    The OCID of the external DB system.

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

    agent_id str
    The OCID of the management agent used for the external DB system connector.
    connection_infos Sequence[databasemanagement.ExternalDbSystemConnectorConnectionInfoArgs]
    The connection details required to connect to an external DB system component.
    defined_tags Mapping[str, Any]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    display_name str
    The user-friendly name for the external connector. The name does not have to be unique.
    freeform_tags Mapping[str, Any]
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    connectorType String
    (Updatable) The type of connector.
    externalDbSystemId String

    The OCID of the external DB system.

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

    agentId String
    The OCID of the management agent used for the external DB system connector.
    connectionInfos List<Property Map>
    The connection details required to connect to an external DB system component.
    definedTags Map<Any>
    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 external connector. The name does not have to be unique.
    freeformTags Map<Any>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ExternalDbSystemConnector 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 external 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 external DB system connector.
    TimeConnectionStatusLastUpdated string
    The date and time the connectionStatus of the external DB system connector was last updated.
    TimeCreated string
    The date and time the external DB system connector was created.
    TimeUpdated string
    The date and time the external 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 external 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 external DB system connector.
    TimeConnectionStatusLastUpdated string
    The date and time the connectionStatus of the external DB system connector was last updated.
    TimeCreated string
    The date and time the external DB system connector was created.
    TimeUpdated string
    The date and time the external 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 external 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 external DB system connector.
    timeConnectionStatusLastUpdated String
    The date and time the connectionStatus of the external DB system connector was last updated.
    timeCreated String
    The date and time the external DB system connector was created.
    timeUpdated String
    The date and time the external 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 external 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 external DB system connector.
    timeConnectionStatusLastUpdated string
    The date and time the connectionStatus of the external DB system connector was last updated.
    timeCreated string
    The date and time the external DB system connector was created.
    timeUpdated string
    The date and time the external 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 external 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 external DB system connector.
    time_connection_status_last_updated str
    The date and time the connectionStatus of the external DB system connector was last updated.
    time_created str
    The date and time the external DB system connector was created.
    time_updated str
    The date and time the external 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 external 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 external DB system connector.
    timeConnectionStatusLastUpdated String
    The date and time the connectionStatus of the external DB system connector was last updated.
    timeCreated String
    The date and time the external DB system connector was created.
    timeUpdated String
    The date and time the external DB system connector was last updated.

    Look up Existing ExternalDbSystemConnector Resource

    Get an existing ExternalDbSystemConnector 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?: ExternalDbSystemConnectorState, opts?: CustomResourceOptions): ExternalDbSystemConnector
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        agent_id: Optional[str] = None,
        compartment_id: Optional[str] = None,
        connection_failure_message: Optional[str] = None,
        connection_infos: Optional[Sequence[_databasemanagement.ExternalDbSystemConnectorConnectionInfoArgs]] = None,
        connection_status: Optional[str] = None,
        connector_type: Optional[str] = None,
        defined_tags: Optional[Mapping[str, Any]] = None,
        display_name: Optional[str] = None,
        external_db_system_id: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, Any]] = None,
        lifecycle_details: Optional[str] = None,
        state: Optional[str] = None,
        time_connection_status_last_updated: Optional[str] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None) -> ExternalDbSystemConnector
    func GetExternalDbSystemConnector(ctx *Context, name string, id IDInput, state *ExternalDbSystemConnectorState, opts ...ResourceOption) (*ExternalDbSystemConnector, error)
    public static ExternalDbSystemConnector Get(string name, Input<string> id, ExternalDbSystemConnectorState? state, CustomResourceOptions? opts = null)
    public static ExternalDbSystemConnector get(String name, Output<String> id, ExternalDbSystemConnectorState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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 external DB system connector.
    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<ExternalDbSystemConnectorConnectionInfo>
    The connection details required to connect to an external DB system component.
    ConnectionStatus string
    The status of connectivity to the external DB system component.
    ConnectorType string
    (Updatable) The type of connector.
    DefinedTags Dictionary<string, object>
    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 external connector. The name does not have to be unique.
    ExternalDbSystemId string

    The OCID of the external DB system.

    ** 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, object>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    LifecycleDetails string
    Additional information about the current lifecycle state.
    State string
    The current lifecycle state of the external DB system connector.
    TimeConnectionStatusLastUpdated string
    The date and time the connectionStatus of the external DB system connector was last updated.
    TimeCreated string
    The date and time the external DB system connector was created.
    TimeUpdated string
    The date and time the external DB system connector was last updated.
    AgentId string
    The OCID of the management agent used for the external DB system connector.
    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 []ExternalDbSystemConnectorConnectionInfoArgs
    The connection details required to connect to an external DB system component.
    ConnectionStatus string
    The status of connectivity to the external DB system component.
    ConnectorType string
    (Updatable) The type of connector.
    DefinedTags map[string]interface{}
    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 external connector. The name does not have to be unique.
    ExternalDbSystemId string

    The OCID of the external DB system.

    ** 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]interface{}
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    LifecycleDetails string
    Additional information about the current lifecycle state.
    State string
    The current lifecycle state of the external DB system connector.
    TimeConnectionStatusLastUpdated string
    The date and time the connectionStatus of the external DB system connector was last updated.
    TimeCreated string
    The date and time the external DB system connector was created.
    TimeUpdated string
    The date and time the external DB system connector was last updated.
    agentId String
    The OCID of the management agent used for the external DB system connector.
    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<ExternalDbSystemConnectorConnectionInfo>
    The connection details required to connect to an external DB system component.
    connectionStatus String
    The status of connectivity to the external DB system component.
    connectorType String
    (Updatable) The type of connector.
    definedTags Map<String,Object>
    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 external connector. The name does not have to be unique.
    externalDbSystemId String

    The OCID of the external DB system.

    ** 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,Object>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    lifecycleDetails String
    Additional information about the current lifecycle state.
    state String
    The current lifecycle state of the external DB system connector.
    timeConnectionStatusLastUpdated String
    The date and time the connectionStatus of the external DB system connector was last updated.
    timeCreated String
    The date and time the external DB system connector was created.
    timeUpdated String
    The date and time the external DB system connector was last updated.
    agentId string
    The OCID of the management agent used for the external DB system connector.
    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 ExternalDbSystemConnectorConnectionInfo[]
    The connection details required to connect to an external DB system component.
    connectionStatus string
    The status of connectivity to the external DB system component.
    connectorType string
    (Updatable) The type of connector.
    definedTags {[key: string]: any}
    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 external connector. The name does not have to be unique.
    externalDbSystemId string

    The OCID of the external DB system.

    ** 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]: any}
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    lifecycleDetails string
    Additional information about the current lifecycle state.
    state string
    The current lifecycle state of the external DB system connector.
    timeConnectionStatusLastUpdated string
    The date and time the connectionStatus of the external DB system connector was last updated.
    timeCreated string
    The date and time the external DB system connector was created.
    timeUpdated string
    The date and time the external DB system connector was last updated.
    agent_id str
    The OCID of the management agent used for the external DB system connector.
    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[databasemanagement.ExternalDbSystemConnectorConnectionInfoArgs]
    The connection details required to connect to an external DB system component.
    connection_status str
    The status of connectivity to the external DB system component.
    connector_type str
    (Updatable) The type of connector.
    defined_tags Mapping[str, Any]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    display_name str
    The user-friendly name for the external connector. The name does not have to be unique.
    external_db_system_id str

    The OCID of the external DB system.

    ** 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, Any]
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    lifecycle_details str
    Additional information about the current lifecycle state.
    state str
    The current lifecycle state of the external DB system connector.
    time_connection_status_last_updated str
    The date and time the connectionStatus of the external DB system connector was last updated.
    time_created str
    The date and time the external DB system connector was created.
    time_updated str
    The date and time the external DB system connector was last updated.
    agentId String
    The OCID of the management agent used for the external DB system connector.
    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 an external DB system component.
    connectionStatus String
    The status of connectivity to the external DB system component.
    connectorType String
    (Updatable) The type of connector.
    definedTags Map<Any>
    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 external connector. The name does not have to be unique.
    externalDbSystemId String

    The OCID of the external DB system.

    ** 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<Any>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    lifecycleDetails String
    Additional information about the current lifecycle state.
    state String
    The current lifecycle state of the external DB system connector.
    timeConnectionStatusLastUpdated String
    The date and time the connectionStatus of the external DB system connector was last updated.
    timeCreated String
    The date and time the external DB system connector was created.
    timeUpdated String
    The date and time the external DB system connector was last updated.

    Supporting Types

    ExternalDbSystemConnectorConnectionInfo, ExternalDbSystemConnectorConnectionInfoArgs

    ComponentType string
    The component type.
    ConnectionCredentials List<ExternalDbSystemConnectorConnectionInfoConnectionCredential>
    The credentials used to connect to the ASM instance. Currently only the DETAILS type is supported for creating MACS connector credentials.
    ConnectionStrings List<ExternalDbSystemConnectorConnectionInfoConnectionString>
    The Oracle Database connection string.
    DatabaseCredentials List<ExternalDbSystemConnectorConnectionInfoDatabaseCredential>
    The credential to connect to the database to perform tablespace administration tasks.
    ComponentType string
    The component type.
    ConnectionCredentials []ExternalDbSystemConnectorConnectionInfoConnectionCredential
    The credentials used to connect to the ASM instance. Currently only the DETAILS type is supported for creating MACS connector credentials.
    ConnectionStrings []ExternalDbSystemConnectorConnectionInfoConnectionString
    The Oracle Database connection string.
    DatabaseCredentials []ExternalDbSystemConnectorConnectionInfoDatabaseCredential
    The credential to connect to the database to perform tablespace administration tasks.
    componentType String
    The component type.
    connectionCredentials List<ExternalDbSystemConnectorConnectionInfoConnectionCredential>
    The credentials used to connect to the ASM instance. Currently only the DETAILS type is supported for creating MACS connector credentials.
    connectionStrings List<ExternalDbSystemConnectorConnectionInfoConnectionString>
    The Oracle Database connection string.
    databaseCredentials List<ExternalDbSystemConnectorConnectionInfoDatabaseCredential>
    The credential to connect to the database to perform tablespace administration tasks.
    componentType string
    The component type.
    connectionCredentials ExternalDbSystemConnectorConnectionInfoConnectionCredential[]
    The credentials used to connect to the ASM instance. Currently only the DETAILS type is supported for creating MACS connector credentials.
    connectionStrings ExternalDbSystemConnectorConnectionInfoConnectionString[]
    The Oracle Database connection string.
    databaseCredentials ExternalDbSystemConnectorConnectionInfoDatabaseCredential[]
    The credential to connect to the database to perform tablespace administration tasks.
    component_type str
    The component type.
    connection_credentials Sequence[databasemanagement.ExternalDbSystemConnectorConnectionInfoConnectionCredential]
    The credentials used to connect to the ASM instance. Currently only the DETAILS type is supported for creating MACS connector credentials.
    connection_strings Sequence[databasemanagement.ExternalDbSystemConnectorConnectionInfoConnectionString]
    The Oracle Database connection string.
    database_credentials Sequence[databasemanagement.ExternalDbSystemConnectorConnectionInfoDatabaseCredential]
    The credential to connect to the database to perform tablespace administration tasks.
    componentType String
    The component type.
    connectionCredentials List<Property Map>
    The credentials used to connect to the ASM instance. Currently only the DETAILS type is supported for creating MACS connector credentials.
    connectionStrings List<Property Map>
    The Oracle Database connection string.
    databaseCredentials List<Property Map>
    The credential to connect to the database to perform tablespace administration tasks.

    ExternalDbSystemConnectorConnectionInfoConnectionCredential, ExternalDbSystemConnectorConnectionInfoConnectionCredentialArgs

    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 the credential for tablespace administration tasks.
    PasswordSecretId string
    The OCID of the Secret where the database password is stored.
    Role string
    The role of the database user.
    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 the credential for tablespace administration tasks.
    PasswordSecretId string
    The OCID of the Secret where the database password is stored.
    Role string
    The role of the database user.
    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 the credential for tablespace administration tasks.
    passwordSecretId String
    The OCID of the Secret where the database password is stored.
    role String
    The role of the database user.
    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 the credential for tablespace administration tasks.
    passwordSecretId string
    The OCID of the Secret where the database password is stored.
    role string
    The role of the database user.
    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 the credential for tablespace administration tasks.
    password_secret_id str
    The OCID of the Secret where the database password is stored.
    role str
    The role of the database user.
    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 the credential for tablespace administration tasks.
    passwordSecretId String
    The OCID of the Secret where the database password is stored.
    role String
    The role of the database user.
    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.

    ExternalDbSystemConnectorConnectionInfoConnectionString, ExternalDbSystemConnectorConnectionInfoConnectionStringArgs

    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.

    ExternalDbSystemConnectorConnectionInfoDatabaseCredential, ExternalDbSystemConnectorConnectionInfoDatabaseCredentialArgs

    CredentialType string
    The type of the credential for tablespace administration tasks.
    NamedCredentialId string
    The OCID of the named credential where the database password metadata is stored.
    Password string
    The database user's password encoded using BASE64 scheme.
    PasswordSecretId string
    The OCID of the Secret where the database password is stored.
    Role string
    The role of the database user.
    Username string
    The user to connect to the database.
    CredentialType string
    The type of the credential for tablespace administration tasks.
    NamedCredentialId string
    The OCID of the named credential where the database password metadata is stored.
    Password string
    The database user's password encoded using BASE64 scheme.
    PasswordSecretId string
    The OCID of the Secret where the database password is stored.
    Role string
    The role of the database user.
    Username string
    The user to connect to the database.
    credentialType String
    The type of the credential for tablespace administration tasks.
    namedCredentialId String
    The OCID of the named credential where the database password metadata is stored.
    password String
    The database user's password encoded using BASE64 scheme.
    passwordSecretId String
    The OCID of the Secret where the database password is stored.
    role String
    The role of the database user.
    username String
    The user to connect to the database.
    credentialType string
    The type of the credential for tablespace administration tasks.
    namedCredentialId string
    The OCID of the named credential where the database password metadata is stored.
    password string
    The database user's password encoded using BASE64 scheme.
    passwordSecretId string
    The OCID of the Secret where the database password is stored.
    role string
    The role of the database user.
    username string
    The user to connect to the database.
    credential_type str
    The type of the credential for tablespace administration tasks.
    named_credential_id str
    The OCID of the named credential where the database password metadata is stored.
    password str
    The database user's password encoded using BASE64 scheme.
    password_secret_id str
    The OCID of the Secret where the database password is stored.
    role str
    The role of the database user.
    username str
    The user to connect to the database.
    credentialType String
    The type of the credential for tablespace administration tasks.
    namedCredentialId String
    The OCID of the named credential where the database password metadata is stored.
    password String
    The database user's password encoded using BASE64 scheme.
    passwordSecretId String
    The OCID of the Secret where the database password is stored.
    role String
    The role of the database user.
    username String
    The user to connect to the database.

    Import

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

    $ pulumi import oci:DatabaseManagement/externalDbSystemConnector:ExternalDbSystemConnector test_external_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 v1.32.0 published on Thursday, Apr 18, 2024 by Pulumi
    pulumi/pulumi-oci