Docs Packages
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DatabaseMigration
  5. Connection
Oracle Cloud Infrastructure v1.11.0 published on Wednesday, Sep 27, 2023 by Pulumi
pulumi/pulumi-oci

oci.DatabaseMigration.Connection

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.11.0 published on Wednesday, Sep 27, 2023 by Pulumi
pulumi/pulumi-oci

    This resource provides the Connection resource in Oracle Cloud Infrastructure Database Migration service.

    Create a Database Connection resource that contains the details to connect to either a Source or Target Database in the migration.

    Example Usage

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testConnection = new Oci.DatabaseMigration.Connection("testConnection", new()
    {
        AdminCredentials = new Oci.DatabaseMigration.Inputs.ConnectionAdminCredentialsArgs
        {
            Password = @var.Connection_admin_credentials_password,
            Username = @var.Connection_admin_credentials_username,
        },
        CompartmentId = @var.Compartment_id,
        DatabaseType = @var.Connection_database_type,
        VaultDetails = new Oci.DatabaseMigration.Inputs.ConnectionVaultDetailsArgs
        {
            CompartmentId = @var.Compartment_id,
            KeyId = oci_kms_key.Test_key.Id,
            VaultId = oci_kms_vault.Test_vault.Id,
        },
        CertificateTdn = @var.Connection_certificate_tdn,
        ConnectDescriptor = new Oci.DatabaseMigration.Inputs.ConnectionConnectDescriptorArgs
        {
            ConnectString = @var.Connection_connect_descriptor_connect_string,
            DatabaseServiceName = oci_core_service.Test_service.Name,
            Host = @var.Connection_connect_descriptor_host,
            Port = @var.Connection_connect_descriptor_port,
        },
        DatabaseId = oci_database_database.Test_database.Id,
        DefinedTags = 
        {
            { "foo-namespace.bar-key", "value" },
        },
        DisplayName = @var.Connection_display_name,
        FreeformTags = 
        {
            { "bar-key", "value" },
        },
        NsgIds = @var.Connection_nsg_ids,
        PrivateEndpoint = new Oci.DatabaseMigration.Inputs.ConnectionPrivateEndpointArgs
        {
            CompartmentId = @var.Compartment_id,
            SubnetId = oci_core_subnet.Test_subnet.Id,
            VcnId = oci_core_vcn.Test_vcn.Id,
        },
        ReplicationCredentials = new Oci.DatabaseMigration.Inputs.ConnectionReplicationCredentialsArgs
        {
            Password = @var.Connection_replication_credentials_password,
            Username = @var.Connection_replication_credentials_username,
        },
        SshDetails = new Oci.DatabaseMigration.Inputs.ConnectionSshDetailsArgs
        {
            Host = @var.Connection_ssh_details_host,
            Sshkey = @var.Connection_ssh_details_sshkey,
            User = @var.Connection_ssh_details_user,
            SudoLocation = @var.Connection_ssh_details_sudo_location,
        },
        TlsKeystore = @var.Connection_tls_keystore,
        TlsWallet = @var.Connection_tls_wallet,
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := DatabaseMigration.NewConnection(ctx, "testConnection", &DatabaseMigration.ConnectionArgs{
			AdminCredentials: &databasemigration.ConnectionAdminCredentialsArgs{
				Password: pulumi.Any(_var.Connection_admin_credentials_password),
				Username: pulumi.Any(_var.Connection_admin_credentials_username),
			},
			CompartmentId: pulumi.Any(_var.Compartment_id),
			DatabaseType:  pulumi.Any(_var.Connection_database_type),
			VaultDetails: &databasemigration.ConnectionVaultDetailsArgs{
				CompartmentId: pulumi.Any(_var.Compartment_id),
				KeyId:         pulumi.Any(oci_kms_key.Test_key.Id),
				VaultId:       pulumi.Any(oci_kms_vault.Test_vault.Id),
			},
			CertificateTdn: pulumi.Any(_var.Connection_certificate_tdn),
			ConnectDescriptor: &databasemigration.ConnectionConnectDescriptorArgs{
				ConnectString:       pulumi.Any(_var.Connection_connect_descriptor_connect_string),
				DatabaseServiceName: pulumi.Any(oci_core_service.Test_service.Name),
				Host:                pulumi.Any(_var.Connection_connect_descriptor_host),
				Port:                pulumi.Any(_var.Connection_connect_descriptor_port),
			},
			DatabaseId: pulumi.Any(oci_database_database.Test_database.Id),
			DefinedTags: pulumi.AnyMap{
				"foo-namespace.bar-key": pulumi.Any("value"),
			},
			DisplayName: pulumi.Any(_var.Connection_display_name),
			FreeformTags: pulumi.AnyMap{
				"bar-key": pulumi.Any("value"),
			},
			NsgIds: pulumi.Any(_var.Connection_nsg_ids),
			PrivateEndpoint: &databasemigration.ConnectionPrivateEndpointArgs{
				CompartmentId: pulumi.Any(_var.Compartment_id),
				SubnetId:      pulumi.Any(oci_core_subnet.Test_subnet.Id),
				VcnId:         pulumi.Any(oci_core_vcn.Test_vcn.Id),
			},
			ReplicationCredentials: &databasemigration.ConnectionReplicationCredentialsArgs{
				Password: pulumi.Any(_var.Connection_replication_credentials_password),
				Username: pulumi.Any(_var.Connection_replication_credentials_username),
			},
			SshDetails: &databasemigration.ConnectionSshDetailsArgs{
				Host:         pulumi.Any(_var.Connection_ssh_details_host),
				Sshkey:       pulumi.Any(_var.Connection_ssh_details_sshkey),
				User:         pulumi.Any(_var.Connection_ssh_details_user),
				SudoLocation: pulumi.Any(_var.Connection_ssh_details_sudo_location),
			},
			TlsKeystore: pulumi.Any(_var.Connection_tls_keystore),
			TlsWallet:   pulumi.Any(_var.Connection_tls_wallet),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DatabaseMigration.Connection;
import com.pulumi.oci.DatabaseMigration.ConnectionArgs;
import com.pulumi.oci.DatabaseMigration.inputs.ConnectionAdminCredentialsArgs;
import com.pulumi.oci.DatabaseMigration.inputs.ConnectionVaultDetailsArgs;
import com.pulumi.oci.DatabaseMigration.inputs.ConnectionConnectDescriptorArgs;
import com.pulumi.oci.DatabaseMigration.inputs.ConnectionPrivateEndpointArgs;
import com.pulumi.oci.DatabaseMigration.inputs.ConnectionReplicationCredentialsArgs;
import com.pulumi.oci.DatabaseMigration.inputs.ConnectionSshDetailsArgs;
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 testConnection = new Connection("testConnection", ConnectionArgs.builder()        
            .adminCredentials(ConnectionAdminCredentialsArgs.builder()
                .password(var_.connection_admin_credentials_password())
                .username(var_.connection_admin_credentials_username())
                .build())
            .compartmentId(var_.compartment_id())
            .databaseType(var_.connection_database_type())
            .vaultDetails(ConnectionVaultDetailsArgs.builder()
                .compartmentId(var_.compartment_id())
                .keyId(oci_kms_key.test_key().id())
                .vaultId(oci_kms_vault.test_vault().id())
                .build())
            .certificateTdn(var_.connection_certificate_tdn())
            .connectDescriptor(ConnectionConnectDescriptorArgs.builder()
                .connectString(var_.connection_connect_descriptor_connect_string())
                .databaseServiceName(oci_core_service.test_service().name())
                .host(var_.connection_connect_descriptor_host())
                .port(var_.connection_connect_descriptor_port())
                .build())
            .databaseId(oci_database_database.test_database().id())
            .definedTags(Map.of("foo-namespace.bar-key", "value"))
            .displayName(var_.connection_display_name())
            .freeformTags(Map.of("bar-key", "value"))
            .nsgIds(var_.connection_nsg_ids())
            .privateEndpoint(ConnectionPrivateEndpointArgs.builder()
                .compartmentId(var_.compartment_id())
                .subnetId(oci_core_subnet.test_subnet().id())
                .vcnId(oci_core_vcn.test_vcn().id())
                .build())
            .replicationCredentials(ConnectionReplicationCredentialsArgs.builder()
                .password(var_.connection_replication_credentials_password())
                .username(var_.connection_replication_credentials_username())
                .build())
            .sshDetails(ConnectionSshDetailsArgs.builder()
                .host(var_.connection_ssh_details_host())
                .sshkey(var_.connection_ssh_details_sshkey())
                .user(var_.connection_ssh_details_user())
                .sudoLocation(var_.connection_ssh_details_sudo_location())
                .build())
            .tlsKeystore(var_.connection_tls_keystore())
            .tlsWallet(var_.connection_tls_wallet())
            .build());

    }
}

    import pulumi
import pulumi_oci as oci

test_connection = oci.database_migration.Connection("testConnection",
    admin_credentials=oci.database_migration.ConnectionAdminCredentialsArgs(
        password=var["connection_admin_credentials_password"],
        username=var["connection_admin_credentials_username"],
    ),
    compartment_id=var["compartment_id"],
    database_type=var["connection_database_type"],
    vault_details=oci.database_migration.ConnectionVaultDetailsArgs(
        compartment_id=var["compartment_id"],
        key_id=oci_kms_key["test_key"]["id"],
        vault_id=oci_kms_vault["test_vault"]["id"],
    ),
    certificate_tdn=var["connection_certificate_tdn"],
    connect_descriptor=oci.database_migration.ConnectionConnectDescriptorArgs(
        connect_string=var["connection_connect_descriptor_connect_string"],
        database_service_name=oci_core_service["test_service"]["name"],
        host=var["connection_connect_descriptor_host"],
        port=var["connection_connect_descriptor_port"],
    ),
    database_id=oci_database_database["test_database"]["id"],
    defined_tags={
        "foo-namespace.bar-key": "value",
    },
    display_name=var["connection_display_name"],
    freeform_tags={
        "bar-key": "value",
    },
    nsg_ids=var["connection_nsg_ids"],
    private_endpoint=oci.database_migration.ConnectionPrivateEndpointArgs(
        compartment_id=var["compartment_id"],
        subnet_id=oci_core_subnet["test_subnet"]["id"],
        vcn_id=oci_core_vcn["test_vcn"]["id"],
    ),
    replication_credentials=oci.database_migration.ConnectionReplicationCredentialsArgs(
        password=var["connection_replication_credentials_password"],
        username=var["connection_replication_credentials_username"],
    ),
    ssh_details=oci.database_migration.ConnectionSshDetailsArgs(
        host=var["connection_ssh_details_host"],
        sshkey=var["connection_ssh_details_sshkey"],
        user=var["connection_ssh_details_user"],
        sudo_location=var["connection_ssh_details_sudo_location"],
    ),
    tls_keystore=var["connection_tls_keystore"],
    tls_wallet=var["connection_tls_wallet"])

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

const testConnection = new oci.databasemigration.Connection("testConnection", {
    adminCredentials: {
        password: _var.connection_admin_credentials_password,
        username: _var.connection_admin_credentials_username,
    },
    compartmentId: _var.compartment_id,
    databaseType: _var.connection_database_type,
    vaultDetails: {
        compartmentId: _var.compartment_id,
        keyId: oci_kms_key.test_key.id,
        vaultId: oci_kms_vault.test_vault.id,
    },
    certificateTdn: _var.connection_certificate_tdn,
    connectDescriptor: {
        connectString: _var.connection_connect_descriptor_connect_string,
        databaseServiceName: oci_core_service.test_service.name,
        host: _var.connection_connect_descriptor_host,
        port: _var.connection_connect_descriptor_port,
    },
    databaseId: oci_database_database.test_database.id,
    definedTags: {
        "foo-namespace.bar-key": "value",
    },
    displayName: _var.connection_display_name,
    freeformTags: {
        "bar-key": "value",
    },
    nsgIds: _var.connection_nsg_ids,
    privateEndpoint: {
        compartmentId: _var.compartment_id,
        subnetId: oci_core_subnet.test_subnet.id,
        vcnId: oci_core_vcn.test_vcn.id,
    },
    replicationCredentials: {
        password: _var.connection_replication_credentials_password,
        username: _var.connection_replication_credentials_username,
    },
    sshDetails: {
        host: _var.connection_ssh_details_host,
        sshkey: _var.connection_ssh_details_sshkey,
        user: _var.connection_ssh_details_user,
        sudoLocation: _var.connection_ssh_details_sudo_location,
    },
    tlsKeystore: _var.connection_tls_keystore,
    tlsWallet: _var.connection_tls_wallet,
});

    resources:
  testConnection:
    type: oci:DatabaseMigration:Connection
    properties:
      adminCredentials:
        password: ${var.connection_admin_credentials_password}
        username: ${var.connection_admin_credentials_username}
      compartmentId: ${var.compartment_id}
      databaseType: ${var.connection_database_type}
      vaultDetails:
        compartmentId: ${var.compartment_id}
        keyId: ${oci_kms_key.test_key.id}
        vaultId: ${oci_kms_vault.test_vault.id}
      #Optional
      certificateTdn: ${var.connection_certificate_tdn}
      connectDescriptor:
        connectString: ${var.connection_connect_descriptor_connect_string}
        databaseServiceName: ${oci_core_service.test_service.name}
        host: ${var.connection_connect_descriptor_host}
        port: ${var.connection_connect_descriptor_port}
      databaseId: ${oci_database_database.test_database.id}
      definedTags:
        foo-namespace.bar-key: value
      displayName: ${var.connection_display_name}
      freeformTags:
        bar-key: value
      nsgIds: ${var.connection_nsg_ids}
      privateEndpoint:
        compartmentId: ${var.compartment_id}
        subnetId: ${oci_core_subnet.test_subnet.id}
        vcnId: ${oci_core_vcn.test_vcn.id}
      replicationCredentials:
        password: ${var.connection_replication_credentials_password}
        username: ${var.connection_replication_credentials_username}
      sshDetails:
        host: ${var.connection_ssh_details_host}
        sshkey: ${var.connection_ssh_details_sshkey}
        user: ${var.connection_ssh_details_user}
        sudoLocation: ${var.connection_ssh_details_sudo_location}
      tlsKeystore: ${var.connection_tls_keystore}
      tlsWallet: ${var.connection_tls_wallet}

    Create Connection Resource

    new Connection(name: string, args: ConnectionArgs, opts?: CustomResourceOptions);
    @overload
def Connection(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               admin_credentials: Optional[_databasemigration.ConnectionAdminCredentialsArgs] = None,
               certificate_tdn: Optional[str] = None,
               compartment_id: Optional[str] = None,
               connect_descriptor: Optional[_databasemigration.ConnectionConnectDescriptorArgs] = None,
               database_id: Optional[str] = None,
               database_type: Optional[str] = None,
               defined_tags: Optional[Mapping[str, Any]] = None,
               display_name: Optional[str] = None,
               freeform_tags: Optional[Mapping[str, Any]] = None,
               nsg_ids: Optional[Sequence[str]] = None,
               private_endpoint: Optional[_databasemigration.ConnectionPrivateEndpointArgs] = None,
               replication_credentials: Optional[_databasemigration.ConnectionReplicationCredentialsArgs] = None,
               ssh_details: Optional[_databasemigration.ConnectionSshDetailsArgs] = None,
               tls_keystore: Optional[str] = None,
               tls_wallet: Optional[str] = None,
               vault_details: Optional[_databasemigration.ConnectionVaultDetailsArgs] = None)
@overload
def Connection(resource_name: str,
               args: ConnectionArgs,
               opts: Optional[ResourceOptions] = None)
    func NewConnection(ctx *Context, name string, args ConnectionArgs, opts ...ResourceOption) (*Connection, error)
    public Connection(string name, ConnectionArgs args, CustomResourceOptions? opts = null)
    public Connection(String name, ConnectionArgs args)
public Connection(String name, ConnectionArgs args, CustomResourceOptions options)

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

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

    AdminCredentials ConnectionAdminCredentials

    (Updatable) Database Administrator Credentials details.

    CompartmentId string

    (Updatable) OCID of the compartment where the secret containing the credentials will be created.

    DatabaseType string

    Database connection type.

    VaultDetails ConnectionVaultDetails

    (Updatable) Oracle Cloud Infrastructure Vault details to store migration and connection credentials secrets

    CertificateTdn string

    (Updatable) This name is the distinguished name used while creating the certificate on target database. Requires a TLS wallet to be specified. Not required for source container database connections.

    ConnectDescriptor ConnectionConnectDescriptor

    (Updatable) Connect Descriptor details. Required for Manual and UserManagerOci connection types. If a Private Endpoint was specified for the Connection, the host should contain a valid IP address.

    DatabaseId string

    (Updatable) The OCID of the cloud database. Required if the database connection type is Autonomous.

    DefinedTags Dictionary<string, object>

    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

    DisplayName string

    (Updatable) Database Connection display name identifier.

    FreeformTags Dictionary<string, object>

    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

    NsgIds List<string>

    (Updatable) An array of Network Security Group OCIDs used to define network access for Connections.

    PrivateEndpoint ConnectionPrivateEndpoint

    (Updatable) Oracle Cloud Infrastructure Private Endpoint configuration details. Not required for source container database connections, it will default to the specified Source Database Connection Private Endpoint.

    ReplicationCredentials ConnectionReplicationCredentials

    (Updatable) Database Administrator Credentials details.

    SshDetails ConnectionSshDetails

    (Updatable) Details of the SSH key that will be used. Required for source database Manual and UserManagerOci connection types. Not required for source container database connections.

    TlsKeystore string

    (Updatable) keystore.jks file contents; base64 encoded String. Requires a TLS wallet to be specified. Not required for source container database connections.

    TlsWallet string

    (Updatable) cwallet.sso containing containing the TCPS/SSL certificate; base64 encoded String. Not required for source container database connections.

    AdminCredentials ConnectionAdminCredentialsArgs

    (Updatable) Database Administrator Credentials details.

    CompartmentId string

    (Updatable) OCID of the compartment where the secret containing the credentials will be created.

    DatabaseType string

    Database connection type.

    VaultDetails ConnectionVaultDetailsArgs

    (Updatable) Oracle Cloud Infrastructure Vault details to store migration and connection credentials secrets

    CertificateTdn string

    (Updatable) This name is the distinguished name used while creating the certificate on target database. Requires a TLS wallet to be specified. Not required for source container database connections.

    ConnectDescriptor ConnectionConnectDescriptorArgs

    (Updatable) Connect Descriptor details. Required for Manual and UserManagerOci connection types. If a Private Endpoint was specified for the Connection, the host should contain a valid IP address.

    DatabaseId string

    (Updatable) The OCID of the cloud database. Required if the database connection type is Autonomous.

    DefinedTags map[string]interface{}

    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

    DisplayName string

    (Updatable) Database Connection display name identifier.

    FreeformTags map[string]interface{}

    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

    NsgIds []string

    (Updatable) An array of Network Security Group OCIDs used to define network access for Connections.

    PrivateEndpoint ConnectionPrivateEndpointArgs

    (Updatable) Oracle Cloud Infrastructure Private Endpoint configuration details. Not required for source container database connections, it will default to the specified Source Database Connection Private Endpoint.

    ReplicationCredentials ConnectionReplicationCredentialsArgs

    (Updatable) Database Administrator Credentials details.

    SshDetails ConnectionSshDetailsArgs

    (Updatable) Details of the SSH key that will be used. Required for source database Manual and UserManagerOci connection types. Not required for source container database connections.

    TlsKeystore string

    (Updatable) keystore.jks file contents; base64 encoded String. Requires a TLS wallet to be specified. Not required for source container database connections.

    TlsWallet string

    (Updatable) cwallet.sso containing containing the TCPS/SSL certificate; base64 encoded String. Not required for source container database connections.

    adminCredentials ConnectionAdminCredentials

    (Updatable) Database Administrator Credentials details.

    compartmentId String

    (Updatable) OCID of the compartment where the secret containing the credentials will be created.

    databaseType String

    Database connection type.

    vaultDetails ConnectionVaultDetails

    (Updatable) Oracle Cloud Infrastructure Vault details to store migration and connection credentials secrets

    certificateTdn String

    (Updatable) This name is the distinguished name used while creating the certificate on target database. Requires a TLS wallet to be specified. Not required for source container database connections.

    connectDescriptor ConnectionConnectDescriptor

    (Updatable) Connect Descriptor details. Required for Manual and UserManagerOci connection types. If a Private Endpoint was specified for the Connection, the host should contain a valid IP address.

    databaseId String

    (Updatable) The OCID of the cloud database. Required if the database connection type is Autonomous.

    definedTags Map<String,Object>

    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

    displayName String

    (Updatable) Database Connection display name identifier.

    freeformTags Map<String,Object>

    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

    nsgIds List<String>

    (Updatable) An array of Network Security Group OCIDs used to define network access for Connections.

    privateEndpoint ConnectionPrivateEndpoint

    (Updatable) Oracle Cloud Infrastructure Private Endpoint configuration details. Not required for source container database connections, it will default to the specified Source Database Connection Private Endpoint.

    replicationCredentials ConnectionReplicationCredentials

    (Updatable) Database Administrator Credentials details.

    sshDetails ConnectionSshDetails

    (Updatable) Details of the SSH key that will be used. Required for source database Manual and UserManagerOci connection types. Not required for source container database connections.

    tlsKeystore String

    (Updatable) keystore.jks file contents; base64 encoded String. Requires a TLS wallet to be specified. Not required for source container database connections.

    tlsWallet String

    (Updatable) cwallet.sso containing containing the TCPS/SSL certificate; base64 encoded String. Not required for source container database connections.

    adminCredentials ConnectionAdminCredentials

    (Updatable) Database Administrator Credentials details.

    compartmentId string

    (Updatable) OCID of the compartment where the secret containing the credentials will be created.

    databaseType string

    Database connection type.

    vaultDetails ConnectionVaultDetails

    (Updatable) Oracle Cloud Infrastructure Vault details to store migration and connection credentials secrets

    certificateTdn string

    (Updatable) This name is the distinguished name used while creating the certificate on target database. Requires a TLS wallet to be specified. Not required for source container database connections.

    connectDescriptor ConnectionConnectDescriptor

    (Updatable) Connect Descriptor details. Required for Manual and UserManagerOci connection types. If a Private Endpoint was specified for the Connection, the host should contain a valid IP address.

    databaseId string

    (Updatable) The OCID of the cloud database. Required if the database connection type is Autonomous.

    definedTags {[key: string]: any}

    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

    displayName string

    (Updatable) Database Connection display name identifier.

    freeformTags {[key: string]: any}

    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

    nsgIds string[]

    (Updatable) An array of Network Security Group OCIDs used to define network access for Connections.

    privateEndpoint ConnectionPrivateEndpoint

    (Updatable) Oracle Cloud Infrastructure Private Endpoint configuration details. Not required for source container database connections, it will default to the specified Source Database Connection Private Endpoint.

    replicationCredentials ConnectionReplicationCredentials

    (Updatable) Database Administrator Credentials details.

    sshDetails ConnectionSshDetails

    (Updatable) Details of the SSH key that will be used. Required for source database Manual and UserManagerOci connection types. Not required for source container database connections.

    tlsKeystore string

    (Updatable) keystore.jks file contents; base64 encoded String. Requires a TLS wallet to be specified. Not required for source container database connections.

    tlsWallet string

    (Updatable) cwallet.sso containing containing the TCPS/SSL certificate; base64 encoded String. Not required for source container database connections.

    admin_credentials ConnectionAdminCredentialsArgs

    (Updatable) Database Administrator Credentials details.

    compartment_id str

    (Updatable) OCID of the compartment where the secret containing the credentials will be created.

    database_type str

    Database connection type.

    vault_details ConnectionVaultDetailsArgs

    (Updatable) Oracle Cloud Infrastructure Vault details to store migration and connection credentials secrets

    certificate_tdn str

    (Updatable) This name is the distinguished name used while creating the certificate on target database. Requires a TLS wallet to be specified. Not required for source container database connections.

    connect_descriptor ConnectionConnectDescriptorArgs

    (Updatable) Connect Descriptor details. Required for Manual and UserManagerOci connection types. If a Private Endpoint was specified for the Connection, the host should contain a valid IP address.

    database_id str

    (Updatable) The OCID of the cloud database. Required if the database connection type is Autonomous.

    defined_tags Mapping[str, Any]

    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

    display_name str

    (Updatable) Database Connection display name identifier.

    freeform_tags Mapping[str, Any]

    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

    nsg_ids Sequence[str]

    (Updatable) An array of Network Security Group OCIDs used to define network access for Connections.

    private_endpoint ConnectionPrivateEndpointArgs

    (Updatable) Oracle Cloud Infrastructure Private Endpoint configuration details. Not required for source container database connections, it will default to the specified Source Database Connection Private Endpoint.

    replication_credentials ConnectionReplicationCredentialsArgs

    (Updatable) Database Administrator Credentials details.

    ssh_details ConnectionSshDetailsArgs

    (Updatable) Details of the SSH key that will be used. Required for source database Manual and UserManagerOci connection types. Not required for source container database connections.

    tls_keystore str

    (Updatable) keystore.jks file contents; base64 encoded String. Requires a TLS wallet to be specified. Not required for source container database connections.

    tls_wallet str

    (Updatable) cwallet.sso containing containing the TCPS/SSL certificate; base64 encoded String. Not required for source container database connections.

    adminCredentials Property Map

    (Updatable) Database Administrator Credentials details.

    compartmentId String

    (Updatable) OCID of the compartment where the secret containing the credentials will be created.

    databaseType String

    Database connection type.

    vaultDetails Property Map

    (Updatable) Oracle Cloud Infrastructure Vault details to store migration and connection credentials secrets

    certificateTdn String

    (Updatable) This name is the distinguished name used while creating the certificate on target database. Requires a TLS wallet to be specified. Not required for source container database connections.

    connectDescriptor Property Map

    (Updatable) Connect Descriptor details. Required for Manual and UserManagerOci connection types. If a Private Endpoint was specified for the Connection, the host should contain a valid IP address.

    databaseId String

    (Updatable) The OCID of the cloud database. Required if the database connection type is Autonomous.

    definedTags Map<Any>

    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

    displayName String

    (Updatable) Database Connection display name identifier.

    freeformTags Map<Any>

    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

    nsgIds List<String>

    (Updatable) An array of Network Security Group OCIDs used to define network access for Connections.

    privateEndpoint Property Map

    (Updatable) Oracle Cloud Infrastructure Private Endpoint configuration details. Not required for source container database connections, it will default to the specified Source Database Connection Private Endpoint.

    replicationCredentials Property Map

    (Updatable) Database Administrator Credentials details.

    sshDetails Property Map

    (Updatable) Details of the SSH key that will be used. Required for source database Manual and UserManagerOci connection types. Not required for source container database connections.

    tlsKeystore String

    (Updatable) keystore.jks file contents; base64 encoded String. Requires a TLS wallet to be specified. Not required for source container database connections.

    tlsWallet String

    (Updatable) cwallet.sso containing containing the TCPS/SSL certificate; base64 encoded String. Not required for source container database connections.

    Outputs

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

    CredentialsSecretId string

    OCID of the Secret in the Oracle Cloud Infrastructure vault containing the Database Connection credentials.

    Id string

    The provider-assigned unique ID for this managed resource.

    LifecycleDetails string

    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

    State string

    The current state of the Connection resource.

    SystemTags Dictionary<string, object>

    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

    TimeCreated string

    The time the Connection resource was created. An RFC3339 formatted datetime string.

    TimeUpdated string

    The time of the last Connection resource details update. An RFC3339 formatted datetime string.

    CredentialsSecretId string

    OCID of the Secret in the Oracle Cloud Infrastructure vault containing the Database Connection credentials.

    Id string

    The provider-assigned unique ID for this managed resource.

    LifecycleDetails string

    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

    State string

    The current state of the Connection resource.

    SystemTags map[string]interface{}

    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

    TimeCreated string

    The time the Connection resource was created. An RFC3339 formatted datetime string.

    TimeUpdated string

    The time of the last Connection resource details update. An RFC3339 formatted datetime string.

    credentialsSecretId String

    OCID of the Secret in the Oracle Cloud Infrastructure vault containing the Database Connection credentials.

    id String

    The provider-assigned unique ID for this managed resource.

    lifecycleDetails String

    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

    state String

    The current state of the Connection resource.

    systemTags Map<String,Object>

    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

    timeCreated String

    The time the Connection resource was created. An RFC3339 formatted datetime string.

    timeUpdated String

    The time of the last Connection resource details update. An RFC3339 formatted datetime string.

    credentialsSecretId string

    OCID of the Secret in the Oracle Cloud Infrastructure vault containing the Database Connection credentials.

    id string

    The provider-assigned unique ID for this managed resource.

    lifecycleDetails string

    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

    state string

    The current state of the Connection resource.

    systemTags {[key: string]: any}

    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

    timeCreated string

    The time the Connection resource was created. An RFC3339 formatted datetime string.

    timeUpdated string

    The time of the last Connection resource details update. An RFC3339 formatted datetime string.

    credentials_secret_id str

    OCID of the Secret in the Oracle Cloud Infrastructure vault containing the Database Connection credentials.

    id str

    The provider-assigned unique ID for this managed resource.

    lifecycle_details str

    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

    state str

    The current state of the Connection resource.

    system_tags Mapping[str, Any]

    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

    time_created str

    The time the Connection resource was created. An RFC3339 formatted datetime string.

    time_updated str

    The time of the last Connection resource details update. An RFC3339 formatted datetime string.

    credentialsSecretId String

    OCID of the Secret in the Oracle Cloud Infrastructure vault containing the Database Connection credentials.

    id String

    The provider-assigned unique ID for this managed resource.

    lifecycleDetails String

    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

    state String

    The current state of the Connection resource.

    systemTags Map<Any>

    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

    timeCreated String

    The time the Connection resource was created. An RFC3339 formatted datetime string.

    timeUpdated String

    The time of the last Connection resource details update. An RFC3339 formatted datetime string.

    Look up Existing Connection Resource

    Get an existing Connection 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?: ConnectionState, opts?: CustomResourceOptions): Connection
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        admin_credentials: Optional[_databasemigration.ConnectionAdminCredentialsArgs] = None,
        certificate_tdn: Optional[str] = None,
        compartment_id: Optional[str] = None,
        connect_descriptor: Optional[_databasemigration.ConnectionConnectDescriptorArgs] = None,
        credentials_secret_id: Optional[str] = None,
        database_id: Optional[str] = None,
        database_type: Optional[str] = None,
        defined_tags: Optional[Mapping[str, Any]] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, Any]] = None,
        lifecycle_details: Optional[str] = None,
        nsg_ids: Optional[Sequence[str]] = None,
        private_endpoint: Optional[_databasemigration.ConnectionPrivateEndpointArgs] = None,
        replication_credentials: Optional[_databasemigration.ConnectionReplicationCredentialsArgs] = None,
        ssh_details: Optional[_databasemigration.ConnectionSshDetailsArgs] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, Any]] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None,
        tls_keystore: Optional[str] = None,
        tls_wallet: Optional[str] = None,
        vault_details: Optional[_databasemigration.ConnectionVaultDetailsArgs] = None) -> Connection
    func GetConnection(ctx *Context, name string, id IDInput, state *ConnectionState, opts ...ResourceOption) (*Connection, error)
    public static Connection Get(string name, Input<string> id, ConnectionState? state, CustomResourceOptions? opts = null)
    public static Connection get(String name, Output<String> id, ConnectionState 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:
    AdminCredentials ConnectionAdminCredentials

    (Updatable) Database Administrator Credentials details.

    CertificateTdn string

    (Updatable) This name is the distinguished name used while creating the certificate on target database. Requires a TLS wallet to be specified. Not required for source container database connections.

    CompartmentId string

    (Updatable) OCID of the compartment where the secret containing the credentials will be created.

    ConnectDescriptor ConnectionConnectDescriptor

    (Updatable) Connect Descriptor details. Required for Manual and UserManagerOci connection types. If a Private Endpoint was specified for the Connection, the host should contain a valid IP address.

    CredentialsSecretId string

    OCID of the Secret in the Oracle Cloud Infrastructure vault containing the Database Connection credentials.

    DatabaseId string

    (Updatable) The OCID of the cloud database. Required if the database connection type is Autonomous.

    DatabaseType string

    Database connection type.

    DefinedTags Dictionary<string, object>

    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

    DisplayName string

    (Updatable) Database Connection display name identifier.

    FreeformTags Dictionary<string, object>

    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

    LifecycleDetails string

    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

    NsgIds List<string>

    (Updatable) An array of Network Security Group OCIDs used to define network access for Connections.

    PrivateEndpoint ConnectionPrivateEndpoint

    (Updatable) Oracle Cloud Infrastructure Private Endpoint configuration details. Not required for source container database connections, it will default to the specified Source Database Connection Private Endpoint.

    ReplicationCredentials ConnectionReplicationCredentials

    (Updatable) Database Administrator Credentials details.

    SshDetails ConnectionSshDetails

    (Updatable) Details of the SSH key that will be used. Required for source database Manual and UserManagerOci connection types. Not required for source container database connections.

    State string

    The current state of the Connection resource.

    SystemTags Dictionary<string, object>

    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

    TimeCreated string

    The time the Connection resource was created. An RFC3339 formatted datetime string.

    TimeUpdated string

    The time of the last Connection resource details update. An RFC3339 formatted datetime string.

    TlsKeystore string

    (Updatable) keystore.jks file contents; base64 encoded String. Requires a TLS wallet to be specified. Not required for source container database connections.

    TlsWallet string

    (Updatable) cwallet.sso containing containing the TCPS/SSL certificate; base64 encoded String. Not required for source container database connections.

    VaultDetails ConnectionVaultDetails

    (Updatable) Oracle Cloud Infrastructure Vault details to store migration and connection credentials secrets

    AdminCredentials ConnectionAdminCredentialsArgs

    (Updatable) Database Administrator Credentials details.

    CertificateTdn string

    (Updatable) This name is the distinguished name used while creating the certificate on target database. Requires a TLS wallet to be specified. Not required for source container database connections.

    CompartmentId string

    (Updatable) OCID of the compartment where the secret containing the credentials will be created.

    ConnectDescriptor ConnectionConnectDescriptorArgs

    (Updatable) Connect Descriptor details. Required for Manual and UserManagerOci connection types. If a Private Endpoint was specified for the Connection, the host should contain a valid IP address.

    CredentialsSecretId string

    OCID of the Secret in the Oracle Cloud Infrastructure vault containing the Database Connection credentials.

    DatabaseId string

    (Updatable) The OCID of the cloud database. Required if the database connection type is Autonomous.

    DatabaseType string

    Database connection type.

    DefinedTags map[string]interface{}

    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

    DisplayName string

    (Updatable) Database Connection display name identifier.

    FreeformTags map[string]interface{}

    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

    LifecycleDetails string

    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

    NsgIds []string

    (Updatable) An array of Network Security Group OCIDs used to define network access for Connections.

    PrivateEndpoint ConnectionPrivateEndpointArgs

    (Updatable) Oracle Cloud Infrastructure Private Endpoint configuration details. Not required for source container database connections, it will default to the specified Source Database Connection Private Endpoint.

    ReplicationCredentials ConnectionReplicationCredentialsArgs

    (Updatable) Database Administrator Credentials details.

    SshDetails ConnectionSshDetailsArgs

    (Updatable) Details of the SSH key that will be used. Required for source database Manual and UserManagerOci connection types. Not required for source container database connections.

    State string

    The current state of the Connection resource.

    SystemTags map[string]interface{}

    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

    TimeCreated string

    The time the Connection resource was created. An RFC3339 formatted datetime string.

    TimeUpdated string

    The time of the last Connection resource details update. An RFC3339 formatted datetime string.

    TlsKeystore string

    (Updatable) keystore.jks file contents; base64 encoded String. Requires a TLS wallet to be specified. Not required for source container database connections.

    TlsWallet string

    (Updatable) cwallet.sso containing containing the TCPS/SSL certificate; base64 encoded String. Not required for source container database connections.

    VaultDetails ConnectionVaultDetailsArgs

    (Updatable) Oracle Cloud Infrastructure Vault details to store migration and connection credentials secrets

    adminCredentials ConnectionAdminCredentials

    (Updatable) Database Administrator Credentials details.

    certificateTdn String

    (Updatable) This name is the distinguished name used while creating the certificate on target database. Requires a TLS wallet to be specified. Not required for source container database connections.

    compartmentId String

    (Updatable) OCID of the compartment where the secret containing the credentials will be created.

    connectDescriptor ConnectionConnectDescriptor

    (Updatable) Connect Descriptor details. Required for Manual and UserManagerOci connection types. If a Private Endpoint was specified for the Connection, the host should contain a valid IP address.

    credentialsSecretId String

    OCID of the Secret in the Oracle Cloud Infrastructure vault containing the Database Connection credentials.

    databaseId String

    (Updatable) The OCID of the cloud database. Required if the database connection type is Autonomous.

    databaseType String

    Database connection type.

    definedTags Map<String,Object>

    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

    displayName String

    (Updatable) Database Connection display name identifier.

    freeformTags Map<String,Object>

    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

    lifecycleDetails String

    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

    nsgIds List<String>

    (Updatable) An array of Network Security Group OCIDs used to define network access for Connections.

    privateEndpoint ConnectionPrivateEndpoint

    (Updatable) Oracle Cloud Infrastructure Private Endpoint configuration details. Not required for source container database connections, it will default to the specified Source Database Connection Private Endpoint.

    replicationCredentials ConnectionReplicationCredentials

    (Updatable) Database Administrator Credentials details.

    sshDetails ConnectionSshDetails

    (Updatable) Details of the SSH key that will be used. Required for source database Manual and UserManagerOci connection types. Not required for source container database connections.

    state String

    The current state of the Connection resource.

    systemTags Map<String,Object>

    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

    timeCreated String

    The time the Connection resource was created. An RFC3339 formatted datetime string.

    timeUpdated String

    The time of the last Connection resource details update. An RFC3339 formatted datetime string.

    tlsKeystore String

    (Updatable) keystore.jks file contents; base64 encoded String. Requires a TLS wallet to be specified. Not required for source container database connections.

    tlsWallet String

    (Updatable) cwallet.sso containing containing the TCPS/SSL certificate; base64 encoded String. Not required for source container database connections.

    vaultDetails ConnectionVaultDetails

    (Updatable) Oracle Cloud Infrastructure Vault details to store migration and connection credentials secrets

    adminCredentials ConnectionAdminCredentials

    (Updatable) Database Administrator Credentials details.

    certificateTdn string

    (Updatable) This name is the distinguished name used while creating the certificate on target database. Requires a TLS wallet to be specified. Not required for source container database connections.

    compartmentId string

    (Updatable) OCID of the compartment where the secret containing the credentials will be created.

    connectDescriptor ConnectionConnectDescriptor

    (Updatable) Connect Descriptor details. Required for Manual and UserManagerOci connection types. If a Private Endpoint was specified for the Connection, the host should contain a valid IP address.

    credentialsSecretId string

    OCID of the Secret in the Oracle Cloud Infrastructure vault containing the Database Connection credentials.

    databaseId string

    (Updatable) The OCID of the cloud database. Required if the database connection type is Autonomous.

    databaseType string

    Database connection type.

    definedTags {[key: string]: any}

    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

    displayName string

    (Updatable) Database Connection display name identifier.

    freeformTags {[key: string]: any}

    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

    lifecycleDetails string

    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

    nsgIds string[]

    (Updatable) An array of Network Security Group OCIDs used to define network access for Connections.

    privateEndpoint ConnectionPrivateEndpoint

    (Updatable) Oracle Cloud Infrastructure Private Endpoint configuration details. Not required for source container database connections, it will default to the specified Source Database Connection Private Endpoint.

    replicationCredentials ConnectionReplicationCredentials

    (Updatable) Database Administrator Credentials details.

    sshDetails ConnectionSshDetails

    (Updatable) Details of the SSH key that will be used. Required for source database Manual and UserManagerOci connection types. Not required for source container database connections.

    state string

    The current state of the Connection resource.

    systemTags {[key: string]: any}

    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

    timeCreated string

    The time the Connection resource was created. An RFC3339 formatted datetime string.

    timeUpdated string

    The time of the last Connection resource details update. An RFC3339 formatted datetime string.

    tlsKeystore string

    (Updatable) keystore.jks file contents; base64 encoded String. Requires a TLS wallet to be specified. Not required for source container database connections.

    tlsWallet string

    (Updatable) cwallet.sso containing containing the TCPS/SSL certificate; base64 encoded String. Not required for source container database connections.

    vaultDetails ConnectionVaultDetails

    (Updatable) Oracle Cloud Infrastructure Vault details to store migration and connection credentials secrets

    admin_credentials ConnectionAdminCredentialsArgs

    (Updatable) Database Administrator Credentials details.

    certificate_tdn str

    (Updatable) This name is the distinguished name used while creating the certificate on target database. Requires a TLS wallet to be specified. Not required for source container database connections.

    compartment_id str

    (Updatable) OCID of the compartment where the secret containing the credentials will be created.

    connect_descriptor ConnectionConnectDescriptorArgs

    (Updatable) Connect Descriptor details. Required for Manual and UserManagerOci connection types. If a Private Endpoint was specified for the Connection, the host should contain a valid IP address.

    credentials_secret_id str

    OCID of the Secret in the Oracle Cloud Infrastructure vault containing the Database Connection credentials.

    database_id str

    (Updatable) The OCID of the cloud database. Required if the database connection type is Autonomous.

    database_type str

    Database connection type.

    defined_tags Mapping[str, Any]

    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

    display_name str

    (Updatable) Database Connection display name identifier.

    freeform_tags Mapping[str, Any]

    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

    lifecycle_details str

    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

    nsg_ids Sequence[str]

    (Updatable) An array of Network Security Group OCIDs used to define network access for Connections.

    private_endpoint ConnectionPrivateEndpointArgs

    (Updatable) Oracle Cloud Infrastructure Private Endpoint configuration details. Not required for source container database connections, it will default to the specified Source Database Connection Private Endpoint.

    replication_credentials ConnectionReplicationCredentialsArgs

    (Updatable) Database Administrator Credentials details.

    ssh_details ConnectionSshDetailsArgs

    (Updatable) Details of the SSH key that will be used. Required for source database Manual and UserManagerOci connection types. Not required for source container database connections.

    state str

    The current state of the Connection resource.

    system_tags Mapping[str, Any]

    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

    time_created str

    The time the Connection resource was created. An RFC3339 formatted datetime string.

    time_updated str

    The time of the last Connection resource details update. An RFC3339 formatted datetime string.

    tls_keystore str

    (Updatable) keystore.jks file contents; base64 encoded String. Requires a TLS wallet to be specified. Not required for source container database connections.

    tls_wallet str

    (Updatable) cwallet.sso containing containing the TCPS/SSL certificate; base64 encoded String. Not required for source container database connections.

    vault_details ConnectionVaultDetailsArgs

    (Updatable) Oracle Cloud Infrastructure Vault details to store migration and connection credentials secrets

    adminCredentials Property Map

    (Updatable) Database Administrator Credentials details.

    certificateTdn String

    (Updatable) This name is the distinguished name used while creating the certificate on target database. Requires a TLS wallet to be specified. Not required for source container database connections.

    compartmentId String

    (Updatable) OCID of the compartment where the secret containing the credentials will be created.

    connectDescriptor Property Map

    (Updatable) Connect Descriptor details. Required for Manual and UserManagerOci connection types. If a Private Endpoint was specified for the Connection, the host should contain a valid IP address.

    credentialsSecretId String

    OCID of the Secret in the Oracle Cloud Infrastructure vault containing the Database Connection credentials.

    databaseId String

    (Updatable) The OCID of the cloud database. Required if the database connection type is Autonomous.

    databaseType String

    Database connection type.

    definedTags Map<Any>

    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

    displayName String

    (Updatable) Database Connection display name identifier.

    freeformTags Map<Any>

    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

    lifecycleDetails String

    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

    nsgIds List<String>

    (Updatable) An array of Network Security Group OCIDs used to define network access for Connections.

    privateEndpoint Property Map

    (Updatable) Oracle Cloud Infrastructure Private Endpoint configuration details. Not required for source container database connections, it will default to the specified Source Database Connection Private Endpoint.

    replicationCredentials Property Map

    (Updatable) Database Administrator Credentials details.

    sshDetails Property Map

    (Updatable) Details of the SSH key that will be used. Required for source database Manual and UserManagerOci connection types. Not required for source container database connections.

    state String

    The current state of the Connection resource.

    systemTags Map<Any>

    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

    timeCreated String

    The time the Connection resource was created. An RFC3339 formatted datetime string.

    timeUpdated String

    The time of the last Connection resource details update. An RFC3339 formatted datetime string.

    tlsKeystore String

    (Updatable) keystore.jks file contents; base64 encoded String. Requires a TLS wallet to be specified. Not required for source container database connections.

    tlsWallet String

    (Updatable) cwallet.sso containing containing the TCPS/SSL certificate; base64 encoded String. Not required for source container database connections.

    vaultDetails Property Map

    (Updatable) Oracle Cloud Infrastructure Vault details to store migration and connection credentials secrets

    Supporting Types

    ConnectionAdminCredentials, ConnectionAdminCredentialsArgs

    Password string

    (Updatable) Administrator password

    Username string

    (Updatable) Administrator username

    Password string

    (Updatable) Administrator password

    Username string

    (Updatable) Administrator username

    password String

    (Updatable) Administrator password

    username String

    (Updatable) Administrator username

    password string

    (Updatable) Administrator password

    username string

    (Updatable) Administrator username

    password str

    (Updatable) Administrator password

    username str

    (Updatable) Administrator username

    password String

    (Updatable) Administrator password

    username String

    (Updatable) Administrator username

    ConnectionConnectDescriptor, ConnectionConnectDescriptorArgs

    ConnectString string

    (Updatable) Connect String. Required if no host, port nor databaseServiceName were specified. If a Private Endpoint was specified in the Connection, the host entry should be a valid IP address. Supported formats: Easy connect: :/<db_service_name> Long format: (description= (address=(port=)(host=))(connect_data=(service_name=<db_service_name>)))

    DatabaseServiceName string

    (Updatable) Database service name. Required if no connectString was specified.

    Host string

    (Updatable) Name of the host the SSH key is valid for.

    Port int

    (Updatable) Port of the connect descriptor. Required if no connectString was specified.

    ConnectString string

    (Updatable) Connect String. Required if no host, port nor databaseServiceName were specified. If a Private Endpoint was specified in the Connection, the host entry should be a valid IP address. Supported formats: Easy connect: :/<db_service_name> Long format: (description= (address=(port=)(host=))(connect_data=(service_name=<db_service_name>)))

    DatabaseServiceName string

    (Updatable) Database service name. Required if no connectString was specified.

    Host string

    (Updatable) Name of the host the SSH key is valid for.

    Port int

    (Updatable) Port of the connect descriptor. Required if no connectString was specified.

    connectString String

    (Updatable) Connect String. Required if no host, port nor databaseServiceName were specified. If a Private Endpoint was specified in the Connection, the host entry should be a valid IP address. Supported formats: Easy connect: :/<db_service_name> Long format: (description= (address=(port=)(host=))(connect_data=(service_name=<db_service_name>)))

    databaseServiceName String

    (Updatable) Database service name. Required if no connectString was specified.

    host String

    (Updatable) Name of the host the SSH key is valid for.

    port Integer

    (Updatable) Port of the connect descriptor. Required if no connectString was specified.

    connectString string

    (Updatable) Connect String. Required if no host, port nor databaseServiceName were specified. If a Private Endpoint was specified in the Connection, the host entry should be a valid IP address. Supported formats: Easy connect: :/<db_service_name> Long format: (description= (address=(port=)(host=))(connect_data=(service_name=<db_service_name>)))

    databaseServiceName string

    (Updatable) Database service name. Required if no connectString was specified.

    host string

    (Updatable) Name of the host the SSH key is valid for.

    port number

    (Updatable) Port of the connect descriptor. Required if no connectString was specified.

    connect_string str

    (Updatable) Connect String. Required if no host, port nor databaseServiceName were specified. If a Private Endpoint was specified in the Connection, the host entry should be a valid IP address. Supported formats: Easy connect: :/<db_service_name> Long format: (description= (address=(port=)(host=))(connect_data=(service_name=<db_service_name>)))

    database_service_name str

    (Updatable) Database service name. Required if no connectString was specified.

    host str

    (Updatable) Name of the host the SSH key is valid for.

    port int

    (Updatable) Port of the connect descriptor. Required if no connectString was specified.

    connectString String

    (Updatable) Connect String. Required if no host, port nor databaseServiceName were specified. If a Private Endpoint was specified in the Connection, the host entry should be a valid IP address. Supported formats: Easy connect: :/<db_service_name> Long format: (description= (address=(port=)(host=))(connect_data=(service_name=<db_service_name>)))

    databaseServiceName String

    (Updatable) Database service name. Required if no connectString was specified.

    host String

    (Updatable) Name of the host the SSH key is valid for.

    port Number

    (Updatable) Port of the connect descriptor. Required if no connectString was specified.

    ConnectionPrivateEndpoint, ConnectionPrivateEndpointArgs

    CompartmentId string

    (Updatable) OCID of the compartment where the secret containing the credentials will be created.

    SubnetId string

    (Updatable) The OCID of the customer's subnet where the private endpoint VNIC will reside.

    VcnId string

    (Updatable) The OCID of the VCN where the Private Endpoint will be bound to.

    Id string

    OCID of a previously created Private Endpoint.

    CompartmentId string

    (Updatable) OCID of the compartment where the secret containing the credentials will be created.

    SubnetId string

    (Updatable) The OCID of the customer's subnet where the private endpoint VNIC will reside.

    VcnId string

    (Updatable) The OCID of the VCN where the Private Endpoint will be bound to.

    Id string

    OCID of a previously created Private Endpoint.

    compartmentId String

    (Updatable) OCID of the compartment where the secret containing the credentials will be created.

    subnetId String

    (Updatable) The OCID of the customer's subnet where the private endpoint VNIC will reside.

    vcnId String

    (Updatable) The OCID of the VCN where the Private Endpoint will be bound to.

    id String

    OCID of a previously created Private Endpoint.

    compartmentId string

    (Updatable) OCID of the compartment where the secret containing the credentials will be created.

    subnetId string

    (Updatable) The OCID of the customer's subnet where the private endpoint VNIC will reside.

    vcnId string

    (Updatable) The OCID of the VCN where the Private Endpoint will be bound to.

    id string

    OCID of a previously created Private Endpoint.

    compartment_id str

    (Updatable) OCID of the compartment where the secret containing the credentials will be created.

    subnet_id str

    (Updatable) The OCID of the customer's subnet where the private endpoint VNIC will reside.

    vcn_id str

    (Updatable) The OCID of the VCN where the Private Endpoint will be bound to.

    id str

    OCID of a previously created Private Endpoint.

    compartmentId String

    (Updatable) OCID of the compartment where the secret containing the credentials will be created.

    subnetId String

    (Updatable) The OCID of the customer's subnet where the private endpoint VNIC will reside.

    vcnId String

    (Updatable) The OCID of the VCN where the Private Endpoint will be bound to.

    id String

    OCID of a previously created Private Endpoint.

    ConnectionReplicationCredentials, ConnectionReplicationCredentialsArgs

    Password string

    (Updatable) Administrator password

    Username string

    (Updatable) Administrator username

    Password string

    (Updatable) Administrator password

    Username string

    (Updatable) Administrator username

    password String

    (Updatable) Administrator password

    username String

    (Updatable) Administrator username

    password string

    (Updatable) Administrator password

    username string

    (Updatable) Administrator username

    password str

    (Updatable) Administrator password

    username str

    (Updatable) Administrator username

    password String

    (Updatable) Administrator password

    username String

    (Updatable) Administrator username

    ConnectionSshDetails, ConnectionSshDetailsArgs

    Host string

    (Updatable) Name of the host the SSH key is valid for.

    Sshkey string

    (Updatable) Private SSH key string.

    User string

    (Updatable) SSH user

    SudoLocation string

    (Updatable) Sudo location

    Host string

    (Updatable) Name of the host the SSH key is valid for.

    Sshkey string

    (Updatable) Private SSH key string.

    User string

    (Updatable) SSH user

    SudoLocation string

    (Updatable) Sudo location

    host String

    (Updatable) Name of the host the SSH key is valid for.

    sshkey String

    (Updatable) Private SSH key string.

    user String

    (Updatable) SSH user

    sudoLocation String

    (Updatable) Sudo location

    host string

    (Updatable) Name of the host the SSH key is valid for.

    sshkey string

    (Updatable) Private SSH key string.

    user string

    (Updatable) SSH user

    sudoLocation string

    (Updatable) Sudo location

    host str

    (Updatable) Name of the host the SSH key is valid for.

    sshkey str

    (Updatable) Private SSH key string.

    user str

    (Updatable) SSH user

    sudo_location str

    (Updatable) Sudo location

    host String

    (Updatable) Name of the host the SSH key is valid for.

    sshkey String

    (Updatable) Private SSH key string.

    user String

    (Updatable) SSH user

    sudoLocation String

    (Updatable) Sudo location

    ConnectionVaultDetails, ConnectionVaultDetailsArgs

    CompartmentId string

    (Updatable) OCID of the compartment where the secret containing the credentials will be created.

    KeyId string

    (Updatable) OCID of the vault encryption key

    VaultId string

    (Updatable) OCID of the vault

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

    CompartmentId string

    (Updatable) OCID of the compartment where the secret containing the credentials will be created.

    KeyId string

    (Updatable) OCID of the vault encryption key

    VaultId string

    (Updatable) OCID of the vault

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

    compartmentId String

    (Updatable) OCID of the compartment where the secret containing the credentials will be created.

    keyId String

    (Updatable) OCID of the vault encryption key

    vaultId String

    (Updatable) OCID of the vault

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

    compartmentId string

    (Updatable) OCID of the compartment where the secret containing the credentials will be created.

    keyId string

    (Updatable) OCID of the vault encryption key

    vaultId string

    (Updatable) OCID of the vault

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

    compartment_id str

    (Updatable) OCID of the compartment where the secret containing the credentials will be created.

    key_id str

    (Updatable) OCID of the vault encryption key

    vault_id str

    (Updatable) OCID of the vault

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

    compartmentId String

    (Updatable) OCID of the compartment where the secret containing the credentials will be created.

    keyId String

    (Updatable) OCID of the vault encryption key

    vaultId String

    (Updatable) OCID of the vault

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

    Import

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

     $ pulumi import oci:DatabaseMigration/connection:Connection test_connection "id"

    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.11.0 published on Wednesday, Sep 27, 2023 by Pulumi
    pulumi/pulumi-oci