Docs
PackagesOracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
oci.DatabaseMigration.Connection
Explore with Pulumi AI
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
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
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testConnection = new oci.databasemigration.Connection("test_connection", {
adminCredentials: {
password: connectionAdminCredentialsPassword,
username: connectionAdminCredentialsUsername,
},
compartmentId: compartmentId,
databaseType: connectionDatabaseType,
vaultDetails: {
compartmentId: compartmentId,
keyId: testKey.id,
vaultId: testVault.id,
},
certificateTdn: connectionCertificateTdn,
connectDescriptor: {
connectString: connectionConnectDescriptorConnectString,
databaseServiceName: testService.name,
host: connectionConnectDescriptorHost,
port: connectionConnectDescriptorPort,
},
databaseId: testDatabase.id,
definedTags: {
"foo-namespace.bar-key": "value",
},
displayName: connectionDisplayName,
freeformTags: {
"bar-key": "value",
},
nsgIds: connectionNsgIds,
privateEndpoint: {
compartmentId: compartmentId,
subnetId: testSubnet.id,
vcnId: testVcn.id,
},
replicationCredentials: {
password: connectionReplicationCredentialsPassword,
username: connectionReplicationCredentialsUsername,
},
sshDetails: {
host: connectionSshDetailsHost,
sshkey: connectionSshDetailsSshkey,
user: connectionSshDetailsUser,
sudoLocation: connectionSshDetailsSudoLocation,
},
tlsKeystore: connectionTlsKeystore,
tlsWallet: connectionTlsWallet,
});
import pulumi
import pulumi_oci as oci
test_connection = oci.database_migration.Connection("test_connection",
admin_credentials=oci.database_migration.ConnectionAdminCredentialsArgs(
password=connection_admin_credentials_password,
username=connection_admin_credentials_username,
),
compartment_id=compartment_id,
database_type=connection_database_type,
vault_details=oci.database_migration.ConnectionVaultDetailsArgs(
compartment_id=compartment_id,
key_id=test_key["id"],
vault_id=test_vault["id"],
),
certificate_tdn=connection_certificate_tdn,
connect_descriptor=oci.database_migration.ConnectionConnectDescriptorArgs(
connect_string=connection_connect_descriptor_connect_string,
database_service_name=test_service["name"],
host=connection_connect_descriptor_host,
port=connection_connect_descriptor_port,
),
database_id=test_database["id"],
defined_tags={
"foo-namespace.bar-key": "value",
},
display_name=connection_display_name,
freeform_tags={
"bar-key": "value",
},
nsg_ids=connection_nsg_ids,
private_endpoint=oci.database_migration.ConnectionPrivateEndpointArgs(
compartment_id=compartment_id,
subnet_id=test_subnet["id"],
vcn_id=test_vcn["id"],
),
replication_credentials=oci.database_migration.ConnectionReplicationCredentialsArgs(
password=connection_replication_credentials_password,
username=connection_replication_credentials_username,
),
ssh_details=oci.database_migration.ConnectionSshDetailsArgs(
host=connection_ssh_details_host,
sshkey=connection_ssh_details_sshkey,
user=connection_ssh_details_user,
sudo_location=connection_ssh_details_sudo_location,
),
tls_keystore=connection_tls_keystore,
tls_wallet=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, "test_connection", &DatabaseMigration.ConnectionArgs{
AdminCredentials: &databasemigration.ConnectionAdminCredentialsArgs{
Password: pulumi.Any(connectionAdminCredentialsPassword),
Username: pulumi.Any(connectionAdminCredentialsUsername),
},
CompartmentId: pulumi.Any(compartmentId),
DatabaseType: pulumi.Any(connectionDatabaseType),
VaultDetails: &databasemigration.ConnectionVaultDetailsArgs{
CompartmentId: pulumi.Any(compartmentId),
KeyId: pulumi.Any(testKey.Id),
VaultId: pulumi.Any(testVault.Id),
},
CertificateTdn: pulumi.Any(connectionCertificateTdn),
ConnectDescriptor: &databasemigration.ConnectionConnectDescriptorArgs{
ConnectString: pulumi.Any(connectionConnectDescriptorConnectString),
DatabaseServiceName: pulumi.Any(testService.Name),
Host: pulumi.Any(connectionConnectDescriptorHost),
Port: pulumi.Any(connectionConnectDescriptorPort),
},
DatabaseId: pulumi.Any(testDatabase.Id),
DefinedTags: pulumi.Map{
"foo-namespace.bar-key": pulumi.Any("value"),
},
DisplayName: pulumi.Any(connectionDisplayName),
FreeformTags: pulumi.Map{
"bar-key": pulumi.Any("value"),
},
NsgIds: pulumi.Any(connectionNsgIds),
PrivateEndpoint: &databasemigration.ConnectionPrivateEndpointArgs{
CompartmentId: pulumi.Any(compartmentId),
SubnetId: pulumi.Any(testSubnet.Id),
VcnId: pulumi.Any(testVcn.Id),
},
ReplicationCredentials: &databasemigration.ConnectionReplicationCredentialsArgs{
Password: pulumi.Any(connectionReplicationCredentialsPassword),
Username: pulumi.Any(connectionReplicationCredentialsUsername),
},
SshDetails: &databasemigration.ConnectionSshDetailsArgs{
Host: pulumi.Any(connectionSshDetailsHost),
Sshkey: pulumi.Any(connectionSshDetailsSshkey),
User: pulumi.Any(connectionSshDetailsUser),
SudoLocation: pulumi.Any(connectionSshDetailsSudoLocation),
},
TlsKeystore: pulumi.Any(connectionTlsKeystore),
TlsWallet: pulumi.Any(connectionTlsWallet),
})
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()
{
AdminCredentials = new Oci.DatabaseMigration.Inputs.ConnectionAdminCredentialsArgs
{
Password = connectionAdminCredentialsPassword,
Username = connectionAdminCredentialsUsername,
},
CompartmentId = compartmentId,
DatabaseType = connectionDatabaseType,
VaultDetails = new Oci.DatabaseMigration.Inputs.ConnectionVaultDetailsArgs
{
CompartmentId = compartmentId,
KeyId = testKey.Id,
VaultId = testVault.Id,
},
CertificateTdn = connectionCertificateTdn,
ConnectDescriptor = new Oci.DatabaseMigration.Inputs.ConnectionConnectDescriptorArgs
{
ConnectString = connectionConnectDescriptorConnectString,
DatabaseServiceName = testService.Name,
Host = connectionConnectDescriptorHost,
Port = connectionConnectDescriptorPort,
},
DatabaseId = testDatabase.Id,
DefinedTags =
{
{ "foo-namespace.bar-key", "value" },
},
DisplayName = connectionDisplayName,
FreeformTags =
{
{ "bar-key", "value" },
},
NsgIds = connectionNsgIds,
PrivateEndpoint = new Oci.DatabaseMigration.Inputs.ConnectionPrivateEndpointArgs
{
CompartmentId = compartmentId,
SubnetId = testSubnet.Id,
VcnId = testVcn.Id,
},
ReplicationCredentials = new Oci.DatabaseMigration.Inputs.ConnectionReplicationCredentialsArgs
{
Password = connectionReplicationCredentialsPassword,
Username = connectionReplicationCredentialsUsername,
},
SshDetails = new Oci.DatabaseMigration.Inputs.ConnectionSshDetailsArgs
{
Host = connectionSshDetailsHost,
Sshkey = connectionSshDetailsSshkey,
User = connectionSshDetailsUser,
SudoLocation = connectionSshDetailsSudoLocation,
},
TlsKeystore = connectionTlsKeystore,
TlsWallet = connectionTlsWallet,
});
});
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(connectionAdminCredentialsPassword)
.username(connectionAdminCredentialsUsername)
.build())
.compartmentId(compartmentId)
.databaseType(connectionDatabaseType)
.vaultDetails(ConnectionVaultDetailsArgs.builder()
.compartmentId(compartmentId)
.keyId(testKey.id())
.vaultId(testVault.id())
.build())
.certificateTdn(connectionCertificateTdn)
.connectDescriptor(ConnectionConnectDescriptorArgs.builder()
.connectString(connectionConnectDescriptorConnectString)
.databaseServiceName(testService.name())
.host(connectionConnectDescriptorHost)
.port(connectionConnectDescriptorPort)
.build())
.databaseId(testDatabase.id())
.definedTags(Map.of("foo-namespace.bar-key", "value"))
.displayName(connectionDisplayName)
.freeformTags(Map.of("bar-key", "value"))
.nsgIds(connectionNsgIds)
.privateEndpoint(ConnectionPrivateEndpointArgs.builder()
.compartmentId(compartmentId)
.subnetId(testSubnet.id())
.vcnId(testVcn.id())
.build())
.replicationCredentials(ConnectionReplicationCredentialsArgs.builder()
.password(connectionReplicationCredentialsPassword)
.username(connectionReplicationCredentialsUsername)
.build())
.sshDetails(ConnectionSshDetailsArgs.builder()
.host(connectionSshDetailsHost)
.sshkey(connectionSshDetailsSshkey)
.user(connectionSshDetailsUser)
.sudoLocation(connectionSshDetailsSudoLocation)
.build())
.tlsKeystore(connectionTlsKeystore)
.tlsWallet(connectionTlsWallet)
.build());
}
}
resources:
testConnection:
type: oci:DatabaseMigration:Connection
name: test_connection
properties:
adminCredentials:
password: ${connectionAdminCredentialsPassword}
username: ${connectionAdminCredentialsUsername}
compartmentId: ${compartmentId}
databaseType: ${connectionDatabaseType}
vaultDetails:
compartmentId: ${compartmentId}
keyId: ${testKey.id}
vaultId: ${testVault.id}
certificateTdn: ${connectionCertificateTdn}
connectDescriptor:
connectString: ${connectionConnectDescriptorConnectString}
databaseServiceName: ${testService.name}
host: ${connectionConnectDescriptorHost}
port: ${connectionConnectDescriptorPort}
databaseId: ${testDatabase.id}
definedTags:
foo-namespace.bar-key: value
displayName: ${connectionDisplayName}
freeformTags:
bar-key: value
nsgIds: ${connectionNsgIds}
privateEndpoint:
compartmentId: ${compartmentId}
subnetId: ${testSubnet.id}
vcnId: ${testVcn.id}
replicationCredentials:
password: ${connectionReplicationCredentialsPassword}
username: ${connectionReplicationCredentialsUsername}
sshDetails:
host: ${connectionSshDetailsHost}
sshkey: ${connectionSshDetailsSshkey}
user: ${connectionSshDetailsUser}
sudoLocation: ${connectionSshDetailsSudoLocation}
tlsKeystore: ${connectionTlsKeystore}
tlsWallet: ${connectionTlsWallet}
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,
database_type: Optional[str] = None,
vault_details: Optional[_databasemigration.ConnectionVaultDetailsArgs] = None,
compartment_id: Optional[str] = None,
admin_credentials: Optional[_databasemigration.ConnectionAdminCredentialsArgs] = None,
freeform_tags: Optional[Mapping[str, Any]] = None,
database_id: Optional[str] = None,
defined_tags: Optional[Mapping[str, Any]] = None,
display_name: Optional[str] = None,
connect_descriptor: Optional[_databasemigration.ConnectionConnectDescriptorArgs] = None,
manual_database_sub_type: 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,
tls_keystore: Optional[str] = None,
tls_wallet: Optional[str] = None,
certificate_tdn: 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()
{
DatabaseType = "string",
VaultDetails = new Oci.DatabaseMigration.Inputs.ConnectionVaultDetailsArgs
{
CompartmentId = "string",
KeyId = "string",
VaultId = "string",
},
CompartmentId = "string",
AdminCredentials = new Oci.DatabaseMigration.Inputs.ConnectionAdminCredentialsArgs
{
Password = "string",
Username = "string",
},
FreeformTags =
{
{ "string", "any" },
},
DatabaseId = "string",
DefinedTags =
{
{ "string", "any" },
},
DisplayName = "string",
ConnectDescriptor = new Oci.DatabaseMigration.Inputs.ConnectionConnectDescriptorArgs
{
ConnectString = "string",
DatabaseServiceName = "string",
Host = "string",
Port = 0,
},
ManualDatabaseSubType = "string",
NsgIds = new[]
{
"string",
},
PrivateEndpoint = new Oci.DatabaseMigration.Inputs.ConnectionPrivateEndpointArgs
{
CompartmentId = "string",
SubnetId = "string",
VcnId = "string",
Id = "string",
},
ReplicationCredentials = new Oci.DatabaseMigration.Inputs.ConnectionReplicationCredentialsArgs
{
Password = "string",
Username = "string",
},
SshDetails = new Oci.DatabaseMigration.Inputs.ConnectionSshDetailsArgs
{
Host = "string",
Sshkey = "string",
User = "string",
SudoLocation = "string",
},
TlsKeystore = "string",
TlsWallet = "string",
CertificateTdn = "string",
});
example, err := DatabaseMigration.NewConnection(ctx, "ociConnectionResource", &DatabaseMigration.ConnectionArgs{
DatabaseType: pulumi.String("string"),
VaultDetails: &databasemigration.ConnectionVaultDetailsArgs{
CompartmentId: pulumi.String("string"),
KeyId: pulumi.String("string"),
VaultId: pulumi.String("string"),
},
CompartmentId: pulumi.String("string"),
AdminCredentials: &databasemigration.ConnectionAdminCredentialsArgs{
Password: pulumi.String("string"),
Username: pulumi.String("string"),
},
FreeformTags: pulumi.Map{
"string": pulumi.Any("any"),
},
DatabaseId: pulumi.String("string"),
DefinedTags: pulumi.Map{
"string": pulumi.Any("any"),
},
DisplayName: pulumi.String("string"),
ConnectDescriptor: &databasemigration.ConnectionConnectDescriptorArgs{
ConnectString: pulumi.String("string"),
DatabaseServiceName: pulumi.String("string"),
Host: pulumi.String("string"),
Port: pulumi.Int(0),
},
ManualDatabaseSubType: pulumi.String("string"),
NsgIds: pulumi.StringArray{
pulumi.String("string"),
},
PrivateEndpoint: &databasemigration.ConnectionPrivateEndpointArgs{
CompartmentId: pulumi.String("string"),
SubnetId: pulumi.String("string"),
VcnId: pulumi.String("string"),
Id: pulumi.String("string"),
},
ReplicationCredentials: &databasemigration.ConnectionReplicationCredentialsArgs{
Password: pulumi.String("string"),
Username: pulumi.String("string"),
},
SshDetails: &databasemigration.ConnectionSshDetailsArgs{
Host: pulumi.String("string"),
Sshkey: pulumi.String("string"),
User: pulumi.String("string"),
SudoLocation: pulumi.String("string"),
},
TlsKeystore: pulumi.String("string"),
TlsWallet: pulumi.String("string"),
CertificateTdn: pulumi.String("string"),
})
var ociConnectionResource = new Connection("ociConnectionResource", ConnectionArgs.builder()
.databaseType("string")
.vaultDetails(ConnectionVaultDetailsArgs.builder()
.compartmentId("string")
.keyId("string")
.vaultId("string")
.build())
.compartmentId("string")
.adminCredentials(ConnectionAdminCredentialsArgs.builder()
.password("string")
.username("string")
.build())
.freeformTags(Map.of("string", "any"))
.databaseId("string")
.definedTags(Map.of("string", "any"))
.displayName("string")
.connectDescriptor(ConnectionConnectDescriptorArgs.builder()
.connectString("string")
.databaseServiceName("string")
.host("string")
.port(0)
.build())
.manualDatabaseSubType("string")
.nsgIds("string")
.privateEndpoint(ConnectionPrivateEndpointArgs.builder()
.compartmentId("string")
.subnetId("string")
.vcnId("string")
.id("string")
.build())
.replicationCredentials(ConnectionReplicationCredentialsArgs.builder()
.password("string")
.username("string")
.build())
.sshDetails(ConnectionSshDetailsArgs.builder()
.host("string")
.sshkey("string")
.user("string")
.sudoLocation("string")
.build())
.tlsKeystore("string")
.tlsWallet("string")
.certificateTdn("string")
.build());
oci_connection_resource = oci.database_migration.Connection("ociConnectionResource",
database_type="string",
vault_details=oci.database_migration.ConnectionVaultDetailsArgs(
compartment_id="string",
key_id="string",
vault_id="string",
),
compartment_id="string",
admin_credentials=oci.database_migration.ConnectionAdminCredentialsArgs(
password="string",
username="string",
),
freeform_tags={
"string": "any",
},
database_id="string",
defined_tags={
"string": "any",
},
display_name="string",
connect_descriptor=oci.database_migration.ConnectionConnectDescriptorArgs(
connect_string="string",
database_service_name="string",
host="string",
port=0,
),
manual_database_sub_type="string",
nsg_ids=["string"],
private_endpoint=oci.database_migration.ConnectionPrivateEndpointArgs(
compartment_id="string",
subnet_id="string",
vcn_id="string",
id="string",
),
replication_credentials=oci.database_migration.ConnectionReplicationCredentialsArgs(
password="string",
username="string",
),
ssh_details=oci.database_migration.ConnectionSshDetailsArgs(
host="string",
sshkey="string",
user="string",
sudo_location="string",
),
tls_keystore="string",
tls_wallet="string",
certificate_tdn="string")
const ociConnectionResource = new oci.databasemigration.Connection("ociConnectionResource", {
databaseType: "string",
vaultDetails: {
compartmentId: "string",
keyId: "string",
vaultId: "string",
},
compartmentId: "string",
adminCredentials: {
password: "string",
username: "string",
},
freeformTags: {
string: "any",
},
databaseId: "string",
definedTags: {
string: "any",
},
displayName: "string",
connectDescriptor: {
connectString: "string",
databaseServiceName: "string",
host: "string",
port: 0,
},
manualDatabaseSubType: "string",
nsgIds: ["string"],
privateEndpoint: {
compartmentId: "string",
subnetId: "string",
vcnId: "string",
id: "string",
},
replicationCredentials: {
password: "string",
username: "string",
},
sshDetails: {
host: "string",
sshkey: "string",
user: "string",
sudoLocation: "string",
},
tlsKeystore: "string",
tlsWallet: "string",
certificateTdn: "string",
});
type: oci:DatabaseMigration:Connection
properties:
adminCredentials:
password: string
username: string
certificateTdn: string
compartmentId: string
connectDescriptor:
connectString: string
databaseServiceName: string
host: string
port: 0
databaseId: string
databaseType: string
definedTags:
string: any
displayName: string
freeformTags:
string: any
manualDatabaseSubType: string
nsgIds:
- string
privateEndpoint:
compartmentId: string
id: string
subnetId: string
vcnId: string
replicationCredentials:
password: string
username: string
sshDetails:
host: string
sshkey: string
sudoLocation: string
user: string
tlsKeystore: string
tlsWallet: string
vaultDetails:
compartmentId: string
keyId: string
vaultId: 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
The Connection resource accepts the following input properties:
- Admin
Credentials ConnectionAdmin Credentials - (Updatable) Database Administrator Credentials details.
- Compartment
Id string - (Updatable) OCID of the compartment
- Database
Type string - Database connection type.
- Vault
Details ConnectionVault Details - (Updatable) Oracle Cloud Infrastructure Vault details to store migration and connection credentials secrets
- Certificate
Tdn 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.
- Connect
Descriptor ConnectionConnect Descriptor - (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 string - (Updatable) The OCID of the cloud database. Required if the database connection type is Autonomous.
- Dictionary<string, object>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - Display
Name string - (Updatable) Database Connection display name identifier.
- 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"} - Manual
Database stringSub Type - Database manual connection subtype. This value can only be specified for manual connections.
- Nsg
Ids List<string> - (Updatable) An array of Network Security Group OCIDs used to define network access for Connections.
- Private
Endpoint ConnectionPrivate Endpoint - (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 ConnectionReplication Credentials - (Updatable) Database Administrator Credentials details.
- Ssh
Details ConnectionSsh Details - (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 string - (Updatable) keystore.jks file contents; base64 encoded String. Requires a TLS wallet to be specified. Not required for source container database connections.
- Tls
Wallet string - (Updatable) cwallet.sso containing containing the TCPS/SSL certificate; base64 encoded String. Not required for source container database connections.
- Admin
Credentials ConnectionAdmin Credentials Args - (Updatable) Database Administrator Credentials details.
- Compartment
Id string - (Updatable) OCID of the compartment
- Database
Type string - Database connection type.
- Vault
Details ConnectionVault Details Args - (Updatable) Oracle Cloud Infrastructure Vault details to store migration and connection credentials secrets
- Certificate
Tdn 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.
- Connect
Descriptor ConnectionConnect Descriptor Args - (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 string - (Updatable) The OCID of the cloud database. Required if the database connection type is Autonomous.
- map[string]interface{}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - Display
Name string - (Updatable) Database Connection display name identifier.
- 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"} - Manual
Database stringSub Type - Database manual connection subtype. This value can only be specified for manual connections.
- Nsg
Ids []string - (Updatable) An array of Network Security Group OCIDs used to define network access for Connections.
- Private
Endpoint ConnectionPrivate Endpoint Args - (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 ConnectionReplication Credentials Args - (Updatable) Database Administrator Credentials details.
- Ssh
Details ConnectionSsh Details Args - (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 string - (Updatable) keystore.jks file contents; base64 encoded String. Requires a TLS wallet to be specified. Not required for source container database connections.
- Tls
Wallet string - (Updatable) cwallet.sso containing containing the TCPS/SSL certificate; base64 encoded String. Not required for source container database connections.
- admin
Credentials ConnectionAdmin Credentials - (Updatable) Database Administrator Credentials details.
- compartment
Id String - (Updatable) OCID of the compartment
- database
Type String - Database connection type.
- vault
Details ConnectionVault Details - (Updatable) Oracle Cloud Infrastructure Vault details to store migration and connection credentials secrets
- certificate
Tdn 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.
- connect
Descriptor ConnectionConnect Descriptor - (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 String - (Updatable) The OCID of the cloud database. Required if the database connection type is Autonomous.
- Map<String,Object>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - display
Name String - (Updatable) Database Connection display name identifier.
- 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"} - manual
Database StringSub Type - Database manual connection subtype. This value can only be specified for manual connections.
- nsg
Ids List<String> - (Updatable) An array of Network Security Group OCIDs used to define network access for Connections.
- private
Endpoint ConnectionPrivate Endpoint - (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 ConnectionReplication Credentials - (Updatable) Database Administrator Credentials details.
- ssh
Details ConnectionSsh Details - (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 String - (Updatable) keystore.jks file contents; base64 encoded String. Requires a TLS wallet to be specified. Not required for source container database connections.
- tls
Wallet String - (Updatable) cwallet.sso containing containing the TCPS/SSL certificate; base64 encoded String. Not required for source container database connections.
- admin
Credentials ConnectionAdmin Credentials - (Updatable) Database Administrator Credentials details.
- compartment
Id string - (Updatable) OCID of the compartment
- database
Type string - Database connection type.
- vault
Details ConnectionVault Details - (Updatable) Oracle Cloud Infrastructure Vault details to store migration and connection credentials secrets
- certificate
Tdn 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.
- connect
Descriptor ConnectionConnect Descriptor - (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 string - (Updatable) The OCID of the cloud database. Required if the database connection type is Autonomous.
- {[key: string]: any}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - display
Name string - (Updatable) Database Connection display name identifier.
- {[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"} - manual
Database stringSub Type - Database manual connection subtype. This value can only be specified for manual connections.
- nsg
Ids string[] - (Updatable) An array of Network Security Group OCIDs used to define network access for Connections.
- private
Endpoint ConnectionPrivate Endpoint - (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 ConnectionReplication Credentials - (Updatable) Database Administrator Credentials details.
- ssh
Details ConnectionSsh Details - (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 string - (Updatable) keystore.jks file contents; base64 encoded String. Requires a TLS wallet to be specified. Not required for source container database connections.
- tls
Wallet string - (Updatable) cwallet.sso containing containing the TCPS/SSL certificate; base64 encoded String. Not required for source container database connections.
- admin_
credentials databasemigration.Connection Admin Credentials Args - (Updatable) Database Administrator Credentials details.
- compartment_
id str - (Updatable) OCID of the compartment
- database_
type str - Database connection type.
- vault_
details databasemigration.Connection Vault Details Args - (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 databasemigration.Connection Connect Descriptor Args - (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.
- 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.
- 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"} - manual_
database_ strsub_ type - Database manual connection subtype. This value can only be specified for manual connections.
- nsg_
ids Sequence[str] - (Updatable) An array of Network Security Group OCIDs used to define network access for Connections.
- private_
endpoint databasemigration.Connection Private Endpoint Args - (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 databasemigration.Connection Replication Credentials Args - (Updatable) Database Administrator Credentials details.
- ssh_
details databasemigration.Connection Ssh Details Args - (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.
- admin
Credentials Property Map - (Updatable) Database Administrator Credentials details.
- compartment
Id String - (Updatable) OCID of the compartment
- database
Type String - Database connection type.
- vault
Details Property Map - (Updatable) Oracle Cloud Infrastructure Vault details to store migration and connection credentials secrets
- certificate
Tdn 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.
- connect
Descriptor 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.
- database
Id String - (Updatable) The OCID of the cloud database. Required if the database connection type is Autonomous.
- Map<Any>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - display
Name String - (Updatable) Database Connection display name identifier.
- 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"} - manual
Database StringSub Type - Database manual connection subtype. This value can only be specified for manual connections.
- nsg
Ids List<String> - (Updatable) An array of Network Security Group OCIDs used to define network access for Connections.
- private
Endpoint 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.
- replication
Credentials Property Map - (Updatable) Database Administrator Credentials details.
- ssh
Details 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.
- tls
Keystore String - (Updatable) keystore.jks file contents; base64 encoded String. Requires a TLS wallet to be specified. Not required for source container database connections.
- tls
Wallet 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:
- Credentials
Secret stringId - 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.
- Lifecycle
Details 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.
- Dictionary<string, object>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - Time
Created string - The time the Connection resource was created. An RFC3339 formatted datetime string.
- Time
Updated string - The time of the last Connection resource details update. An RFC3339 formatted datetime string.
- Credentials
Secret stringId - 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.
- Lifecycle
Details 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.
- map[string]interface{}
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - Time
Created string - The time the Connection resource was created. An RFC3339 formatted datetime string.
- Time
Updated string - The time of the last Connection resource details update. An RFC3339 formatted datetime string.
- credentials
Secret StringId - 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.
- lifecycle
Details 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.
- Map<String,Object>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - time
Created String - The time the Connection resource was created. An RFC3339 formatted datetime string.
- time
Updated String - The time of the last Connection resource details update. An RFC3339 formatted datetime string.
- credentials
Secret stringId - 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.
- lifecycle
Details 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.
- {[key: string]: any}
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - time
Created string - The time the Connection resource was created. An RFC3339 formatted datetime string.
- time
Updated string - The time of the last Connection resource details update. An RFC3339 formatted datetime string.
- credentials_
secret_ strid - 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.
- 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.
- credentials
Secret StringId - 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.
- lifecycle
Details 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.
- Map<Any>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - time
Created String - The time the Connection resource was created. An RFC3339 formatted datetime string.
- time
Updated 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,
manual_database_sub_type: 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) -> Connectionfunc 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.
- Admin
Credentials ConnectionAdmin Credentials - (Updatable) Database Administrator Credentials details.
- Certificate
Tdn 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.
- Compartment
Id string - (Updatable) OCID of the compartment
- Connect
Descriptor ConnectionConnect Descriptor - (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 stringId - OCID of the Secret in the Oracle Cloud Infrastructure vault containing the Database Connection credentials.
- Database
Id string - (Updatable) The OCID of the cloud database. Required if the database connection type is Autonomous.
- Database
Type string - Database connection type.
- Dictionary<string, object>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - Display
Name string - (Updatable) Database Connection display name identifier.
- 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"} - Lifecycle
Details 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.
- Manual
Database stringSub Type - Database manual connection subtype. This value can only be specified for manual connections.
- Nsg
Ids List<string> - (Updatable) An array of Network Security Group OCIDs used to define network access for Connections.
- Private
Endpoint ConnectionPrivate Endpoint - (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 ConnectionReplication Credentials - (Updatable) Database Administrator Credentials details.
- Ssh
Details ConnectionSsh Details - (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.
- Dictionary<string, object>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - Time
Created string - The time the Connection resource was created. An RFC3339 formatted datetime string.
- Time
Updated string - The time of the last Connection resource details update. An RFC3339 formatted datetime string.
- Tls
Keystore string - (Updatable) keystore.jks file contents; base64 encoded String. Requires a TLS wallet to be specified. Not required for source container database connections.
- Tls
Wallet string - (Updatable) cwallet.sso containing containing the TCPS/SSL certificate; base64 encoded String. Not required for source container database connections.
- Vault
Details ConnectionVault Details - (Updatable) Oracle Cloud Infrastructure Vault details to store migration and connection credentials secrets
- Admin
Credentials ConnectionAdmin Credentials Args - (Updatable) Database Administrator Credentials details.
- Certificate
Tdn 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.
- Compartment
Id string - (Updatable) OCID of the compartment
- Connect
Descriptor ConnectionConnect Descriptor Args - (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 stringId - OCID of the Secret in the Oracle Cloud Infrastructure vault containing the Database Connection credentials.
- Database
Id string - (Updatable) The OCID of the cloud database. Required if the database connection type is Autonomous.
- Database
Type string - Database connection type.
- map[string]interface{}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - Display
Name string - (Updatable) Database Connection display name identifier.
- 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"} - Lifecycle
Details 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.
- Manual
Database stringSub Type - Database manual connection subtype. This value can only be specified for manual connections.
- Nsg
Ids []string - (Updatable) An array of Network Security Group OCIDs used to define network access for Connections.
- Private
Endpoint ConnectionPrivate Endpoint Args - (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 ConnectionReplication Credentials Args - (Updatable) Database Administrator Credentials details.
- Ssh
Details ConnectionSsh Details Args - (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.
- map[string]interface{}
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - Time
Created string - The time the Connection resource was created. An RFC3339 formatted datetime string.
- Time
Updated string - The time of the last Connection resource details update. An RFC3339 formatted datetime string.
- Tls
Keystore string - (Updatable) keystore.jks file contents; base64 encoded String. Requires a TLS wallet to be specified. Not required for source container database connections.
- Tls
Wallet string - (Updatable) cwallet.sso containing containing the TCPS/SSL certificate; base64 encoded String. Not required for source container database connections.
- Vault
Details ConnectionVault Details Args - (Updatable) Oracle Cloud Infrastructure Vault details to store migration and connection credentials secrets
- admin
Credentials ConnectionAdmin Credentials - (Updatable) Database Administrator Credentials details.
- certificate
Tdn 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.
- compartment
Id String - (Updatable) OCID of the compartment
- connect
Descriptor ConnectionConnect Descriptor - (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 StringId - OCID of the Secret in the Oracle Cloud Infrastructure vault containing the Database Connection credentials.
- database
Id String - (Updatable) The OCID of the cloud database. Required if the database connection type is Autonomous.
- database
Type String - Database connection type.
- Map<String,Object>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - display
Name String - (Updatable) Database Connection display name identifier.
- 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"} - lifecycle
Details 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.
- manual
Database StringSub Type - Database manual connection subtype. This value can only be specified for manual connections.
- nsg
Ids List<String> - (Updatable) An array of Network Security Group OCIDs used to define network access for Connections.
- private
Endpoint ConnectionPrivate Endpoint - (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 ConnectionReplication Credentials - (Updatable) Database Administrator Credentials details.
- ssh
Details ConnectionSsh Details - (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.
- Map<String,Object>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - time
Created String - The time the Connection resource was created. An RFC3339 formatted datetime string.
- time
Updated String - The time of the last Connection resource details update. An RFC3339 formatted datetime string.
- tls
Keystore String - (Updatable) keystore.jks file contents; base64 encoded String. Requires a TLS wallet to be specified. Not required for source container database connections.
- tls
Wallet String - (Updatable) cwallet.sso containing containing the TCPS/SSL certificate; base64 encoded String. Not required for source container database connections.
- vault
Details ConnectionVault Details - (Updatable) Oracle Cloud Infrastructure Vault details to store migration and connection credentials secrets
- admin
Credentials ConnectionAdmin Credentials - (Updatable) Database Administrator Credentials details.
- certificate
Tdn 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.
- compartment
Id string - (Updatable) OCID of the compartment
- connect
Descriptor ConnectionConnect Descriptor - (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 stringId - OCID of the Secret in the Oracle Cloud Infrastructure vault containing the Database Connection credentials.
- database
Id string - (Updatable) The OCID of the cloud database. Required if the database connection type is Autonomous.
- database
Type string - Database connection type.
- {[key: string]: any}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - display
Name string - (Updatable) Database Connection display name identifier.
- {[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"} - lifecycle
Details 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.
- manual
Database stringSub Type - Database manual connection subtype. This value can only be specified for manual connections.
- nsg
Ids string[] - (Updatable) An array of Network Security Group OCIDs used to define network access for Connections.
- private
Endpoint ConnectionPrivate Endpoint - (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 ConnectionReplication Credentials - (Updatable) Database Administrator Credentials details.
- ssh
Details ConnectionSsh Details - (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.
- {[key: string]: any}
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - time
Created string - The time the Connection resource was created. An RFC3339 formatted datetime string.
- time
Updated string - The time of the last Connection resource details update. An RFC3339 formatted datetime string.
- tls
Keystore string - (Updatable) keystore.jks file contents; base64 encoded String. Requires a TLS wallet to be specified. Not required for source container database connections.
- tls
Wallet string - (Updatable) cwallet.sso containing containing the TCPS/SSL certificate; base64 encoded String. Not required for source container database connections.
- vault
Details ConnectionVault Details - (Updatable) Oracle Cloud Infrastructure Vault details to store migration and connection credentials secrets
- admin_
credentials databasemigration.Connection Admin Credentials Args - (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
- connect_
descriptor databasemigration.Connection Connect Descriptor Args - (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_ strid - 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.
- 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.
- 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.
- manual_
database_ strsub_ type - Database manual connection subtype. This value can only be specified for manual connections.
- nsg_
ids Sequence[str] - (Updatable) An array of Network Security Group OCIDs used to define network access for Connections.
- private_
endpoint databasemigration.Connection Private Endpoint Args - (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 databasemigration.Connection Replication Credentials Args - (Updatable) Database Administrator Credentials details.
- ssh_
details databasemigration.Connection Ssh Details Args - (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.
- 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 databasemigration.Connection Vault Details Args - (Updatable) Oracle Cloud Infrastructure Vault details to store migration and connection credentials secrets
- admin
Credentials Property Map - (Updatable) Database Administrator Credentials details.
- certificate
Tdn 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.
- compartment
Id String - (Updatable) OCID of the compartment
- connect
Descriptor 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.
- credentials
Secret StringId - OCID of the Secret in the Oracle Cloud Infrastructure vault containing the Database Connection credentials.
- database
Id String - (Updatable) The OCID of the cloud database. Required if the database connection type is Autonomous.
- database
Type String - Database connection type.
- Map<Any>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - display
Name String - (Updatable) Database Connection display name identifier.
- 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"} - lifecycle
Details 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.
- manual
Database StringSub Type - Database manual connection subtype. This value can only be specified for manual connections.
- nsg
Ids List<String> - (Updatable) An array of Network Security Group OCIDs used to define network access for Connections.
- private
Endpoint 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.
- replication
Credentials Property Map - (Updatable) Database Administrator Credentials details.
- ssh
Details 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.
- Map<Any>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - time
Created String - The time the Connection resource was created. An RFC3339 formatted datetime string.
- time
Updated String - The time of the last Connection resource details update. An RFC3339 formatted datetime string.
- tls
Keystore String - (Updatable) keystore.jks file contents; base64 encoded String. Requires a TLS wallet to be specified. Not required for source container database connections.
- tls
Wallet String - (Updatable) cwallet.sso containing containing the TCPS/SSL certificate; base64 encoded String. Not required for source container database connections.
- vault
Details Property Map - (Updatable) Oracle Cloud Infrastructure Vault details to store migration and connection credentials secrets
Supporting Types
ConnectionAdminCredentials, ConnectionAdminCredentialsArgs
ConnectionConnectDescriptor, ConnectionConnectDescriptorArgs
- Connect
String 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>)))
- Database
Service stringName - (Updatable) Database service name. Required if no connectString was specified.
- Host string
- (Updatable) Host or IP address of the connect descriptor. Required if no connectString was specified.
- Port int
- (Updatable) Port of the connect descriptor. Required if no connectString was specified.
- Connect
String 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>)))
- Database
Service stringName - (Updatable) Database service name. Required if no connectString was specified.
- Host string
- (Updatable) Host or IP address of the connect descriptor. Required if no connectString was specified.
- Port int
- (Updatable) Port of the connect descriptor. Required if no connectString was specified.
- connect
String 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>)))
- database
Service StringName - (Updatable) Database service name. Required if no connectString was specified.
- host String
- (Updatable) Host or IP address of the connect descriptor. Required if no connectString was specified.
- port Integer
- (Updatable) Port of the connect descriptor. Required if no connectString was specified.
- connect
String 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>)))
- database
Service stringName - (Updatable) Database service name. Required if no connectString was specified.
- host string
- (Updatable) Host or IP address of the connect descriptor. Required if no connectString was specified.
- 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_ strname - (Updatable) Database service name. Required if no connectString was specified.
- host str
- (Updatable) Host or IP address of the connect descriptor. Required if no connectString was specified.
- port int
- (Updatable) Port of the connect descriptor. Required if no connectString was specified.
- connect
String 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>)))
- database
Service StringName - (Updatable) Database service name. Required if no connectString was specified.
- host String
- (Updatable) Host or IP address of the connect descriptor. Required if no connectString was specified.
- port Number
- (Updatable) Port of the connect descriptor. Required if no connectString was specified.
ConnectionPrivateEndpoint, ConnectionPrivateEndpointArgs
- Compartment
Id string - (Updatable) The OCID of the compartment to contain the private endpoint.
- Subnet
Id string - (Updatable) The OCID of the customer's subnet where the private endpoint VNIC will reside.
- Vcn
Id 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 string - (Updatable) The OCID of the compartment to contain the private endpoint.
- Subnet
Id string - (Updatable) The OCID of the customer's subnet where the private endpoint VNIC will reside.
- Vcn
Id 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 String - (Updatable) The OCID of the compartment to contain the private endpoint.
- subnet
Id String - (Updatable) The OCID of the customer's subnet where the private endpoint VNIC will reside.
- vcn
Id 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 string - (Updatable) The OCID of the compartment to contain the private endpoint.
- subnet
Id string - (Updatable) The OCID of the customer's subnet where the private endpoint VNIC will reside.
- vcn
Id 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) The OCID of the compartment to contain the private endpoint.
- 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.
- compartment
Id String - (Updatable) The OCID of the compartment to contain the private endpoint.
- subnet
Id String - (Updatable) The OCID of the customer's subnet where the private endpoint VNIC will reside.
- vcn
Id 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
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
- Sudo
Location 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
- Sudo
Location 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
- sudo
Location 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
- sudo
Location 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
- sudo
Location String - (Updatable) Sudo location
ConnectionVaultDetails, ConnectionVaultDetailsArgs
- Compartment
Id string - (Updatable) OCID of the compartment where the secret containing the credentials will be created.
- Key
Id string - (Updatable) OCID of the vault encryption key
- Vault
Id 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 string - (Updatable) OCID of the compartment where the secret containing the credentials will be created.
- Key
Id string - (Updatable) OCID of the vault encryption key
- Vault
Id 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 String - (Updatable) OCID of the compartment where the secret containing the credentials will be created.
- key
Id String - (Updatable) OCID of the vault encryption key
- vault
Id 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 string - (Updatable) OCID of the compartment where the secret containing the credentials will be created.
- key
Id string - (Updatable) OCID of the vault encryption key
- vault
Id 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
- compartment
Id String - (Updatable) OCID of the compartment where the secret containing the credentials will be created.
- key
Id String - (Updatable) OCID of the vault encryption key
- vault
Id 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"
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
ociTerraform Provider.
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi