1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DatabaseMigration
  5. getConnection
Oracle Cloud Infrastructure v1.31.0 published on Wednesday, Apr 10, 2024 by Pulumi

oci.DatabaseMigration.getConnection

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.31.0 published on Wednesday, Apr 10, 2024 by Pulumi

    This data source provides details about a specific Connection resource in Oracle Cloud Infrastructure Database Migration service.

    Display Database Connection details.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testConnection = oci.DatabaseMigration.getConnection({
        connectionId: oci_database_migration_connection.test_connection.id,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_connection = oci.DatabaseMigration.get_connection(connection_id=oci_database_migration_connection["test_connection"]["id"])
    
    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.GetConnection(ctx, &databasemigration.GetConnectionArgs{
    			ConnectionId: oci_database_migration_connection.Test_connection.Id,
    		}, nil)
    		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 = Oci.DatabaseMigration.GetConnection.Invoke(new()
        {
            ConnectionId = oci_database_migration_connection.Test_connection.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.DatabaseMigration.DatabaseMigrationFunctions;
    import com.pulumi.oci.DatabaseMigration.inputs.GetConnectionArgs;
    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) {
            final var testConnection = DatabaseMigrationFunctions.getConnection(GetConnectionArgs.builder()
                .connectionId(oci_database_migration_connection.test_connection().id())
                .build());
    
        }
    }
    
    variables:
      testConnection:
        fn::invoke:
          Function: oci:DatabaseMigration:getConnection
          Arguments:
            connectionId: ${oci_database_migration_connection.test_connection.id}
    

    Using getConnection

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getConnection(args: GetConnectionArgs, opts?: InvokeOptions): Promise<GetConnectionResult>
    function getConnectionOutput(args: GetConnectionOutputArgs, opts?: InvokeOptions): Output<GetConnectionResult>
    def get_connection(connection_id: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetConnectionResult
    def get_connection_output(connection_id: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetConnectionResult]
    func GetConnection(ctx *Context, args *GetConnectionArgs, opts ...InvokeOption) (*GetConnectionResult, error)
    func GetConnectionOutput(ctx *Context, args *GetConnectionOutputArgs, opts ...InvokeOption) GetConnectionResultOutput

    > Note: This function is named GetConnection in the Go SDK.

    public static class GetConnection 
    {
        public static Task<GetConnectionResult> InvokeAsync(GetConnectionArgs args, InvokeOptions? opts = null)
        public static Output<GetConnectionResult> Invoke(GetConnectionInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetConnectionResult> getConnection(GetConnectionArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:DatabaseMigration/getConnection:getConnection
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ConnectionId string
    The OCID of the database connection
    ConnectionId string
    The OCID of the database connection
    connectionId String
    The OCID of the database connection
    connectionId string
    The OCID of the database connection
    connection_id str
    The OCID of the database connection
    connectionId String
    The OCID of the database connection

    getConnection Result

    The following output properties are available:

    AdminCredentials List<GetConnectionAdminCredential>
    Database Administrator Credentials details.
    CertificateTdn string
    This name is the distinguished name used while creating the certificate on target database.
    CompartmentId string
    OCID of the compartment where the secret containing the credentials will be created.
    ConnectDescriptors List<GetConnectionConnectDescriptor>
    Connect Descriptor details.
    ConnectionId string
    CredentialsSecretId string
    OCID of the Secret in the Oracle Cloud Infrastructure vault containing the Database Connection credentials.
    DatabaseId string
    The OCID of the cloud database.
    DatabaseType string
    Database connection type.
    DefinedTags Dictionary<string, object>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    Database Connection display name identifier.
    FreeformTags Dictionary<string, object>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    Id string
    OCID of a previously created Private Endpoint.
    LifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    ManualDatabaseSubType string
    NsgIds List<string>
    An array of Network Security Group OCIDs used to define network access for Connections.
    PrivateEndpoints List<GetConnectionPrivateEndpoint>
    Oracle Cloud Infrastructure Private Endpoint configuration details.
    ReplicationCredentials List<GetConnectionReplicationCredential>
    Database Administrator Credentials details.
    SshDetails List<GetConnectionSshDetail>
    Details of the SSH key that will be used.
    State string
    The current state of the Connection resource.
    SystemTags Dictionary<string, object>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time the Connection resource was created. An RFC3339 formatted datetime string.
    TimeUpdated string
    The time of the last Connection resource details update. An RFC3339 formatted datetime string.
    TlsKeystore string
    TlsWallet string
    VaultDetails List<GetConnectionVaultDetail>
    Oracle Cloud Infrastructure Vault details to store migration and connection credentials secrets
    AdminCredentials []GetConnectionAdminCredential
    Database Administrator Credentials details.
    CertificateTdn string
    This name is the distinguished name used while creating the certificate on target database.
    CompartmentId string
    OCID of the compartment where the secret containing the credentials will be created.
    ConnectDescriptors []GetConnectionConnectDescriptor
    Connect Descriptor details.
    ConnectionId string
    CredentialsSecretId string
    OCID of the Secret in the Oracle Cloud Infrastructure vault containing the Database Connection credentials.
    DatabaseId string
    The OCID of the cloud database.
    DatabaseType string
    Database connection type.
    DefinedTags map[string]interface{}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    Database Connection display name identifier.
    FreeformTags map[string]interface{}
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    Id string
    OCID of a previously created Private Endpoint.
    LifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    ManualDatabaseSubType string
    NsgIds []string
    An array of Network Security Group OCIDs used to define network access for Connections.
    PrivateEndpoints []GetConnectionPrivateEndpoint
    Oracle Cloud Infrastructure Private Endpoint configuration details.
    ReplicationCredentials []GetConnectionReplicationCredential
    Database Administrator Credentials details.
    SshDetails []GetConnectionSshDetail
    Details of the SSH key that will be used.
    State string
    The current state of the Connection resource.
    SystemTags map[string]interface{}
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time the Connection resource was created. An RFC3339 formatted datetime string.
    TimeUpdated string
    The time of the last Connection resource details update. An RFC3339 formatted datetime string.
    TlsKeystore string
    TlsWallet string
    VaultDetails []GetConnectionVaultDetail
    Oracle Cloud Infrastructure Vault details to store migration and connection credentials secrets
    adminCredentials List<GetConnectionAdminCredential>
    Database Administrator Credentials details.
    certificateTdn String
    This name is the distinguished name used while creating the certificate on target database.
    compartmentId String
    OCID of the compartment where the secret containing the credentials will be created.
    connectDescriptors List<GetConnectionConnectDescriptor>
    Connect Descriptor details.
    connectionId String
    credentialsSecretId String
    OCID of the Secret in the Oracle Cloud Infrastructure vault containing the Database Connection credentials.
    databaseId String
    The OCID of the cloud database.
    databaseType String
    Database connection type.
    definedTags Map<String,Object>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    Database Connection display name identifier.
    freeformTags Map<String,Object>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id String
    OCID of a previously created Private Endpoint.
    lifecycleDetails String
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    manualDatabaseSubType String
    nsgIds List<String>
    An array of Network Security Group OCIDs used to define network access for Connections.
    privateEndpoints List<GetConnectionPrivateEndpoint>
    Oracle Cloud Infrastructure Private Endpoint configuration details.
    replicationCredentials List<GetConnectionReplicationCredential>
    Database Administrator Credentials details.
    sshDetails List<GetConnectionSshDetail>
    Details of the SSH key that will be used.
    state String
    The current state of the Connection resource.
    systemTags Map<String,Object>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time the Connection resource was created. An RFC3339 formatted datetime string.
    timeUpdated String
    The time of the last Connection resource details update. An RFC3339 formatted datetime string.
    tlsKeystore String
    tlsWallet String
    vaultDetails List<GetConnectionVaultDetail>
    Oracle Cloud Infrastructure Vault details to store migration and connection credentials secrets
    adminCredentials GetConnectionAdminCredential[]
    Database Administrator Credentials details.
    certificateTdn string
    This name is the distinguished name used while creating the certificate on target database.
    compartmentId string
    OCID of the compartment where the secret containing the credentials will be created.
    connectDescriptors GetConnectionConnectDescriptor[]
    Connect Descriptor details.
    connectionId string
    credentialsSecretId string
    OCID of the Secret in the Oracle Cloud Infrastructure vault containing the Database Connection credentials.
    databaseId string
    The OCID of the cloud database.
    databaseType string
    Database connection type.
    definedTags {[key: string]: any}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName string
    Database Connection display name identifier.
    freeformTags {[key: string]: any}
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id string
    OCID of a previously created Private Endpoint.
    lifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    manualDatabaseSubType string
    nsgIds string[]
    An array of Network Security Group OCIDs used to define network access for Connections.
    privateEndpoints GetConnectionPrivateEndpoint[]
    Oracle Cloud Infrastructure Private Endpoint configuration details.
    replicationCredentials GetConnectionReplicationCredential[]
    Database Administrator Credentials details.
    sshDetails GetConnectionSshDetail[]
    Details of the SSH key that will be used.
    state string
    The current state of the Connection resource.
    systemTags {[key: string]: any}
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The time the Connection resource was created. An RFC3339 formatted datetime string.
    timeUpdated string
    The time of the last Connection resource details update. An RFC3339 formatted datetime string.
    tlsKeystore string
    tlsWallet string
    vaultDetails GetConnectionVaultDetail[]
    Oracle Cloud Infrastructure Vault details to store migration and connection credentials secrets
    admin_credentials Sequence[databasemigration.GetConnectionAdminCredential]
    Database Administrator Credentials details.
    certificate_tdn str
    This name is the distinguished name used while creating the certificate on target database.
    compartment_id str
    OCID of the compartment where the secret containing the credentials will be created.
    connect_descriptors Sequence[databasemigration.GetConnectionConnectDescriptor]
    Connect Descriptor details.
    connection_id str
    credentials_secret_id str
    OCID of the Secret in the Oracle Cloud Infrastructure vault containing the Database Connection credentials.
    database_id str
    The OCID of the cloud database.
    database_type str
    Database connection type.
    defined_tags Mapping[str, Any]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    display_name str
    Database Connection display name identifier.
    freeform_tags Mapping[str, Any]
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id str
    OCID of a previously created Private Endpoint.
    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_sub_type str
    nsg_ids Sequence[str]
    An array of Network Security Group OCIDs used to define network access for Connections.
    private_endpoints Sequence[databasemigration.GetConnectionPrivateEndpoint]
    Oracle Cloud Infrastructure Private Endpoint configuration details.
    replication_credentials Sequence[databasemigration.GetConnectionReplicationCredential]
    Database Administrator Credentials details.
    ssh_details Sequence[databasemigration.GetConnectionSshDetail]
    Details of the SSH key that will be used.
    state str
    The current state of the Connection resource.
    system_tags Mapping[str, Any]
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The time the Connection resource was created. An RFC3339 formatted datetime string.
    time_updated str
    The time of the last Connection resource details update. An RFC3339 formatted datetime string.
    tls_keystore str
    tls_wallet str
    vault_details Sequence[databasemigration.GetConnectionVaultDetail]
    Oracle Cloud Infrastructure Vault details to store migration and connection credentials secrets
    adminCredentials List<Property Map>
    Database Administrator Credentials details.
    certificateTdn String
    This name is the distinguished name used while creating the certificate on target database.
    compartmentId String
    OCID of the compartment where the secret containing the credentials will be created.
    connectDescriptors List<Property Map>
    Connect Descriptor details.
    connectionId String
    credentialsSecretId String
    OCID of the Secret in the Oracle Cloud Infrastructure vault containing the Database Connection credentials.
    databaseId String
    The OCID of the cloud database.
    databaseType String
    Database connection type.
    definedTags Map<Any>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    Database Connection display name identifier.
    freeformTags Map<Any>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id String
    OCID of a previously created Private Endpoint.
    lifecycleDetails String
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    manualDatabaseSubType String
    nsgIds List<String>
    An array of Network Security Group OCIDs used to define network access for Connections.
    privateEndpoints List<Property Map>
    Oracle Cloud Infrastructure Private Endpoint configuration details.
    replicationCredentials List<Property Map>
    Database Administrator Credentials details.
    sshDetails List<Property Map>
    Details of the SSH key that will be used.
    state String
    The current state of the Connection resource.
    systemTags Map<Any>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time the Connection resource was created. An RFC3339 formatted datetime string.
    timeUpdated String
    The time of the last Connection resource details update. An RFC3339 formatted datetime string.
    tlsKeystore String
    tlsWallet String
    vaultDetails List<Property Map>
    Oracle Cloud Infrastructure Vault details to store migration and connection credentials secrets

    Supporting Types

    GetConnectionAdminCredential

    Password string
    Username string
    Administrator username
    Password string
    Username string
    Administrator username
    password String
    username String
    Administrator username
    password string
    username string
    Administrator username
    password str
    username str
    Administrator username
    password String
    username String
    Administrator username

    GetConnectionConnectDescriptor

    ConnectString string
    Connect string.
    DatabaseServiceName string
    Database service name.
    Host string
    Name of the host the SSH key is valid for.
    Port int
    Port of the connect descriptor.
    ConnectString string
    Connect string.
    DatabaseServiceName string
    Database service name.
    Host string
    Name of the host the SSH key is valid for.
    Port int
    Port of the connect descriptor.
    connectString String
    Connect string.
    databaseServiceName String
    Database service name.
    host String
    Name of the host the SSH key is valid for.
    port Integer
    Port of the connect descriptor.
    connectString string
    Connect string.
    databaseServiceName string
    Database service name.
    host string
    Name of the host the SSH key is valid for.
    port number
    Port of the connect descriptor.
    connect_string str
    Connect string.
    database_service_name str
    Database service name.
    host str
    Name of the host the SSH key is valid for.
    port int
    Port of the connect descriptor.
    connectString String
    Connect string.
    databaseServiceName String
    Database service name.
    host String
    Name of the host the SSH key is valid for.
    port Number
    Port of the connect descriptor.

    GetConnectionPrivateEndpoint

    CompartmentId string
    OCID of the compartment where the secret containing the credentials will be created.
    Id string
    OCID of a previously created Private Endpoint.
    SubnetId string
    The OCID of the customer's subnet where the private endpoint VNIC will reside.
    VcnId string
    The OCID of the VCN where the Private Endpoint will be bound to.
    CompartmentId string
    OCID of the compartment where the secret containing the credentials will be created.
    Id string
    OCID of a previously created Private Endpoint.
    SubnetId string
    The OCID of the customer's subnet where the private endpoint VNIC will reside.
    VcnId string
    The OCID of the VCN where the Private Endpoint will be bound to.
    compartmentId String
    OCID of the compartment where the secret containing the credentials will be created.
    id String
    OCID of a previously created Private Endpoint.
    subnetId String
    The OCID of the customer's subnet where the private endpoint VNIC will reside.
    vcnId String
    The OCID of the VCN where the Private Endpoint will be bound to.
    compartmentId string
    OCID of the compartment where the secret containing the credentials will be created.
    id string
    OCID of a previously created Private Endpoint.
    subnetId string
    The OCID of the customer's subnet where the private endpoint VNIC will reside.
    vcnId string
    The OCID of the VCN where the Private Endpoint will be bound to.
    compartment_id str
    OCID of the compartment where the secret containing the credentials will be created.
    id str
    OCID of a previously created Private Endpoint.
    subnet_id str
    The OCID of the customer's subnet where the private endpoint VNIC will reside.
    vcn_id str
    The OCID of the VCN where the Private Endpoint will be bound to.
    compartmentId String
    OCID of the compartment where the secret containing the credentials will be created.
    id String
    OCID of a previously created Private Endpoint.
    subnetId String
    The OCID of the customer's subnet where the private endpoint VNIC will reside.
    vcnId String
    The OCID of the VCN where the Private Endpoint will be bound to.

    GetConnectionReplicationCredential

    Password string
    Username string
    Administrator username
    Password string
    Username string
    Administrator username
    password String
    username String
    Administrator username
    password string
    username string
    Administrator username
    password str
    username str
    Administrator username
    password String
    username String
    Administrator username

    GetConnectionSshDetail

    Host string
    Name of the host the SSH key is valid for.
    Sshkey string
    SudoLocation string
    Sudo location
    User string
    SSH user
    Host string
    Name of the host the SSH key is valid for.
    Sshkey string
    SudoLocation string
    Sudo location
    User string
    SSH user
    host String
    Name of the host the SSH key is valid for.
    sshkey String
    sudoLocation String
    Sudo location
    user String
    SSH user
    host string
    Name of the host the SSH key is valid for.
    sshkey string
    sudoLocation string
    Sudo location
    user string
    SSH user
    host str
    Name of the host the SSH key is valid for.
    sshkey str
    sudo_location str
    Sudo location
    user str
    SSH user
    host String
    Name of the host the SSH key is valid for.
    sshkey String
    sudoLocation String
    Sudo location
    user String
    SSH user

    GetConnectionVaultDetail

    CompartmentId string
    OCID of the compartment where the secret containing the credentials will be created.
    KeyId string
    OCID of the vault encryption key
    VaultId string
    OCID of the vault
    CompartmentId string
    OCID of the compartment where the secret containing the credentials will be created.
    KeyId string
    OCID of the vault encryption key
    VaultId string
    OCID of the vault
    compartmentId String
    OCID of the compartment where the secret containing the credentials will be created.
    keyId String
    OCID of the vault encryption key
    vaultId String
    OCID of the vault
    compartmentId string
    OCID of the compartment where the secret containing the credentials will be created.
    keyId string
    OCID of the vault encryption key
    vaultId string
    OCID of the vault
    compartment_id str
    OCID of the compartment where the secret containing the credentials will be created.
    key_id str
    OCID of the vault encryption key
    vault_id str
    OCID of the vault
    compartmentId String
    OCID of the compartment where the secret containing the credentials will be created.
    keyId String
    OCID of the vault encryption key
    vaultId String
    OCID of the vault

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v1.31.0 published on Wednesday, Apr 10, 2024 by Pulumi