Oracle Cloud Infrastructure v0.6.0, Jan 23 23

oci.GoldenGate.getConnection

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

Retrieves a Connection.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var testConnection = Oci.GoldenGate.GetConnection.Invoke(new()
    {
        ConnectionId = oci_golden_gate_connection.Test_connection.Id,
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := GoldenGate.GetConnection(ctx, &goldengate.GetConnectionArgs{
			ConnectionId: oci_golden_gate_connection.Test_connection.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.GoldenGate.GoldenGateFunctions;
import com.pulumi.oci.GoldenGate.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 = GoldenGateFunctions.getConnection(GetConnectionArgs.builder()
            .connectionId(oci_golden_gate_connection.test_connection().id())
            .build());

    }
}

import pulumi
import pulumi_oci as oci

test_connection = oci.GoldenGate.get_connection(connection_id=oci_golden_gate_connection["test_connection"]["id"])

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

const testConnection = oci.GoldenGate.getConnection({
    connectionId: oci_golden_gate_connection.test_connection.id,
});

variables:
  testConnection:
    fn::invoke:
      Function: oci:GoldenGate:getConnection
      Arguments:
        connectionId: ${oci_golden_gate_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:GoldenGate/getConnection:getConnection
  arguments:
    # arguments dictionary

The following arguments are supported:

ConnectionId string: The OCID of a Connection.

ConnectionId string: The OCID of a Connection.

connectionId String: The OCID of a Connection.

connectionId string: The OCID of a Connection.

connection_id str: The OCID of a Connection.

connectionId String: The OCID of a Connection.

getConnection Result

The following output properties are available:

AccountKey string
AccountName string: Sets the Azure storage account name.
AdditionalAttributes List<GetConnectionAdditionalAttribute>: An array of name-value pair attribute entries. Used as additional parameters in connection string.
AuthenticationType string: Used authentication mechanism to access Azure Data Lake Storage.
AzureTenantId string: Azure tenant ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 14593954-d337-4a61-a364-9f758c64f97f
BootstrapServers List<GetConnectionBootstrapServer>: Kafka bootstrap. Equivalent of bootstrap.servers configuration property in Kafka: list of KafkaBootstrapServer objects specified by host/port. Used for establishing the initial connection to the Kafka cluster. Example: "server1.example.com:9092,server2.example.com:9092"
ClientId string: Azure client ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 06ecaabf-8b80-4ec8-a0ec-20cbf463703d
ClientSecret string
CompartmentId string: The OCID of the compartment being referenced.
ConnectionId string
ConnectionString string: JDBC connection string. e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'
ConnectionType string: The connection type.
ConsumerProperties string
DatabaseId string: The OCID of the database being referenced.
DatabaseName string: The name of the database.
DbSystemId string: The OCID of the database system being referenced.
DefinedTags Dictionary<string, object>: Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DeploymentId string: The OCID of the deployment being referenced.
Description string: Metadata about this specific object.
DisplayName string: An object's Display Name.
Endpoint string: Azure Storage service endpoint. e.g: https://test.blob.core.windows.net
FreeformTags Dictionary<string, object>: A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Host string: The name or address of a host.
Id string: The OCID of the connection being referenced.
IngressIps List<GetConnectionIngressIp>: List of ingress IP addresses, from where the GoldenGate deployment connects to this connection's privateIp.
KeyId string: The OCID of the customer "Master" key being referenced. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this key to manage secrets.
KeyStore string
KeyStorePassword string
LifecycleDetails string: Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.
NsgIds List<string>: An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
Password string
Port int: The port of an endpoint usually specified for a connection.
PrivateIp string: The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
PrivateKeyFile string
PrivateKeyPassphrase string
ProducerProperties string
PublicKeyFingerprint string
Region string: The name of the region. e.g.: us-ashburn-1
SasToken string
SecurityProtocol string: Security protocol for PostgreSQL.
SessionMode string: The mode of the database connection session to be established by the data client. 'REDIRECT' - for a RAC database, 'DIRECT' - for a non-RAC database. Connection to a RAC database involves a redirection received from the SCAN listeners to the database node to connect to. By default the mode would be DIRECT.
SslCa string
SslCert string
SslCrl string
SslKey string
SslKeyPassword string
SslMode string: SSL mode for PostgreSQL.
State string: Possible lifecycle states for connection.
StreamPoolId string: The OCID of the stream pool being referenced.
SubnetId string: The OCID of the subnet being referenced.
SystemTags Dictionary<string, object>: The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}
TechnologyType string: The Kafka (e.g. Confluent) Schema Registry technology type.
TenancyId string: The OCID of the related Oracle Cloud Infrastructure tenancy.
TimeCreated string: The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
TimeUpdated string: The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
TrustStore string
TrustStorePassword string
Url string: Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'
UserId string: The OCID of the Oracle Cloud Infrastructure user who will access the Object Storage. The user must have write access to the bucket they want to connect to.
Username string: The username Oracle GoldenGate uses to connect the associated RDBMS. This username must already exist and be available for use by the database. It must conform to the security requirements implemented by the database including length, case sensitivity, and so on.
VaultId string: The OCID of the customer vault being referenced. If provided, this will reference a vault which the customer will be required to ensure the policies are established to permit the GoldenGate Service to manage secrets contained within this vault.
Wallet string

AccountKey string
AccountName string: Sets the Azure storage account name.
AdditionalAttributes []GetConnectionAdditionalAttribute: An array of name-value pair attribute entries. Used as additional parameters in connection string.
AuthenticationType string: Used authentication mechanism to access Azure Data Lake Storage.
AzureTenantId string: Azure tenant ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 14593954-d337-4a61-a364-9f758c64f97f
BootstrapServers []GetConnectionBootstrapServer: Kafka bootstrap. Equivalent of bootstrap.servers configuration property in Kafka: list of KafkaBootstrapServer objects specified by host/port. Used for establishing the initial connection to the Kafka cluster. Example: "server1.example.com:9092,server2.example.com:9092"
ClientId string: Azure client ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 06ecaabf-8b80-4ec8-a0ec-20cbf463703d
ClientSecret string
CompartmentId string: The OCID of the compartment being referenced.
ConnectionId string
ConnectionString string: JDBC connection string. e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'
ConnectionType string: The connection type.
ConsumerProperties string
DatabaseId string: The OCID of the database being referenced.
DatabaseName string: The name of the database.
DbSystemId string: The OCID of the database system being referenced.
DefinedTags map[string]interface{}: Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DeploymentId string: The OCID of the deployment being referenced.
Description string: Metadata about this specific object.
DisplayName string: An object's Display Name.
Endpoint string: Azure Storage service endpoint. e.g: https://test.blob.core.windows.net
FreeformTags map[string]interface{}: A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Host string: The name or address of a host.
Id string: The OCID of the connection being referenced.
IngressIps []GetConnectionIngressIp: List of ingress IP addresses, from where the GoldenGate deployment connects to this connection's privateIp.
KeyId string: The OCID of the customer "Master" key being referenced. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this key to manage secrets.
KeyStore string
KeyStorePassword string
LifecycleDetails string: Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.
NsgIds []string: An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
Password string
Port int: The port of an endpoint usually specified for a connection.
PrivateIp string: The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
PrivateKeyFile string
PrivateKeyPassphrase string
ProducerProperties string
PublicKeyFingerprint string
Region string: The name of the region. e.g.: us-ashburn-1
SasToken string
SecurityProtocol string: Security protocol for PostgreSQL.
SessionMode string: The mode of the database connection session to be established by the data client. 'REDIRECT' - for a RAC database, 'DIRECT' - for a non-RAC database. Connection to a RAC database involves a redirection received from the SCAN listeners to the database node to connect to. By default the mode would be DIRECT.
SslCa string
SslCert string
SslCrl string
SslKey string
SslKeyPassword string
SslMode string: SSL mode for PostgreSQL.
State string: Possible lifecycle states for connection.
StreamPoolId string: The OCID of the stream pool being referenced.
SubnetId string: The OCID of the subnet being referenced.
SystemTags map[string]interface{}: The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}
TechnologyType string: The Kafka (e.g. Confluent) Schema Registry technology type.
TenancyId string: The OCID of the related Oracle Cloud Infrastructure tenancy.
TimeCreated string: The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
TimeUpdated string: The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
TrustStore string
TrustStorePassword string
Url string: Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'
UserId string: The OCID of the Oracle Cloud Infrastructure user who will access the Object Storage. The user must have write access to the bucket they want to connect to.
Username string: The username Oracle GoldenGate uses to connect the associated RDBMS. This username must already exist and be available for use by the database. It must conform to the security requirements implemented by the database including length, case sensitivity, and so on.
VaultId string: The OCID of the customer vault being referenced. If provided, this will reference a vault which the customer will be required to ensure the policies are established to permit the GoldenGate Service to manage secrets contained within this vault.
Wallet string

accountKey String
accountName String: Sets the Azure storage account name.
additionalAttributes List<GetConnectionAdditionalAttribute>: An array of name-value pair attribute entries. Used as additional parameters in connection string.
authenticationType String: Used authentication mechanism to access Azure Data Lake Storage.
azureTenantId String: Azure tenant ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 14593954-d337-4a61-a364-9f758c64f97f
bootstrapServers List<GetConnectionBootstrapServer>: Kafka bootstrap. Equivalent of bootstrap.servers configuration property in Kafka: list of KafkaBootstrapServer objects specified by host/port. Used for establishing the initial connection to the Kafka cluster. Example: "server1.example.com:9092,server2.example.com:9092"
clientId String: Azure client ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 06ecaabf-8b80-4ec8-a0ec-20cbf463703d
clientSecret String
compartmentId String: The OCID of the compartment being referenced.
connectionId String
connectionString String: JDBC connection string. e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'
connectionType String: The connection type.
consumerProperties String
databaseId String: The OCID of the database being referenced.
databaseName String: The name of the database.
dbSystemId String: The OCID of the database system being referenced.
definedTags Map<String,Object>: Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
deploymentId String: The OCID of the deployment being referenced.
description String: Metadata about this specific object.
displayName String: An object's Display Name.
endpoint String: Azure Storage service endpoint. e.g: https://test.blob.core.windows.net
freeformTags Map<String,Object>: A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
host String: The name or address of a host.
id String: The OCID of the connection being referenced.
ingressIps List<GetConnectionIngressIp>: List of ingress IP addresses, from where the GoldenGate deployment connects to this connection's privateIp.
keyId String: The OCID of the customer "Master" key being referenced. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this key to manage secrets.
keyStore String
keyStorePassword String
lifecycleDetails String: Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.
nsgIds List<String>: An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
password String
port Integer: The port of an endpoint usually specified for a connection.
privateIp String: The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
privateKeyFile String
privateKeyPassphrase String
producerProperties String
publicKeyFingerprint String
region String: The name of the region. e.g.: us-ashburn-1
sasToken String
securityProtocol String: Security protocol for PostgreSQL.
sessionMode String: The mode of the database connection session to be established by the data client. 'REDIRECT' - for a RAC database, 'DIRECT' - for a non-RAC database. Connection to a RAC database involves a redirection received from the SCAN listeners to the database node to connect to. By default the mode would be DIRECT.
sslCa String
sslCert String
sslCrl String
sslKey String
sslKeyPassword String
sslMode String: SSL mode for PostgreSQL.
state String: Possible lifecycle states for connection.
streamPoolId String: The OCID of the stream pool being referenced.
subnetId String: The OCID of the subnet being referenced.
systemTags Map<String,Object>: The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}
technologyType String: The Kafka (e.g. Confluent) Schema Registry technology type.
tenancyId String: The OCID of the related Oracle Cloud Infrastructure tenancy.
timeCreated String: The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
timeUpdated String: The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
trustStore String
trustStorePassword String
url String: Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'
userId String: The OCID of the Oracle Cloud Infrastructure user who will access the Object Storage. The user must have write access to the bucket they want to connect to.
username String: The username Oracle GoldenGate uses to connect the associated RDBMS. This username must already exist and be available for use by the database. It must conform to the security requirements implemented by the database including length, case sensitivity, and so on.
vaultId String: The OCID of the customer vault being referenced. If provided, this will reference a vault which the customer will be required to ensure the policies are established to permit the GoldenGate Service to manage secrets contained within this vault.
wallet String

accountKey string
accountName string: Sets the Azure storage account name.
additionalAttributes GetConnectionAdditionalAttribute[]: An array of name-value pair attribute entries. Used as additional parameters in connection string.
authenticationType string: Used authentication mechanism to access Azure Data Lake Storage.
azureTenantId string: Azure tenant ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 14593954-d337-4a61-a364-9f758c64f97f
bootstrapServers GetConnectionBootstrapServer[]: Kafka bootstrap. Equivalent of bootstrap.servers configuration property in Kafka: list of KafkaBootstrapServer objects specified by host/port. Used for establishing the initial connection to the Kafka cluster. Example: "server1.example.com:9092,server2.example.com:9092"
clientId string: Azure client ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 06ecaabf-8b80-4ec8-a0ec-20cbf463703d
clientSecret string
compartmentId string: The OCID of the compartment being referenced.
connectionId string
connectionString string: JDBC connection string. e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'
connectionType string: The connection type.
consumerProperties string
databaseId string: The OCID of the database being referenced.
databaseName string: The name of the database.
dbSystemId string: The OCID of the database system being referenced.
definedTags {[key: string]: any}: Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
deploymentId string: The OCID of the deployment being referenced.
description string: Metadata about this specific object.
displayName string: An object's Display Name.
endpoint string: Azure Storage service endpoint. e.g: https://test.blob.core.windows.net
freeformTags {[key: string]: any}: A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
host string: The name or address of a host.
id string: The OCID of the connection being referenced.
ingressIps GetConnectionIngressIp[]: List of ingress IP addresses, from where the GoldenGate deployment connects to this connection's privateIp.
keyId string: The OCID of the customer "Master" key being referenced. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this key to manage secrets.
keyStore string
keyStorePassword string
lifecycleDetails string: Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.
nsgIds string[]: An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
password string
port number: The port of an endpoint usually specified for a connection.
privateIp string: The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
privateKeyFile string
privateKeyPassphrase string
producerProperties string
publicKeyFingerprint string
region string: The name of the region. e.g.: us-ashburn-1
sasToken string
securityProtocol string: Security protocol for PostgreSQL.
sessionMode string: The mode of the database connection session to be established by the data client. 'REDIRECT' - for a RAC database, 'DIRECT' - for a non-RAC database. Connection to a RAC database involves a redirection received from the SCAN listeners to the database node to connect to. By default the mode would be DIRECT.
sslCa string
sslCert string
sslCrl string
sslKey string
sslKeyPassword string
sslMode string: SSL mode for PostgreSQL.
state string: Possible lifecycle states for connection.
streamPoolId string: The OCID of the stream pool being referenced.
subnetId string: The OCID of the subnet being referenced.
systemTags {[key: string]: any}: The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}
technologyType string: The Kafka (e.g. Confluent) Schema Registry technology type.
tenancyId string: The OCID of the related Oracle Cloud Infrastructure tenancy.
timeCreated string: The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
timeUpdated string: The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
trustStore string
trustStorePassword string
url string: Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'
userId string: The OCID of the Oracle Cloud Infrastructure user who will access the Object Storage. The user must have write access to the bucket they want to connect to.
username string: The username Oracle GoldenGate uses to connect the associated RDBMS. This username must already exist and be available for use by the database. It must conform to the security requirements implemented by the database including length, case sensitivity, and so on.
vaultId string: The OCID of the customer vault being referenced. If provided, this will reference a vault which the customer will be required to ensure the policies are established to permit the GoldenGate Service to manage secrets contained within this vault.
wallet string

account_key str
account_name str: Sets the Azure storage account name.
additional_attributes GetConnectionAdditionalAttribute]: An array of name-value pair attribute entries. Used as additional parameters in connection string.
authentication_type str: Used authentication mechanism to access Azure Data Lake Storage.
azure_tenant_id str: Azure tenant ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 14593954-d337-4a61-a364-9f758c64f97f
bootstrap_servers GetConnectionBootstrapServer]: Kafka bootstrap. Equivalent of bootstrap.servers configuration property in Kafka: list of KafkaBootstrapServer objects specified by host/port. Used for establishing the initial connection to the Kafka cluster. Example: "server1.example.com:9092,server2.example.com:9092"
client_id str: Azure client ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 06ecaabf-8b80-4ec8-a0ec-20cbf463703d
client_secret str
compartment_id str: The OCID of the compartment being referenced.
connection_id str
connection_string str: JDBC connection string. e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'
connection_type str: The connection type.
consumer_properties str
database_id str: The OCID of the database being referenced.
database_name str: The name of the database.
db_system_id str: The OCID of the database system being referenced.
defined_tags Mapping[str, Any]: Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
deployment_id str: The OCID of the deployment being referenced.
description str: Metadata about this specific object.
display_name str: An object's Display Name.
endpoint str: Azure Storage service endpoint. e.g: https://test.blob.core.windows.net
freeform_tags Mapping[str, Any]: A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
host str: The name or address of a host.
id str: The OCID of the connection being referenced.
ingress_ips GetConnectionIngressIp]: List of ingress IP addresses, from where the GoldenGate deployment connects to this connection's privateIp.
key_id str: The OCID of the customer "Master" key being referenced. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this key to manage secrets.
key_store str
key_store_password str
lifecycle_details str: Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.
nsg_ids Sequence[str]: An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
password str
port int: The port of an endpoint usually specified for a connection.
private_ip str: The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
private_key_file str
private_key_passphrase str
producer_properties str
public_key_fingerprint str
region str: The name of the region. e.g.: us-ashburn-1
sas_token str
security_protocol str: Security protocol for PostgreSQL.
session_mode str: The mode of the database connection session to be established by the data client. 'REDIRECT' - for a RAC database, 'DIRECT' - for a non-RAC database. Connection to a RAC database involves a redirection received from the SCAN listeners to the database node to connect to. By default the mode would be DIRECT.
ssl_ca str
ssl_cert str
ssl_crl str
ssl_key str
ssl_key_password str
ssl_mode str: SSL mode for PostgreSQL.
state str: Possible lifecycle states for connection.
stream_pool_id str: The OCID of the stream pool being referenced.
subnet_id str: The OCID of the subnet being referenced.
system_tags Mapping[str, Any]: The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}
technology_type str: The Kafka (e.g. Confluent) Schema Registry technology type.
tenancy_id str: The OCID of the related Oracle Cloud Infrastructure tenancy.
time_created str: The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
time_updated str: The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
trust_store str
trust_store_password str
url str: Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'
user_id str: The OCID of the Oracle Cloud Infrastructure user who will access the Object Storage. The user must have write access to the bucket they want to connect to.
username str: The username Oracle GoldenGate uses to connect the associated RDBMS. This username must already exist and be available for use by the database. It must conform to the security requirements implemented by the database including length, case sensitivity, and so on.
vault_id str: The OCID of the customer vault being referenced. If provided, this will reference a vault which the customer will be required to ensure the policies are established to permit the GoldenGate Service to manage secrets contained within this vault.
wallet str

accountKey String
accountName String: Sets the Azure storage account name.
additionalAttributes List<Property Map>: An array of name-value pair attribute entries. Used as additional parameters in connection string.
authenticationType String: Used authentication mechanism to access Azure Data Lake Storage.
azureTenantId String: Azure tenant ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 14593954-d337-4a61-a364-9f758c64f97f
bootstrapServers List<Property Map>: Kafka bootstrap. Equivalent of bootstrap.servers configuration property in Kafka: list of KafkaBootstrapServer objects specified by host/port. Used for establishing the initial connection to the Kafka cluster. Example: "server1.example.com:9092,server2.example.com:9092"
clientId String: Azure client ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 06ecaabf-8b80-4ec8-a0ec-20cbf463703d
clientSecret String
compartmentId String: The OCID of the compartment being referenced.
connectionId String
connectionString String: JDBC connection string. e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'
connectionType String: The connection type.
consumerProperties String
databaseId String: The OCID of the database being referenced.
databaseName String: The name of the database.
dbSystemId String: The OCID of the database system being referenced.
definedTags Map<Any>: Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
deploymentId String: The OCID of the deployment being referenced.
description String: Metadata about this specific object.
displayName String: An object's Display Name.
endpoint String: Azure Storage service endpoint. e.g: https://test.blob.core.windows.net
freeformTags Map<Any>: A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
host String: The name or address of a host.
id String: The OCID of the connection being referenced.
ingressIps List<Property Map>: List of ingress IP addresses, from where the GoldenGate deployment connects to this connection's privateIp.
keyId String: The OCID of the customer "Master" key being referenced. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this key to manage secrets.
keyStore String
keyStorePassword String
lifecycleDetails String: Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.
nsgIds List<String>: An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
password String
port Number: The port of an endpoint usually specified for a connection.
privateIp String: The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
privateKeyFile String
privateKeyPassphrase String
producerProperties String
publicKeyFingerprint String
region String: The name of the region. e.g.: us-ashburn-1
sasToken String
securityProtocol String: Security protocol for PostgreSQL.
sessionMode String: The mode of the database connection session to be established by the data client. 'REDIRECT' - for a RAC database, 'DIRECT' - for a non-RAC database. Connection to a RAC database involves a redirection received from the SCAN listeners to the database node to connect to. By default the mode would be DIRECT.
sslCa String
sslCert String
sslCrl String
sslKey String
sslKeyPassword String
sslMode String: SSL mode for PostgreSQL.
state String: Possible lifecycle states for connection.
streamPoolId String: The OCID of the stream pool being referenced.
subnetId String: The OCID of the subnet being referenced.
systemTags Map<Any>: The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}
technologyType String: The Kafka (e.g. Confluent) Schema Registry technology type.
tenancyId String: The OCID of the related Oracle Cloud Infrastructure tenancy.
timeCreated String: The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
timeUpdated String: The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
trustStore String
trustStorePassword String
url String: Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'
userId String: The OCID of the Oracle Cloud Infrastructure user who will access the Object Storage. The user must have write access to the bucket they want to connect to.
username String: The username Oracle GoldenGate uses to connect the associated RDBMS. This username must already exist and be available for use by the database. It must conform to the security requirements implemented by the database including length, case sensitivity, and so on.
vaultId String: The OCID of the customer vault being referenced. If provided, this will reference a vault which the customer will be required to ensure the policies are established to permit the GoldenGate Service to manage secrets contained within this vault.
wallet String

Supporting Types

GetConnectionAdditionalAttribute

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

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

name String: The name of the property entry.
value String: The value of the property entry.

name string: The name of the property entry.
value string: The value of the property entry.

name str: The name of the property entry.
value str: The value of the property entry.

name String: The name of the property entry.
value String: The value of the property entry.

GetConnectionBootstrapServer

Host string: The name or address of a host.
Port int: The port of an endpoint usually specified for a connection.
PrivateIp string: The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.

Host string: The name or address of a host.
Port int: The port of an endpoint usually specified for a connection.
PrivateIp string: The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.

host String: The name or address of a host.
port Integer: The port of an endpoint usually specified for a connection.
privateIp String: The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.

host string: The name or address of a host.
port number: The port of an endpoint usually specified for a connection.
privateIp string: The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.

host str: The name or address of a host.
port int: The port of an endpoint usually specified for a connection.
private_ip str: The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.

host String: The name or address of a host.
port Number: The port of an endpoint usually specified for a connection.
privateIp String: The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.

GetConnectionIngressIp

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

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

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

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

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

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

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.