Oracle Cloud Infrastructure v2.32.0, Apr 24 25

Oracle Cloud Infrastructure v2.32.0 published on Thursday, Apr 24, 2025 by Pulumi

oci.DatabaseMigration.Connection

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.32.0 published on Thursday, Apr 24, 2025 by Pulumi

Example Usage

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

const testConnection = new oci.databasemigration.Connection("test_connection", {
    compartmentId: compartmentId,
    connectionType: connectionConnectionType,
    displayName: connectionDisplayName,
    keyId: testKey.id,
    password: connectionPassword,
    technologyType: connectionTechnologyType,
    username: connectionUsername,
    vaultId: testVault.id,
    additionalAttributes: [{
        name: connectionAdditionalAttributesName,
        value: connectionAdditionalAttributesValue,
    }],
    connectionString: connectionConnectionString,
    databaseId: testDatabase.id,
    databaseName: testDatabase.name,
    dbSystemId: testDbSystem.id,
    definedTags: {
        "foo-namespace.bar-key": "value",
    },
    description: connectionDescription,
    freeformTags: connectionFreeformTags,
    host: connectionHost,
    nsgIds: connectionNsgIds,
    port: connectionPort,
    replicationPassword: connectionReplicationPassword,
    replicationUsername: connectionReplicationUsername,
    securityProtocol: connectionSecurityProtocol,
    sshHost: connectionSshHost,
    sshKey: connectionSshKey,
    sshSudoLocation: connectionSshSudoLocation,
    sshUser: connectionSshUser,
    sslCa: connectionSslCa,
    sslCert: connectionSslCert,
    sslCrl: connectionSslCrl,
    sslKey: connectionSslKey,
    sslMode: connectionSslMode,
    subnetId: testSubnet.id,
    wallet: connectionWallet,
});

import pulumi
import pulumi_oci as oci

test_connection = oci.database_migration.Connection("test_connection",
    compartment_id=compartment_id,
    connection_type=connection_connection_type,
    display_name=connection_display_name,
    key_id=test_key["id"],
    password=connection_password,
    technology_type=connection_technology_type,
    username=connection_username,
    vault_id=test_vault["id"],
    additional_attributes=[{
        "name": connection_additional_attributes_name,
        "value": connection_additional_attributes_value,
    }],
    connection_string=connection_connection_string,
    database_id=test_database["id"],
    database_name=test_database["name"],
    db_system_id=test_db_system["id"],
    defined_tags={
        "foo-namespace.bar-key": "value",
    },
    description=connection_description,
    freeform_tags=connection_freeform_tags,
    host=connection_host,
    nsg_ids=connection_nsg_ids,
    port=connection_port,
    replication_password=connection_replication_password,
    replication_username=connection_replication_username,
    security_protocol=connection_security_protocol,
    ssh_host=connection_ssh_host,
    ssh_key=connection_ssh_key,
    ssh_sudo_location=connection_ssh_sudo_location,
    ssh_user=connection_ssh_user,
    ssl_ca=connection_ssl_ca,
    ssl_cert=connection_ssl_cert,
    ssl_crl=connection_ssl_crl,
    ssl_key=connection_ssl_key,
    ssl_mode=connection_ssl_mode,
    subnet_id=test_subnet["id"],
    wallet=connection_wallet)

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := databasemigration.NewConnection(ctx, "test_connection", &databasemigration.ConnectionArgs{
			CompartmentId:  pulumi.Any(compartmentId),
			ConnectionType: pulumi.Any(connectionConnectionType),
			DisplayName:    pulumi.Any(connectionDisplayName),
			KeyId:          pulumi.Any(testKey.Id),
			Password:       pulumi.Any(connectionPassword),
			TechnologyType: pulumi.Any(connectionTechnologyType),
			Username:       pulumi.Any(connectionUsername),
			VaultId:        pulumi.Any(testVault.Id),
			AdditionalAttributes: databasemigration.ConnectionAdditionalAttributeArray{
				&databasemigration.ConnectionAdditionalAttributeArgs{
					Name:  pulumi.Any(connectionAdditionalAttributesName),
					Value: pulumi.Any(connectionAdditionalAttributesValue),
				},
			},
			ConnectionString: pulumi.Any(connectionConnectionString),
			DatabaseId:       pulumi.Any(testDatabase.Id),
			DatabaseName:     pulumi.Any(testDatabase.Name),
			DbSystemId:       pulumi.Any(testDbSystem.Id),
			DefinedTags: pulumi.StringMap{
				"foo-namespace.bar-key": pulumi.String("value"),
			},
			Description:         pulumi.Any(connectionDescription),
			FreeformTags:        pulumi.Any(connectionFreeformTags),
			Host:                pulumi.Any(connectionHost),
			NsgIds:              pulumi.Any(connectionNsgIds),
			Port:                pulumi.Any(connectionPort),
			ReplicationPassword: pulumi.Any(connectionReplicationPassword),
			ReplicationUsername: pulumi.Any(connectionReplicationUsername),
			SecurityProtocol:    pulumi.Any(connectionSecurityProtocol),
			SshHost:             pulumi.Any(connectionSshHost),
			SshKey:              pulumi.Any(connectionSshKey),
			SshSudoLocation:     pulumi.Any(connectionSshSudoLocation),
			SshUser:             pulumi.Any(connectionSshUser),
			SslCa:               pulumi.Any(connectionSslCa),
			SslCert:             pulumi.Any(connectionSslCert),
			SslCrl:              pulumi.Any(connectionSslCrl),
			SslKey:              pulumi.Any(connectionSslKey),
			SslMode:             pulumi.Any(connectionSslMode),
			SubnetId:            pulumi.Any(testSubnet.Id),
			Wallet:              pulumi.Any(connectionWallet),
		})
		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 testConnection = new Oci.DatabaseMigration.Connection("test_connection", new()
    {
        CompartmentId = compartmentId,
        ConnectionType = connectionConnectionType,
        DisplayName = connectionDisplayName,
        KeyId = testKey.Id,
        Password = connectionPassword,
        TechnologyType = connectionTechnologyType,
        Username = connectionUsername,
        VaultId = testVault.Id,
        AdditionalAttributes = new[]
        {
            new Oci.DatabaseMigration.Inputs.ConnectionAdditionalAttributeArgs
            {
                Name = connectionAdditionalAttributesName,
                Value = connectionAdditionalAttributesValue,
            },
        },
        ConnectionString = connectionConnectionString,
        DatabaseId = testDatabase.Id,
        DatabaseName = testDatabase.Name,
        DbSystemId = testDbSystem.Id,
        DefinedTags = 
        {
            { "foo-namespace.bar-key", "value" },
        },
        Description = connectionDescription,
        FreeformTags = connectionFreeformTags,
        Host = connectionHost,
        NsgIds = connectionNsgIds,
        Port = connectionPort,
        ReplicationPassword = connectionReplicationPassword,
        ReplicationUsername = connectionReplicationUsername,
        SecurityProtocol = connectionSecurityProtocol,
        SshHost = connectionSshHost,
        SshKey = connectionSshKey,
        SshSudoLocation = connectionSshSudoLocation,
        SshUser = connectionSshUser,
        SslCa = connectionSslCa,
        SslCert = connectionSslCert,
        SslCrl = connectionSslCrl,
        SslKey = connectionSslKey,
        SslMode = connectionSslMode,
        SubnetId = testSubnet.Id,
        Wallet = connectionWallet,
    });

});

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.ConnectionAdditionalAttributeArgs;
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()
            .compartmentId(compartmentId)
            .connectionType(connectionConnectionType)
            .displayName(connectionDisplayName)
            .keyId(testKey.id())
            .password(connectionPassword)
            .technologyType(connectionTechnologyType)
            .username(connectionUsername)
            .vaultId(testVault.id())
            .additionalAttributes(ConnectionAdditionalAttributeArgs.builder()
                .name(connectionAdditionalAttributesName)
                .value(connectionAdditionalAttributesValue)
                .build())
            .connectionString(connectionConnectionString)
            .databaseId(testDatabase.id())
            .databaseName(testDatabase.name())
            .dbSystemId(testDbSystem.id())
            .definedTags(Map.of("foo-namespace.bar-key", "value"))
            .description(connectionDescription)
            .freeformTags(connectionFreeformTags)
            .host(connectionHost)
            .nsgIds(connectionNsgIds)
            .port(connectionPort)
            .replicationPassword(connectionReplicationPassword)
            .replicationUsername(connectionReplicationUsername)
            .securityProtocol(connectionSecurityProtocol)
            .sshHost(connectionSshHost)
            .sshKey(connectionSshKey)
            .sshSudoLocation(connectionSshSudoLocation)
            .sshUser(connectionSshUser)
            .sslCa(connectionSslCa)
            .sslCert(connectionSslCert)
            .sslCrl(connectionSslCrl)
            .sslKey(connectionSslKey)
            .sslMode(connectionSslMode)
            .subnetId(testSubnet.id())
            .wallet(connectionWallet)
            .build());

    }
}

resources:
  testConnection:
    type: oci:DatabaseMigration:Connection
    name: test_connection
    properties:
      compartmentId: ${compartmentId}
      connectionType: ${connectionConnectionType}
      displayName: ${connectionDisplayName}
      keyId: ${testKey.id}
      password: ${connectionPassword}
      technologyType: ${connectionTechnologyType}
      username: ${connectionUsername}
      vaultId: ${testVault.id}
      additionalAttributes:
        - name: ${connectionAdditionalAttributesName}
          value: ${connectionAdditionalAttributesValue}
      connectionString: ${connectionConnectionString}
      databaseId: ${testDatabase.id}
      databaseName: ${testDatabase.name}
      dbSystemId: ${testDbSystem.id}
      definedTags:
        foo-namespace.bar-key: value
      description: ${connectionDescription}
      freeformTags: ${connectionFreeformTags}
      host: ${connectionHost}
      nsgIds: ${connectionNsgIds}
      port: ${connectionPort}
      replicationPassword: ${connectionReplicationPassword}
      replicationUsername: ${connectionReplicationUsername}
      securityProtocol: ${connectionSecurityProtocol}
      sshHost: ${connectionSshHost}
      sshKey: ${connectionSshKey}
      sshSudoLocation: ${connectionSshSudoLocation}
      sshUser: ${connectionSshUser}
      sslCa: ${connectionSslCa}
      sslCert: ${connectionSslCert}
      sslCrl: ${connectionSslCrl}
      sslKey: ${connectionSslKey}
      sslMode: ${connectionSslMode}
      subnetId: ${testSubnet.id}
      wallet: ${connectionWallet}

Create Connection Resource

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

Constructor syntax

new Connection(name: string, args: ConnectionArgs, opts?: CustomResourceOptions);

@overload
def Connection(resource_name: str,
               args: ConnectionArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def Connection(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               display_name: Optional[str] = None,
               compartment_id: Optional[str] = None,
               vault_id: Optional[str] = None,
               connection_type: Optional[str] = None,
               username: Optional[str] = None,
               technology_type: Optional[str] = None,
               password: Optional[str] = None,
               key_id: Optional[str] = None,
               replication_password: Optional[str] = None,
               ssh_sudo_location: Optional[str] = None,
               freeform_tags: Optional[Mapping[str, str]] = None,
               host: Optional[str] = None,
               defined_tags: Optional[Mapping[str, str]] = None,
               nsg_ids: Optional[Sequence[str]] = None,
               db_system_id: Optional[str] = None,
               port: Optional[int] = None,
               additional_attributes: Optional[Sequence[_databasemigration.ConnectionAdditionalAttributeArgs]] = None,
               replication_username: Optional[str] = None,
               security_protocol: Optional[str] = None,
               ssh_host: Optional[str] = None,
               ssh_key: Optional[str] = None,
               description: Optional[str] = None,
               ssh_user: Optional[str] = None,
               ssl_ca: Optional[str] = None,
               ssl_cert: Optional[str] = None,
               ssl_crl: Optional[str] = None,
               ssl_key: Optional[str] = None,
               ssl_mode: Optional[str] = None,
               subnet_id: Optional[str] = None,
               database_name: Optional[str] = None,
               database_id: Optional[str] = None,
               connection_string: Optional[str] = None,
               wallet: Optional[str] = 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.

Parameters

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.

Constructor example

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

var ociConnectionResource = new Oci.DatabaseMigration.Connection("ociConnectionResource", new()
{
    DisplayName = "string",
    CompartmentId = "string",
    VaultId = "string",
    ConnectionType = "string",
    Username = "string",
    TechnologyType = "string",
    Password = "string",
    KeyId = "string",
    ReplicationPassword = "string",
    SshSudoLocation = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    Host = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    NsgIds = new[]
    {
        "string",
    },
    DbSystemId = "string",
    Port = 0,
    AdditionalAttributes = new[]
    {
        new Oci.DatabaseMigration.Inputs.ConnectionAdditionalAttributeArgs
        {
            Name = "string",
            Value = "string",
        },
    },
    ReplicationUsername = "string",
    SecurityProtocol = "string",
    SshHost = "string",
    SshKey = "string",
    Description = "string",
    SshUser = "string",
    SslCa = "string",
    SslCert = "string",
    SslCrl = "string",
    SslKey = "string",
    SslMode = "string",
    SubnetId = "string",
    DatabaseName = "string",
    DatabaseId = "string",
    ConnectionString = "string",
    Wallet = "string",
});

example, err := databasemigration.NewConnection(ctx, "ociConnectionResource", &databasemigration.ConnectionArgs{
	DisplayName:         pulumi.String("string"),
	CompartmentId:       pulumi.String("string"),
	VaultId:             pulumi.String("string"),
	ConnectionType:      pulumi.String("string"),
	Username:            pulumi.String("string"),
	TechnologyType:      pulumi.String("string"),
	Password:            pulumi.String("string"),
	KeyId:               pulumi.String("string"),
	ReplicationPassword: pulumi.String("string"),
	SshSudoLocation:     pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Host: pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	NsgIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	DbSystemId: pulumi.String("string"),
	Port:       pulumi.Int(0),
	AdditionalAttributes: databasemigration.ConnectionAdditionalAttributeArray{
		&databasemigration.ConnectionAdditionalAttributeArgs{
			Name:  pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	ReplicationUsername: pulumi.String("string"),
	SecurityProtocol:    pulumi.String("string"),
	SshHost:             pulumi.String("string"),
	SshKey:              pulumi.String("string"),
	Description:         pulumi.String("string"),
	SshUser:             pulumi.String("string"),
	SslCa:               pulumi.String("string"),
	SslCert:             pulumi.String("string"),
	SslCrl:              pulumi.String("string"),
	SslKey:              pulumi.String("string"),
	SslMode:             pulumi.String("string"),
	SubnetId:            pulumi.String("string"),
	DatabaseName:        pulumi.String("string"),
	DatabaseId:          pulumi.String("string"),
	ConnectionString:    pulumi.String("string"),
	Wallet:              pulumi.String("string"),
})

var ociConnectionResource = new com.pulumi.oci.DatabaseMigration.Connection("ociConnectionResource", com.pulumi.oci.DatabaseMigration.ConnectionArgs.builder()
    .displayName("string")
    .compartmentId("string")
    .vaultId("string")
    .connectionType("string")
    .username("string")
    .technologyType("string")
    .password("string")
    .keyId("string")
    .replicationPassword("string")
    .sshSudoLocation("string")
    .freeformTags(Map.of("string", "string"))
    .host("string")
    .definedTags(Map.of("string", "string"))
    .nsgIds("string")
    .dbSystemId("string")
    .port(0)
    .additionalAttributes(ConnectionAdditionalAttributeArgs.builder()
        .name("string")
        .value("string")
        .build())
    .replicationUsername("string")
    .securityProtocol("string")
    .sshHost("string")
    .sshKey("string")
    .description("string")
    .sshUser("string")
    .sslCa("string")
    .sslCert("string")
    .sslCrl("string")
    .sslKey("string")
    .sslMode("string")
    .subnetId("string")
    .databaseName("string")
    .databaseId("string")
    .connectionString("string")
    .wallet("string")
    .build());

oci_connection_resource = oci.database_migration.Connection("ociConnectionResource",
    display_name="string",
    compartment_id="string",
    vault_id="string",
    connection_type="string",
    username="string",
    technology_type="string",
    password="string",
    key_id="string",
    replication_password="string",
    ssh_sudo_location="string",
    freeform_tags={
        "string": "string",
    },
    host="string",
    defined_tags={
        "string": "string",
    },
    nsg_ids=["string"],
    db_system_id="string",
    port=0,
    additional_attributes=[{
        "name": "string",
        "value": "string",
    }],
    replication_username="string",
    security_protocol="string",
    ssh_host="string",
    ssh_key="string",
    description="string",
    ssh_user="string",
    ssl_ca="string",
    ssl_cert="string",
    ssl_crl="string",
    ssl_key="string",
    ssl_mode="string",
    subnet_id="string",
    database_name="string",
    database_id="string",
    connection_string="string",
    wallet="string")

const ociConnectionResource = new oci.databasemigration.Connection("ociConnectionResource", {
    displayName: "string",
    compartmentId: "string",
    vaultId: "string",
    connectionType: "string",
    username: "string",
    technologyType: "string",
    password: "string",
    keyId: "string",
    replicationPassword: "string",
    sshSudoLocation: "string",
    freeformTags: {
        string: "string",
    },
    host: "string",
    definedTags: {
        string: "string",
    },
    nsgIds: ["string"],
    dbSystemId: "string",
    port: 0,
    additionalAttributes: [{
        name: "string",
        value: "string",
    }],
    replicationUsername: "string",
    securityProtocol: "string",
    sshHost: "string",
    sshKey: "string",
    description: "string",
    sshUser: "string",
    sslCa: "string",
    sslCert: "string",
    sslCrl: "string",
    sslKey: "string",
    sslMode: "string",
    subnetId: "string",
    databaseName: "string",
    databaseId: "string",
    connectionString: "string",
    wallet: "string",
});

type: oci:DatabaseMigration:Connection
properties:
    additionalAttributes:
        - name: string
          value: string
    compartmentId: string
    connectionString: string
    connectionType: string
    databaseId: string
    databaseName: string
    dbSystemId: string
    definedTags:
        string: string
    description: string
    displayName: string
    freeformTags:
        string: string
    host: string
    keyId: string
    nsgIds:
        - string
    password: string
    port: 0
    replicationPassword: string
    replicationUsername: string
    securityProtocol: string
    sshHost: string
    sshKey: string
    sshSudoLocation: string
    sshUser: string
    sslCa: string
    sslCert: string
    sslCrl: string
    sslKey: string
    sslMode: string
    subnetId: string
    technologyType: string
    username: string
    vaultId: string
    wallet: string

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

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

The Connection resource accepts the following input properties:

CompartmentId string

(Updatable) The OCID of the compartment.

ConnectionType string

(Updatable) Defines the type of connection. For example, ORACLE.

DisplayName string

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

KeyId string

(Updatable) The OCID of the key used in cryptographic operations.

Password string

(Updatable) The password (credential) used when creating or updating this resource.

TechnologyType string

The type of MySQL source or target connection. Example: OCI_MYSQL represents Oracle Cloud Infrastructure MySQL HeatWave Database Service

Username string

(Updatable) The username (credential) used when creating or updating this resource.

VaultId string

(Updatable) Oracle Cloud Infrastructure resource ID.

AdditionalAttributes List<ConnectionAdditionalAttribute>

(Updatable) An array of name-value pair attribute entries.

ConnectionString string

(Updatable) Connect descriptor or Easy Connect Naming method used to connect to a database.

DatabaseId string

(Updatable) The OCID of the database being referenced.

DatabaseName string

(Updatable) The name of the database being referenced.

DbSystemId string

(Updatable) The OCID of the database system being referenced.

DefinedTags Dictionary<string, string>

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

Description string

(Updatable) A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information.

FreeformTags Dictionary<string, string>

(Updatable) 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"}

Host string

(Updatable) The IP Address of the host.

NsgIds List<string>

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

Port int

(Updatable) The port to be used for the connection.

ReplicationPassword string

(Updatable) The password (credential) used when creating or updating this resource.

ReplicationUsername string

(Updatable) The username (credential) used when creating or updating this resource.

SecurityProtocol string

(Updatable) Security Type for MySQL.

SshHost string

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

SshKey string

(Updatable) Private SSH key string.

SshSudoLocation string

(Updatable) Sudo location

SshUser string

(Updatable) The username (credential) used when creating or updating this resource.

SslCa string

(Updatable) Database Certificate - The base64 encoded content of mysql.pem file containing the server public key (for 1 and 2-way SSL).

SslCert string

(Updatable) Client Certificate - The base64 encoded content of client-cert.pem file containing the client public key (for 2-way SSL).

SslCrl string

(Updatable) Certificates revoked by certificate authorities (CA). Server certificate must not be on this list (for 1 and 2-way SSL). Note: This is an optional and that too only applicable if TLS/MTLS option is selected.

SslKey string

(Updatable) Client Key - The client-key.pem containing the client private key (for 2-way SSL).

SslMode string

(Updatable) SSL modes for MySQL.

SubnetId string

(Updatable) Oracle Cloud Infrastructure resource ID.

Wallet string

(Updatable) The wallet contents used to make connections to a database. This attribute is expected to be base64 encoded.

** 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) The OCID of the compartment.

ConnectionType string

(Updatable) Defines the type of connection. For example, ORACLE.

DisplayName string

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

KeyId string

(Updatable) The OCID of the key used in cryptographic operations.

Password string

(Updatable) The password (credential) used when creating or updating this resource.

TechnologyType string

The type of MySQL source or target connection. Example: OCI_MYSQL represents Oracle Cloud Infrastructure MySQL HeatWave Database Service

Username string

(Updatable) The username (credential) used when creating or updating this resource.

VaultId string

(Updatable) Oracle Cloud Infrastructure resource ID.

AdditionalAttributes []ConnectionAdditionalAttributeArgs

(Updatable) An array of name-value pair attribute entries.

ConnectionString string

(Updatable) Connect descriptor or Easy Connect Naming method used to connect to a database.

DatabaseId string

(Updatable) The OCID of the database being referenced.

DatabaseName string

(Updatable) The name of the database being referenced.

DbSystemId string

(Updatable) The OCID of the database system being referenced.

DefinedTags map[string]string

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

Description string

(Updatable) A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information.

FreeformTags map[string]string

Host string

(Updatable) The IP Address of the host.

NsgIds []string

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

Port int

(Updatable) The port to be used for the connection.

ReplicationPassword string

(Updatable) The password (credential) used when creating or updating this resource.

ReplicationUsername string

(Updatable) The username (credential) used when creating or updating this resource.

SecurityProtocol string

(Updatable) Security Type for MySQL.

SshHost string

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

SshKey string

(Updatable) Private SSH key string.

SshSudoLocation string

(Updatable) Sudo location

SshUser string

(Updatable) The username (credential) used when creating or updating this resource.

SslCa string

(Updatable) Database Certificate - The base64 encoded content of mysql.pem file containing the server public key (for 1 and 2-way SSL).

SslCert string

(Updatable) Client Certificate - The base64 encoded content of client-cert.pem file containing the client public key (for 2-way SSL).

SslCrl string

SslKey string

(Updatable) Client Key - The client-key.pem containing the client private key (for 2-way SSL).

SslMode string

(Updatable) SSL modes for MySQL.

SubnetId string

(Updatable) Oracle Cloud Infrastructure resource ID.

Wallet string

(Updatable) The wallet contents used to make connections to a database. This attribute is expected to be base64 encoded.

** 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) The OCID of the compartment.

connectionType String

(Updatable) Defines the type of connection. For example, ORACLE.

displayName String

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

keyId String

(Updatable) The OCID of the key used in cryptographic operations.

password String

(Updatable) The password (credential) used when creating or updating this resource.

technologyType String

The type of MySQL source or target connection. Example: OCI_MYSQL represents Oracle Cloud Infrastructure MySQL HeatWave Database Service

username String

(Updatable) The username (credential) used when creating or updating this resource.

vaultId String

(Updatable) Oracle Cloud Infrastructure resource ID.

additionalAttributes List<ConnectionAdditionalAttribute>

(Updatable) An array of name-value pair attribute entries.

connectionString String

(Updatable) Connect descriptor or Easy Connect Naming method used to connect to a database.

databaseId String

(Updatable) The OCID of the database being referenced.

databaseName String

(Updatable) The name of the database being referenced.

dbSystemId String

(Updatable) The OCID of the database system being referenced.

definedTags Map<String,String>

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

description String

(Updatable) A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information.

freeformTags Map<String,String>

host String

(Updatable) The IP Address of the host.

nsgIds List<String>

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

port Integer

(Updatable) The port to be used for the connection.

replicationPassword String

(Updatable) The password (credential) used when creating or updating this resource.

replicationUsername String

(Updatable) The username (credential) used when creating or updating this resource.

securityProtocol String

(Updatable) Security Type for MySQL.

sshHost String

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

sshKey String

(Updatable) Private SSH key string.

sshSudoLocation String

(Updatable) Sudo location

sshUser String

(Updatable) The username (credential) used when creating or updating this resource.

sslCa String

(Updatable) Database Certificate - The base64 encoded content of mysql.pem file containing the server public key (for 1 and 2-way SSL).

sslCert String

(Updatable) Client Certificate - The base64 encoded content of client-cert.pem file containing the client public key (for 2-way SSL).

sslCrl String

sslKey String

(Updatable) Client Key - The client-key.pem containing the client private key (for 2-way SSL).

sslMode String

(Updatable) SSL modes for MySQL.

subnetId String

(Updatable) Oracle Cloud Infrastructure resource ID.

wallet String

(Updatable) The wallet contents used to make connections to a database. This attribute is expected to be base64 encoded.

** 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) The OCID of the compartment.

connectionType string

(Updatable) Defines the type of connection. For example, ORACLE.

displayName string

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

keyId string

(Updatable) The OCID of the key used in cryptographic operations.

password string

(Updatable) The password (credential) used when creating or updating this resource.

technologyType string

The type of MySQL source or target connection. Example: OCI_MYSQL represents Oracle Cloud Infrastructure MySQL HeatWave Database Service

username string

(Updatable) The username (credential) used when creating or updating this resource.

vaultId string

(Updatable) Oracle Cloud Infrastructure resource ID.

additionalAttributes ConnectionAdditionalAttribute[]

(Updatable) An array of name-value pair attribute entries.

connectionString string

(Updatable) Connect descriptor or Easy Connect Naming method used to connect to a database.

databaseId string

(Updatable) The OCID of the database being referenced.

databaseName string

(Updatable) The name of the database being referenced.

dbSystemId string

(Updatable) The OCID of the database system being referenced.

definedTags {[key: string]: string}

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

description string

(Updatable) A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information.

freeformTags {[key: string]: string}

host string

(Updatable) The IP Address of the host.

nsgIds string[]

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

port number

(Updatable) The port to be used for the connection.

replicationPassword string

(Updatable) The password (credential) used when creating or updating this resource.

replicationUsername string

(Updatable) The username (credential) used when creating or updating this resource.

securityProtocol string

(Updatable) Security Type for MySQL.

sshHost string

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

sshKey string

(Updatable) Private SSH key string.

sshSudoLocation string

(Updatable) Sudo location

sshUser string

(Updatable) The username (credential) used when creating or updating this resource.

sslCa string

(Updatable) Database Certificate - The base64 encoded content of mysql.pem file containing the server public key (for 1 and 2-way SSL).

sslCert string

(Updatable) Client Certificate - The base64 encoded content of client-cert.pem file containing the client public key (for 2-way SSL).

sslCrl string

sslKey string

(Updatable) Client Key - The client-key.pem containing the client private key (for 2-way SSL).

sslMode string

(Updatable) SSL modes for MySQL.

subnetId string

(Updatable) Oracle Cloud Infrastructure resource ID.

wallet string

(Updatable) The wallet contents used to make connections to a database. This attribute is expected to be base64 encoded.

** 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) The OCID of the compartment.

connection_type str

(Updatable) Defines the type of connection. For example, ORACLE.

display_name str

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

key_id str

(Updatable) The OCID of the key used in cryptographic operations.

password str

(Updatable) The password (credential) used when creating or updating this resource.

technology_type str

The type of MySQL source or target connection. Example: OCI_MYSQL represents Oracle Cloud Infrastructure MySQL HeatWave Database Service

username str

(Updatable) The username (credential) used when creating or updating this resource.

vault_id str

(Updatable) Oracle Cloud Infrastructure resource ID.

additional_attributes Sequence[databasemigration.ConnectionAdditionalAttributeArgs]

(Updatable) An array of name-value pair attribute entries.

connection_string str

(Updatable) Connect descriptor or Easy Connect Naming method used to connect to a database.

database_id str

(Updatable) The OCID of the database being referenced.

database_name str

(Updatable) The name of the database being referenced.

db_system_id str

(Updatable) The OCID of the database system being referenced.

defined_tags Mapping[str, str]

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

description str

(Updatable) A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information.

freeform_tags Mapping[str, str]

host str

(Updatable) The IP Address of the host.

nsg_ids Sequence[str]

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

port int

(Updatable) The port to be used for the connection.

replication_password str

(Updatable) The password (credential) used when creating or updating this resource.

replication_username str

(Updatable) The username (credential) used when creating or updating this resource.

security_protocol str

(Updatable) Security Type for MySQL.

ssh_host str

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

ssh_key str

(Updatable) Private SSH key string.

ssh_sudo_location str

(Updatable) Sudo location

ssh_user str

(Updatable) The username (credential) used when creating or updating this resource.

ssl_ca str

(Updatable) Database Certificate - The base64 encoded content of mysql.pem file containing the server public key (for 1 and 2-way SSL).

ssl_cert str

(Updatable) Client Certificate - The base64 encoded content of client-cert.pem file containing the client public key (for 2-way SSL).

ssl_crl str

ssl_key str

(Updatable) Client Key - The client-key.pem containing the client private key (for 2-way SSL).

ssl_mode str

(Updatable) SSL modes for MySQL.

subnet_id str

(Updatable) Oracle Cloud Infrastructure resource ID.

wallet str

(Updatable) The wallet contents used to make connections to a database. This attribute is expected to be base64 encoded.

** 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) The OCID of the compartment.

connectionType String

(Updatable) Defines the type of connection. For example, ORACLE.

displayName String

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

keyId String

(Updatable) The OCID of the key used in cryptographic operations.

password String

(Updatable) The password (credential) used when creating or updating this resource.

technologyType String

The type of MySQL source or target connection. Example: OCI_MYSQL represents Oracle Cloud Infrastructure MySQL HeatWave Database Service

username String

(Updatable) The username (credential) used when creating or updating this resource.

vaultId String

(Updatable) Oracle Cloud Infrastructure resource ID.

additionalAttributes List<Property Map>

(Updatable) An array of name-value pair attribute entries.

connectionString String

(Updatable) Connect descriptor or Easy Connect Naming method used to connect to a database.

databaseId String

(Updatable) The OCID of the database being referenced.

databaseName String

(Updatable) The name of the database being referenced.

dbSystemId String

(Updatable) The OCID of the database system being referenced.

definedTags Map<String>

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

description String

(Updatable) A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information.

freeformTags Map<String>

host String

(Updatable) The IP Address of the host.

nsgIds List<String>

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

port Number

(Updatable) The port to be used for the connection.

replicationPassword String

(Updatable) The password (credential) used when creating or updating this resource.

replicationUsername String

(Updatable) The username (credential) used when creating or updating this resource.

securityProtocol String

(Updatable) Security Type for MySQL.

sshHost String

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

sshKey String

(Updatable) Private SSH key string.

sshSudoLocation String

(Updatable) Sudo location

sshUser String

(Updatable) The username (credential) used when creating or updating this resource.

sslCa String

(Updatable) Database Certificate - The base64 encoded content of mysql.pem file containing the server public key (for 1 and 2-way SSL).

sslCert String

(Updatable) Client Certificate - The base64 encoded content of client-cert.pem file containing the client public key (for 2-way SSL).

sslCrl String

sslKey String

(Updatable) Client Key - The client-key.pem containing the client private key (for 2-way SSL).

sslMode String

(Updatable) SSL modes for MySQL.

subnetId String

(Updatable) Oracle Cloud Infrastructure resource ID.

wallet String

(Updatable) The wallet contents used to make connections to a database. This attribute is expected to be base64 encoded.

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

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
IngressIps List<ConnectionIngressIp>: List of ingress IP addresses from where to connect to this connection's privateIp.
LifecycleDetails string: The message describing the current state of the connection's lifecycle in detail. For example, can be used to provide actionable information for a connection in a Failed state.
PrivateEndpointId string: The OCID of the resource being referenced.
SecretId string: The OCID of the resource being referenced.
State string: The Connection's current lifecycle state.
SystemTags Dictionary<string, string>: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string: The time when this resource was created. An RFC3339 formatted datetime string such as 2016-08-25T21:10:29.600Z.
TimeUpdated string: The time when this resource was updated. An RFC3339 formatted datetime string such as 2016-08-25T21:10:29.600Z.

Id string: The provider-assigned unique ID for this managed resource.
IngressIps []ConnectionIngressIp: List of ingress IP addresses from where to connect to this connection's privateIp.
LifecycleDetails string: The message describing the current state of the connection's lifecycle in detail. For example, can be used to provide actionable information for a connection in a Failed state.
PrivateEndpointId string: The OCID of the resource being referenced.
SecretId string: The OCID of the resource being referenced.
State string: The Connection's current lifecycle state.
SystemTags map[string]string: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string: The time when this resource was created. An RFC3339 formatted datetime string such as 2016-08-25T21:10:29.600Z.
TimeUpdated string: The time when this resource was updated. An RFC3339 formatted datetime string such as 2016-08-25T21:10:29.600Z.

id String: The provider-assigned unique ID for this managed resource.
ingressIps List<ConnectionIngressIp>: List of ingress IP addresses from where to connect to this connection's privateIp.
lifecycleDetails String: The message describing the current state of the connection's lifecycle in detail. For example, can be used to provide actionable information for a connection in a Failed state.
privateEndpointId String: The OCID of the resource being referenced.
secretId String: The OCID of the resource being referenced.
state String: The Connection's current lifecycle state.
systemTags Map<String,String>: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String: The time when this resource was created. An RFC3339 formatted datetime string such as 2016-08-25T21:10:29.600Z.
timeUpdated String: The time when this resource was updated. An RFC3339 formatted datetime string such as 2016-08-25T21:10:29.600Z.

id string: The provider-assigned unique ID for this managed resource.
ingressIps ConnectionIngressIp[]: List of ingress IP addresses from where to connect to this connection's privateIp.
lifecycleDetails string: The message describing the current state of the connection's lifecycle in detail. For example, can be used to provide actionable information for a connection in a Failed state.
privateEndpointId string: The OCID of the resource being referenced.
secretId string: The OCID of the resource being referenced.
state string: The Connection's current lifecycle state.
systemTags {[key: string]: string}: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated string: The time when this resource was created. An RFC3339 formatted datetime string such as 2016-08-25T21:10:29.600Z.
timeUpdated string: The time when this resource was updated. An RFC3339 formatted datetime string such as 2016-08-25T21:10:29.600Z.

id str: The provider-assigned unique ID for this managed resource.
ingress_ips Sequence[databasemigration.ConnectionIngressIp]: List of ingress IP addresses from where to connect to this connection's privateIp.
lifecycle_details str: The message describing the current state of the connection's lifecycle in detail. For example, can be used to provide actionable information for a connection in a Failed state.
private_endpoint_id str: The OCID of the resource being referenced.
secret_id str: The OCID of the resource being referenced.
state str: The Connection's current lifecycle state.
system_tags Mapping[str, str]: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
time_created str: The time when this resource was created. An RFC3339 formatted datetime string such as 2016-08-25T21:10:29.600Z.
time_updated str: The time when this resource was updated. An RFC3339 formatted datetime string such as 2016-08-25T21:10:29.600Z.

id String: The provider-assigned unique ID for this managed resource.
ingressIps List<Property Map>: List of ingress IP addresses from where to connect to this connection's privateIp.
lifecycleDetails String: The message describing the current state of the connection's lifecycle in detail. For example, can be used to provide actionable information for a connection in a Failed state.
privateEndpointId String: The OCID of the resource being referenced.
secretId String: The OCID of the resource being referenced.
state String: The Connection's current lifecycle state.
systemTags Map<String>: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String: The time when this resource was created. An RFC3339 formatted datetime string such as 2016-08-25T21:10:29.600Z.
timeUpdated String: The time when this resource was updated. An RFC3339 formatted datetime string such as 2016-08-25T21:10:29.600Z.

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,
        additional_attributes: Optional[Sequence[_databasemigration.ConnectionAdditionalAttributeArgs]] = None,
        compartment_id: Optional[str] = None,
        connection_string: Optional[str] = None,
        connection_type: Optional[str] = None,
        database_id: Optional[str] = None,
        database_name: Optional[str] = None,
        db_system_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        host: Optional[str] = None,
        ingress_ips: Optional[Sequence[_databasemigration.ConnectionIngressIpArgs]] = None,
        key_id: Optional[str] = None,
        lifecycle_details: Optional[str] = None,
        nsg_ids: Optional[Sequence[str]] = None,
        password: Optional[str] = None,
        port: Optional[int] = None,
        private_endpoint_id: Optional[str] = None,
        replication_password: Optional[str] = None,
        replication_username: Optional[str] = None,
        secret_id: Optional[str] = None,
        security_protocol: Optional[str] = None,
        ssh_host: Optional[str] = None,
        ssh_key: Optional[str] = None,
        ssh_sudo_location: Optional[str] = None,
        ssh_user: Optional[str] = None,
        ssl_ca: Optional[str] = None,
        ssl_cert: Optional[str] = None,
        ssl_crl: Optional[str] = None,
        ssl_key: Optional[str] = None,
        ssl_mode: Optional[str] = None,
        state: Optional[str] = None,
        subnet_id: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        technology_type: Optional[str] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None,
        username: Optional[str] = None,
        vault_id: Optional[str] = None,
        wallet: Optional[str] = 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)

resources:  _:    type: oci:DatabaseMigration:Connection    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AdditionalAttributes List<ConnectionAdditionalAttribute>

(Updatable) An array of name-value pair attribute entries.

CompartmentId string

(Updatable) The OCID of the compartment.

ConnectionString string

(Updatable) Connect descriptor or Easy Connect Naming method used to connect to a database.

ConnectionType string

(Updatable) Defines the type of connection. For example, ORACLE.

DatabaseId string

(Updatable) The OCID of the database being referenced.

DatabaseName string

(Updatable) The name of the database being referenced.

DbSystemId string

(Updatable) The OCID of the database system being referenced.

DefinedTags Dictionary<string, string>

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

Description string

(Updatable) A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information.

DisplayName string

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

FreeformTags Dictionary<string, string>

Host string

(Updatable) The IP Address of the host.

IngressIps List<ConnectionIngressIp>

List of ingress IP addresses from where to connect to this connection's privateIp.

KeyId string

(Updatable) The OCID of the key used in cryptographic operations.

LifecycleDetails string

The message describing the current state of the connection's lifecycle in detail. For example, can be used to provide actionable information for a connection in a Failed state.

NsgIds List<string>

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

Password string

(Updatable) The password (credential) used when creating or updating this resource.

Port int

(Updatable) The port to be used for the connection.

PrivateEndpointId string

The OCID of the resource being referenced.

ReplicationPassword string

(Updatable) The password (credential) used when creating or updating this resource.

ReplicationUsername string

(Updatable) The username (credential) used when creating or updating this resource.

SecretId string

The OCID of the resource being referenced.

SecurityProtocol string

(Updatable) Security Type for MySQL.

SshHost string

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

SshKey string

(Updatable) Private SSH key string.

SshSudoLocation string

(Updatable) Sudo location

SshUser string

(Updatable) The username (credential) used when creating or updating this resource.

SslCa string

(Updatable) Database Certificate - The base64 encoded content of mysql.pem file containing the server public key (for 1 and 2-way SSL).

SslCert string

(Updatable) Client Certificate - The base64 encoded content of client-cert.pem file containing the client public key (for 2-way SSL).

SslCrl string

SslKey string

(Updatable) Client Key - The client-key.pem containing the client private key (for 2-way SSL).

SslMode string

(Updatable) SSL modes for MySQL.

State string

The Connection's current lifecycle state.

SubnetId string

(Updatable) Oracle Cloud Infrastructure resource ID.

SystemTags Dictionary<string, string>

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

TechnologyType string

The type of MySQL source or target connection. Example: OCI_MYSQL represents Oracle Cloud Infrastructure MySQL HeatWave Database Service

TimeCreated string

The time when this resource was created. An RFC3339 formatted datetime string such as 2016-08-25T21:10:29.600Z.

TimeUpdated string

The time when this resource was updated. An RFC3339 formatted datetime string such as 2016-08-25T21:10:29.600Z.

Username string

(Updatable) The username (credential) used when creating or updating this resource.

VaultId string

(Updatable) Oracle Cloud Infrastructure resource ID.

Wallet string

(Updatable) The wallet contents used to make connections to a database. This attribute is expected to be base64 encoded.

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

AdditionalAttributes []ConnectionAdditionalAttributeArgs

(Updatable) An array of name-value pair attribute entries.

CompartmentId string

(Updatable) The OCID of the compartment.

ConnectionString string

(Updatable) Connect descriptor or Easy Connect Naming method used to connect to a database.

ConnectionType string

(Updatable) Defines the type of connection. For example, ORACLE.

DatabaseId string

(Updatable) The OCID of the database being referenced.

DatabaseName string

(Updatable) The name of the database being referenced.

DbSystemId string

(Updatable) The OCID of the database system being referenced.

DefinedTags map[string]string

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

Description string

(Updatable) A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information.

DisplayName string

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

FreeformTags map[string]string

Host string

(Updatable) The IP Address of the host.

IngressIps []ConnectionIngressIpArgs

List of ingress IP addresses from where to connect to this connection's privateIp.

KeyId string

(Updatable) The OCID of the key used in cryptographic operations.

LifecycleDetails string

The message describing the current state of the connection's lifecycle in detail. For example, can be used to provide actionable information for a connection in a Failed state.

NsgIds []string

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

Password string

(Updatable) The password (credential) used when creating or updating this resource.

Port int

(Updatable) The port to be used for the connection.

PrivateEndpointId string

The OCID of the resource being referenced.

ReplicationPassword string

(Updatable) The password (credential) used when creating or updating this resource.

ReplicationUsername string

(Updatable) The username (credential) used when creating or updating this resource.

SecretId string

The OCID of the resource being referenced.

SecurityProtocol string

(Updatable) Security Type for MySQL.

SshHost string

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

SshKey string

(Updatable) Private SSH key string.

SshSudoLocation string

(Updatable) Sudo location

SshUser string

(Updatable) The username (credential) used when creating or updating this resource.

SslCa string

(Updatable) Database Certificate - The base64 encoded content of mysql.pem file containing the server public key (for 1 and 2-way SSL).

SslCert string

(Updatable) Client Certificate - The base64 encoded content of client-cert.pem file containing the client public key (for 2-way SSL).

SslCrl string

SslKey string

(Updatable) Client Key - The client-key.pem containing the client private key (for 2-way SSL).

SslMode string

(Updatable) SSL modes for MySQL.

State string

The Connection's current lifecycle state.

SubnetId string

(Updatable) Oracle Cloud Infrastructure resource ID.

SystemTags map[string]string

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

TechnologyType string

The type of MySQL source or target connection. Example: OCI_MYSQL represents Oracle Cloud Infrastructure MySQL HeatWave Database Service

TimeCreated string

The time when this resource was created. An RFC3339 formatted datetime string such as 2016-08-25T21:10:29.600Z.

TimeUpdated string

The time when this resource was updated. An RFC3339 formatted datetime string such as 2016-08-25T21:10:29.600Z.

Username string

(Updatable) The username (credential) used when creating or updating this resource.

VaultId string

(Updatable) Oracle Cloud Infrastructure resource ID.

Wallet string

(Updatable) The wallet contents used to make connections to a database. This attribute is expected to be base64 encoded.

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

additionalAttributes List<ConnectionAdditionalAttribute>

(Updatable) An array of name-value pair attribute entries.

compartmentId String

(Updatable) The OCID of the compartment.

connectionString String

(Updatable) Connect descriptor or Easy Connect Naming method used to connect to a database.

connectionType String

(Updatable) Defines the type of connection. For example, ORACLE.

databaseId String

(Updatable) The OCID of the database being referenced.

databaseName String

(Updatable) The name of the database being referenced.

dbSystemId String

(Updatable) The OCID of the database system being referenced.

definedTags Map<String,String>

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

description String

(Updatable) A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information.

displayName String

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

freeformTags Map<String,String>

host String

(Updatable) The IP Address of the host.

ingressIps List<ConnectionIngressIp>

List of ingress IP addresses from where to connect to this connection's privateIp.

keyId String

(Updatable) The OCID of the key used in cryptographic operations.

lifecycleDetails String

The message describing the current state of the connection's lifecycle in detail. For example, can be used to provide actionable information for a connection in a Failed state.

nsgIds List<String>

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

password String

(Updatable) The password (credential) used when creating or updating this resource.

port Integer

(Updatable) The port to be used for the connection.

privateEndpointId String

The OCID of the resource being referenced.

replicationPassword String

(Updatable) The password (credential) used when creating or updating this resource.

replicationUsername String

(Updatable) The username (credential) used when creating or updating this resource.

secretId String

The OCID of the resource being referenced.

securityProtocol String

(Updatable) Security Type for MySQL.

sshHost String

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

sshKey String

(Updatable) Private SSH key string.

sshSudoLocation String

(Updatable) Sudo location

sshUser String

(Updatable) The username (credential) used when creating or updating this resource.

sslCa String

(Updatable) Database Certificate - The base64 encoded content of mysql.pem file containing the server public key (for 1 and 2-way SSL).

sslCert String

(Updatable) Client Certificate - The base64 encoded content of client-cert.pem file containing the client public key (for 2-way SSL).

sslCrl String

sslKey String

(Updatable) Client Key - The client-key.pem containing the client private key (for 2-way SSL).

sslMode String

(Updatable) SSL modes for MySQL.

state String

The Connection's current lifecycle state.

subnetId String

(Updatable) Oracle Cloud Infrastructure resource ID.

systemTags Map<String,String>

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

technologyType String

The type of MySQL source or target connection. Example: OCI_MYSQL represents Oracle Cloud Infrastructure MySQL HeatWave Database Service

timeCreated String

The time when this resource was created. An RFC3339 formatted datetime string such as 2016-08-25T21:10:29.600Z.

timeUpdated String

The time when this resource was updated. An RFC3339 formatted datetime string such as 2016-08-25T21:10:29.600Z.

username String

(Updatable) The username (credential) used when creating or updating this resource.

vaultId String

(Updatable) Oracle Cloud Infrastructure resource ID.

wallet String

(Updatable) The wallet contents used to make connections to a database. This attribute is expected to be base64 encoded.

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

additionalAttributes ConnectionAdditionalAttribute[]

(Updatable) An array of name-value pair attribute entries.

compartmentId string

(Updatable) The OCID of the compartment.

connectionString string

(Updatable) Connect descriptor or Easy Connect Naming method used to connect to a database.

connectionType string

(Updatable) Defines the type of connection. For example, ORACLE.

databaseId string

(Updatable) The OCID of the database being referenced.

databaseName string

(Updatable) The name of the database being referenced.

dbSystemId string

(Updatable) The OCID of the database system being referenced.

definedTags {[key: string]: string}

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

description string

(Updatable) A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information.

displayName string

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

freeformTags {[key: string]: string}

host string

(Updatable) The IP Address of the host.

ingressIps ConnectionIngressIp[]

List of ingress IP addresses from where to connect to this connection's privateIp.

keyId string

(Updatable) The OCID of the key used in cryptographic operations.

lifecycleDetails string

The message describing the current state of the connection's lifecycle in detail. For example, can be used to provide actionable information for a connection in a Failed state.

nsgIds string[]

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

password string

(Updatable) The password (credential) used when creating or updating this resource.

port number

(Updatable) The port to be used for the connection.

privateEndpointId string

The OCID of the resource being referenced.

replicationPassword string

(Updatable) The password (credential) used when creating or updating this resource.

replicationUsername string

(Updatable) The username (credential) used when creating or updating this resource.

secretId string

The OCID of the resource being referenced.

securityProtocol string

(Updatable) Security Type for MySQL.

sshHost string

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

sshKey string

(Updatable) Private SSH key string.

sshSudoLocation string

(Updatable) Sudo location

sshUser string

(Updatable) The username (credential) used when creating or updating this resource.

sslCa string

(Updatable) Database Certificate - The base64 encoded content of mysql.pem file containing the server public key (for 1 and 2-way SSL).

sslCert string

(Updatable) Client Certificate - The base64 encoded content of client-cert.pem file containing the client public key (for 2-way SSL).

sslCrl string

sslKey string

(Updatable) Client Key - The client-key.pem containing the client private key (for 2-way SSL).

sslMode string

(Updatable) SSL modes for MySQL.

state string

The Connection's current lifecycle state.

subnetId string

(Updatable) Oracle Cloud Infrastructure resource ID.

systemTags {[key: string]: string}

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

technologyType string

The type of MySQL source or target connection. Example: OCI_MYSQL represents Oracle Cloud Infrastructure MySQL HeatWave Database Service

timeCreated string

The time when this resource was created. An RFC3339 formatted datetime string such as 2016-08-25T21:10:29.600Z.

timeUpdated string

The time when this resource was updated. An RFC3339 formatted datetime string such as 2016-08-25T21:10:29.600Z.

username string

(Updatable) The username (credential) used when creating or updating this resource.

vaultId string

(Updatable) Oracle Cloud Infrastructure resource ID.

wallet string

(Updatable) The wallet contents used to make connections to a database. This attribute is expected to be base64 encoded.

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

additional_attributes Sequence[databasemigration.ConnectionAdditionalAttributeArgs]

(Updatable) An array of name-value pair attribute entries.

compartment_id str

(Updatable) The OCID of the compartment.

connection_string str

(Updatable) Connect descriptor or Easy Connect Naming method used to connect to a database.

connection_type str

(Updatable) Defines the type of connection. For example, ORACLE.

database_id str

(Updatable) The OCID of the database being referenced.

database_name str

(Updatable) The name of the database being referenced.

db_system_id str

(Updatable) The OCID of the database system being referenced.

defined_tags Mapping[str, str]

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

description str

(Updatable) A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information.

display_name str

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

freeform_tags Mapping[str, str]

host str

(Updatable) The IP Address of the host.

ingress_ips Sequence[databasemigration.ConnectionIngressIpArgs]

List of ingress IP addresses from where to connect to this connection's privateIp.

key_id str

(Updatable) The OCID of the key used in cryptographic operations.

lifecycle_details str

The message describing the current state of the connection's lifecycle in detail. For example, can be used to provide actionable information for a connection in a Failed state.

nsg_ids Sequence[str]

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

password str

(Updatable) The password (credential) used when creating or updating this resource.

port int

(Updatable) The port to be used for the connection.

private_endpoint_id str

The OCID of the resource being referenced.

replication_password str

(Updatable) The password (credential) used when creating or updating this resource.

replication_username str

(Updatable) The username (credential) used when creating or updating this resource.

secret_id str

The OCID of the resource being referenced.

security_protocol str

(Updatable) Security Type for MySQL.

ssh_host str

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

ssh_key str

(Updatable) Private SSH key string.

ssh_sudo_location str

(Updatable) Sudo location

ssh_user str

(Updatable) The username (credential) used when creating or updating this resource.

ssl_ca str

(Updatable) Database Certificate - The base64 encoded content of mysql.pem file containing the server public key (for 1 and 2-way SSL).

ssl_cert str

(Updatable) Client Certificate - The base64 encoded content of client-cert.pem file containing the client public key (for 2-way SSL).

ssl_crl str

ssl_key str

(Updatable) Client Key - The client-key.pem containing the client private key (for 2-way SSL).

ssl_mode str

(Updatable) SSL modes for MySQL.

state str

The Connection's current lifecycle state.

subnet_id str

(Updatable) Oracle Cloud Infrastructure resource ID.

system_tags Mapping[str, str]

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

technology_type str

The type of MySQL source or target connection. Example: OCI_MYSQL represents Oracle Cloud Infrastructure MySQL HeatWave Database Service

time_created str

The time when this resource was created. An RFC3339 formatted datetime string such as 2016-08-25T21:10:29.600Z.

time_updated str

The time when this resource was updated. An RFC3339 formatted datetime string such as 2016-08-25T21:10:29.600Z.

username str

(Updatable) The username (credential) used when creating or updating this resource.

vault_id str

(Updatable) Oracle Cloud Infrastructure resource ID.

wallet str

(Updatable) The wallet contents used to make connections to a database. This attribute is expected to be base64 encoded.

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

additionalAttributes List<Property Map>

(Updatable) An array of name-value pair attribute entries.

compartmentId String

(Updatable) The OCID of the compartment.

connectionString String

(Updatable) Connect descriptor or Easy Connect Naming method used to connect to a database.

connectionType String

(Updatable) Defines the type of connection. For example, ORACLE.

databaseId String

(Updatable) The OCID of the database being referenced.

databaseName String

(Updatable) The name of the database being referenced.

dbSystemId String

(Updatable) The OCID of the database system being referenced.

definedTags Map<String>

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

description String

(Updatable) A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information.

displayName String

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

freeformTags Map<String>

host String

(Updatable) The IP Address of the host.

ingressIps List<Property Map>

List of ingress IP addresses from where to connect to this connection's privateIp.

keyId String

(Updatable) The OCID of the key used in cryptographic operations.

lifecycleDetails String

The message describing the current state of the connection's lifecycle in detail. For example, can be used to provide actionable information for a connection in a Failed state.

nsgIds List<String>

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

password String

(Updatable) The password (credential) used when creating or updating this resource.

port Number

(Updatable) The port to be used for the connection.

privateEndpointId String

The OCID of the resource being referenced.

replicationPassword String

(Updatable) The password (credential) used when creating or updating this resource.

replicationUsername String

(Updatable) The username (credential) used when creating or updating this resource.

secretId String

The OCID of the resource being referenced.

securityProtocol String

(Updatable) Security Type for MySQL.

sshHost String

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

sshKey String

(Updatable) Private SSH key string.

sshSudoLocation String

(Updatable) Sudo location

sshUser String

(Updatable) The username (credential) used when creating or updating this resource.

sslCa String

(Updatable) Database Certificate - The base64 encoded content of mysql.pem file containing the server public key (for 1 and 2-way SSL).

sslCert String

(Updatable) Client Certificate - The base64 encoded content of client-cert.pem file containing the client public key (for 2-way SSL).

sslCrl String

sslKey String

(Updatable) Client Key - The client-key.pem containing the client private key (for 2-way SSL).

sslMode String

(Updatable) SSL modes for MySQL.

state String

The Connection's current lifecycle state.

subnetId String

(Updatable) Oracle Cloud Infrastructure resource ID.

systemTags Map<String>

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

technologyType String

The type of MySQL source or target connection. Example: OCI_MYSQL represents Oracle Cloud Infrastructure MySQL HeatWave Database Service

timeCreated String

The time when this resource was created. An RFC3339 formatted datetime string such as 2016-08-25T21:10:29.600Z.

timeUpdated String

The time when this resource was updated. An RFC3339 formatted datetime string such as 2016-08-25T21:10:29.600Z.

username String

(Updatable) The username (credential) used when creating or updating this resource.

vaultId String

(Updatable) Oracle Cloud Infrastructure resource ID.

wallet String

(Updatable) The wallet contents used to make connections to a database. This attribute is expected to be base64 encoded.

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

Supporting Types

ConnectionAdditionalAttribute, ConnectionAdditionalAttributeArgs

Name string: (Updatable) The name of the property entry.
Value string: (Updatable) The value of the property entry.

Name string: (Updatable) The name of the property entry.
Value string: (Updatable) The value of the property entry.

name String: (Updatable) The name of the property entry.
value String: (Updatable) The value of the property entry.

name string: (Updatable) The name of the property entry.
value string: (Updatable) The value of the property entry.

name str: (Updatable) The name of the property entry.
value str: (Updatable) The value of the property entry.

name String: (Updatable) The name of the property entry.
value String: (Updatable) The value of the property entry.

ConnectionIngressIp, ConnectionIngressIpArgs

IngressIp string: A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet.

IngressIp string: A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet.

ingressIp String: A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet.

ingressIp string: A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet.

ingress_ip str: A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet.

ingressIp String: A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet.

Import

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

$ pulumi import oci:DatabaseMigration/connection:Connection test_connection "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.

Oracle Cloud Infrastructure v2.32.0 published on Thursday, Apr 24, 2025 by Pulumi

pulumi/pulumi-oci

oci.DatabaseMigration.Connection

On this page

On this page

Example Usage

Create Connection Resource

Constructor syntax

Parameters

Constructor example

Connection Resource Properties

Inputs

Outputs

Look up Existing Connection Resource

Supporting Types

ConnectionAdditionalAttribute, ConnectionAdditionalAttributeArgs

ConnectionIngressIp, ConnectionIngressIpArgs

Import

Package Details

On this page

On this page