Oracle Cloud Infrastructure

Pulumi Official
Package maintained by Pulumi
v0.1.1 published on Tuesday, May 3, 2022 by Pulumi

getConnections

This data source provides the list of Connections in Oracle Cloud Infrastructure Database Migration service.

List all Database Connections.

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testConnections = Output.Create(Oci.DatabaseMigration.GetConnections.InvokeAsync(new Oci.DatabaseMigration.GetConnectionsArgs
        {
            CompartmentId = @var.Compartment_id,
            DisplayName = @var.Connection_display_name,
            State = @var.Connection_state,
        }));
    }

}
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.GetConnections(ctx, &databasemigration.GetConnectionsArgs{
			CompartmentId: _var.Compartment_id,
			DisplayName:   pulumi.StringRef(_var.Connection_display_name),
			State:         pulumi.StringRef(_var.Connection_state),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_connections = oci.DatabaseMigration.get_connections(compartment_id=var["compartment_id"],
    display_name=var["connection_display_name"],
    state=var["connection_state"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testConnections = oci.DatabaseMigration.getConnections({
    compartmentId: _var.compartment_id,
    displayName: _var.connection_display_name,
    state: _var.connection_state,
});

Coming soon!

Using getConnections

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 getConnections(args: GetConnectionsArgs, opts?: InvokeOptions): Promise<GetConnectionsResult>
function getConnectionsOutput(args: GetConnectionsOutputArgs, opts?: InvokeOptions): Output<GetConnectionsResult>
def get_connections(compartment_id: Optional[str] = None,
                    display_name: Optional[str] = None,
                    filters: Optional[Sequence[_databasemigration.GetConnectionsFilter]] = None,
                    state: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetConnectionsResult
def get_connections_output(compartment_id: Optional[pulumi.Input[str]] = None,
                    display_name: Optional[pulumi.Input[str]] = None,
                    filters: Optional[pulumi.Input[Sequence[pulumi.Input[_databasemigration.GetConnectionsFilterArgs]]]] = None,
                    state: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetConnectionsResult]
func GetConnections(ctx *Context, args *GetConnectionsArgs, opts ...InvokeOption) (*GetConnectionsResult, error)
func GetConnectionsOutput(ctx *Context, args *GetConnectionsOutputArgs, opts ...InvokeOption) GetConnectionsResultOutput

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

public static class GetConnections 
{
    public static Task<GetConnectionsResult> InvokeAsync(GetConnectionsArgs args, InvokeOptions? opts = null)
    public static Output<GetConnectionsResult> Invoke(GetConnectionsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetConnectionsResult> getConnections(GetConnectionsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: oci:DatabaseMigration/getConnections:getConnections
  Arguments:
    # Arguments dictionary

The following arguments are supported:

CompartmentId string

The ID of the compartment in which to list resources.

DisplayName string

A filter to return only resources that match the entire display name given.

Filters List<GetConnectionsFilter>
State string

The current state of the Database Migration Deployment.

CompartmentId string

The ID of the compartment in which to list resources.

DisplayName string

A filter to return only resources that match the entire display name given.

Filters []GetConnectionsFilter
State string

The current state of the Database Migration Deployment.

compartmentId String

The ID of the compartment in which to list resources.

displayName String

A filter to return only resources that match the entire display name given.

filters List<GetConnectionsFilter>
state String

The current state of the Database Migration Deployment.

compartmentId string

The ID of the compartment in which to list resources.

displayName string

A filter to return only resources that match the entire display name given.

filters GetConnectionsFilter[]
state string

The current state of the Database Migration Deployment.

compartment_id str

The ID of the compartment in which to list resources.

display_name str

A filter to return only resources that match the entire display name given.

filters GetConnectionsFilter]
state str

The current state of the Database Migration Deployment.

compartmentId String

The ID of the compartment in which to list resources.

displayName String

A filter to return only resources that match the entire display name given.

filters List<Property Map>
state String

The current state of the Database Migration Deployment.

getConnections Result

The following output properties are available:

CompartmentId string

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

ConnectionCollections List<GetConnectionsConnectionCollection>

The list of connection_collection.

Id string

The provider-assigned unique ID for this managed resource.

DisplayName string

Database Connection display name identifier.

Filters List<GetConnectionsFilter>
State string

The current state of the Connection resource.

CompartmentId string

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

ConnectionCollections []GetConnectionsConnectionCollection

The list of connection_collection.

Id string

The provider-assigned unique ID for this managed resource.

DisplayName string

Database Connection display name identifier.

Filters []GetConnectionsFilter
State string

The current state of the Connection resource.

compartmentId String

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

connectionCollections List<GetConnectionsConnectionCollection>

The list of connection_collection.

id String

The provider-assigned unique ID for this managed resource.

displayName String

Database Connection display name identifier.

filters List<GetConnectionsFilter>
state String

The current state of the Connection resource.

compartmentId string

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

connectionCollections GetConnectionsConnectionCollection[]

The list of connection_collection.

id string

The provider-assigned unique ID for this managed resource.

displayName string

Database Connection display name identifier.

filters GetConnectionsFilter[]
state string

The current state of the Connection resource.

compartment_id str

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

connection_collections GetConnectionsConnectionCollection]

The list of connection_collection.

id str

The provider-assigned unique ID for this managed resource.

display_name str

Database Connection display name identifier.

filters GetConnectionsFilter]
state str

The current state of the Connection resource.

compartmentId String

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

connectionCollections List<Property Map>

The list of connection_collection.

id String

The provider-assigned unique ID for this managed resource.

displayName String

Database Connection display name identifier.

filters List<Property Map>
state String

The current state of the Connection resource.

Supporting Types

GetConnectionsConnectionCollection

GetConnectionsConnectionCollectionItem

AdminCredentials List<GetConnectionsConnectionCollectionItemAdminCredential>

Database Administrator Credentials details.

CertificateTdn string

This name is the distinguished name used while creating the certificate on target database.

CompartmentId string

The ID of the compartment in which to list resources.

ConnectDescriptors List<GetConnectionsConnectionCollectionItemConnectDescriptor>

Connect Descriptor details.

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

A filter to return only resources that match the entire display name given.

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.

PrivateEndpoints List<GetConnectionsConnectionCollectionItemPrivateEndpoint>

Oracle Cloud Infrastructure Private Endpoint configuration details.

SshDetails List<GetConnectionsConnectionCollectionItemSshDetail>

Details of the SSH key that will be used.

State string

The current state of the Database Migration Deployment.

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

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

AdminCredentials []GetConnectionsConnectionCollectionItemAdminCredential

Database Administrator Credentials details.

CertificateTdn string

This name is the distinguished name used while creating the certificate on target database.

CompartmentId string

The ID of the compartment in which to list resources.

ConnectDescriptors []GetConnectionsConnectionCollectionItemConnectDescriptor

Connect Descriptor details.

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

A filter to return only resources that match the entire display name given.

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.

PrivateEndpoints []GetConnectionsConnectionCollectionItemPrivateEndpoint

Oracle Cloud Infrastructure Private Endpoint configuration details.

SshDetails []GetConnectionsConnectionCollectionItemSshDetail

Details of the SSH key that will be used.

State string

The current state of the Database Migration Deployment.

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 []GetConnectionsConnectionCollectionItemVaultDetail

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

adminCredentials List<GetConnectionsConnectionCollectionItemAdminCredential>

Database Administrator Credentials details.

certificateTdn String

This name is the distinguished name used while creating the certificate on target database.

compartmentId String

The ID of the compartment in which to list resources.

connectDescriptors List<GetConnectionsConnectionCollectionItemConnectDescriptor>

Connect Descriptor details.

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

A filter to return only resources that match the entire display name given.

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.

privateEndpoints List<GetConnectionsConnectionCollectionItemPrivateEndpoint>

Oracle Cloud Infrastructure Private Endpoint configuration details.

sshDetails List<GetConnectionsConnectionCollectionItemSshDetail>

Details of the SSH key that will be used.

state String

The current state of the Database Migration Deployment.

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

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

adminCredentials GetConnectionsConnectionCollectionItemAdminCredential[]

Database Administrator Credentials details.

certificateTdn string

This name is the distinguished name used while creating the certificate on target database.

compartmentId string

The ID of the compartment in which to list resources.

connectDescriptors GetConnectionsConnectionCollectionItemConnectDescriptor[]

Connect Descriptor details.

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

A filter to return only resources that match the entire display name given.

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.

privateEndpoints GetConnectionsConnectionCollectionItemPrivateEndpoint[]

Oracle Cloud Infrastructure Private Endpoint configuration details.

sshDetails GetConnectionsConnectionCollectionItemSshDetail[]

Details of the SSH key that will be used.

state string

The current state of the Database Migration Deployment.

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 GetConnectionsConnectionCollectionItemVaultDetail[]

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

admin_credentials GetConnectionsConnectionCollectionItemAdminCredential]

Database Administrator Credentials details.

certificate_tdn str

This name is the distinguished name used while creating the certificate on target database.

compartment_id str

The ID of the compartment in which to list resources.

connect_descriptors GetConnectionsConnectionCollectionItemConnectDescriptor]

Connect Descriptor details.

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

A filter to return only resources that match the entire display name given.

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.

private_endpoints GetConnectionsConnectionCollectionItemPrivateEndpoint]

Oracle Cloud Infrastructure Private Endpoint configuration details.

ssh_details GetConnectionsConnectionCollectionItemSshDetail]

Details of the SSH key that will be used.

state str

The current state of the Database Migration Deployment.

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 GetConnectionsConnectionCollectionItemVaultDetail]

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

The ID of the compartment in which to list resources.

connectDescriptors List<Property Map>

Connect Descriptor details.

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

A filter to return only resources that match the entire display name given.

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.

privateEndpoints List<Property Map>

Oracle Cloud Infrastructure Private Endpoint configuration details.

sshDetails List<Property Map>

Details of the SSH key that will be used.

state String

The current state of the Database Migration Deployment.

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

GetConnectionsConnectionCollectionItemAdminCredential

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

GetConnectionsConnectionCollectionItemConnectDescriptor

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.

GetConnectionsConnectionCollectionItemPrivateEndpoint

CompartmentId string

The ID of the compartment in which to list resources.

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

The ID of the compartment in which to list resources.

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

The ID of the compartment in which to list resources.

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

The ID of the compartment in which to list resources.

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

The ID of the compartment in which to list resources.

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

The ID of the compartment in which to list resources.

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.

GetConnectionsConnectionCollectionItemSshDetail

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

GetConnectionsConnectionCollectionItemVaultDetail

CompartmentId string

The ID of the compartment in which to list resources.

KeyId string

OCID of the vault encryption key

VaultId string

OCID of the vault

CompartmentId string

The ID of the compartment in which to list resources.

KeyId string

OCID of the vault encryption key

VaultId string

OCID of the vault

compartmentId String

The ID of the compartment in which to list resources.

keyId String

OCID of the vault encryption key

vaultId String

OCID of the vault

compartmentId string

The ID of the compartment in which to list resources.

keyId string

OCID of the vault encryption key

vaultId string

OCID of the vault

compartment_id str

The ID of the compartment in which to list resources.

key_id str

OCID of the vault encryption key

vault_id str

OCID of the vault

compartmentId String

The ID of the compartment in which to list resources.

keyId String

OCID of the vault encryption key

vaultId String

OCID of the vault

GetConnectionsFilter

Name string
Values List<string>
Regex bool
Name string
Values []string
Regex bool
name String
values List<String>
regex Boolean
name string
values string[]
regex boolean
name str
values Sequence[str]
regex bool
name String
values List<String>
regex Boolean

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.