Docs Home
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
oci.GoldenGate.Connection
Explore with Pulumi AI
This resource provides the Connection resource in Oracle Cloud Infrastructure Golden Gate service.
Creates a new Connection.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testConnection = new oci.goldengate.Connection("test_connection", {
compartmentId: compartmentId,
connectionType: connectionConnectionType,
displayName: connectionDisplayName,
technologyType: connectionTechnologyType,
accessKeyId: testKey.id,
accountKey: connectionAccountKey,
accountKeySecretId: testSecret.id,
accountName: connectionAccountName,
additionalAttributes: [{
name: connectionAdditionalAttributesName,
value: connectionAdditionalAttributesValue,
}],
authenticationMode: connectionAuthenticationMode,
authenticationType: connectionAuthenticationType,
azureTenantId: testAzureTenant.id,
bootstrapServers: [{
host: connectionBootstrapServersHost,
port: connectionBootstrapServersPort,
privateIp: connectionBootstrapServersPrivateIp,
}],
clientId: testClient.id,
clientSecret: connectionClientSecret,
clientSecretSecretId: testSecret.id,
connectionFactory: connectionConnectionFactory,
connectionString: connectionConnectionString,
connectionUrl: connectionConnectionUrl,
consumerProperties: connectionConsumerProperties,
coreSiteXml: connectionCoreSiteXml,
databaseId: testDatabase.id,
databaseName: testDatabase.name,
dbSystemId: testDbSystem.id,
definedTags: {
"foo-namespace.bar-key": "value",
},
deploymentId: testDeployment.id,
description: connectionDescription,
doesUseSecretIds: connectionDoesUseSecretIds,
endpoint: connectionEndpoint,
fingerprint: connectionFingerprint,
freeformTags: {
"bar-key": "value",
},
host: connectionHost,
jndiConnectionFactory: connectionJndiConnectionFactory,
jndiInitialContextFactory: connectionJndiInitialContextFactory,
jndiProviderUrl: connectionJndiProviderUrl,
jndiSecurityCredentials: connectionJndiSecurityCredentials,
jndiSecurityCredentialsSecretId: testSecret.id,
jndiSecurityPrincipal: connectionJndiSecurityPrincipal,
keyId: testKey.id,
keyStore: connectionKeyStore,
keyStorePassword: connectionKeyStorePassword,
keyStoreSecretId: testSecret.id,
keyStorePasswordSecretId: testSecret.id,
locks: [{
type: connectionLocksType,
message: connectionLocksMessage,
}],
nsgIds: connectionNsgIds,
password: connectionPassword,
passwordSecretId: testSecret.id,
port: connectionPort,
privateIp: connectionPrivateIp,
privateKeyFile: connectionPrivateKeyFile,
privateKeyFileSecretId: testSecret.id,
privateKeyPassphrase: connectionPrivateKeyPassphrase,
privateKeyPassphraseSecretId: testSecret.id,
producerProperties: connectionProducerProperties,
publicKeyFingerprint: connectionPublicKeyFingerprint,
redisClusterId: testRedisCluster.id,
region: connectionRegion,
routingMethod: connectionRoutingMethod,
sasToken: connectionSasToken,
sasTokenSecretId: testSecret.id,
secretAccessKey: connectionSecretAccessKey,
secretAccessKeySecretId: testSecret.id,
securityProtocol: connectionSecurityProtocol,
servers: connectionServers,
serviceAccountKeyFile: connectionServiceAccountKeyFile,
serviceAccountKeyFileSecretId: testSecret.id,
sessionMode: connectionSessionMode,
shouldUseJndi: connectionShouldUseJndi,
shouldUseResourcePrincipal: connectionShouldUseResourcePrincipal,
shouldValidateServerCertificate: connectionShouldValidateServerCertificate,
sslCa: connectionSslCa,
sslCert: connectionSslCert,
sslClientKeystash: connectionSslClientKeystash,
sslClientKeystashSecretId: testSecret.id,
sslClientKeystoredb: connectionSslClientKeystoredb,
sslClientKeystoredbSecretId: testSecret.id,
sslCrl: connectionSslCrl,
sslKey: connectionSslKey,
sslKeyPassword: connectionSslKeyPassword,
sslKeyPasswordSecretId: testSecret.id,
sslKeySecretId: testSecret.id,
sslMode: connectionSslMode,
sslServerCertificate: connectionSslServerCertificate,
storageCredentialName: connectionStorageCredentialName,
streamPoolId: testStreamPool.id,
subnetId: testSubnet.id,
tenancyId: testTenancy.id,
tenantId: testTenant.id,
tlsCaFile: connectionTlsCaFile,
tlsCertificateKeyFile: connectionTlsCertificateKeyFile,
tlsCertificateKeyFilePassword: connectionTlsCertificateKeyFilePassword,
tlsCertificateKeyFilePasswordSecretId: testSecret.id,
tlsCertificateKeyFileSecretId: testSecret.id,
trustStore: connectionTrustStore,
trustStorePassword: connectionTrustStorePassword,
trustStorePasswordSecretId: testSecret.id,
trustStoreSecretId: testSecret.id,
url: connectionUrl,
userId: testUser.id,
username: connectionUsername,
vaultId: testVault.id,
wallet: connectionWallet,
walletSecretId: testSecret.id,
triggerRefresh: true,
});
import pulumi
import pulumi_oci as oci
test_connection = oci.golden_gate.Connection("test_connection",
compartment_id=compartment_id,
connection_type=connection_connection_type,
display_name=connection_display_name,
technology_type=connection_technology_type,
access_key_id=test_key["id"],
account_key=connection_account_key,
account_key_secret_id=test_secret["id"],
account_name=connection_account_name,
additional_attributes=[{
"name": connection_additional_attributes_name,
"value": connection_additional_attributes_value,
}],
authentication_mode=connection_authentication_mode,
authentication_type=connection_authentication_type,
azure_tenant_id=test_azure_tenant["id"],
bootstrap_servers=[{
"host": connection_bootstrap_servers_host,
"port": connection_bootstrap_servers_port,
"private_ip": connection_bootstrap_servers_private_ip,
}],
client_id=test_client["id"],
client_secret=connection_client_secret,
client_secret_secret_id=test_secret["id"],
connection_factory=connection_connection_factory,
connection_string=connection_connection_string,
connection_url=connection_connection_url,
consumer_properties=connection_consumer_properties,
core_site_xml=connection_core_site_xml,
database_id=test_database["id"],
database_name=test_database["name"],
db_system_id=test_db_system["id"],
defined_tags={
"foo-namespace.bar-key": "value",
},
deployment_id=test_deployment["id"],
description=connection_description,
does_use_secret_ids=connection_does_use_secret_ids,
endpoint=connection_endpoint,
fingerprint=connection_fingerprint,
freeform_tags={
"bar-key": "value",
},
host=connection_host,
jndi_connection_factory=connection_jndi_connection_factory,
jndi_initial_context_factory=connection_jndi_initial_context_factory,
jndi_provider_url=connection_jndi_provider_url,
jndi_security_credentials=connection_jndi_security_credentials,
jndi_security_credentials_secret_id=test_secret["id"],
jndi_security_principal=connection_jndi_security_principal,
key_id=test_key["id"],
key_store=connection_key_store,
key_store_password=connection_key_store_password,
key_store_secret_id=test_secret["id"],
key_store_password_secret_id=test_secret["id"],
locks=[{
"type": connection_locks_type,
"message": connection_locks_message,
}],
nsg_ids=connection_nsg_ids,
password=connection_password,
password_secret_id=test_secret["id"],
port=connection_port,
private_ip=connection_private_ip,
private_key_file=connection_private_key_file,
private_key_file_secret_id=test_secret["id"],
private_key_passphrase=connection_private_key_passphrase,
private_key_passphrase_secret_id=test_secret["id"],
producer_properties=connection_producer_properties,
public_key_fingerprint=connection_public_key_fingerprint,
redis_cluster_id=test_redis_cluster["id"],
region=connection_region,
routing_method=connection_routing_method,
sas_token=connection_sas_token,
sas_token_secret_id=test_secret["id"],
secret_access_key=connection_secret_access_key,
secret_access_key_secret_id=test_secret["id"],
security_protocol=connection_security_protocol,
servers=connection_servers,
service_account_key_file=connection_service_account_key_file,
service_account_key_file_secret_id=test_secret["id"],
session_mode=connection_session_mode,
should_use_jndi=connection_should_use_jndi,
should_use_resource_principal=connection_should_use_resource_principal,
should_validate_server_certificate=connection_should_validate_server_certificate,
ssl_ca=connection_ssl_ca,
ssl_cert=connection_ssl_cert,
ssl_client_keystash=connection_ssl_client_keystash,
ssl_client_keystash_secret_id=test_secret["id"],
ssl_client_keystoredb=connection_ssl_client_keystoredb,
ssl_client_keystoredb_secret_id=test_secret["id"],
ssl_crl=connection_ssl_crl,
ssl_key=connection_ssl_key,
ssl_key_password=connection_ssl_key_password,
ssl_key_password_secret_id=test_secret["id"],
ssl_key_secret_id=test_secret["id"],
ssl_mode=connection_ssl_mode,
ssl_server_certificate=connection_ssl_server_certificate,
storage_credential_name=connection_storage_credential_name,
stream_pool_id=test_stream_pool["id"],
subnet_id=test_subnet["id"],
tenancy_id=test_tenancy["id"],
tenant_id=test_tenant["id"],
tls_ca_file=connection_tls_ca_file,
tls_certificate_key_file=connection_tls_certificate_key_file,
tls_certificate_key_file_password=connection_tls_certificate_key_file_password,
tls_certificate_key_file_password_secret_id=test_secret["id"],
tls_certificate_key_file_secret_id=test_secret["id"],
trust_store=connection_trust_store,
trust_store_password=connection_trust_store_password,
trust_store_password_secret_id=test_secret["id"],
trust_store_secret_id=test_secret["id"],
url=connection_url,
user_id=test_user["id"],
username=connection_username,
vault_id=test_vault["id"],
wallet=connection_wallet,
wallet_secret_id=test_secret["id"],
trigger_refresh=True)
package main
import (
"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/goldengate"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := goldengate.NewConnection(ctx, "test_connection", &goldengate.ConnectionArgs{
CompartmentId: pulumi.Any(compartmentId),
ConnectionType: pulumi.Any(connectionConnectionType),
DisplayName: pulumi.Any(connectionDisplayName),
TechnologyType: pulumi.Any(connectionTechnologyType),
AccessKeyId: pulumi.Any(testKey.Id),
AccountKey: pulumi.Any(connectionAccountKey),
AccountKeySecretId: pulumi.Any(testSecret.Id),
AccountName: pulumi.Any(connectionAccountName),
AdditionalAttributes: goldengate.ConnectionAdditionalAttributeArray{
&goldengate.ConnectionAdditionalAttributeArgs{
Name: pulumi.Any(connectionAdditionalAttributesName),
Value: pulumi.Any(connectionAdditionalAttributesValue),
},
},
AuthenticationMode: pulumi.Any(connectionAuthenticationMode),
AuthenticationType: pulumi.Any(connectionAuthenticationType),
AzureTenantId: pulumi.Any(testAzureTenant.Id),
BootstrapServers: goldengate.ConnectionBootstrapServerArray{
&goldengate.ConnectionBootstrapServerArgs{
Host: pulumi.Any(connectionBootstrapServersHost),
Port: pulumi.Any(connectionBootstrapServersPort),
PrivateIp: pulumi.Any(connectionBootstrapServersPrivateIp),
},
},
ClientId: pulumi.Any(testClient.Id),
ClientSecret: pulumi.Any(connectionClientSecret),
ClientSecretSecretId: pulumi.Any(testSecret.Id),
ConnectionFactory: pulumi.Any(connectionConnectionFactory),
ConnectionString: pulumi.Any(connectionConnectionString),
ConnectionUrl: pulumi.Any(connectionConnectionUrl),
ConsumerProperties: pulumi.Any(connectionConsumerProperties),
CoreSiteXml: pulumi.Any(connectionCoreSiteXml),
DatabaseId: pulumi.Any(testDatabase.Id),
DatabaseName: pulumi.Any(testDatabase.Name),
DbSystemId: pulumi.Any(testDbSystem.Id),
DefinedTags: pulumi.StringMap{
"foo-namespace.bar-key": pulumi.String("value"),
},
DeploymentId: pulumi.Any(testDeployment.Id),
Description: pulumi.Any(connectionDescription),
DoesUseSecretIds: pulumi.Any(connectionDoesUseSecretIds),
Endpoint: pulumi.Any(connectionEndpoint),
Fingerprint: pulumi.Any(connectionFingerprint),
FreeformTags: pulumi.StringMap{
"bar-key": pulumi.String("value"),
},
Host: pulumi.Any(connectionHost),
JndiConnectionFactory: pulumi.Any(connectionJndiConnectionFactory),
JndiInitialContextFactory: pulumi.Any(connectionJndiInitialContextFactory),
JndiProviderUrl: pulumi.Any(connectionJndiProviderUrl),
JndiSecurityCredentials: pulumi.Any(connectionJndiSecurityCredentials),
JndiSecurityCredentialsSecretId: pulumi.Any(testSecret.Id),
JndiSecurityPrincipal: pulumi.Any(connectionJndiSecurityPrincipal),
KeyId: pulumi.Any(testKey.Id),
KeyStore: pulumi.Any(connectionKeyStore),
KeyStorePassword: pulumi.Any(connectionKeyStorePassword),
KeyStoreSecretId: pulumi.Any(testSecret.Id),
KeyStorePasswordSecretId: pulumi.Any(testSecret.Id),
Locks: goldengate.ConnectionLockArray{
&goldengate.ConnectionLockArgs{
Type: pulumi.Any(connectionLocksType),
Message: pulumi.Any(connectionLocksMessage),
},
},
NsgIds: pulumi.Any(connectionNsgIds),
Password: pulumi.Any(connectionPassword),
PasswordSecretId: pulumi.Any(testSecret.Id),
Port: pulumi.Any(connectionPort),
PrivateIp: pulumi.Any(connectionPrivateIp),
PrivateKeyFile: pulumi.Any(connectionPrivateKeyFile),
PrivateKeyFileSecretId: pulumi.Any(testSecret.Id),
PrivateKeyPassphrase: pulumi.Any(connectionPrivateKeyPassphrase),
PrivateKeyPassphraseSecretId: pulumi.Any(testSecret.Id),
ProducerProperties: pulumi.Any(connectionProducerProperties),
PublicKeyFingerprint: pulumi.Any(connectionPublicKeyFingerprint),
RedisClusterId: pulumi.Any(testRedisCluster.Id),
Region: pulumi.Any(connectionRegion),
RoutingMethod: pulumi.Any(connectionRoutingMethod),
SasToken: pulumi.Any(connectionSasToken),
SasTokenSecretId: pulumi.Any(testSecret.Id),
SecretAccessKey: pulumi.Any(connectionSecretAccessKey),
SecretAccessKeySecretId: pulumi.Any(testSecret.Id),
SecurityProtocol: pulumi.Any(connectionSecurityProtocol),
Servers: pulumi.Any(connectionServers),
ServiceAccountKeyFile: pulumi.Any(connectionServiceAccountKeyFile),
ServiceAccountKeyFileSecretId: pulumi.Any(testSecret.Id),
SessionMode: pulumi.Any(connectionSessionMode),
ShouldUseJndi: pulumi.Any(connectionShouldUseJndi),
ShouldUseResourcePrincipal: pulumi.Any(connectionShouldUseResourcePrincipal),
ShouldValidateServerCertificate: pulumi.Any(connectionShouldValidateServerCertificate),
SslCa: pulumi.Any(connectionSslCa),
SslCert: pulumi.Any(connectionSslCert),
SslClientKeystash: pulumi.Any(connectionSslClientKeystash),
SslClientKeystashSecretId: pulumi.Any(testSecret.Id),
SslClientKeystoredb: pulumi.Any(connectionSslClientKeystoredb),
SslClientKeystoredbSecretId: pulumi.Any(testSecret.Id),
SslCrl: pulumi.Any(connectionSslCrl),
SslKey: pulumi.Any(connectionSslKey),
SslKeyPassword: pulumi.Any(connectionSslKeyPassword),
SslKeyPasswordSecretId: pulumi.Any(testSecret.Id),
SslKeySecretId: pulumi.Any(testSecret.Id),
SslMode: pulumi.Any(connectionSslMode),
SslServerCertificate: pulumi.Any(connectionSslServerCertificate),
StorageCredentialName: pulumi.Any(connectionStorageCredentialName),
StreamPoolId: pulumi.Any(testStreamPool.Id),
SubnetId: pulumi.Any(testSubnet.Id),
TenancyId: pulumi.Any(testTenancy.Id),
TenantId: pulumi.Any(testTenant.Id),
TlsCaFile: pulumi.Any(connectionTlsCaFile),
TlsCertificateKeyFile: pulumi.Any(connectionTlsCertificateKeyFile),
TlsCertificateKeyFilePassword: pulumi.Any(connectionTlsCertificateKeyFilePassword),
TlsCertificateKeyFilePasswordSecretId: pulumi.Any(testSecret.Id),
TlsCertificateKeyFileSecretId: pulumi.Any(testSecret.Id),
TrustStore: pulumi.Any(connectionTrustStore),
TrustStorePassword: pulumi.Any(connectionTrustStorePassword),
TrustStorePasswordSecretId: pulumi.Any(testSecret.Id),
TrustStoreSecretId: pulumi.Any(testSecret.Id),
Url: pulumi.Any(connectionUrl),
UserId: pulumi.Any(testUser.Id),
Username: pulumi.Any(connectionUsername),
VaultId: pulumi.Any(testVault.Id),
Wallet: pulumi.Any(connectionWallet),
WalletSecretId: pulumi.Any(testSecret.Id),
TriggerRefresh: pulumi.Bool(true),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() =>
{
var testConnection = new Oci.GoldenGate.Connection("test_connection", new()
{
CompartmentId = compartmentId,
ConnectionType = connectionConnectionType,
DisplayName = connectionDisplayName,
TechnologyType = connectionTechnologyType,
AccessKeyId = testKey.Id,
AccountKey = connectionAccountKey,
AccountKeySecretId = testSecret.Id,
AccountName = connectionAccountName,
AdditionalAttributes = new[]
{
new Oci.GoldenGate.Inputs.ConnectionAdditionalAttributeArgs
{
Name = connectionAdditionalAttributesName,
Value = connectionAdditionalAttributesValue,
},
},
AuthenticationMode = connectionAuthenticationMode,
AuthenticationType = connectionAuthenticationType,
AzureTenantId = testAzureTenant.Id,
BootstrapServers = new[]
{
new Oci.GoldenGate.Inputs.ConnectionBootstrapServerArgs
{
Host = connectionBootstrapServersHost,
Port = connectionBootstrapServersPort,
PrivateIp = connectionBootstrapServersPrivateIp,
},
},
ClientId = testClient.Id,
ClientSecret = connectionClientSecret,
ClientSecretSecretId = testSecret.Id,
ConnectionFactory = connectionConnectionFactory,
ConnectionString = connectionConnectionString,
ConnectionUrl = connectionConnectionUrl,
ConsumerProperties = connectionConsumerProperties,
CoreSiteXml = connectionCoreSiteXml,
DatabaseId = testDatabase.Id,
DatabaseName = testDatabase.Name,
DbSystemId = testDbSystem.Id,
DefinedTags =
{
{ "foo-namespace.bar-key", "value" },
},
DeploymentId = testDeployment.Id,
Description = connectionDescription,
DoesUseSecretIds = connectionDoesUseSecretIds,
Endpoint = connectionEndpoint,
Fingerprint = connectionFingerprint,
FreeformTags =
{
{ "bar-key", "value" },
},
Host = connectionHost,
JndiConnectionFactory = connectionJndiConnectionFactory,
JndiInitialContextFactory = connectionJndiInitialContextFactory,
JndiProviderUrl = connectionJndiProviderUrl,
JndiSecurityCredentials = connectionJndiSecurityCredentials,
JndiSecurityCredentialsSecretId = testSecret.Id,
JndiSecurityPrincipal = connectionJndiSecurityPrincipal,
KeyId = testKey.Id,
KeyStore = connectionKeyStore,
KeyStorePassword = connectionKeyStorePassword,
KeyStoreSecretId = testSecret.Id,
KeyStorePasswordSecretId = testSecret.Id,
Locks = new[]
{
new Oci.GoldenGate.Inputs.ConnectionLockArgs
{
Type = connectionLocksType,
Message = connectionLocksMessage,
},
},
NsgIds = connectionNsgIds,
Password = connectionPassword,
PasswordSecretId = testSecret.Id,
Port = connectionPort,
PrivateIp = connectionPrivateIp,
PrivateKeyFile = connectionPrivateKeyFile,
PrivateKeyFileSecretId = testSecret.Id,
PrivateKeyPassphrase = connectionPrivateKeyPassphrase,
PrivateKeyPassphraseSecretId = testSecret.Id,
ProducerProperties = connectionProducerProperties,
PublicKeyFingerprint = connectionPublicKeyFingerprint,
RedisClusterId = testRedisCluster.Id,
Region = connectionRegion,
RoutingMethod = connectionRoutingMethod,
SasToken = connectionSasToken,
SasTokenSecretId = testSecret.Id,
SecretAccessKey = connectionSecretAccessKey,
SecretAccessKeySecretId = testSecret.Id,
SecurityProtocol = connectionSecurityProtocol,
Servers = connectionServers,
ServiceAccountKeyFile = connectionServiceAccountKeyFile,
ServiceAccountKeyFileSecretId = testSecret.Id,
SessionMode = connectionSessionMode,
ShouldUseJndi = connectionShouldUseJndi,
ShouldUseResourcePrincipal = connectionShouldUseResourcePrincipal,
ShouldValidateServerCertificate = connectionShouldValidateServerCertificate,
SslCa = connectionSslCa,
SslCert = connectionSslCert,
SslClientKeystash = connectionSslClientKeystash,
SslClientKeystashSecretId = testSecret.Id,
SslClientKeystoredb = connectionSslClientKeystoredb,
SslClientKeystoredbSecretId = testSecret.Id,
SslCrl = connectionSslCrl,
SslKey = connectionSslKey,
SslKeyPassword = connectionSslKeyPassword,
SslKeyPasswordSecretId = testSecret.Id,
SslKeySecretId = testSecret.Id,
SslMode = connectionSslMode,
SslServerCertificate = connectionSslServerCertificate,
StorageCredentialName = connectionStorageCredentialName,
StreamPoolId = testStreamPool.Id,
SubnetId = testSubnet.Id,
TenancyId = testTenancy.Id,
TenantId = testTenant.Id,
TlsCaFile = connectionTlsCaFile,
TlsCertificateKeyFile = connectionTlsCertificateKeyFile,
TlsCertificateKeyFilePassword = connectionTlsCertificateKeyFilePassword,
TlsCertificateKeyFilePasswordSecretId = testSecret.Id,
TlsCertificateKeyFileSecretId = testSecret.Id,
TrustStore = connectionTrustStore,
TrustStorePassword = connectionTrustStorePassword,
TrustStorePasswordSecretId = testSecret.Id,
TrustStoreSecretId = testSecret.Id,
Url = connectionUrl,
UserId = testUser.Id,
Username = connectionUsername,
VaultId = testVault.Id,
Wallet = connectionWallet,
WalletSecretId = testSecret.Id,
TriggerRefresh = true,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.GoldenGate.Connection;
import com.pulumi.oci.GoldenGate.ConnectionArgs;
import com.pulumi.oci.GoldenGate.inputs.ConnectionAdditionalAttributeArgs;
import com.pulumi.oci.GoldenGate.inputs.ConnectionBootstrapServerArgs;
import com.pulumi.oci.GoldenGate.inputs.ConnectionLockArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var testConnection = new Connection("testConnection", ConnectionArgs.builder()
.compartmentId(compartmentId)
.connectionType(connectionConnectionType)
.displayName(connectionDisplayName)
.technologyType(connectionTechnologyType)
.accessKeyId(testKey.id())
.accountKey(connectionAccountKey)
.accountKeySecretId(testSecret.id())
.accountName(connectionAccountName)
.additionalAttributes(ConnectionAdditionalAttributeArgs.builder()
.name(connectionAdditionalAttributesName)
.value(connectionAdditionalAttributesValue)
.build())
.authenticationMode(connectionAuthenticationMode)
.authenticationType(connectionAuthenticationType)
.azureTenantId(testAzureTenant.id())
.bootstrapServers(ConnectionBootstrapServerArgs.builder()
.host(connectionBootstrapServersHost)
.port(connectionBootstrapServersPort)
.privateIp(connectionBootstrapServersPrivateIp)
.build())
.clientId(testClient.id())
.clientSecret(connectionClientSecret)
.clientSecretSecretId(testSecret.id())
.connectionFactory(connectionConnectionFactory)
.connectionString(connectionConnectionString)
.connectionUrl(connectionConnectionUrl)
.consumerProperties(connectionConsumerProperties)
.coreSiteXml(connectionCoreSiteXml)
.databaseId(testDatabase.id())
.databaseName(testDatabase.name())
.dbSystemId(testDbSystem.id())
.definedTags(Map.of("foo-namespace.bar-key", "value"))
.deploymentId(testDeployment.id())
.description(connectionDescription)
.doesUseSecretIds(connectionDoesUseSecretIds)
.endpoint(connectionEndpoint)
.fingerprint(connectionFingerprint)
.freeformTags(Map.of("bar-key", "value"))
.host(connectionHost)
.jndiConnectionFactory(connectionJndiConnectionFactory)
.jndiInitialContextFactory(connectionJndiInitialContextFactory)
.jndiProviderUrl(connectionJndiProviderUrl)
.jndiSecurityCredentials(connectionJndiSecurityCredentials)
.jndiSecurityCredentialsSecretId(testSecret.id())
.jndiSecurityPrincipal(connectionJndiSecurityPrincipal)
.keyId(testKey.id())
.keyStore(connectionKeyStore)
.keyStorePassword(connectionKeyStorePassword)
.keyStoreSecretId(testSecret.id())
.keyStorePasswordSecretId(testSecret.id())
.locks(ConnectionLockArgs.builder()
.type(connectionLocksType)
.message(connectionLocksMessage)
.build())
.nsgIds(connectionNsgIds)
.password(connectionPassword)
.passwordSecretId(testSecret.id())
.port(connectionPort)
.privateIp(connectionPrivateIp)
.privateKeyFile(connectionPrivateKeyFile)
.privateKeyFileSecretId(testSecret.id())
.privateKeyPassphrase(connectionPrivateKeyPassphrase)
.privateKeyPassphraseSecretId(testSecret.id())
.producerProperties(connectionProducerProperties)
.publicKeyFingerprint(connectionPublicKeyFingerprint)
.redisClusterId(testRedisCluster.id())
.region(connectionRegion)
.routingMethod(connectionRoutingMethod)
.sasToken(connectionSasToken)
.sasTokenSecretId(testSecret.id())
.secretAccessKey(connectionSecretAccessKey)
.secretAccessKeySecretId(testSecret.id())
.securityProtocol(connectionSecurityProtocol)
.servers(connectionServers)
.serviceAccountKeyFile(connectionServiceAccountKeyFile)
.serviceAccountKeyFileSecretId(testSecret.id())
.sessionMode(connectionSessionMode)
.shouldUseJndi(connectionShouldUseJndi)
.shouldUseResourcePrincipal(connectionShouldUseResourcePrincipal)
.shouldValidateServerCertificate(connectionShouldValidateServerCertificate)
.sslCa(connectionSslCa)
.sslCert(connectionSslCert)
.sslClientKeystash(connectionSslClientKeystash)
.sslClientKeystashSecretId(testSecret.id())
.sslClientKeystoredb(connectionSslClientKeystoredb)
.sslClientKeystoredbSecretId(testSecret.id())
.sslCrl(connectionSslCrl)
.sslKey(connectionSslKey)
.sslKeyPassword(connectionSslKeyPassword)
.sslKeyPasswordSecretId(testSecret.id())
.sslKeySecretId(testSecret.id())
.sslMode(connectionSslMode)
.sslServerCertificate(connectionSslServerCertificate)
.storageCredentialName(connectionStorageCredentialName)
.streamPoolId(testStreamPool.id())
.subnetId(testSubnet.id())
.tenancyId(testTenancy.id())
.tenantId(testTenant.id())
.tlsCaFile(connectionTlsCaFile)
.tlsCertificateKeyFile(connectionTlsCertificateKeyFile)
.tlsCertificateKeyFilePassword(connectionTlsCertificateKeyFilePassword)
.tlsCertificateKeyFilePasswordSecretId(testSecret.id())
.tlsCertificateKeyFileSecretId(testSecret.id())
.trustStore(connectionTrustStore)
.trustStorePassword(connectionTrustStorePassword)
.trustStorePasswordSecretId(testSecret.id())
.trustStoreSecretId(testSecret.id())
.url(connectionUrl)
.userId(testUser.id())
.username(connectionUsername)
.vaultId(testVault.id())
.wallet(connectionWallet)
.walletSecretId(testSecret.id())
.triggerRefresh(true)
.build());
}
}
resources:
testConnection:
type: oci:GoldenGate:Connection
name: test_connection
properties:
compartmentId: ${compartmentId}
connectionType: ${connectionConnectionType}
displayName: ${connectionDisplayName}
technologyType: ${connectionTechnologyType}
accessKeyId: ${testKey.id}
accountKey: ${connectionAccountKey}
accountKeySecretId: ${testSecret.id}
accountName: ${connectionAccountName}
additionalAttributes:
- name: ${connectionAdditionalAttributesName}
value: ${connectionAdditionalAttributesValue}
authenticationMode: ${connectionAuthenticationMode}
authenticationType: ${connectionAuthenticationType}
azureTenantId: ${testAzureTenant.id}
bootstrapServers:
- host: ${connectionBootstrapServersHost}
port: ${connectionBootstrapServersPort}
privateIp: ${connectionBootstrapServersPrivateIp}
clientId: ${testClient.id}
clientSecret: ${connectionClientSecret}
clientSecretSecretId: ${testSecret.id}
connectionFactory: ${connectionConnectionFactory}
connectionString: ${connectionConnectionString}
connectionUrl: ${connectionConnectionUrl}
consumerProperties: ${connectionConsumerProperties}
coreSiteXml: ${connectionCoreSiteXml}
databaseId: ${testDatabase.id}
databaseName: ${testDatabase.name}
dbSystemId: ${testDbSystem.id}
definedTags:
foo-namespace.bar-key: value
deploymentId: ${testDeployment.id}
description: ${connectionDescription}
doesUseSecretIds: ${connectionDoesUseSecretIds}
endpoint: ${connectionEndpoint}
fingerprint: ${connectionFingerprint}
freeformTags:
bar-key: value
host: ${connectionHost}
jndiConnectionFactory: ${connectionJndiConnectionFactory}
jndiInitialContextFactory: ${connectionJndiInitialContextFactory}
jndiProviderUrl: ${connectionJndiProviderUrl}
jndiSecurityCredentials: ${connectionJndiSecurityCredentials}
jndiSecurityCredentialsSecretId: ${testSecret.id}
jndiSecurityPrincipal: ${connectionJndiSecurityPrincipal}
keyId: ${testKey.id}
keyStore: ${connectionKeyStore}
keyStorePassword: ${connectionKeyStorePassword}
keyStoreSecretId: ${testSecret.id}
keyStorePasswordSecretId: ${testSecret.id}
locks:
- type: ${connectionLocksType}
message: ${connectionLocksMessage}
nsgIds: ${connectionNsgIds}
password: ${connectionPassword}
passwordSecretId: ${testSecret.id}
port: ${connectionPort}
privateIp: ${connectionPrivateIp}
privateKeyFile: ${connectionPrivateKeyFile}
privateKeyFileSecretId: ${testSecret.id}
privateKeyPassphrase: ${connectionPrivateKeyPassphrase}
privateKeyPassphraseSecretId: ${testSecret.id}
producerProperties: ${connectionProducerProperties}
publicKeyFingerprint: ${connectionPublicKeyFingerprint}
redisClusterId: ${testRedisCluster.id}
region: ${connectionRegion}
routingMethod: ${connectionRoutingMethod}
sasToken: ${connectionSasToken}
sasTokenSecretId: ${testSecret.id}
secretAccessKey: ${connectionSecretAccessKey}
secretAccessKeySecretId: ${testSecret.id}
securityProtocol: ${connectionSecurityProtocol}
servers: ${connectionServers}
serviceAccountKeyFile: ${connectionServiceAccountKeyFile}
serviceAccountKeyFileSecretId: ${testSecret.id}
sessionMode: ${connectionSessionMode}
shouldUseJndi: ${connectionShouldUseJndi}
shouldUseResourcePrincipal: ${connectionShouldUseResourcePrincipal}
shouldValidateServerCertificate: ${connectionShouldValidateServerCertificate}
sslCa: ${connectionSslCa}
sslCert: ${connectionSslCert}
sslClientKeystash: ${connectionSslClientKeystash}
sslClientKeystashSecretId: ${testSecret.id}
sslClientKeystoredb: ${connectionSslClientKeystoredb}
sslClientKeystoredbSecretId: ${testSecret.id}
sslCrl: ${connectionSslCrl}
sslKey: ${connectionSslKey}
sslKeyPassword: ${connectionSslKeyPassword}
sslKeyPasswordSecretId: ${testSecret.id}
sslKeySecretId: ${testSecret.id}
sslMode: ${connectionSslMode}
sslServerCertificate: ${connectionSslServerCertificate}
storageCredentialName: ${connectionStorageCredentialName}
streamPoolId: ${testStreamPool.id}
subnetId: ${testSubnet.id}
tenancyId: ${testTenancy.id}
tenantId: ${testTenant.id}
tlsCaFile: ${connectionTlsCaFile}
tlsCertificateKeyFile: ${connectionTlsCertificateKeyFile}
tlsCertificateKeyFilePassword: ${connectionTlsCertificateKeyFilePassword}
tlsCertificateKeyFilePasswordSecretId: ${testSecret.id}
tlsCertificateKeyFileSecretId: ${testSecret.id}
trustStore: ${connectionTrustStore}
trustStorePassword: ${connectionTrustStorePassword}
trustStorePasswordSecretId: ${testSecret.id}
trustStoreSecretId: ${testSecret.id}
url: ${connectionUrl}
userId: ${testUser.id}
username: ${connectionUsername}
vaultId: ${testVault.id}
wallet: ${connectionWallet}
walletSecretId: ${testSecret.id}
triggerRefresh: true
Create Connection Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Connection(name: string, args: ConnectionArgs, opts?: CustomResourceOptions);@overload
def Connection(resource_name: str,
args: ConnectionArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Connection(resource_name: str,
opts: Optional[ResourceOptions] = None,
compartment_id: Optional[str] = None,
connection_type: Optional[str] = None,
display_name: Optional[str] = None,
technology_type: Optional[str] = None,
access_key_id: Optional[str] = None,
account_key: Optional[str] = None,
account_key_secret_id: Optional[str] = None,
account_name: Optional[str] = None,
additional_attributes: Optional[Sequence[ConnectionAdditionalAttributeArgs]] = None,
authentication_mode: Optional[str] = None,
authentication_type: Optional[str] = None,
azure_tenant_id: Optional[str] = None,
bootstrap_servers: Optional[Sequence[ConnectionBootstrapServerArgs]] = None,
client_id: Optional[str] = None,
client_secret: Optional[str] = None,
client_secret_secret_id: Optional[str] = None,
connection_factory: Optional[str] = None,
connection_string: Optional[str] = None,
connection_url: Optional[str] = None,
consumer_properties: Optional[str] = None,
core_site_xml: Optional[str] = None,
database_id: Optional[str] = None,
database_name: Optional[str] = None,
db_system_id: Optional[str] = None,
defined_tags: Optional[Mapping[str, str]] = None,
deployment_id: Optional[str] = None,
description: Optional[str] = None,
does_use_secret_ids: Optional[bool] = None,
endpoint: Optional[str] = None,
fingerprint: Optional[str] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
host: Optional[str] = None,
is_lock_override: Optional[bool] = None,
jndi_connection_factory: Optional[str] = None,
jndi_initial_context_factory: Optional[str] = None,
jndi_provider_url: Optional[str] = None,
jndi_security_credentials: Optional[str] = None,
jndi_security_credentials_secret_id: Optional[str] = None,
jndi_security_principal: Optional[str] = None,
key_id: Optional[str] = None,
key_store: Optional[str] = None,
key_store_password: Optional[str] = None,
key_store_password_secret_id: Optional[str] = None,
key_store_secret_id: Optional[str] = None,
locks: Optional[Sequence[ConnectionLockArgs]] = None,
nsg_ids: Optional[Sequence[str]] = None,
password: Optional[str] = None,
password_secret_id: Optional[str] = None,
port: Optional[int] = None,
private_ip: Optional[str] = None,
private_key_file: Optional[str] = None,
private_key_file_secret_id: Optional[str] = None,
private_key_passphrase: Optional[str] = None,
private_key_passphrase_secret_id: Optional[str] = None,
producer_properties: Optional[str] = None,
public_key_fingerprint: Optional[str] = None,
redis_cluster_id: Optional[str] = None,
region: Optional[str] = None,
routing_method: Optional[str] = None,
sas_token: Optional[str] = None,
sas_token_secret_id: Optional[str] = None,
secret_access_key: Optional[str] = None,
secret_access_key_secret_id: Optional[str] = None,
security_protocol: Optional[str] = None,
servers: Optional[str] = None,
service_account_key_file: Optional[str] = None,
service_account_key_file_secret_id: Optional[str] = None,
session_mode: Optional[str] = None,
should_use_jndi: Optional[bool] = None,
should_use_resource_principal: Optional[bool] = None,
should_validate_server_certificate: Optional[bool] = None,
ssl_ca: Optional[str] = None,
ssl_cert: Optional[str] = None,
ssl_client_keystash: Optional[str] = None,
ssl_client_keystash_secret_id: Optional[str] = None,
ssl_client_keystoredb: Optional[str] = None,
ssl_client_keystoredb_secret_id: Optional[str] = None,
ssl_crl: Optional[str] = None,
ssl_key: Optional[str] = None,
ssl_key_password: Optional[str] = None,
ssl_key_password_secret_id: Optional[str] = None,
ssl_key_secret_id: Optional[str] = None,
ssl_mode: Optional[str] = None,
ssl_server_certificate: Optional[str] = None,
storage_credential_name: Optional[str] = None,
stream_pool_id: Optional[str] = None,
subnet_id: Optional[str] = None,
tenancy_id: Optional[str] = None,
tenant_id: Optional[str] = None,
tls_ca_file: Optional[str] = None,
tls_certificate_key_file: Optional[str] = None,
tls_certificate_key_file_password: Optional[str] = None,
tls_certificate_key_file_password_secret_id: Optional[str] = None,
tls_certificate_key_file_secret_id: Optional[str] = None,
trigger_refresh: Optional[bool] = None,
trust_store: Optional[str] = None,
trust_store_password: Optional[str] = None,
trust_store_password_secret_id: Optional[str] = None,
trust_store_secret_id: Optional[str] = None,
url: Optional[str] = None,
user_id: Optional[str] = None,
username: Optional[str] = None,
vault_id: Optional[str] = None,
wallet: Optional[str] = None,
wallet_secret_id: Optional[str] = None)func NewConnection(ctx *Context, name string, args ConnectionArgs, opts ...ResourceOption) (*Connection, error)public Connection(string name, ConnectionArgs args, CustomResourceOptions? opts = null)
public Connection(String name, ConnectionArgs args)
public Connection(String name, ConnectionArgs args, CustomResourceOptions options)
type: oci:GoldenGate:Connection
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ConnectionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ConnectionArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ConnectionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ConnectionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ConnectionArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var exampleconnectionResourceResourceFromGoldenGateconnection = new Oci.GoldenGate.Connection("exampleconnectionResourceResourceFromGoldenGateconnection", new()
{
CompartmentId = "string",
ConnectionType = "string",
DisplayName = "string",
TechnologyType = "string",
AccessKeyId = "string",
AccountKey = "string",
AccountKeySecretId = "string",
AccountName = "string",
AdditionalAttributes = new[]
{
new Oci.GoldenGate.Inputs.ConnectionAdditionalAttributeArgs
{
Name = "string",
Value = "string",
},
},
AuthenticationMode = "string",
AuthenticationType = "string",
AzureTenantId = "string",
BootstrapServers = new[]
{
new Oci.GoldenGate.Inputs.ConnectionBootstrapServerArgs
{
Host = "string",
Port = 0,
PrivateIp = "string",
},
},
ClientId = "string",
ClientSecret = "string",
ClientSecretSecretId = "string",
ConnectionFactory = "string",
ConnectionString = "string",
ConnectionUrl = "string",
ConsumerProperties = "string",
CoreSiteXml = "string",
DatabaseId = "string",
DatabaseName = "string",
DbSystemId = "string",
DefinedTags =
{
{ "string", "string" },
},
DeploymentId = "string",
Description = "string",
DoesUseSecretIds = false,
Endpoint = "string",
Fingerprint = "string",
FreeformTags =
{
{ "string", "string" },
},
Host = "string",
IsLockOverride = false,
JndiConnectionFactory = "string",
JndiInitialContextFactory = "string",
JndiProviderUrl = "string",
JndiSecurityCredentials = "string",
JndiSecurityCredentialsSecretId = "string",
JndiSecurityPrincipal = "string",
KeyId = "string",
KeyStore = "string",
KeyStorePassword = "string",
KeyStorePasswordSecretId = "string",
KeyStoreSecretId = "string",
Locks = new[]
{
new Oci.GoldenGate.Inputs.ConnectionLockArgs
{
Type = "string",
Message = "string",
RelatedResourceId = "string",
TimeCreated = "string",
},
},
NsgIds = new[]
{
"string",
},
Password = "string",
PasswordSecretId = "string",
Port = 0,
PrivateIp = "string",
PrivateKeyFile = "string",
PrivateKeyFileSecretId = "string",
PrivateKeyPassphrase = "string",
PrivateKeyPassphraseSecretId = "string",
ProducerProperties = "string",
PublicKeyFingerprint = "string",
RedisClusterId = "string",
Region = "string",
RoutingMethod = "string",
SasToken = "string",
SasTokenSecretId = "string",
SecretAccessKey = "string",
SecretAccessKeySecretId = "string",
SecurityProtocol = "string",
Servers = "string",
ServiceAccountKeyFile = "string",
ServiceAccountKeyFileSecretId = "string",
SessionMode = "string",
ShouldUseJndi = false,
ShouldUseResourcePrincipal = false,
ShouldValidateServerCertificate = false,
SslCa = "string",
SslCert = "string",
SslClientKeystash = "string",
SslClientKeystashSecretId = "string",
SslClientKeystoredb = "string",
SslClientKeystoredbSecretId = "string",
SslCrl = "string",
SslKey = "string",
SslKeyPassword = "string",
SslKeyPasswordSecretId = "string",
SslKeySecretId = "string",
SslMode = "string",
SslServerCertificate = "string",
StorageCredentialName = "string",
StreamPoolId = "string",
SubnetId = "string",
TenancyId = "string",
TenantId = "string",
TlsCaFile = "string",
TlsCertificateKeyFile = "string",
TlsCertificateKeyFilePassword = "string",
TlsCertificateKeyFilePasswordSecretId = "string",
TlsCertificateKeyFileSecretId = "string",
TriggerRefresh = false,
TrustStore = "string",
TrustStorePassword = "string",
TrustStorePasswordSecretId = "string",
TrustStoreSecretId = "string",
Url = "string",
UserId = "string",
Username = "string",
VaultId = "string",
Wallet = "string",
WalletSecretId = "string",
});
example, err := goldengate.NewConnection(ctx, "exampleconnectionResourceResourceFromGoldenGateconnection", &goldengate.ConnectionArgs{
CompartmentId: pulumi.String("string"),
ConnectionType: pulumi.String("string"),
DisplayName: pulumi.String("string"),
TechnologyType: pulumi.String("string"),
AccessKeyId: pulumi.String("string"),
AccountKey: pulumi.String("string"),
AccountKeySecretId: pulumi.String("string"),
AccountName: pulumi.String("string"),
AdditionalAttributes: goldengate.ConnectionAdditionalAttributeArray{
&goldengate.ConnectionAdditionalAttributeArgs{
Name: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
AuthenticationMode: pulumi.String("string"),
AuthenticationType: pulumi.String("string"),
AzureTenantId: pulumi.String("string"),
BootstrapServers: goldengate.ConnectionBootstrapServerArray{
&goldengate.ConnectionBootstrapServerArgs{
Host: pulumi.String("string"),
Port: pulumi.Int(0),
PrivateIp: pulumi.String("string"),
},
},
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
ClientSecretSecretId: pulumi.String("string"),
ConnectionFactory: pulumi.String("string"),
ConnectionString: pulumi.String("string"),
ConnectionUrl: pulumi.String("string"),
ConsumerProperties: pulumi.String("string"),
CoreSiteXml: pulumi.String("string"),
DatabaseId: pulumi.String("string"),
DatabaseName: pulumi.String("string"),
DbSystemId: pulumi.String("string"),
DefinedTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
DeploymentId: pulumi.String("string"),
Description: pulumi.String("string"),
DoesUseSecretIds: pulumi.Bool(false),
Endpoint: pulumi.String("string"),
Fingerprint: pulumi.String("string"),
FreeformTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
Host: pulumi.String("string"),
IsLockOverride: pulumi.Bool(false),
JndiConnectionFactory: pulumi.String("string"),
JndiInitialContextFactory: pulumi.String("string"),
JndiProviderUrl: pulumi.String("string"),
JndiSecurityCredentials: pulumi.String("string"),
JndiSecurityCredentialsSecretId: pulumi.String("string"),
JndiSecurityPrincipal: pulumi.String("string"),
KeyId: pulumi.String("string"),
KeyStore: pulumi.String("string"),
KeyStorePassword: pulumi.String("string"),
KeyStorePasswordSecretId: pulumi.String("string"),
KeyStoreSecretId: pulumi.String("string"),
Locks: goldengate.ConnectionLockArray{
&goldengate.ConnectionLockArgs{
Type: pulumi.String("string"),
Message: pulumi.String("string"),
RelatedResourceId: pulumi.String("string"),
TimeCreated: pulumi.String("string"),
},
},
NsgIds: pulumi.StringArray{
pulumi.String("string"),
},
Password: pulumi.String("string"),
PasswordSecretId: pulumi.String("string"),
Port: pulumi.Int(0),
PrivateIp: pulumi.String("string"),
PrivateKeyFile: pulumi.String("string"),
PrivateKeyFileSecretId: pulumi.String("string"),
PrivateKeyPassphrase: pulumi.String("string"),
PrivateKeyPassphraseSecretId: pulumi.String("string"),
ProducerProperties: pulumi.String("string"),
PublicKeyFingerprint: pulumi.String("string"),
RedisClusterId: pulumi.String("string"),
Region: pulumi.String("string"),
RoutingMethod: pulumi.String("string"),
SasToken: pulumi.String("string"),
SasTokenSecretId: pulumi.String("string"),
SecretAccessKey: pulumi.String("string"),
SecretAccessKeySecretId: pulumi.String("string"),
SecurityProtocol: pulumi.String("string"),
Servers: pulumi.String("string"),
ServiceAccountKeyFile: pulumi.String("string"),
ServiceAccountKeyFileSecretId: pulumi.String("string"),
SessionMode: pulumi.String("string"),
ShouldUseJndi: pulumi.Bool(false),
ShouldUseResourcePrincipal: pulumi.Bool(false),
ShouldValidateServerCertificate: pulumi.Bool(false),
SslCa: pulumi.String("string"),
SslCert: pulumi.String("string"),
SslClientKeystash: pulumi.String("string"),
SslClientKeystashSecretId: pulumi.String("string"),
SslClientKeystoredb: pulumi.String("string"),
SslClientKeystoredbSecretId: pulumi.String("string"),
SslCrl: pulumi.String("string"),
SslKey: pulumi.String("string"),
SslKeyPassword: pulumi.String("string"),
SslKeyPasswordSecretId: pulumi.String("string"),
SslKeySecretId: pulumi.String("string"),
SslMode: pulumi.String("string"),
SslServerCertificate: pulumi.String("string"),
StorageCredentialName: pulumi.String("string"),
StreamPoolId: pulumi.String("string"),
SubnetId: pulumi.String("string"),
TenancyId: pulumi.String("string"),
TenantId: pulumi.String("string"),
TlsCaFile: pulumi.String("string"),
TlsCertificateKeyFile: pulumi.String("string"),
TlsCertificateKeyFilePassword: pulumi.String("string"),
TlsCertificateKeyFilePasswordSecretId: pulumi.String("string"),
TlsCertificateKeyFileSecretId: pulumi.String("string"),
TriggerRefresh: pulumi.Bool(false),
TrustStore: pulumi.String("string"),
TrustStorePassword: pulumi.String("string"),
TrustStorePasswordSecretId: pulumi.String("string"),
TrustStoreSecretId: pulumi.String("string"),
Url: pulumi.String("string"),
UserId: pulumi.String("string"),
Username: pulumi.String("string"),
VaultId: pulumi.String("string"),
Wallet: pulumi.String("string"),
WalletSecretId: pulumi.String("string"),
})
var exampleconnectionResourceResourceFromGoldenGateconnection = new com.pulumi.oci.GoldenGate.Connection("exampleconnectionResourceResourceFromGoldenGateconnection", com.pulumi.oci.GoldenGate.ConnectionArgs.builder()
.compartmentId("string")
.connectionType("string")
.displayName("string")
.technologyType("string")
.accessKeyId("string")
.accountKey("string")
.accountKeySecretId("string")
.accountName("string")
.additionalAttributes(ConnectionAdditionalAttributeArgs.builder()
.name("string")
.value("string")
.build())
.authenticationMode("string")
.authenticationType("string")
.azureTenantId("string")
.bootstrapServers(ConnectionBootstrapServerArgs.builder()
.host("string")
.port(0)
.privateIp("string")
.build())
.clientId("string")
.clientSecret("string")
.clientSecretSecretId("string")
.connectionFactory("string")
.connectionString("string")
.connectionUrl("string")
.consumerProperties("string")
.coreSiteXml("string")
.databaseId("string")
.databaseName("string")
.dbSystemId("string")
.definedTags(Map.of("string", "string"))
.deploymentId("string")
.description("string")
.doesUseSecretIds(false)
.endpoint("string")
.fingerprint("string")
.freeformTags(Map.of("string", "string"))
.host("string")
.isLockOverride(false)
.jndiConnectionFactory("string")
.jndiInitialContextFactory("string")
.jndiProviderUrl("string")
.jndiSecurityCredentials("string")
.jndiSecurityCredentialsSecretId("string")
.jndiSecurityPrincipal("string")
.keyId("string")
.keyStore("string")
.keyStorePassword("string")
.keyStorePasswordSecretId("string")
.keyStoreSecretId("string")
.locks(ConnectionLockArgs.builder()
.type("string")
.message("string")
.relatedResourceId("string")
.timeCreated("string")
.build())
.nsgIds("string")
.password("string")
.passwordSecretId("string")
.port(0)
.privateIp("string")
.privateKeyFile("string")
.privateKeyFileSecretId("string")
.privateKeyPassphrase("string")
.privateKeyPassphraseSecretId("string")
.producerProperties("string")
.publicKeyFingerprint("string")
.redisClusterId("string")
.region("string")
.routingMethod("string")
.sasToken("string")
.sasTokenSecretId("string")
.secretAccessKey("string")
.secretAccessKeySecretId("string")
.securityProtocol("string")
.servers("string")
.serviceAccountKeyFile("string")
.serviceAccountKeyFileSecretId("string")
.sessionMode("string")
.shouldUseJndi(false)
.shouldUseResourcePrincipal(false)
.shouldValidateServerCertificate(false)
.sslCa("string")
.sslCert("string")
.sslClientKeystash("string")
.sslClientKeystashSecretId("string")
.sslClientKeystoredb("string")
.sslClientKeystoredbSecretId("string")
.sslCrl("string")
.sslKey("string")
.sslKeyPassword("string")
.sslKeyPasswordSecretId("string")
.sslKeySecretId("string")
.sslMode("string")
.sslServerCertificate("string")
.storageCredentialName("string")
.streamPoolId("string")
.subnetId("string")
.tenancyId("string")
.tenantId("string")
.tlsCaFile("string")
.tlsCertificateKeyFile("string")
.tlsCertificateKeyFilePassword("string")
.tlsCertificateKeyFilePasswordSecretId("string")
.tlsCertificateKeyFileSecretId("string")
.triggerRefresh(false)
.trustStore("string")
.trustStorePassword("string")
.trustStorePasswordSecretId("string")
.trustStoreSecretId("string")
.url("string")
.userId("string")
.username("string")
.vaultId("string")
.wallet("string")
.walletSecretId("string")
.build());
exampleconnection_resource_resource_from_golden_gateconnection = oci.golden_gate.Connection("exampleconnectionResourceResourceFromGoldenGateconnection",
compartment_id="string",
connection_type="string",
display_name="string",
technology_type="string",
access_key_id="string",
account_key="string",
account_key_secret_id="string",
account_name="string",
additional_attributes=[{
"name": "string",
"value": "string",
}],
authentication_mode="string",
authentication_type="string",
azure_tenant_id="string",
bootstrap_servers=[{
"host": "string",
"port": 0,
"private_ip": "string",
}],
client_id="string",
client_secret="string",
client_secret_secret_id="string",
connection_factory="string",
connection_string="string",
connection_url="string",
consumer_properties="string",
core_site_xml="string",
database_id="string",
database_name="string",
db_system_id="string",
defined_tags={
"string": "string",
},
deployment_id="string",
description="string",
does_use_secret_ids=False,
endpoint="string",
fingerprint="string",
freeform_tags={
"string": "string",
},
host="string",
is_lock_override=False,
jndi_connection_factory="string",
jndi_initial_context_factory="string",
jndi_provider_url="string",
jndi_security_credentials="string",
jndi_security_credentials_secret_id="string",
jndi_security_principal="string",
key_id="string",
key_store="string",
key_store_password="string",
key_store_password_secret_id="string",
key_store_secret_id="string",
locks=[{
"type": "string",
"message": "string",
"related_resource_id": "string",
"time_created": "string",
}],
nsg_ids=["string"],
password="string",
password_secret_id="string",
port=0,
private_ip="string",
private_key_file="string",
private_key_file_secret_id="string",
private_key_passphrase="string",
private_key_passphrase_secret_id="string",
producer_properties="string",
public_key_fingerprint="string",
redis_cluster_id="string",
region="string",
routing_method="string",
sas_token="string",
sas_token_secret_id="string",
secret_access_key="string",
secret_access_key_secret_id="string",
security_protocol="string",
servers="string",
service_account_key_file="string",
service_account_key_file_secret_id="string",
session_mode="string",
should_use_jndi=False,
should_use_resource_principal=False,
should_validate_server_certificate=False,
ssl_ca="string",
ssl_cert="string",
ssl_client_keystash="string",
ssl_client_keystash_secret_id="string",
ssl_client_keystoredb="string",
ssl_client_keystoredb_secret_id="string",
ssl_crl="string",
ssl_key="string",
ssl_key_password="string",
ssl_key_password_secret_id="string",
ssl_key_secret_id="string",
ssl_mode="string",
ssl_server_certificate="string",
storage_credential_name="string",
stream_pool_id="string",
subnet_id="string",
tenancy_id="string",
tenant_id="string",
tls_ca_file="string",
tls_certificate_key_file="string",
tls_certificate_key_file_password="string",
tls_certificate_key_file_password_secret_id="string",
tls_certificate_key_file_secret_id="string",
trigger_refresh=False,
trust_store="string",
trust_store_password="string",
trust_store_password_secret_id="string",
trust_store_secret_id="string",
url="string",
user_id="string",
username="string",
vault_id="string",
wallet="string",
wallet_secret_id="string")
const exampleconnectionResourceResourceFromGoldenGateconnection = new oci.goldengate.Connection("exampleconnectionResourceResourceFromGoldenGateconnection", {
compartmentId: "string",
connectionType: "string",
displayName: "string",
technologyType: "string",
accessKeyId: "string",
accountKey: "string",
accountKeySecretId: "string",
accountName: "string",
additionalAttributes: [{
name: "string",
value: "string",
}],
authenticationMode: "string",
authenticationType: "string",
azureTenantId: "string",
bootstrapServers: [{
host: "string",
port: 0,
privateIp: "string",
}],
clientId: "string",
clientSecret: "string",
clientSecretSecretId: "string",
connectionFactory: "string",
connectionString: "string",
connectionUrl: "string",
consumerProperties: "string",
coreSiteXml: "string",
databaseId: "string",
databaseName: "string",
dbSystemId: "string",
definedTags: {
string: "string",
},
deploymentId: "string",
description: "string",
doesUseSecretIds: false,
endpoint: "string",
fingerprint: "string",
freeformTags: {
string: "string",
},
host: "string",
isLockOverride: false,
jndiConnectionFactory: "string",
jndiInitialContextFactory: "string",
jndiProviderUrl: "string",
jndiSecurityCredentials: "string",
jndiSecurityCredentialsSecretId: "string",
jndiSecurityPrincipal: "string",
keyId: "string",
keyStore: "string",
keyStorePassword: "string",
keyStorePasswordSecretId: "string",
keyStoreSecretId: "string",
locks: [{
type: "string",
message: "string",
relatedResourceId: "string",
timeCreated: "string",
}],
nsgIds: ["string"],
password: "string",
passwordSecretId: "string",
port: 0,
privateIp: "string",
privateKeyFile: "string",
privateKeyFileSecretId: "string",
privateKeyPassphrase: "string",
privateKeyPassphraseSecretId: "string",
producerProperties: "string",
publicKeyFingerprint: "string",
redisClusterId: "string",
region: "string",
routingMethod: "string",
sasToken: "string",
sasTokenSecretId: "string",
secretAccessKey: "string",
secretAccessKeySecretId: "string",
securityProtocol: "string",
servers: "string",
serviceAccountKeyFile: "string",
serviceAccountKeyFileSecretId: "string",
sessionMode: "string",
shouldUseJndi: false,
shouldUseResourcePrincipal: false,
shouldValidateServerCertificate: false,
sslCa: "string",
sslCert: "string",
sslClientKeystash: "string",
sslClientKeystashSecretId: "string",
sslClientKeystoredb: "string",
sslClientKeystoredbSecretId: "string",
sslCrl: "string",
sslKey: "string",
sslKeyPassword: "string",
sslKeyPasswordSecretId: "string",
sslKeySecretId: "string",
sslMode: "string",
sslServerCertificate: "string",
storageCredentialName: "string",
streamPoolId: "string",
subnetId: "string",
tenancyId: "string",
tenantId: "string",
tlsCaFile: "string",
tlsCertificateKeyFile: "string",
tlsCertificateKeyFilePassword: "string",
tlsCertificateKeyFilePasswordSecretId: "string",
tlsCertificateKeyFileSecretId: "string",
triggerRefresh: false,
trustStore: "string",
trustStorePassword: "string",
trustStorePasswordSecretId: "string",
trustStoreSecretId: "string",
url: "string",
userId: "string",
username: "string",
vaultId: "string",
wallet: "string",
walletSecretId: "string",
});
type: oci:GoldenGate:Connection
properties:
accessKeyId: string
accountKey: string
accountKeySecretId: string
accountName: string
additionalAttributes:
- name: string
value: string
authenticationMode: string
authenticationType: string
azureTenantId: string
bootstrapServers:
- host: string
port: 0
privateIp: string
clientId: string
clientSecret: string
clientSecretSecretId: string
compartmentId: string
connectionFactory: string
connectionString: string
connectionType: string
connectionUrl: string
consumerProperties: string
coreSiteXml: string
databaseId: string
databaseName: string
dbSystemId: string
definedTags:
string: string
deploymentId: string
description: string
displayName: string
doesUseSecretIds: false
endpoint: string
fingerprint: string
freeformTags:
string: string
host: string
isLockOverride: false
jndiConnectionFactory: string
jndiInitialContextFactory: string
jndiProviderUrl: string
jndiSecurityCredentials: string
jndiSecurityCredentialsSecretId: string
jndiSecurityPrincipal: string
keyId: string
keyStore: string
keyStorePassword: string
keyStorePasswordSecretId: string
keyStoreSecretId: string
locks:
- message: string
relatedResourceId: string
timeCreated: string
type: string
nsgIds:
- string
password: string
passwordSecretId: string
port: 0
privateIp: string
privateKeyFile: string
privateKeyFileSecretId: string
privateKeyPassphrase: string
privateKeyPassphraseSecretId: string
producerProperties: string
publicKeyFingerprint: string
redisClusterId: string
region: string
routingMethod: string
sasToken: string
sasTokenSecretId: string
secretAccessKey: string
secretAccessKeySecretId: string
securityProtocol: string
servers: string
serviceAccountKeyFile: string
serviceAccountKeyFileSecretId: string
sessionMode: string
shouldUseJndi: false
shouldUseResourcePrincipal: false
shouldValidateServerCertificate: false
sslCa: string
sslCert: string
sslClientKeystash: string
sslClientKeystashSecretId: string
sslClientKeystoredb: string
sslClientKeystoredbSecretId: string
sslCrl: string
sslKey: string
sslKeyPassword: string
sslKeyPasswordSecretId: string
sslKeySecretId: string
sslMode: string
sslServerCertificate: string
storageCredentialName: string
streamPoolId: string
subnetId: string
technologyType: string
tenancyId: string
tenantId: string
tlsCaFile: string
tlsCertificateKeyFile: string
tlsCertificateKeyFilePassword: string
tlsCertificateKeyFilePasswordSecretId: string
tlsCertificateKeyFileSecretId: string
triggerRefresh: false
trustStore: string
trustStorePassword: string
trustStorePasswordSecretId: string
trustStoreSecretId: string
url: string
userId: string
username: string
vaultId: string
wallet: string
walletSecretId: string
Connection Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Connection resource accepts the following input properties:
- Compartment
Id string - (Updatable) The OCID of the compartment being referenced.
- Connection
Type string - (Updatable) The connection type.
- Display
Name string - (Updatable) An object's Display Name.
- Technology
Type string - The Kafka (e.g. Confluent) Schema Registry technology type.
- Access
Key stringId - (Updatable) Access key ID to access the Amazon S3 bucket. e.g.: "this-is-not-the-secret"
- Account
Key string - (Updatable) Azure storage account key. This property is required when 'authenticationType' is set to 'SHARED_KEY'. e.g.: pa3WbhVATzj56xD4DH1VjOUhApRGEGHvOo58eQJVWIzX+j8j4CUVFcTjpIqDSRaSa1Wo2LbWY5at+AStEgLOIQ== Deprecated: This field is deprecated and replaced by "accountKeySecretId". This field will be removed after February 15 2026.
- Account
Key stringSecret Id - (Updatable) The OCID of the Secret where the account key is stored. Note: When provided, 'accountKey' field must not be provided.
- Account
Name string - (Updatable) Sets the Azure storage account name.
- Additional
Attributes List<ConnectionAdditional Attribute> - (Updatable) An array of name-value pair attribute entries. Used as additional parameters in connection string.
- Authentication
Mode string - (Updatable) Authentication mode. It can be provided at creation of Oracle Autonomous Database Serverless connections, when a databaseId is provided. The default value is MTLS.
- Authentication
Type string - (Updatable) Authentication type for Java Message Service. If not provided, default is NONE. Optional until 2024-06-27, in the release after it will be made required.
- Azure
Tenant stringId - (Updatable) 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 List<ConnectionBootstrap Server> - (Updatable) 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 string - (Updatable) 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 string - (Updatable) Azure client secret (aka application password) for authentication. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: dO29Q~F5-VwnA.lZdd11xFF_t5NAXCaGwDl9NbT1 Deprecated: This field is deprecated and replaced by "clientSecretSecretId". This field will be removed after February 15 2026.
- Client
Secret stringSecret Id - (Updatable) The OCID of the Secret where the client secret is stored. Only applicable for authenticationType == OAUTH_M2M. Note: When provided, 'clientSecret' field must not be provided.
- Connection
Factory string - (Updatable) The of Java class implementing javax.jms.ConnectionFactory interface supplied by the Java Message Service provider. e.g.: 'com.stc.jmsjca.core.JConnectionFactoryXA'
- Connection
String string - (Updatable) Connection string. AZURE_SYNAPSE_ANALYTICS e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;', MONGODB e.g.: 'mongodb://mongodb0.example.com:27017/recordsrecords'.
- Connection
Url string - (Updatable) Connection URL. e.g.: 'jdbc:databricks://adb-33934.4.azuredatabricks.net:443/default;transportMode=http;ssl=1;httpPath=sql/protocolv1/o/3393########44/0##3-7-hlrb'
- Consumer
Properties string - (Updatable) The base64 encoded content of the consumer.properties file.
- Core
Site stringXml - (Updatable) The base64 encoded content of the Hadoop Distributed File System configuration file (core-site.xml).
- Database
Id string - (Updatable) The OCID of the Oracle Autonomous Json Database.
- Database
Name string - (Updatable) The name of the database.
- Db
System stringId - (Updatable) The OCID of the database system being referenced.
- Dictionary<string, string>
- (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - Deployment
Id string - (Updatable) The OCID of the deployment being referenced.
- Description string
- (Updatable) Metadata about this specific object.
- Does
Use boolSecret Ids - (Updatable) Indicates that sensitive attributes are provided via Secrets.
- Endpoint string
- (Updatable)Azure Storage service endpoint. e.g: https://test.blob.core.windows.net, Optional Microsoft Fabric service endpoint. Default value: https://onelake.dfs.fabric.microsoft.com
- Fingerprint string
- (Updatable) Fingerprint required by TLS security protocol. Eg.: '6152b2dfbff200f973c5074a5b91d06ab3b472c07c09a1ea57bb7fd406cdce9c'
- Dictionary<string, string>
- (Updatable) 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
- (Updatable) The name or address of a host. In case of Generic connection type host and port separated by colon. Example:
"server.example.com:1234"For multiple hosts, provide a comma separated list. Example:"server1.example.com:1000,server1.example.com:2000" - Is
Lock boolOverride - Jndi
Connection stringFactory - (Updatable) The Connection Factory can be looked up using this name. e.g.: 'ConnectionFactory'
- Jndi
Initial stringContext Factory - (Updatable) The implementation of javax.naming.spi.InitialContextFactory interface that the client uses to obtain initial naming context. e.g.: 'org.apache.activemq.jndi.ActiveMQInitialContextFactory'
- Jndi
Provider stringUrl - (Updatable) The URL that Java Message Service will use to contact the JNDI provider. e.g.: 'tcp://myjms.host.domain:61616?jms.prefetchPolicy.all=1000'
- Jndi
Security stringCredentials - (Updatable) The password associated to the principal. Deprecated: This field is deprecated and replaced by "jndiSecurityCredentialsSecretId". This field will be removed after February 15 2026.
- Jndi
Security stringCredentials Secret Id - (Updatable) The OCID of the Secret where the security credentials are stored associated to the principal. Note: When provided, 'jndiSecurityCredentials' field must not be provided.
- Jndi
Security stringPrincipal - (Updatable) Specifies the identity of the principal (user) to be authenticated. e.g.: 'admin2'
- Key
Id string - (Updatable) Refers to the customer's master key OCID. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
- Key
Store string - (Updatable) The base64 encoded content of the KeyStore file. Deprecated: This field is deprecated and replaced by "keyStoreSecretId". This field will be removed after February 15 2026.
- Key
Store stringPassword - (Updatable) The KeyStore password. Deprecated: This field is deprecated and replaced by "keyStorePasswordSecretId". This field will be removed after February 15 2026.
- Key
Store stringPassword Secret Id - (Updatable) The OCID of the Secret where the kafka Ssl KeyStore password is stored. Note: When provided, 'keyStorePassword' field must not be provided.
- Key
Store stringSecret Id - (Updatable) The OCID of the Secret where the content of the KeyStore file is stored. Note: When provided, 'keyStore' field must not be provided.
- Locks
List<Connection
Lock> - Locks associated with this resource.
- Nsg
Ids List<string> - (Updatable) An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
- Password string
- (Updatable) The password Oracle GoldenGate uses to connect the associated system of the given technology. It must conform to the specific security requirements including length, case sensitivity, and so on. Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
- Password
Secret stringId - (Updatable) The OCID of the Secret where the password is stored. The password Oracle GoldenGate uses to connect the associated system of the given technology. It must conform to the specific security requirements including length, case sensitivity, and so on. If secretId is used plaintext field must not be provided. Note: When provided, 'password' field must not be provided.
- Port int
- (Updatable) The port of an endpoint usually specified for a connection.
- Private
Ip string (Updatable) Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host field, or make sure the host name is resolvable in the target VCN.
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 stringFile - (Updatable) The base64 encoded content of the private key file (PEM file) corresponding to the API key of the fingerprint. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm Deprecated: This field is deprecated and replaced by "privateKeyFileSecretId". This field will be removed after February 15 2026.
- Private
Key stringFile Secret Id - (Updatable) The OCID of the Secret that stores the content of the private key file (PEM file) corresponding to the API key of the fingerprint. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm Note: When provided, 'privateKeyFile' field must not be provided.
- Private
Key stringPassphrase - (Updatable) Password if the private key file is encrypted. Deprecated: This field is deprecated and replaced by "privateKeyPassphraseSecretId". This field will be removed after February 15 2026.
- Private
Key stringPassphrase Secret Id - (Updatable) The OCID of the Secret that stores the password for the private key file. Note: When provided, 'privateKeyPassphrase' field must not be provided.
- Producer
Properties string - (Updatable) The base64 encoded content of the producer.properties file.
- Public
Key stringFingerprint - (Updatable) The fingerprint of the API Key of the user specified by the userId. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm
- Redis
Cluster stringId - (Updatable) The OCID of the Redis cluster.
- Region string
- (Updatable) The name of the region. e.g.: us-ashburn-1 If the region is not provided, backend will default to the default region.
- Routing
Method string - (Updatable) Controls the network traffic direction to the target: SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets. SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet. DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
- Sas
Token string - (Updatable) Credential that uses a shared access signature (SAS) to authenticate to an Azure Service. This property is required when 'authenticationType' is set to 'SHARED_ACCESS_SIGNATURE'. e.g.: ?sv=2020-06-08&ss=bfqt&srt=sco&sp=rwdlacupyx&se=2020-09-10T20:27:28Z&st=2022-08-05T12:27:28Z&spr=https&sig=C1IgHsiLBmTSStYkXXGLTP8it0xBrArcgCqOsZbXwIQ%3D Deprecated: This field is deprecated and replaced by "sasTokenSecretId". This field will be removed after February 15 2026.
- Sas
Token stringSecret Id - (Updatable) The OCID of the Secret where the sas token is stored. Note: When provided, 'sasToken' field must not be provided.
- Secret
Access stringKey - (Updatable) Secret access key to access the Amazon S3 bucket. e.g.: "this-is-not-the-secret" Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". This field will be removed after February 15 2026.
- Secret
Access stringKey Secret Id - (Updatable) The OCID of the Secret where the secret access key is stored. Note: When provided, 'secretAccessKey' field must not be provided.
- Security
Protocol string - (Updatable) Security protocol for Java Message Service. If not provided, default is PLAIN. Optional until 2024-06-27, in the release after it will be made required.
- Servers string
- (Updatable) Comma separated list of Elasticsearch server addresses, specified as host:port entries, where :port is optional. If port is not specified, it defaults to 9200. Used for establishing the initial connection to the Elasticsearch cluster. Example:
"server1.example.com:4000,server2.example.com:4000" - Service
Account stringKey File - (Updatable) The base64 encoded content of the service account key file containing the credentials required to use Google Cloud Storage. Deprecated: This field is deprecated and replaced by "serviceAccountKeyFileSecretId". This field will be removed after February 15 2026.
- Service
Account stringKey File Secret Id - (Updatable) The OCID of the Secret where the content of the service account key file is stored, which containing the credentials required to use Google Cloud Storage. Note: When provided, 'serviceAccountKeyFile' field must not be provided.
- Session
Mode string - (Updatable) 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.
- Should
Use boolJndi - (Updatable) If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.
- Should
Use boolResource Principal - (Updatable) Indicates that the user intents to connect to the instance through resource principal.
- Should
Validate boolServer Certificate - (Updatable) If set to true, the driver validates the certificate that is sent by the database server.
- Ssl
Ca string - (Updatable) The base64 encoded certificate of the trusted certificate authorities (Trusted CA) for PostgreSQL. The supported file formats are .pem and .crt.
- Ssl
Cert string - (Updatable) Client Certificate - The base64 encoded content of a .pem or .crt file. containing the client public key (for 2-way SSL).
- Ssl
Client stringKeystash - (Updatable) The base64 encoded keystash file which contains the encrypted password to the key database file. Deprecated: This field is deprecated and replaced by "sslClientKeystashSecretId". This field will be removed after February 15 2026.
- Ssl
Client stringKeystash Secret Id - (Updatable) The OCID of the Secret where the keystash file is stored, which contains the encrypted password to the key database file. Note: When provided, 'sslClientKeystash' field must not be provided.
- Ssl
Client stringKeystoredb - (Updatable) The base64 encoded keystore file created at the client containing the server certificate / CA root certificate. Deprecated: This field is deprecated and replaced by "sslClientKeystoredbSecretId". This field will be removed after February 15 2026.
- Ssl
Client stringKeystoredb Secret Id - (Updatable) The OCID of the Secret where the keystore file stored, which created at the client containing the server certificate / CA root certificate. Note: When provided, 'sslClientKeystoredb' field must not be provided.
- Ssl
Crl string - (Updatable) The base64 encoded list of certificates revoked by the trusted certificate authorities (Trusted CA). Note: This is an optional property and only applicable if TLS/MTLS option is selected.
- Ssl
Key string - (Updatable) Client Key - The base64 encoded content of a .pem or .crt file containing the client private key (for 2-way SSL). Deprecated: This field is deprecated and replaced by "sslKeySecretId". This field will be removed after February 15 2026.
- Ssl
Key stringPassword - (Updatable) The password for the cert inside of the KeyStore. In case it differs from the KeyStore password, it should be provided. Deprecated: This field is deprecated and replaced by "sslKeyPasswordSecretId". This field will be removed after February 15 2026.
- Ssl
Key stringPassword Secret Id - (Updatable) The OCID of the Secret where the password is stored for the cert inside of the Keystore. In case it differs from the KeyStore password, it should be provided. Note: When provided, 'sslKeyPassword' field must not be provided.
- Ssl
Key stringSecret Id - (Updatable) The OCID of the Secret that stores the Client Key
- The content of a .pem or .crt file containing the client private key (for 2-way SSL). Note: When provided, 'sslKey' field must not be provided.
- Ssl
Mode string - (Updatable) SSL modes for PostgreSQL.
- Ssl
Server stringCertificate - (Updatable) The base64 encoded file which contains the self-signed server certificate / Certificate Authority (CA) certificate.
- Storage
Credential stringName - (Updatable) Optional. External storage credential name to access files on object storage such as ADLS Gen2, S3 or GCS.
- Stream
Pool stringId - (Updatable) The OCID of the stream pool being referenced.
- Subnet
Id string - (Updatable) The OCID of the target subnet of the dedicated connection.
- Tenancy
Id string - (Updatable) The OCID of the related Oracle Cloud Infrastructure tenancy.
- Tenant
Id string - (Updatable) Azure tenant ID of the application. e.g.: 14593954-d337-4a61-a364-9f758c64f97f
- Tls
Ca stringFile - (Updatable) Database Certificate - The base64 encoded content of a .pem file, containing the server public key (for 1 and 2-way SSL).
- Tls
Certificate stringKey File - (Updatable) Client Certificate - The base64 encoded content of a .pem file, containing the client public key (for 2-way SSL). Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFileSecretId". This field will be removed after February 15 2026.
- Tls
Certificate stringKey File Password - (Updatable) Client Certificate key file password. Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFilePasswordSecretId". This field will be removed after February 15 2026.
- Tls
Certificate stringKey File Password Secret Id - (Updatable) The OCID of the Secret that stores the password of the tls certificate key file. Note: When provided, 'tlsCertificateKeyFilePassword' field must not be provided.
- Tls
Certificate stringKey File Secret Id - (Updatable) The OCID of the Secret that stores the certificate key file of the mtls connection.
- The content of a .pem file containing the client private key (for 2-way SSL). Note: When provided, 'tlsCertificateKeyFile' field must not be provided.
- Trigger
Refresh bool (Updatable) If value is true, it triggers connection refresh action and this attribute change will always show up in the "update" plan and will apply steps in order to refresh secrets and dependent service properties (such as ADB connection strings, wallets, etc..).
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Trust
Store string - (Updatable) The base64 encoded content of the TrustStore file. Deprecated: This field is deprecated and replaced by "trustStoreSecretId". This field will be removed after February 15 2026.
- Trust
Store stringPassword - (Updatable) The TrustStore password. Deprecated: This field is deprecated and replaced by "trustStorePasswordSecretId". This field will be removed after February 15 2026.
- Trust
Store stringPassword Secret Id - (Updatable) The OCID of the Secret where the kafka Ssl TrustStore password is stored. Note: When provided, 'trustStorePassword' field must not be provided.
- Trust
Store stringSecret Id - (Updatable) The OCID of the Secret where the content of the TrustStore file is stored. Note: When provided, 'trustStore' field must not be provided.
- Url string
- (Updatable) Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'
- User
Id string - (Updatable) The OCID of the Oracle Cloud Infrastructure user who will access the Oracle NoSQL database. The user must have write access to the table they want to connect to. If the user is not provided, backend will default to the user who is calling the API endpoint.
- Username string
- (Updatable) The username Oracle GoldenGate uses to connect the associated system of the given technology. This username must already exist and be available by the system/application to be connected to and must conform to the case sensitivty requirments defined in it.
- Vault
Id string - (Updatable) Refers to the customer's vault OCID. If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate to manage secrets contained within this vault.
- Wallet string
- (Updatable) The wallet contents Oracle GoldenGate uses to make connections to a database. This attribute is expected to be base64 encoded. Deprecated: This field is deprecated and replaced by "walletSecretId". This field will be removed after February 15 2026.
- Wallet
Secret stringId - (Updatable) The OCID of the Secret where the wallet file is stored. The wallet contents Oracle GoldenGate uses to make connections to a database. Note: When provided, 'wallet' field must not be provided.
- Compartment
Id string - (Updatable) The OCID of the compartment being referenced.
- Connection
Type string - (Updatable) The connection type.
- Display
Name string - (Updatable) An object's Display Name.
- Technology
Type string - The Kafka (e.g. Confluent) Schema Registry technology type.
- Access
Key stringId - (Updatable) Access key ID to access the Amazon S3 bucket. e.g.: "this-is-not-the-secret"
- Account
Key string - (Updatable) Azure storage account key. This property is required when 'authenticationType' is set to 'SHARED_KEY'. e.g.: pa3WbhVATzj56xD4DH1VjOUhApRGEGHvOo58eQJVWIzX+j8j4CUVFcTjpIqDSRaSa1Wo2LbWY5at+AStEgLOIQ== Deprecated: This field is deprecated and replaced by "accountKeySecretId". This field will be removed after February 15 2026.
- Account
Key stringSecret Id - (Updatable) The OCID of the Secret where the account key is stored. Note: When provided, 'accountKey' field must not be provided.
- Account
Name string - (Updatable) Sets the Azure storage account name.
- Additional
Attributes []ConnectionAdditional Attribute Args - (Updatable) An array of name-value pair attribute entries. Used as additional parameters in connection string.
- Authentication
Mode string - (Updatable) Authentication mode. It can be provided at creation of Oracle Autonomous Database Serverless connections, when a databaseId is provided. The default value is MTLS.
- Authentication
Type string - (Updatable) Authentication type for Java Message Service. If not provided, default is NONE. Optional until 2024-06-27, in the release after it will be made required.
- Azure
Tenant stringId - (Updatable) 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 []ConnectionBootstrap Server Args - (Updatable) 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 string - (Updatable) 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 string - (Updatable) Azure client secret (aka application password) for authentication. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: dO29Q~F5-VwnA.lZdd11xFF_t5NAXCaGwDl9NbT1 Deprecated: This field is deprecated and replaced by "clientSecretSecretId". This field will be removed after February 15 2026.
- Client
Secret stringSecret Id - (Updatable) The OCID of the Secret where the client secret is stored. Only applicable for authenticationType == OAUTH_M2M. Note: When provided, 'clientSecret' field must not be provided.
- Connection
Factory string - (Updatable) The of Java class implementing javax.jms.ConnectionFactory interface supplied by the Java Message Service provider. e.g.: 'com.stc.jmsjca.core.JConnectionFactoryXA'
- Connection
String string - (Updatable) Connection string. AZURE_SYNAPSE_ANALYTICS e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;', MONGODB e.g.: 'mongodb://mongodb0.example.com:27017/recordsrecords'.
- Connection
Url string - (Updatable) Connection URL. e.g.: 'jdbc:databricks://adb-33934.4.azuredatabricks.net:443/default;transportMode=http;ssl=1;httpPath=sql/protocolv1/o/3393########44/0##3-7-hlrb'
- Consumer
Properties string - (Updatable) The base64 encoded content of the consumer.properties file.
- Core
Site stringXml - (Updatable) The base64 encoded content of the Hadoop Distributed File System configuration file (core-site.xml).
- Database
Id string - (Updatable) The OCID of the Oracle Autonomous Json Database.
- Database
Name string - (Updatable) The name of the database.
- Db
System stringId - (Updatable) The OCID of the database system being referenced.
- map[string]string
- (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - Deployment
Id string - (Updatable) The OCID of the deployment being referenced.
- Description string
- (Updatable) Metadata about this specific object.
- Does
Use boolSecret Ids - (Updatable) Indicates that sensitive attributes are provided via Secrets.
- Endpoint string
- (Updatable)Azure Storage service endpoint. e.g: https://test.blob.core.windows.net, Optional Microsoft Fabric service endpoint. Default value: https://onelake.dfs.fabric.microsoft.com
- Fingerprint string
- (Updatable) Fingerprint required by TLS security protocol. Eg.: '6152b2dfbff200f973c5074a5b91d06ab3b472c07c09a1ea57bb7fd406cdce9c'
- map[string]string
- (Updatable) 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
- (Updatable) The name or address of a host. In case of Generic connection type host and port separated by colon. Example:
"server.example.com:1234"For multiple hosts, provide a comma separated list. Example:"server1.example.com:1000,server1.example.com:2000" - Is
Lock boolOverride - Jndi
Connection stringFactory - (Updatable) The Connection Factory can be looked up using this name. e.g.: 'ConnectionFactory'
- Jndi
Initial stringContext Factory - (Updatable) The implementation of javax.naming.spi.InitialContextFactory interface that the client uses to obtain initial naming context. e.g.: 'org.apache.activemq.jndi.ActiveMQInitialContextFactory'
- Jndi
Provider stringUrl - (Updatable) The URL that Java Message Service will use to contact the JNDI provider. e.g.: 'tcp://myjms.host.domain:61616?jms.prefetchPolicy.all=1000'
- Jndi
Security stringCredentials - (Updatable) The password associated to the principal. Deprecated: This field is deprecated and replaced by "jndiSecurityCredentialsSecretId". This field will be removed after February 15 2026.
- Jndi
Security stringCredentials Secret Id - (Updatable) The OCID of the Secret where the security credentials are stored associated to the principal. Note: When provided, 'jndiSecurityCredentials' field must not be provided.
- Jndi
Security stringPrincipal - (Updatable) Specifies the identity of the principal (user) to be authenticated. e.g.: 'admin2'
- Key
Id string - (Updatable) Refers to the customer's master key OCID. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
- Key
Store string - (Updatable) The base64 encoded content of the KeyStore file. Deprecated: This field is deprecated and replaced by "keyStoreSecretId". This field will be removed after February 15 2026.
- Key
Store stringPassword - (Updatable) The KeyStore password. Deprecated: This field is deprecated and replaced by "keyStorePasswordSecretId". This field will be removed after February 15 2026.
- Key
Store stringPassword Secret Id - (Updatable) The OCID of the Secret where the kafka Ssl KeyStore password is stored. Note: When provided, 'keyStorePassword' field must not be provided.
- Key
Store stringSecret Id - (Updatable) The OCID of the Secret where the content of the KeyStore file is stored. Note: When provided, 'keyStore' field must not be provided.
- Locks
[]Connection
Lock Args - Locks associated with this resource.
- Nsg
Ids []string - (Updatable) An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
- Password string
- (Updatable) The password Oracle GoldenGate uses to connect the associated system of the given technology. It must conform to the specific security requirements including length, case sensitivity, and so on. Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
- Password
Secret stringId - (Updatable) The OCID of the Secret where the password is stored. The password Oracle GoldenGate uses to connect the associated system of the given technology. It must conform to the specific security requirements including length, case sensitivity, and so on. If secretId is used plaintext field must not be provided. Note: When provided, 'password' field must not be provided.
- Port int
- (Updatable) The port of an endpoint usually specified for a connection.
- Private
Ip string (Updatable) Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host field, or make sure the host name is resolvable in the target VCN.
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 stringFile - (Updatable) The base64 encoded content of the private key file (PEM file) corresponding to the API key of the fingerprint. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm Deprecated: This field is deprecated and replaced by "privateKeyFileSecretId". This field will be removed after February 15 2026.
- Private
Key stringFile Secret Id - (Updatable) The OCID of the Secret that stores the content of the private key file (PEM file) corresponding to the API key of the fingerprint. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm Note: When provided, 'privateKeyFile' field must not be provided.
- Private
Key stringPassphrase - (Updatable) Password if the private key file is encrypted. Deprecated: This field is deprecated and replaced by "privateKeyPassphraseSecretId". This field will be removed after February 15 2026.
- Private
Key stringPassphrase Secret Id - (Updatable) The OCID of the Secret that stores the password for the private key file. Note: When provided, 'privateKeyPassphrase' field must not be provided.
- Producer
Properties string - (Updatable) The base64 encoded content of the producer.properties file.
- Public
Key stringFingerprint - (Updatable) The fingerprint of the API Key of the user specified by the userId. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm
- Redis
Cluster stringId - (Updatable) The OCID of the Redis cluster.
- Region string
- (Updatable) The name of the region. e.g.: us-ashburn-1 If the region is not provided, backend will default to the default region.
- Routing
Method string - (Updatable) Controls the network traffic direction to the target: SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets. SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet. DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
- Sas
Token string - (Updatable) Credential that uses a shared access signature (SAS) to authenticate to an Azure Service. This property is required when 'authenticationType' is set to 'SHARED_ACCESS_SIGNATURE'. e.g.: ?sv=2020-06-08&ss=bfqt&srt=sco&sp=rwdlacupyx&se=2020-09-10T20:27:28Z&st=2022-08-05T12:27:28Z&spr=https&sig=C1IgHsiLBmTSStYkXXGLTP8it0xBrArcgCqOsZbXwIQ%3D Deprecated: This field is deprecated and replaced by "sasTokenSecretId". This field will be removed after February 15 2026.
- Sas
Token stringSecret Id - (Updatable) The OCID of the Secret where the sas token is stored. Note: When provided, 'sasToken' field must not be provided.
- Secret
Access stringKey - (Updatable) Secret access key to access the Amazon S3 bucket. e.g.: "this-is-not-the-secret" Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". This field will be removed after February 15 2026.
- Secret
Access stringKey Secret Id - (Updatable) The OCID of the Secret where the secret access key is stored. Note: When provided, 'secretAccessKey' field must not be provided.
- Security
Protocol string - (Updatable) Security protocol for Java Message Service. If not provided, default is PLAIN. Optional until 2024-06-27, in the release after it will be made required.
- Servers string
- (Updatable) Comma separated list of Elasticsearch server addresses, specified as host:port entries, where :port is optional. If port is not specified, it defaults to 9200. Used for establishing the initial connection to the Elasticsearch cluster. Example:
"server1.example.com:4000,server2.example.com:4000" - Service
Account stringKey File - (Updatable) The base64 encoded content of the service account key file containing the credentials required to use Google Cloud Storage. Deprecated: This field is deprecated and replaced by "serviceAccountKeyFileSecretId". This field will be removed after February 15 2026.
- Service
Account stringKey File Secret Id - (Updatable) The OCID of the Secret where the content of the service account key file is stored, which containing the credentials required to use Google Cloud Storage. Note: When provided, 'serviceAccountKeyFile' field must not be provided.
- Session
Mode string - (Updatable) 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.
- Should
Use boolJndi - (Updatable) If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.
- Should
Use boolResource Principal - (Updatable) Indicates that the user intents to connect to the instance through resource principal.
- Should
Validate boolServer Certificate - (Updatable) If set to true, the driver validates the certificate that is sent by the database server.
- Ssl
Ca string - (Updatable) The base64 encoded certificate of the trusted certificate authorities (Trusted CA) for PostgreSQL. The supported file formats are .pem and .crt.
- Ssl
Cert string - (Updatable) Client Certificate - The base64 encoded content of a .pem or .crt file. containing the client public key (for 2-way SSL).
- Ssl
Client stringKeystash - (Updatable) The base64 encoded keystash file which contains the encrypted password to the key database file. Deprecated: This field is deprecated and replaced by "sslClientKeystashSecretId". This field will be removed after February 15 2026.
- Ssl
Client stringKeystash Secret Id - (Updatable) The OCID of the Secret where the keystash file is stored, which contains the encrypted password to the key database file. Note: When provided, 'sslClientKeystash' field must not be provided.
- Ssl
Client stringKeystoredb - (Updatable) The base64 encoded keystore file created at the client containing the server certificate / CA root certificate. Deprecated: This field is deprecated and replaced by "sslClientKeystoredbSecretId". This field will be removed after February 15 2026.
- Ssl
Client stringKeystoredb Secret Id - (Updatable) The OCID of the Secret where the keystore file stored, which created at the client containing the server certificate / CA root certificate. Note: When provided, 'sslClientKeystoredb' field must not be provided.
- Ssl
Crl string - (Updatable) The base64 encoded list of certificates revoked by the trusted certificate authorities (Trusted CA). Note: This is an optional property and only applicable if TLS/MTLS option is selected.
- Ssl
Key string - (Updatable) Client Key - The base64 encoded content of a .pem or .crt file containing the client private key (for 2-way SSL). Deprecated: This field is deprecated and replaced by "sslKeySecretId". This field will be removed after February 15 2026.
- Ssl
Key stringPassword - (Updatable) The password for the cert inside of the KeyStore. In case it differs from the KeyStore password, it should be provided. Deprecated: This field is deprecated and replaced by "sslKeyPasswordSecretId". This field will be removed after February 15 2026.
- Ssl
Key stringPassword Secret Id - (Updatable) The OCID of the Secret where the password is stored for the cert inside of the Keystore. In case it differs from the KeyStore password, it should be provided. Note: When provided, 'sslKeyPassword' field must not be provided.
- Ssl
Key stringSecret Id - (Updatable) The OCID of the Secret that stores the Client Key
- The content of a .pem or .crt file containing the client private key (for 2-way SSL). Note: When provided, 'sslKey' field must not be provided.
- Ssl
Mode string - (Updatable) SSL modes for PostgreSQL.
- Ssl
Server stringCertificate - (Updatable) The base64 encoded file which contains the self-signed server certificate / Certificate Authority (CA) certificate.
- Storage
Credential stringName - (Updatable) Optional. External storage credential name to access files on object storage such as ADLS Gen2, S3 or GCS.
- Stream
Pool stringId - (Updatable) The OCID of the stream pool being referenced.
- Subnet
Id string - (Updatable) The OCID of the target subnet of the dedicated connection.
- Tenancy
Id string - (Updatable) The OCID of the related Oracle Cloud Infrastructure tenancy.
- Tenant
Id string - (Updatable) Azure tenant ID of the application. e.g.: 14593954-d337-4a61-a364-9f758c64f97f
- Tls
Ca stringFile - (Updatable) Database Certificate - The base64 encoded content of a .pem file, containing the server public key (for 1 and 2-way SSL).
- Tls
Certificate stringKey File - (Updatable) Client Certificate - The base64 encoded content of a .pem file, containing the client public key (for 2-way SSL). Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFileSecretId". This field will be removed after February 15 2026.
- Tls
Certificate stringKey File Password - (Updatable) Client Certificate key file password. Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFilePasswordSecretId". This field will be removed after February 15 2026.
- Tls
Certificate stringKey File Password Secret Id - (Updatable) The OCID of the Secret that stores the password of the tls certificate key file. Note: When provided, 'tlsCertificateKeyFilePassword' field must not be provided.
- Tls
Certificate stringKey File Secret Id - (Updatable) The OCID of the Secret that stores the certificate key file of the mtls connection.
- The content of a .pem file containing the client private key (for 2-way SSL). Note: When provided, 'tlsCertificateKeyFile' field must not be provided.
- Trigger
Refresh bool (Updatable) If value is true, it triggers connection refresh action and this attribute change will always show up in the "update" plan and will apply steps in order to refresh secrets and dependent service properties (such as ADB connection strings, wallets, etc..).
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Trust
Store string - (Updatable) The base64 encoded content of the TrustStore file. Deprecated: This field is deprecated and replaced by "trustStoreSecretId". This field will be removed after February 15 2026.
- Trust
Store stringPassword - (Updatable) The TrustStore password. Deprecated: This field is deprecated and replaced by "trustStorePasswordSecretId". This field will be removed after February 15 2026.
- Trust
Store stringPassword Secret Id - (Updatable) The OCID of the Secret where the kafka Ssl TrustStore password is stored. Note: When provided, 'trustStorePassword' field must not be provided.
- Trust
Store stringSecret Id - (Updatable) The OCID of the Secret where the content of the TrustStore file is stored. Note: When provided, 'trustStore' field must not be provided.
- Url string
- (Updatable) Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'
- User
Id string - (Updatable) The OCID of the Oracle Cloud Infrastructure user who will access the Oracle NoSQL database. The user must have write access to the table they want to connect to. If the user is not provided, backend will default to the user who is calling the API endpoint.
- Username string
- (Updatable) The username Oracle GoldenGate uses to connect the associated system of the given technology. This username must already exist and be available by the system/application to be connected to and must conform to the case sensitivty requirments defined in it.
- Vault
Id string - (Updatable) Refers to the customer's vault OCID. If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate to manage secrets contained within this vault.
- Wallet string
- (Updatable) The wallet contents Oracle GoldenGate uses to make connections to a database. This attribute is expected to be base64 encoded. Deprecated: This field is deprecated and replaced by "walletSecretId". This field will be removed after February 15 2026.
- Wallet
Secret stringId - (Updatable) The OCID of the Secret where the wallet file is stored. The wallet contents Oracle GoldenGate uses to make connections to a database. Note: When provided, 'wallet' field must not be provided.
- compartment
Id String - (Updatable) The OCID of the compartment being referenced.
- connection
Type String - (Updatable) The connection type.
- display
Name String - (Updatable) An object's Display Name.
- technology
Type String - The Kafka (e.g. Confluent) Schema Registry technology type.
- access
Key StringId - (Updatable) Access key ID to access the Amazon S3 bucket. e.g.: "this-is-not-the-secret"
- account
Key String - (Updatable) Azure storage account key. This property is required when 'authenticationType' is set to 'SHARED_KEY'. e.g.: pa3WbhVATzj56xD4DH1VjOUhApRGEGHvOo58eQJVWIzX+j8j4CUVFcTjpIqDSRaSa1Wo2LbWY5at+AStEgLOIQ== Deprecated: This field is deprecated and replaced by "accountKeySecretId". This field will be removed after February 15 2026.
- account
Key StringSecret Id - (Updatable) The OCID of the Secret where the account key is stored. Note: When provided, 'accountKey' field must not be provided.
- account
Name String - (Updatable) Sets the Azure storage account name.
- additional
Attributes List<ConnectionAdditional Attribute> - (Updatable) An array of name-value pair attribute entries. Used as additional parameters in connection string.
- authentication
Mode String - (Updatable) Authentication mode. It can be provided at creation of Oracle Autonomous Database Serverless connections, when a databaseId is provided. The default value is MTLS.
- authentication
Type String - (Updatable) Authentication type for Java Message Service. If not provided, default is NONE. Optional until 2024-06-27, in the release after it will be made required.
- azure
Tenant StringId - (Updatable) 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 List<ConnectionBootstrap Server> - (Updatable) 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 String - (Updatable) 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 String - (Updatable) Azure client secret (aka application password) for authentication. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: dO29Q~F5-VwnA.lZdd11xFF_t5NAXCaGwDl9NbT1 Deprecated: This field is deprecated and replaced by "clientSecretSecretId". This field will be removed after February 15 2026.
- client
Secret StringSecret Id - (Updatable) The OCID of the Secret where the client secret is stored. Only applicable for authenticationType == OAUTH_M2M. Note: When provided, 'clientSecret' field must not be provided.
- connection
Factory String - (Updatable) The of Java class implementing javax.jms.ConnectionFactory interface supplied by the Java Message Service provider. e.g.: 'com.stc.jmsjca.core.JConnectionFactoryXA'
- connection
String String - (Updatable) Connection string. AZURE_SYNAPSE_ANALYTICS e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;', MONGODB e.g.: 'mongodb://mongodb0.example.com:27017/recordsrecords'.
- connection
Url String - (Updatable) Connection URL. e.g.: 'jdbc:databricks://adb-33934.4.azuredatabricks.net:443/default;transportMode=http;ssl=1;httpPath=sql/protocolv1/o/3393########44/0##3-7-hlrb'
- consumer
Properties String - (Updatable) The base64 encoded content of the consumer.properties file.
- core
Site StringXml - (Updatable) The base64 encoded content of the Hadoop Distributed File System configuration file (core-site.xml).
- database
Id String - (Updatable) The OCID of the Oracle Autonomous Json Database.
- database
Name String - (Updatable) The name of the database.
- db
System StringId - (Updatable) The OCID of the database system being referenced.
- Map<String,String>
- (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - deployment
Id String - (Updatable) The OCID of the deployment being referenced.
- description String
- (Updatable) Metadata about this specific object.
- does
Use BooleanSecret Ids - (Updatable) Indicates that sensitive attributes are provided via Secrets.
- endpoint String
- (Updatable)Azure Storage service endpoint. e.g: https://test.blob.core.windows.net, Optional Microsoft Fabric service endpoint. Default value: https://onelake.dfs.fabric.microsoft.com
- fingerprint String
- (Updatable) Fingerprint required by TLS security protocol. Eg.: '6152b2dfbff200f973c5074a5b91d06ab3b472c07c09a1ea57bb7fd406cdce9c'
- Map<String,String>
- (Updatable) 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
- (Updatable) The name or address of a host. In case of Generic connection type host and port separated by colon. Example:
"server.example.com:1234"For multiple hosts, provide a comma separated list. Example:"server1.example.com:1000,server1.example.com:2000" - is
Lock BooleanOverride - jndi
Connection StringFactory - (Updatable) The Connection Factory can be looked up using this name. e.g.: 'ConnectionFactory'
- jndi
Initial StringContext Factory - (Updatable) The implementation of javax.naming.spi.InitialContextFactory interface that the client uses to obtain initial naming context. e.g.: 'org.apache.activemq.jndi.ActiveMQInitialContextFactory'
- jndi
Provider StringUrl - (Updatable) The URL that Java Message Service will use to contact the JNDI provider. e.g.: 'tcp://myjms.host.domain:61616?jms.prefetchPolicy.all=1000'
- jndi
Security StringCredentials - (Updatable) The password associated to the principal. Deprecated: This field is deprecated and replaced by "jndiSecurityCredentialsSecretId". This field will be removed after February 15 2026.
- jndi
Security StringCredentials Secret Id - (Updatable) The OCID of the Secret where the security credentials are stored associated to the principal. Note: When provided, 'jndiSecurityCredentials' field must not be provided.
- jndi
Security StringPrincipal - (Updatable) Specifies the identity of the principal (user) to be authenticated. e.g.: 'admin2'
- key
Id String - (Updatable) Refers to the customer's master key OCID. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
- key
Store String - (Updatable) The base64 encoded content of the KeyStore file. Deprecated: This field is deprecated and replaced by "keyStoreSecretId". This field will be removed after February 15 2026.
- key
Store StringPassword - (Updatable) The KeyStore password. Deprecated: This field is deprecated and replaced by "keyStorePasswordSecretId". This field will be removed after February 15 2026.
- key
Store StringPassword Secret Id - (Updatable) The OCID of the Secret where the kafka Ssl KeyStore password is stored. Note: When provided, 'keyStorePassword' field must not be provided.
- key
Store StringSecret Id - (Updatable) The OCID of the Secret where the content of the KeyStore file is stored. Note: When provided, 'keyStore' field must not be provided.
- locks
List<Connection
Lock> - Locks associated with this resource.
- nsg
Ids List<String> - (Updatable) An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
- password String
- (Updatable) The password Oracle GoldenGate uses to connect the associated system of the given technology. It must conform to the specific security requirements including length, case sensitivity, and so on. Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
- password
Secret StringId - (Updatable) The OCID of the Secret where the password is stored. The password Oracle GoldenGate uses to connect the associated system of the given technology. It must conform to the specific security requirements including length, case sensitivity, and so on. If secretId is used plaintext field must not be provided. Note: When provided, 'password' field must not be provided.
- port Integer
- (Updatable) The port of an endpoint usually specified for a connection.
- private
Ip String (Updatable) Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host field, or make sure the host name is resolvable in the target VCN.
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 StringFile - (Updatable) The base64 encoded content of the private key file (PEM file) corresponding to the API key of the fingerprint. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm Deprecated: This field is deprecated and replaced by "privateKeyFileSecretId". This field will be removed after February 15 2026.
- private
Key StringFile Secret Id - (Updatable) The OCID of the Secret that stores the content of the private key file (PEM file) corresponding to the API key of the fingerprint. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm Note: When provided, 'privateKeyFile' field must not be provided.
- private
Key StringPassphrase - (Updatable) Password if the private key file is encrypted. Deprecated: This field is deprecated and replaced by "privateKeyPassphraseSecretId". This field will be removed after February 15 2026.
- private
Key StringPassphrase Secret Id - (Updatable) The OCID of the Secret that stores the password for the private key file. Note: When provided, 'privateKeyPassphrase' field must not be provided.
- producer
Properties String - (Updatable) The base64 encoded content of the producer.properties file.
- public
Key StringFingerprint - (Updatable) The fingerprint of the API Key of the user specified by the userId. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm
- redis
Cluster StringId - (Updatable) The OCID of the Redis cluster.
- region String
- (Updatable) The name of the region. e.g.: us-ashburn-1 If the region is not provided, backend will default to the default region.
- routing
Method String - (Updatable) Controls the network traffic direction to the target: SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets. SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet. DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
- sas
Token String - (Updatable) Credential that uses a shared access signature (SAS) to authenticate to an Azure Service. This property is required when 'authenticationType' is set to 'SHARED_ACCESS_SIGNATURE'. e.g.: ?sv=2020-06-08&ss=bfqt&srt=sco&sp=rwdlacupyx&se=2020-09-10T20:27:28Z&st=2022-08-05T12:27:28Z&spr=https&sig=C1IgHsiLBmTSStYkXXGLTP8it0xBrArcgCqOsZbXwIQ%3D Deprecated: This field is deprecated and replaced by "sasTokenSecretId". This field will be removed after February 15 2026.
- sas
Token StringSecret Id - (Updatable) The OCID of the Secret where the sas token is stored. Note: When provided, 'sasToken' field must not be provided.
- secret
Access StringKey - (Updatable) Secret access key to access the Amazon S3 bucket. e.g.: "this-is-not-the-secret" Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". This field will be removed after February 15 2026.
- secret
Access StringKey Secret Id - (Updatable) The OCID of the Secret where the secret access key is stored. Note: When provided, 'secretAccessKey' field must not be provided.
- security
Protocol String - (Updatable) Security protocol for Java Message Service. If not provided, default is PLAIN. Optional until 2024-06-27, in the release after it will be made required.
- servers String
- (Updatable) Comma separated list of Elasticsearch server addresses, specified as host:port entries, where :port is optional. If port is not specified, it defaults to 9200. Used for establishing the initial connection to the Elasticsearch cluster. Example:
"server1.example.com:4000,server2.example.com:4000" - service
Account StringKey File - (Updatable) The base64 encoded content of the service account key file containing the credentials required to use Google Cloud Storage. Deprecated: This field is deprecated and replaced by "serviceAccountKeyFileSecretId". This field will be removed after February 15 2026.
- service
Account StringKey File Secret Id - (Updatable) The OCID of the Secret where the content of the service account key file is stored, which containing the credentials required to use Google Cloud Storage. Note: When provided, 'serviceAccountKeyFile' field must not be provided.
- session
Mode String - (Updatable) 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.
- should
Use BooleanJndi - (Updatable) If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.
- should
Use BooleanResource Principal - (Updatable) Indicates that the user intents to connect to the instance through resource principal.
- should
Validate BooleanServer Certificate - (Updatable) If set to true, the driver validates the certificate that is sent by the database server.
- ssl
Ca String - (Updatable) The base64 encoded certificate of the trusted certificate authorities (Trusted CA) for PostgreSQL. The supported file formats are .pem and .crt.
- ssl
Cert String - (Updatable) Client Certificate - The base64 encoded content of a .pem or .crt file. containing the client public key (for 2-way SSL).
- ssl
Client StringKeystash - (Updatable) The base64 encoded keystash file which contains the encrypted password to the key database file. Deprecated: This field is deprecated and replaced by "sslClientKeystashSecretId". This field will be removed after February 15 2026.
- ssl
Client StringKeystash Secret Id - (Updatable) The OCID of the Secret where the keystash file is stored, which contains the encrypted password to the key database file. Note: When provided, 'sslClientKeystash' field must not be provided.
- ssl
Client StringKeystoredb - (Updatable) The base64 encoded keystore file created at the client containing the server certificate / CA root certificate. Deprecated: This field is deprecated and replaced by "sslClientKeystoredbSecretId". This field will be removed after February 15 2026.
- ssl
Client StringKeystoredb Secret Id - (Updatable) The OCID of the Secret where the keystore file stored, which created at the client containing the server certificate / CA root certificate. Note: When provided, 'sslClientKeystoredb' field must not be provided.
- ssl
Crl String - (Updatable) The base64 encoded list of certificates revoked by the trusted certificate authorities (Trusted CA). Note: This is an optional property and only applicable if TLS/MTLS option is selected.
- ssl
Key String - (Updatable) Client Key - The base64 encoded content of a .pem or .crt file containing the client private key (for 2-way SSL). Deprecated: This field is deprecated and replaced by "sslKeySecretId". This field will be removed after February 15 2026.
- ssl
Key StringPassword - (Updatable) The password for the cert inside of the KeyStore. In case it differs from the KeyStore password, it should be provided. Deprecated: This field is deprecated and replaced by "sslKeyPasswordSecretId". This field will be removed after February 15 2026.
- ssl
Key StringPassword Secret Id - (Updatable) The OCID of the Secret where the password is stored for the cert inside of the Keystore. In case it differs from the KeyStore password, it should be provided. Note: When provided, 'sslKeyPassword' field must not be provided.
- ssl
Key StringSecret Id - (Updatable) The OCID of the Secret that stores the Client Key
- The content of a .pem or .crt file containing the client private key (for 2-way SSL). Note: When provided, 'sslKey' field must not be provided.
- ssl
Mode String - (Updatable) SSL modes for PostgreSQL.
- ssl
Server StringCertificate - (Updatable) The base64 encoded file which contains the self-signed server certificate / Certificate Authority (CA) certificate.
- storage
Credential StringName - (Updatable) Optional. External storage credential name to access files on object storage such as ADLS Gen2, S3 or GCS.
- stream
Pool StringId - (Updatable) The OCID of the stream pool being referenced.
- subnet
Id String - (Updatable) The OCID of the target subnet of the dedicated connection.
- tenancy
Id String - (Updatable) The OCID of the related Oracle Cloud Infrastructure tenancy.
- tenant
Id String - (Updatable) Azure tenant ID of the application. e.g.: 14593954-d337-4a61-a364-9f758c64f97f
- tls
Ca StringFile - (Updatable) Database Certificate - The base64 encoded content of a .pem file, containing the server public key (for 1 and 2-way SSL).
- tls
Certificate StringKey File - (Updatable) Client Certificate - The base64 encoded content of a .pem file, containing the client public key (for 2-way SSL). Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFileSecretId". This field will be removed after February 15 2026.
- tls
Certificate StringKey File Password - (Updatable) Client Certificate key file password. Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFilePasswordSecretId". This field will be removed after February 15 2026.
- tls
Certificate StringKey File Password Secret Id - (Updatable) The OCID of the Secret that stores the password of the tls certificate key file. Note: When provided, 'tlsCertificateKeyFilePassword' field must not be provided.
- tls
Certificate StringKey File Secret Id - (Updatable) The OCID of the Secret that stores the certificate key file of the mtls connection.
- The content of a .pem file containing the client private key (for 2-way SSL). Note: When provided, 'tlsCertificateKeyFile' field must not be provided.
- trigger
Refresh Boolean (Updatable) If value is true, it triggers connection refresh action and this attribute change will always show up in the "update" plan and will apply steps in order to refresh secrets and dependent service properties (such as ADB connection strings, wallets, etc..).
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- trust
Store String - (Updatable) The base64 encoded content of the TrustStore file. Deprecated: This field is deprecated and replaced by "trustStoreSecretId". This field will be removed after February 15 2026.
- trust
Store StringPassword - (Updatable) The TrustStore password. Deprecated: This field is deprecated and replaced by "trustStorePasswordSecretId". This field will be removed after February 15 2026.
- trust
Store StringPassword Secret Id - (Updatable) The OCID of the Secret where the kafka Ssl TrustStore password is stored. Note: When provided, 'trustStorePassword' field must not be provided.
- trust
Store StringSecret Id - (Updatable) The OCID of the Secret where the content of the TrustStore file is stored. Note: When provided, 'trustStore' field must not be provided.
- url String
- (Updatable) Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'
- user
Id String - (Updatable) The OCID of the Oracle Cloud Infrastructure user who will access the Oracle NoSQL database. The user must have write access to the table they want to connect to. If the user is not provided, backend will default to the user who is calling the API endpoint.
- username String
- (Updatable) The username Oracle GoldenGate uses to connect the associated system of the given technology. This username must already exist and be available by the system/application to be connected to and must conform to the case sensitivty requirments defined in it.
- vault
Id String - (Updatable) Refers to the customer's vault OCID. If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate to manage secrets contained within this vault.
- wallet String
- (Updatable) The wallet contents Oracle GoldenGate uses to make connections to a database. This attribute is expected to be base64 encoded. Deprecated: This field is deprecated and replaced by "walletSecretId". This field will be removed after February 15 2026.
- wallet
Secret StringId - (Updatable) The OCID of the Secret where the wallet file is stored. The wallet contents Oracle GoldenGate uses to make connections to a database. Note: When provided, 'wallet' field must not be provided.
- compartment
Id string - (Updatable) The OCID of the compartment being referenced.
- connection
Type string - (Updatable) The connection type.
- display
Name string - (Updatable) An object's Display Name.
- technology
Type string - The Kafka (e.g. Confluent) Schema Registry technology type.
- access
Key stringId - (Updatable) Access key ID to access the Amazon S3 bucket. e.g.: "this-is-not-the-secret"
- account
Key string - (Updatable) Azure storage account key. This property is required when 'authenticationType' is set to 'SHARED_KEY'. e.g.: pa3WbhVATzj56xD4DH1VjOUhApRGEGHvOo58eQJVWIzX+j8j4CUVFcTjpIqDSRaSa1Wo2LbWY5at+AStEgLOIQ== Deprecated: This field is deprecated and replaced by "accountKeySecretId". This field will be removed after February 15 2026.
- account
Key stringSecret Id - (Updatable) The OCID of the Secret where the account key is stored. Note: When provided, 'accountKey' field must not be provided.
- account
Name string - (Updatable) Sets the Azure storage account name.
- additional
Attributes ConnectionAdditional Attribute[] - (Updatable) An array of name-value pair attribute entries. Used as additional parameters in connection string.
- authentication
Mode string - (Updatable) Authentication mode. It can be provided at creation of Oracle Autonomous Database Serverless connections, when a databaseId is provided. The default value is MTLS.
- authentication
Type string - (Updatable) Authentication type for Java Message Service. If not provided, default is NONE. Optional until 2024-06-27, in the release after it will be made required.
- azure
Tenant stringId - (Updatable) 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 ConnectionBootstrap Server[] - (Updatable) 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 string - (Updatable) 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 string - (Updatable) Azure client secret (aka application password) for authentication. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: dO29Q~F5-VwnA.lZdd11xFF_t5NAXCaGwDl9NbT1 Deprecated: This field is deprecated and replaced by "clientSecretSecretId". This field will be removed after February 15 2026.
- client
Secret stringSecret Id - (Updatable) The OCID of the Secret where the client secret is stored. Only applicable for authenticationType == OAUTH_M2M. Note: When provided, 'clientSecret' field must not be provided.
- connection
Factory string - (Updatable) The of Java class implementing javax.jms.ConnectionFactory interface supplied by the Java Message Service provider. e.g.: 'com.stc.jmsjca.core.JConnectionFactoryXA'
- connection
String string - (Updatable) Connection string. AZURE_SYNAPSE_ANALYTICS e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;', MONGODB e.g.: 'mongodb://mongodb0.example.com:27017/recordsrecords'.
- connection
Url string - (Updatable) Connection URL. e.g.: 'jdbc:databricks://adb-33934.4.azuredatabricks.net:443/default;transportMode=http;ssl=1;httpPath=sql/protocolv1/o/3393########44/0##3-7-hlrb'
- consumer
Properties string - (Updatable) The base64 encoded content of the consumer.properties file.
- core
Site stringXml - (Updatable) The base64 encoded content of the Hadoop Distributed File System configuration file (core-site.xml).
- database
Id string - (Updatable) The OCID of the Oracle Autonomous Json Database.
- database
Name string - (Updatable) The name of the database.
- db
System stringId - (Updatable) The OCID of the database system being referenced.
- {[key: string]: string}
- (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - deployment
Id string - (Updatable) The OCID of the deployment being referenced.
- description string
- (Updatable) Metadata about this specific object.
- does
Use booleanSecret Ids - (Updatable) Indicates that sensitive attributes are provided via Secrets.
- endpoint string
- (Updatable)Azure Storage service endpoint. e.g: https://test.blob.core.windows.net, Optional Microsoft Fabric service endpoint. Default value: https://onelake.dfs.fabric.microsoft.com
- fingerprint string
- (Updatable) Fingerprint required by TLS security protocol. Eg.: '6152b2dfbff200f973c5074a5b91d06ab3b472c07c09a1ea57bb7fd406cdce9c'
- {[key: string]: string}
- (Updatable) 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
- (Updatable) The name or address of a host. In case of Generic connection type host and port separated by colon. Example:
"server.example.com:1234"For multiple hosts, provide a comma separated list. Example:"server1.example.com:1000,server1.example.com:2000" - is
Lock booleanOverride - jndi
Connection stringFactory - (Updatable) The Connection Factory can be looked up using this name. e.g.: 'ConnectionFactory'
- jndi
Initial stringContext Factory - (Updatable) The implementation of javax.naming.spi.InitialContextFactory interface that the client uses to obtain initial naming context. e.g.: 'org.apache.activemq.jndi.ActiveMQInitialContextFactory'
- jndi
Provider stringUrl - (Updatable) The URL that Java Message Service will use to contact the JNDI provider. e.g.: 'tcp://myjms.host.domain:61616?jms.prefetchPolicy.all=1000'
- jndi
Security stringCredentials - (Updatable) The password associated to the principal. Deprecated: This field is deprecated and replaced by "jndiSecurityCredentialsSecretId". This field will be removed after February 15 2026.
- jndi
Security stringCredentials Secret Id - (Updatable) The OCID of the Secret where the security credentials are stored associated to the principal. Note: When provided, 'jndiSecurityCredentials' field must not be provided.
- jndi
Security stringPrincipal - (Updatable) Specifies the identity of the principal (user) to be authenticated. e.g.: 'admin2'
- key
Id string - (Updatable) Refers to the customer's master key OCID. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
- key
Store string - (Updatable) The base64 encoded content of the KeyStore file. Deprecated: This field is deprecated and replaced by "keyStoreSecretId". This field will be removed after February 15 2026.
- key
Store stringPassword - (Updatable) The KeyStore password. Deprecated: This field is deprecated and replaced by "keyStorePasswordSecretId". This field will be removed after February 15 2026.
- key
Store stringPassword Secret Id - (Updatable) The OCID of the Secret where the kafka Ssl KeyStore password is stored. Note: When provided, 'keyStorePassword' field must not be provided.
- key
Store stringSecret Id - (Updatable) The OCID of the Secret where the content of the KeyStore file is stored. Note: When provided, 'keyStore' field must not be provided.
- locks
Connection
Lock[] - Locks associated with this resource.
- nsg
Ids string[] - (Updatable) An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
- password string
- (Updatable) The password Oracle GoldenGate uses to connect the associated system of the given technology. It must conform to the specific security requirements including length, case sensitivity, and so on. Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
- password
Secret stringId - (Updatable) The OCID of the Secret where the password is stored. The password Oracle GoldenGate uses to connect the associated system of the given technology. It must conform to the specific security requirements including length, case sensitivity, and so on. If secretId is used plaintext field must not be provided. Note: When provided, 'password' field must not be provided.
- port number
- (Updatable) The port of an endpoint usually specified for a connection.
- private
Ip string (Updatable) Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host field, or make sure the host name is resolvable in the target VCN.
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 stringFile - (Updatable) The base64 encoded content of the private key file (PEM file) corresponding to the API key of the fingerprint. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm Deprecated: This field is deprecated and replaced by "privateKeyFileSecretId". This field will be removed after February 15 2026.
- private
Key stringFile Secret Id - (Updatable) The OCID of the Secret that stores the content of the private key file (PEM file) corresponding to the API key of the fingerprint. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm Note: When provided, 'privateKeyFile' field must not be provided.
- private
Key stringPassphrase - (Updatable) Password if the private key file is encrypted. Deprecated: This field is deprecated and replaced by "privateKeyPassphraseSecretId". This field will be removed after February 15 2026.
- private
Key stringPassphrase Secret Id - (Updatable) The OCID of the Secret that stores the password for the private key file. Note: When provided, 'privateKeyPassphrase' field must not be provided.
- producer
Properties string - (Updatable) The base64 encoded content of the producer.properties file.
- public
Key stringFingerprint - (Updatable) The fingerprint of the API Key of the user specified by the userId. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm
- redis
Cluster stringId - (Updatable) The OCID of the Redis cluster.
- region string
- (Updatable) The name of the region. e.g.: us-ashburn-1 If the region is not provided, backend will default to the default region.
- routing
Method string - (Updatable) Controls the network traffic direction to the target: SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets. SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet. DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
- sas
Token string - (Updatable) Credential that uses a shared access signature (SAS) to authenticate to an Azure Service. This property is required when 'authenticationType' is set to 'SHARED_ACCESS_SIGNATURE'. e.g.: ?sv=2020-06-08&ss=bfqt&srt=sco&sp=rwdlacupyx&se=2020-09-10T20:27:28Z&st=2022-08-05T12:27:28Z&spr=https&sig=C1IgHsiLBmTSStYkXXGLTP8it0xBrArcgCqOsZbXwIQ%3D Deprecated: This field is deprecated and replaced by "sasTokenSecretId". This field will be removed after February 15 2026.
- sas
Token stringSecret Id - (Updatable) The OCID of the Secret where the sas token is stored. Note: When provided, 'sasToken' field must not be provided.
- secret
Access stringKey - (Updatable) Secret access key to access the Amazon S3 bucket. e.g.: "this-is-not-the-secret" Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". This field will be removed after February 15 2026.
- secret
Access stringKey Secret Id - (Updatable) The OCID of the Secret where the secret access key is stored. Note: When provided, 'secretAccessKey' field must not be provided.
- security
Protocol string - (Updatable) Security protocol for Java Message Service. If not provided, default is PLAIN. Optional until 2024-06-27, in the release after it will be made required.
- servers string
- (Updatable) Comma separated list of Elasticsearch server addresses, specified as host:port entries, where :port is optional. If port is not specified, it defaults to 9200. Used for establishing the initial connection to the Elasticsearch cluster. Example:
"server1.example.com:4000,server2.example.com:4000" - service
Account stringKey File - (Updatable) The base64 encoded content of the service account key file containing the credentials required to use Google Cloud Storage. Deprecated: This field is deprecated and replaced by "serviceAccountKeyFileSecretId". This field will be removed after February 15 2026.
- service
Account stringKey File Secret Id - (Updatable) The OCID of the Secret where the content of the service account key file is stored, which containing the credentials required to use Google Cloud Storage. Note: When provided, 'serviceAccountKeyFile' field must not be provided.
- session
Mode string - (Updatable) 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.
- should
Use booleanJndi - (Updatable) If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.
- should
Use booleanResource Principal - (Updatable) Indicates that the user intents to connect to the instance through resource principal.
- should
Validate booleanServer Certificate - (Updatable) If set to true, the driver validates the certificate that is sent by the database server.
- ssl
Ca string - (Updatable) The base64 encoded certificate of the trusted certificate authorities (Trusted CA) for PostgreSQL. The supported file formats are .pem and .crt.
- ssl
Cert string - (Updatable) Client Certificate - The base64 encoded content of a .pem or .crt file. containing the client public key (for 2-way SSL).
- ssl
Client stringKeystash - (Updatable) The base64 encoded keystash file which contains the encrypted password to the key database file. Deprecated: This field is deprecated and replaced by "sslClientKeystashSecretId". This field will be removed after February 15 2026.
- ssl
Client stringKeystash Secret Id - (Updatable) The OCID of the Secret where the keystash file is stored, which contains the encrypted password to the key database file. Note: When provided, 'sslClientKeystash' field must not be provided.
- ssl
Client stringKeystoredb - (Updatable) The base64 encoded keystore file created at the client containing the server certificate / CA root certificate. Deprecated: This field is deprecated and replaced by "sslClientKeystoredbSecretId". This field will be removed after February 15 2026.
- ssl
Client stringKeystoredb Secret Id - (Updatable) The OCID of the Secret where the keystore file stored, which created at the client containing the server certificate / CA root certificate. Note: When provided, 'sslClientKeystoredb' field must not be provided.
- ssl
Crl string - (Updatable) The base64 encoded list of certificates revoked by the trusted certificate authorities (Trusted CA). Note: This is an optional property and only applicable if TLS/MTLS option is selected.
- ssl
Key string - (Updatable) Client Key - The base64 encoded content of a .pem or .crt file containing the client private key (for 2-way SSL). Deprecated: This field is deprecated and replaced by "sslKeySecretId". This field will be removed after February 15 2026.
- ssl
Key stringPassword - (Updatable) The password for the cert inside of the KeyStore. In case it differs from the KeyStore password, it should be provided. Deprecated: This field is deprecated and replaced by "sslKeyPasswordSecretId". This field will be removed after February 15 2026.
- ssl
Key stringPassword Secret Id - (Updatable) The OCID of the Secret where the password is stored for the cert inside of the Keystore. In case it differs from the KeyStore password, it should be provided. Note: When provided, 'sslKeyPassword' field must not be provided.
- ssl
Key stringSecret Id - (Updatable) The OCID of the Secret that stores the Client Key
- The content of a .pem or .crt file containing the client private key (for 2-way SSL). Note: When provided, 'sslKey' field must not be provided.
- ssl
Mode string - (Updatable) SSL modes for PostgreSQL.
- ssl
Server stringCertificate - (Updatable) The base64 encoded file which contains the self-signed server certificate / Certificate Authority (CA) certificate.
- storage
Credential stringName - (Updatable) Optional. External storage credential name to access files on object storage such as ADLS Gen2, S3 or GCS.
- stream
Pool stringId - (Updatable) The OCID of the stream pool being referenced.
- subnet
Id string - (Updatable) The OCID of the target subnet of the dedicated connection.
- tenancy
Id string - (Updatable) The OCID of the related Oracle Cloud Infrastructure tenancy.
- tenant
Id string - (Updatable) Azure tenant ID of the application. e.g.: 14593954-d337-4a61-a364-9f758c64f97f
- tls
Ca stringFile - (Updatable) Database Certificate - The base64 encoded content of a .pem file, containing the server public key (for 1 and 2-way SSL).
- tls
Certificate stringKey File - (Updatable) Client Certificate - The base64 encoded content of a .pem file, containing the client public key (for 2-way SSL). Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFileSecretId". This field will be removed after February 15 2026.
- tls
Certificate stringKey File Password - (Updatable) Client Certificate key file password. Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFilePasswordSecretId". This field will be removed after February 15 2026.
- tls
Certificate stringKey File Password Secret Id - (Updatable) The OCID of the Secret that stores the password of the tls certificate key file. Note: When provided, 'tlsCertificateKeyFilePassword' field must not be provided.
- tls
Certificate stringKey File Secret Id - (Updatable) The OCID of the Secret that stores the certificate key file of the mtls connection.
- The content of a .pem file containing the client private key (for 2-way SSL). Note: When provided, 'tlsCertificateKeyFile' field must not be provided.
- trigger
Refresh boolean (Updatable) If value is true, it triggers connection refresh action and this attribute change will always show up in the "update" plan and will apply steps in order to refresh secrets and dependent service properties (such as ADB connection strings, wallets, etc..).
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- trust
Store string - (Updatable) The base64 encoded content of the TrustStore file. Deprecated: This field is deprecated and replaced by "trustStoreSecretId". This field will be removed after February 15 2026.
- trust
Store stringPassword - (Updatable) The TrustStore password. Deprecated: This field is deprecated and replaced by "trustStorePasswordSecretId". This field will be removed after February 15 2026.
- trust
Store stringPassword Secret Id - (Updatable) The OCID of the Secret where the kafka Ssl TrustStore password is stored. Note: When provided, 'trustStorePassword' field must not be provided.
- trust
Store stringSecret Id - (Updatable) The OCID of the Secret where the content of the TrustStore file is stored. Note: When provided, 'trustStore' field must not be provided.
- url string
- (Updatable) Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'
- user
Id string - (Updatable) The OCID of the Oracle Cloud Infrastructure user who will access the Oracle NoSQL database. The user must have write access to the table they want to connect to. If the user is not provided, backend will default to the user who is calling the API endpoint.
- username string
- (Updatable) The username Oracle GoldenGate uses to connect the associated system of the given technology. This username must already exist and be available by the system/application to be connected to and must conform to the case sensitivty requirments defined in it.
- vault
Id string - (Updatable) Refers to the customer's vault OCID. If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate to manage secrets contained within this vault.
- wallet string
- (Updatable) The wallet contents Oracle GoldenGate uses to make connections to a database. This attribute is expected to be base64 encoded. Deprecated: This field is deprecated and replaced by "walletSecretId". This field will be removed after February 15 2026.
- wallet
Secret stringId - (Updatable) The OCID of the Secret where the wallet file is stored. The wallet contents Oracle GoldenGate uses to make connections to a database. Note: When provided, 'wallet' field must not be provided.
- compartment_
id str - (Updatable) The OCID of the compartment being referenced.
- connection_
type str - (Updatable) The connection type.
- display_
name str - (Updatable) An object's Display Name.
- technology_
type str - The Kafka (e.g. Confluent) Schema Registry technology type.
- access_
key_ strid - (Updatable) Access key ID to access the Amazon S3 bucket. e.g.: "this-is-not-the-secret"
- account_
key str - (Updatable) Azure storage account key. This property is required when 'authenticationType' is set to 'SHARED_KEY'. e.g.: pa3WbhVATzj56xD4DH1VjOUhApRGEGHvOo58eQJVWIzX+j8j4CUVFcTjpIqDSRaSa1Wo2LbWY5at+AStEgLOIQ== Deprecated: This field is deprecated and replaced by "accountKeySecretId". This field will be removed after February 15 2026.
- account_
key_ strsecret_ id - (Updatable) The OCID of the Secret where the account key is stored. Note: When provided, 'accountKey' field must not be provided.
- account_
name str - (Updatable) Sets the Azure storage account name.
- additional_
attributes Sequence[ConnectionAdditional Attribute Args] - (Updatable) An array of name-value pair attribute entries. Used as additional parameters in connection string.
- authentication_
mode str - (Updatable) Authentication mode. It can be provided at creation of Oracle Autonomous Database Serverless connections, when a databaseId is provided. The default value is MTLS.
- authentication_
type str - (Updatable) Authentication type for Java Message Service. If not provided, default is NONE. Optional until 2024-06-27, in the release after it will be made required.
- azure_
tenant_ strid - (Updatable) 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 Sequence[ConnectionBootstrap Server Args] - (Updatable) 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 - (Updatable) 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 - (Updatable) Azure client secret (aka application password) for authentication. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: dO29Q~F5-VwnA.lZdd11xFF_t5NAXCaGwDl9NbT1 Deprecated: This field is deprecated and replaced by "clientSecretSecretId". This field will be removed after February 15 2026.
- client_
secret_ strsecret_ id - (Updatable) The OCID of the Secret where the client secret is stored. Only applicable for authenticationType == OAUTH_M2M. Note: When provided, 'clientSecret' field must not be provided.
- connection_
factory str - (Updatable) The of Java class implementing javax.jms.ConnectionFactory interface supplied by the Java Message Service provider. e.g.: 'com.stc.jmsjca.core.JConnectionFactoryXA'
- connection_
string str - (Updatable) Connection string. AZURE_SYNAPSE_ANALYTICS e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;', MONGODB e.g.: 'mongodb://mongodb0.example.com:27017/recordsrecords'.
- connection_
url str - (Updatable) Connection URL. e.g.: 'jdbc:databricks://adb-33934.4.azuredatabricks.net:443/default;transportMode=http;ssl=1;httpPath=sql/protocolv1/o/3393########44/0##3-7-hlrb'
- consumer_
properties str - (Updatable) The base64 encoded content of the consumer.properties file.
- core_
site_ strxml - (Updatable) The base64 encoded content of the Hadoop Distributed File System configuration file (core-site.xml).
- database_
id str - (Updatable) The OCID of the Oracle Autonomous Json Database.
- database_
name str - (Updatable) The name of the database.
- db_
system_ strid - (Updatable) The OCID of the database system being referenced.
- Mapping[str, str]
- (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - deployment_
id str - (Updatable) The OCID of the deployment being referenced.
- description str
- (Updatable) Metadata about this specific object.
- does_
use_ boolsecret_ ids - (Updatable) Indicates that sensitive attributes are provided via Secrets.
- endpoint str
- (Updatable)Azure Storage service endpoint. e.g: https://test.blob.core.windows.net, Optional Microsoft Fabric service endpoint. Default value: https://onelake.dfs.fabric.microsoft.com
- fingerprint str
- (Updatable) Fingerprint required by TLS security protocol. Eg.: '6152b2dfbff200f973c5074a5b91d06ab3b472c07c09a1ea57bb7fd406cdce9c'
- Mapping[str, str]
- (Updatable) 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
- (Updatable) The name or address of a host. In case of Generic connection type host and port separated by colon. Example:
"server.example.com:1234"For multiple hosts, provide a comma separated list. Example:"server1.example.com:1000,server1.example.com:2000" - is_
lock_ booloverride - jndi_
connection_ strfactory - (Updatable) The Connection Factory can be looked up using this name. e.g.: 'ConnectionFactory'
- jndi_
initial_ strcontext_ factory - (Updatable) The implementation of javax.naming.spi.InitialContextFactory interface that the client uses to obtain initial naming context. e.g.: 'org.apache.activemq.jndi.ActiveMQInitialContextFactory'
- jndi_
provider_ strurl - (Updatable) The URL that Java Message Service will use to contact the JNDI provider. e.g.: 'tcp://myjms.host.domain:61616?jms.prefetchPolicy.all=1000'
- jndi_
security_ strcredentials - (Updatable) The password associated to the principal. Deprecated: This field is deprecated and replaced by "jndiSecurityCredentialsSecretId". This field will be removed after February 15 2026.
- jndi_
security_ strcredentials_ secret_ id - (Updatable) The OCID of the Secret where the security credentials are stored associated to the principal. Note: When provided, 'jndiSecurityCredentials' field must not be provided.
- jndi_
security_ strprincipal - (Updatable) Specifies the identity of the principal (user) to be authenticated. e.g.: 'admin2'
- key_
id str - (Updatable) Refers to the customer's master key OCID. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
- key_
store str - (Updatable) The base64 encoded content of the KeyStore file. Deprecated: This field is deprecated and replaced by "keyStoreSecretId". This field will be removed after February 15 2026.
- key_
store_ strpassword - (Updatable) The KeyStore password. Deprecated: This field is deprecated and replaced by "keyStorePasswordSecretId". This field will be removed after February 15 2026.
- key_
store_ strpassword_ secret_ id - (Updatable) The OCID of the Secret where the kafka Ssl KeyStore password is stored. Note: When provided, 'keyStorePassword' field must not be provided.
- key_
store_ strsecret_ id - (Updatable) The OCID of the Secret where the content of the KeyStore file is stored. Note: When provided, 'keyStore' field must not be provided.
- locks
Sequence[Connection
Lock Args] - Locks associated with this resource.
- nsg_
ids Sequence[str] - (Updatable) An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
- password str
- (Updatable) The password Oracle GoldenGate uses to connect the associated system of the given technology. It must conform to the specific security requirements including length, case sensitivity, and so on. Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
- password_
secret_ strid - (Updatable) The OCID of the Secret where the password is stored. The password Oracle GoldenGate uses to connect the associated system of the given technology. It must conform to the specific security requirements including length, case sensitivity, and so on. If secretId is used plaintext field must not be provided. Note: When provided, 'password' field must not be provided.
- port int
- (Updatable) The port of an endpoint usually specified for a connection.
- private_
ip str (Updatable) Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host field, or make sure the host name is resolvable in the target VCN.
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_ strfile - (Updatable) The base64 encoded content of the private key file (PEM file) corresponding to the API key of the fingerprint. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm Deprecated: This field is deprecated and replaced by "privateKeyFileSecretId". This field will be removed after February 15 2026.
- private_
key_ strfile_ secret_ id - (Updatable) The OCID of the Secret that stores the content of the private key file (PEM file) corresponding to the API key of the fingerprint. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm Note: When provided, 'privateKeyFile' field must not be provided.
- private_
key_ strpassphrase - (Updatable) Password if the private key file is encrypted. Deprecated: This field is deprecated and replaced by "privateKeyPassphraseSecretId". This field will be removed after February 15 2026.
- private_
key_ strpassphrase_ secret_ id - (Updatable) The OCID of the Secret that stores the password for the private key file. Note: When provided, 'privateKeyPassphrase' field must not be provided.
- producer_
properties str - (Updatable) The base64 encoded content of the producer.properties file.
- public_
key_ strfingerprint - (Updatable) The fingerprint of the API Key of the user specified by the userId. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm
- redis_
cluster_ strid - (Updatable) The OCID of the Redis cluster.
- region str
- (Updatable) The name of the region. e.g.: us-ashburn-1 If the region is not provided, backend will default to the default region.
- routing_
method str - (Updatable) Controls the network traffic direction to the target: SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets. SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet. DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
- sas_
token str - (Updatable) Credential that uses a shared access signature (SAS) to authenticate to an Azure Service. This property is required when 'authenticationType' is set to 'SHARED_ACCESS_SIGNATURE'. e.g.: ?sv=2020-06-08&ss=bfqt&srt=sco&sp=rwdlacupyx&se=2020-09-10T20:27:28Z&st=2022-08-05T12:27:28Z&spr=https&sig=C1IgHsiLBmTSStYkXXGLTP8it0xBrArcgCqOsZbXwIQ%3D Deprecated: This field is deprecated and replaced by "sasTokenSecretId". This field will be removed after February 15 2026.
- sas_
token_ strsecret_ id - (Updatable) The OCID of the Secret where the sas token is stored. Note: When provided, 'sasToken' field must not be provided.
- secret_
access_ strkey - (Updatable) Secret access key to access the Amazon S3 bucket. e.g.: "this-is-not-the-secret" Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". This field will be removed after February 15 2026.
- secret_
access_ strkey_ secret_ id - (Updatable) The OCID of the Secret where the secret access key is stored. Note: When provided, 'secretAccessKey' field must not be provided.
- security_
protocol str - (Updatable) Security protocol for Java Message Service. If not provided, default is PLAIN. Optional until 2024-06-27, in the release after it will be made required.
- servers str
- (Updatable) Comma separated list of Elasticsearch server addresses, specified as host:port entries, where :port is optional. If port is not specified, it defaults to 9200. Used for establishing the initial connection to the Elasticsearch cluster. Example:
"server1.example.com:4000,server2.example.com:4000" - service_
account_ strkey_ file - (Updatable) The base64 encoded content of the service account key file containing the credentials required to use Google Cloud Storage. Deprecated: This field is deprecated and replaced by "serviceAccountKeyFileSecretId". This field will be removed after February 15 2026.
- service_
account_ strkey_ file_ secret_ id - (Updatable) The OCID of the Secret where the content of the service account key file is stored, which containing the credentials required to use Google Cloud Storage. Note: When provided, 'serviceAccountKeyFile' field must not be provided.
- session_
mode str - (Updatable) 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.
- should_
use_ booljndi - (Updatable) If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.
- should_
use_ boolresource_ principal - (Updatable) Indicates that the user intents to connect to the instance through resource principal.
- should_
validate_ boolserver_ certificate - (Updatable) If set to true, the driver validates the certificate that is sent by the database server.
- ssl_
ca str - (Updatable) The base64 encoded certificate of the trusted certificate authorities (Trusted CA) for PostgreSQL. The supported file formats are .pem and .crt.
- ssl_
cert str - (Updatable) Client Certificate - The base64 encoded content of a .pem or .crt file. containing the client public key (for 2-way SSL).
- ssl_
client_ strkeystash - (Updatable) The base64 encoded keystash file which contains the encrypted password to the key database file. Deprecated: This field is deprecated and replaced by "sslClientKeystashSecretId". This field will be removed after February 15 2026.
- ssl_
client_ strkeystash_ secret_ id - (Updatable) The OCID of the Secret where the keystash file is stored, which contains the encrypted password to the key database file. Note: When provided, 'sslClientKeystash' field must not be provided.
- ssl_
client_ strkeystoredb - (Updatable) The base64 encoded keystore file created at the client containing the server certificate / CA root certificate. Deprecated: This field is deprecated and replaced by "sslClientKeystoredbSecretId". This field will be removed after February 15 2026.
- ssl_
client_ strkeystoredb_ secret_ id - (Updatable) The OCID of the Secret where the keystore file stored, which created at the client containing the server certificate / CA root certificate. Note: When provided, 'sslClientKeystoredb' field must not be provided.
- ssl_
crl str - (Updatable) The base64 encoded list of certificates revoked by the trusted certificate authorities (Trusted CA). Note: This is an optional property and only applicable if TLS/MTLS option is selected.
- ssl_
key str - (Updatable) Client Key - The base64 encoded content of a .pem or .crt file containing the client private key (for 2-way SSL). Deprecated: This field is deprecated and replaced by "sslKeySecretId". This field will be removed after February 15 2026.
- ssl_
key_ strpassword - (Updatable) The password for the cert inside of the KeyStore. In case it differs from the KeyStore password, it should be provided. Deprecated: This field is deprecated and replaced by "sslKeyPasswordSecretId". This field will be removed after February 15 2026.
- ssl_
key_ strpassword_ secret_ id - (Updatable) The OCID of the Secret where the password is stored for the cert inside of the Keystore. In case it differs from the KeyStore password, it should be provided. Note: When provided, 'sslKeyPassword' field must not be provided.
- ssl_
key_ strsecret_ id - (Updatable) The OCID of the Secret that stores the Client Key
- The content of a .pem or .crt file containing the client private key (for 2-way SSL). Note: When provided, 'sslKey' field must not be provided.
- ssl_
mode str - (Updatable) SSL modes for PostgreSQL.
- ssl_
server_ strcertificate - (Updatable) The base64 encoded file which contains the self-signed server certificate / Certificate Authority (CA) certificate.
- storage_
credential_ strname - (Updatable) Optional. External storage credential name to access files on object storage such as ADLS Gen2, S3 or GCS.
- stream_
pool_ strid - (Updatable) The OCID of the stream pool being referenced.
- subnet_
id str - (Updatable) The OCID of the target subnet of the dedicated connection.
- tenancy_
id str - (Updatable) The OCID of the related Oracle Cloud Infrastructure tenancy.
- tenant_
id str - (Updatable) Azure tenant ID of the application. e.g.: 14593954-d337-4a61-a364-9f758c64f97f
- tls_
ca_ strfile - (Updatable) Database Certificate - The base64 encoded content of a .pem file, containing the server public key (for 1 and 2-way SSL).
- tls_
certificate_ strkey_ file - (Updatable) Client Certificate - The base64 encoded content of a .pem file, containing the client public key (for 2-way SSL). Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFileSecretId". This field will be removed after February 15 2026.
- tls_
certificate_ strkey_ file_ password - (Updatable) Client Certificate key file password. Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFilePasswordSecretId". This field will be removed after February 15 2026.
- tls_
certificate_ strkey_ file_ password_ secret_ id - (Updatable) The OCID of the Secret that stores the password of the tls certificate key file. Note: When provided, 'tlsCertificateKeyFilePassword' field must not be provided.
- tls_
certificate_ strkey_ file_ secret_ id - (Updatable) The OCID of the Secret that stores the certificate key file of the mtls connection.
- The content of a .pem file containing the client private key (for 2-way SSL). Note: When provided, 'tlsCertificateKeyFile' field must not be provided.
- trigger_
refresh bool (Updatable) If value is true, it triggers connection refresh action and this attribute change will always show up in the "update" plan and will apply steps in order to refresh secrets and dependent service properties (such as ADB connection strings, wallets, etc..).
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- trust_
store str - (Updatable) The base64 encoded content of the TrustStore file. Deprecated: This field is deprecated and replaced by "trustStoreSecretId". This field will be removed after February 15 2026.
- trust_
store_ strpassword - (Updatable) The TrustStore password. Deprecated: This field is deprecated and replaced by "trustStorePasswordSecretId". This field will be removed after February 15 2026.
- trust_
store_ strpassword_ secret_ id - (Updatable) The OCID of the Secret where the kafka Ssl TrustStore password is stored. Note: When provided, 'trustStorePassword' field must not be provided.
- trust_
store_ strsecret_ id - (Updatable) The OCID of the Secret where the content of the TrustStore file is stored. Note: When provided, 'trustStore' field must not be provided.
- url str
- (Updatable) Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'
- user_
id str - (Updatable) The OCID of the Oracle Cloud Infrastructure user who will access the Oracle NoSQL database. The user must have write access to the table they want to connect to. If the user is not provided, backend will default to the user who is calling the API endpoint.
- username str
- (Updatable) The username Oracle GoldenGate uses to connect the associated system of the given technology. This username must already exist and be available by the system/application to be connected to and must conform to the case sensitivty requirments defined in it.
- vault_
id str - (Updatable) Refers to the customer's vault OCID. If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate to manage secrets contained within this vault.
- wallet str
- (Updatable) The wallet contents Oracle GoldenGate uses to make connections to a database. This attribute is expected to be base64 encoded. Deprecated: This field is deprecated and replaced by "walletSecretId". This field will be removed after February 15 2026.
- wallet_
secret_ strid - (Updatable) The OCID of the Secret where the wallet file is stored. The wallet contents Oracle GoldenGate uses to make connections to a database. Note: When provided, 'wallet' field must not be provided.
- compartment
Id String - (Updatable) The OCID of the compartment being referenced.
- connection
Type String - (Updatable) The connection type.
- display
Name String - (Updatable) An object's Display Name.
- technology
Type String - The Kafka (e.g. Confluent) Schema Registry technology type.
- access
Key StringId - (Updatable) Access key ID to access the Amazon S3 bucket. e.g.: "this-is-not-the-secret"
- account
Key String - (Updatable) Azure storage account key. This property is required when 'authenticationType' is set to 'SHARED_KEY'. e.g.: pa3WbhVATzj56xD4DH1VjOUhApRGEGHvOo58eQJVWIzX+j8j4CUVFcTjpIqDSRaSa1Wo2LbWY5at+AStEgLOIQ== Deprecated: This field is deprecated and replaced by "accountKeySecretId". This field will be removed after February 15 2026.
- account
Key StringSecret Id - (Updatable) The OCID of the Secret where the account key is stored. Note: When provided, 'accountKey' field must not be provided.
- account
Name String - (Updatable) Sets the Azure storage account name.
- additional
Attributes List<Property Map> - (Updatable) An array of name-value pair attribute entries. Used as additional parameters in connection string.
- authentication
Mode String - (Updatable) Authentication mode. It can be provided at creation of Oracle Autonomous Database Serverless connections, when a databaseId is provided. The default value is MTLS.
- authentication
Type String - (Updatable) Authentication type for Java Message Service. If not provided, default is NONE. Optional until 2024-06-27, in the release after it will be made required.
- azure
Tenant StringId - (Updatable) 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 List<Property Map> - (Updatable) 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 String - (Updatable) 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 String - (Updatable) Azure client secret (aka application password) for authentication. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: dO29Q~F5-VwnA.lZdd11xFF_t5NAXCaGwDl9NbT1 Deprecated: This field is deprecated and replaced by "clientSecretSecretId". This field will be removed after February 15 2026.
- client
Secret StringSecret Id - (Updatable) The OCID of the Secret where the client secret is stored. Only applicable for authenticationType == OAUTH_M2M. Note: When provided, 'clientSecret' field must not be provided.
- connection
Factory String - (Updatable) The of Java class implementing javax.jms.ConnectionFactory interface supplied by the Java Message Service provider. e.g.: 'com.stc.jmsjca.core.JConnectionFactoryXA'
- connection
String String - (Updatable) Connection string. AZURE_SYNAPSE_ANALYTICS e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;', MONGODB e.g.: 'mongodb://mongodb0.example.com:27017/recordsrecords'.
- connection
Url String - (Updatable) Connection URL. e.g.: 'jdbc:databricks://adb-33934.4.azuredatabricks.net:443/default;transportMode=http;ssl=1;httpPath=sql/protocolv1/o/3393########44/0##3-7-hlrb'
- consumer
Properties String - (Updatable) The base64 encoded content of the consumer.properties file.
- core
Site StringXml - (Updatable) The base64 encoded content of the Hadoop Distributed File System configuration file (core-site.xml).
- database
Id String - (Updatable) The OCID of the Oracle Autonomous Json Database.
- database
Name String - (Updatable) The name of the database.
- db
System StringId - (Updatable) The OCID of the database system being referenced.
- Map<String>
- (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - deployment
Id String - (Updatable) The OCID of the deployment being referenced.
- description String
- (Updatable) Metadata about this specific object.
- does
Use BooleanSecret Ids - (Updatable) Indicates that sensitive attributes are provided via Secrets.
- endpoint String
- (Updatable)Azure Storage service endpoint. e.g: https://test.blob.core.windows.net, Optional Microsoft Fabric service endpoint. Default value: https://onelake.dfs.fabric.microsoft.com
- fingerprint String
- (Updatable) Fingerprint required by TLS security protocol. Eg.: '6152b2dfbff200f973c5074a5b91d06ab3b472c07c09a1ea57bb7fd406cdce9c'
- Map<String>
- (Updatable) 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
- (Updatable) The name or address of a host. In case of Generic connection type host and port separated by colon. Example:
"server.example.com:1234"For multiple hosts, provide a comma separated list. Example:"server1.example.com:1000,server1.example.com:2000" - is
Lock BooleanOverride - jndi
Connection StringFactory - (Updatable) The Connection Factory can be looked up using this name. e.g.: 'ConnectionFactory'
- jndi
Initial StringContext Factory - (Updatable) The implementation of javax.naming.spi.InitialContextFactory interface that the client uses to obtain initial naming context. e.g.: 'org.apache.activemq.jndi.ActiveMQInitialContextFactory'
- jndi
Provider StringUrl - (Updatable) The URL that Java Message Service will use to contact the JNDI provider. e.g.: 'tcp://myjms.host.domain:61616?jms.prefetchPolicy.all=1000'
- jndi
Security StringCredentials - (Updatable) The password associated to the principal. Deprecated: This field is deprecated and replaced by "jndiSecurityCredentialsSecretId". This field will be removed after February 15 2026.
- jndi
Security StringCredentials Secret Id - (Updatable) The OCID of the Secret where the security credentials are stored associated to the principal. Note: When provided, 'jndiSecurityCredentials' field must not be provided.
- jndi
Security StringPrincipal - (Updatable) Specifies the identity of the principal (user) to be authenticated. e.g.: 'admin2'
- key
Id String - (Updatable) Refers to the customer's master key OCID. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
- key
Store String - (Updatable) The base64 encoded content of the KeyStore file. Deprecated: This field is deprecated and replaced by "keyStoreSecretId". This field will be removed after February 15 2026.
- key
Store StringPassword - (Updatable) The KeyStore password. Deprecated: This field is deprecated and replaced by "keyStorePasswordSecretId". This field will be removed after February 15 2026.
- key
Store StringPassword Secret Id - (Updatable) The OCID of the Secret where the kafka Ssl KeyStore password is stored. Note: When provided, 'keyStorePassword' field must not be provided.
- key
Store StringSecret Id - (Updatable) The OCID of the Secret where the content of the KeyStore file is stored. Note: When provided, 'keyStore' field must not be provided.
- locks List<Property Map>
- Locks associated with this resource.
- nsg
Ids List<String> - (Updatable) An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
- password String
- (Updatable) The password Oracle GoldenGate uses to connect the associated system of the given technology. It must conform to the specific security requirements including length, case sensitivity, and so on. Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
- password
Secret StringId - (Updatable) The OCID of the Secret where the password is stored. The password Oracle GoldenGate uses to connect the associated system of the given technology. It must conform to the specific security requirements including length, case sensitivity, and so on. If secretId is used plaintext field must not be provided. Note: When provided, 'password' field must not be provided.
- port Number
- (Updatable) The port of an endpoint usually specified for a connection.
- private
Ip String (Updatable) Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host field, or make sure the host name is resolvable in the target VCN.
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 StringFile - (Updatable) The base64 encoded content of the private key file (PEM file) corresponding to the API key of the fingerprint. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm Deprecated: This field is deprecated and replaced by "privateKeyFileSecretId". This field will be removed after February 15 2026.
- private
Key StringFile Secret Id - (Updatable) The OCID of the Secret that stores the content of the private key file (PEM file) corresponding to the API key of the fingerprint. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm Note: When provided, 'privateKeyFile' field must not be provided.
- private
Key StringPassphrase - (Updatable) Password if the private key file is encrypted. Deprecated: This field is deprecated and replaced by "privateKeyPassphraseSecretId". This field will be removed after February 15 2026.
- private
Key StringPassphrase Secret Id - (Updatable) The OCID of the Secret that stores the password for the private key file. Note: When provided, 'privateKeyPassphrase' field must not be provided.
- producer
Properties String - (Updatable) The base64 encoded content of the producer.properties file.
- public
Key StringFingerprint - (Updatable) The fingerprint of the API Key of the user specified by the userId. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm
- redis
Cluster StringId - (Updatable) The OCID of the Redis cluster.
- region String
- (Updatable) The name of the region. e.g.: us-ashburn-1 If the region is not provided, backend will default to the default region.
- routing
Method String - (Updatable) Controls the network traffic direction to the target: SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets. SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet. DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
- sas
Token String - (Updatable) Credential that uses a shared access signature (SAS) to authenticate to an Azure Service. This property is required when 'authenticationType' is set to 'SHARED_ACCESS_SIGNATURE'. e.g.: ?sv=2020-06-08&ss=bfqt&srt=sco&sp=rwdlacupyx&se=2020-09-10T20:27:28Z&st=2022-08-05T12:27:28Z&spr=https&sig=C1IgHsiLBmTSStYkXXGLTP8it0xBrArcgCqOsZbXwIQ%3D Deprecated: This field is deprecated and replaced by "sasTokenSecretId". This field will be removed after February 15 2026.
- sas
Token StringSecret Id - (Updatable) The OCID of the Secret where the sas token is stored. Note: When provided, 'sasToken' field must not be provided.
- secret
Access StringKey - (Updatable) Secret access key to access the Amazon S3 bucket. e.g.: "this-is-not-the-secret" Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". This field will be removed after February 15 2026.
- secret
Access StringKey Secret Id - (Updatable) The OCID of the Secret where the secret access key is stored. Note: When provided, 'secretAccessKey' field must not be provided.
- security
Protocol String - (Updatable) Security protocol for Java Message Service. If not provided, default is PLAIN. Optional until 2024-06-27, in the release after it will be made required.
- servers String
- (Updatable) Comma separated list of Elasticsearch server addresses, specified as host:port entries, where :port is optional. If port is not specified, it defaults to 9200. Used for establishing the initial connection to the Elasticsearch cluster. Example:
"server1.example.com:4000,server2.example.com:4000" - service
Account StringKey File - (Updatable) The base64 encoded content of the service account key file containing the credentials required to use Google Cloud Storage. Deprecated: This field is deprecated and replaced by "serviceAccountKeyFileSecretId". This field will be removed after February 15 2026.
- service
Account StringKey File Secret Id - (Updatable) The OCID of the Secret where the content of the service account key file is stored, which containing the credentials required to use Google Cloud Storage. Note: When provided, 'serviceAccountKeyFile' field must not be provided.
- session
Mode String - (Updatable) 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.
- should
Use BooleanJndi - (Updatable) If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.
- should
Use BooleanResource Principal - (Updatable) Indicates that the user intents to connect to the instance through resource principal.
- should
Validate BooleanServer Certificate - (Updatable) If set to true, the driver validates the certificate that is sent by the database server.
- ssl
Ca String - (Updatable) The base64 encoded certificate of the trusted certificate authorities (Trusted CA) for PostgreSQL. The supported file formats are .pem and .crt.
- ssl
Cert String - (Updatable) Client Certificate - The base64 encoded content of a .pem or .crt file. containing the client public key (for 2-way SSL).
- ssl
Client StringKeystash - (Updatable) The base64 encoded keystash file which contains the encrypted password to the key database file. Deprecated: This field is deprecated and replaced by "sslClientKeystashSecretId". This field will be removed after February 15 2026.
- ssl
Client StringKeystash Secret Id - (Updatable) The OCID of the Secret where the keystash file is stored, which contains the encrypted password to the key database file. Note: When provided, 'sslClientKeystash' field must not be provided.
- ssl
Client StringKeystoredb - (Updatable) The base64 encoded keystore file created at the client containing the server certificate / CA root certificate. Deprecated: This field is deprecated and replaced by "sslClientKeystoredbSecretId". This field will be removed after February 15 2026.
- ssl
Client StringKeystoredb Secret Id - (Updatable) The OCID of the Secret where the keystore file stored, which created at the client containing the server certificate / CA root certificate. Note: When provided, 'sslClientKeystoredb' field must not be provided.
- ssl
Crl String - (Updatable) The base64 encoded list of certificates revoked by the trusted certificate authorities (Trusted CA). Note: This is an optional property and only applicable if TLS/MTLS option is selected.
- ssl
Key String - (Updatable) Client Key - The base64 encoded content of a .pem or .crt file containing the client private key (for 2-way SSL). Deprecated: This field is deprecated and replaced by "sslKeySecretId". This field will be removed after February 15 2026.
- ssl
Key StringPassword - (Updatable) The password for the cert inside of the KeyStore. In case it differs from the KeyStore password, it should be provided. Deprecated: This field is deprecated and replaced by "sslKeyPasswordSecretId". This field will be removed after February 15 2026.
- ssl
Key StringPassword Secret Id - (Updatable) The OCID of the Secret where the password is stored for the cert inside of the Keystore. In case it differs from the KeyStore password, it should be provided. Note: When provided, 'sslKeyPassword' field must not be provided.
- ssl
Key StringSecret Id - (Updatable) The OCID of the Secret that stores the Client Key
- The content of a .pem or .crt file containing the client private key (for 2-way SSL). Note: When provided, 'sslKey' field must not be provided.
- ssl
Mode String - (Updatable) SSL modes for PostgreSQL.
- ssl
Server StringCertificate - (Updatable) The base64 encoded file which contains the self-signed server certificate / Certificate Authority (CA) certificate.
- storage
Credential StringName - (Updatable) Optional. External storage credential name to access files on object storage such as ADLS Gen2, S3 or GCS.
- stream
Pool StringId - (Updatable) The OCID of the stream pool being referenced.
- subnet
Id String - (Updatable) The OCID of the target subnet of the dedicated connection.
- tenancy
Id String - (Updatable) The OCID of the related Oracle Cloud Infrastructure tenancy.
- tenant
Id String - (Updatable) Azure tenant ID of the application. e.g.: 14593954-d337-4a61-a364-9f758c64f97f
- tls
Ca StringFile - (Updatable) Database Certificate - The base64 encoded content of a .pem file, containing the server public key (for 1 and 2-way SSL).
- tls
Certificate StringKey File - (Updatable) Client Certificate - The base64 encoded content of a .pem file, containing the client public key (for 2-way SSL). Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFileSecretId". This field will be removed after February 15 2026.
- tls
Certificate StringKey File Password - (Updatable) Client Certificate key file password. Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFilePasswordSecretId". This field will be removed after February 15 2026.
- tls
Certificate StringKey File Password Secret Id - (Updatable) The OCID of the Secret that stores the password of the tls certificate key file. Note: When provided, 'tlsCertificateKeyFilePassword' field must not be provided.
- tls
Certificate StringKey File Secret Id - (Updatable) The OCID of the Secret that stores the certificate key file of the mtls connection.
- The content of a .pem file containing the client private key (for 2-way SSL). Note: When provided, 'tlsCertificateKeyFile' field must not be provided.
- trigger
Refresh Boolean (Updatable) If value is true, it triggers connection refresh action and this attribute change will always show up in the "update" plan and will apply steps in order to refresh secrets and dependent service properties (such as ADB connection strings, wallets, etc..).
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- trust
Store String - (Updatable) The base64 encoded content of the TrustStore file. Deprecated: This field is deprecated and replaced by "trustStoreSecretId". This field will be removed after February 15 2026.
- trust
Store StringPassword - (Updatable) The TrustStore password. Deprecated: This field is deprecated and replaced by "trustStorePasswordSecretId". This field will be removed after February 15 2026.
- trust
Store StringPassword Secret Id - (Updatable) The OCID of the Secret where the kafka Ssl TrustStore password is stored. Note: When provided, 'trustStorePassword' field must not be provided.
- trust
Store StringSecret Id - (Updatable) The OCID of the Secret where the content of the TrustStore file is stored. Note: When provided, 'trustStore' field must not be provided.
- url String
- (Updatable) Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'
- user
Id String - (Updatable) The OCID of the Oracle Cloud Infrastructure user who will access the Oracle NoSQL database. The user must have write access to the table they want to connect to. If the user is not provided, backend will default to the user who is calling the API endpoint.
- username String
- (Updatable) The username Oracle GoldenGate uses to connect the associated system of the given technology. This username must already exist and be available by the system/application to be connected to and must conform to the case sensitivty requirments defined in it.
- vault
Id String - (Updatable) Refers to the customer's vault OCID. If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate to manage secrets contained within this vault.
- wallet String
- (Updatable) The wallet contents Oracle GoldenGate uses to make connections to a database. This attribute is expected to be base64 encoded. Deprecated: This field is deprecated and replaced by "walletSecretId". This field will be removed after February 15 2026.
- wallet
Secret StringId - (Updatable) The OCID of the Secret where the wallet file is stored. The wallet contents Oracle GoldenGate uses to make connections to a database. Note: When provided, 'wallet' field must not be provided.
Outputs
All input properties are implicitly available as output properties. Additionally, the Connection resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Ingress
Ips List<ConnectionIngress Ip> - List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp. Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
- Lifecycle
Details 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.
- State string
- Possible lifecycle states for connection.
- Dictionary<string, string>
- 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}} - Time
Created string - The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - Time
Updated string - The time the resource was last updated. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z.
- Id string
- The provider-assigned unique ID for this managed resource.
- Ingress
Ips []ConnectionIngress Ip - List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp. Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
- Lifecycle
Details 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.
- State string
- Possible lifecycle states for connection.
- map[string]string
- 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}} - Time
Created string - The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - Time
Updated string - The time the resource was last updated. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z.
- id String
- The provider-assigned unique ID for this managed resource.
- ingress
Ips List<ConnectionIngress Ip> - List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp. Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
- lifecycle
Details 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.
- state String
- Possible lifecycle states for connection.
- Map<String,String>
- 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}} - time
Created String - The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - time
Updated String - The time the resource was last updated. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z.
- id string
- The provider-assigned unique ID for this managed resource.
- ingress
Ips ConnectionIngress Ip[] - List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp. Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
- lifecycle
Details 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.
- state string
- Possible lifecycle states for connection.
- {[key: string]: string}
- 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}} - time
Created string - The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - time
Updated string - The time the resource was last updated. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z.
- id str
- The provider-assigned unique ID for this managed resource.
- ingress_
ips Sequence[ConnectionIngress Ip] - List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp. Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
- 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.
- state str
- Possible lifecycle states for connection.
- Mapping[str, str]
- 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}} - 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.
- id String
- The provider-assigned unique ID for this managed resource.
- ingress
Ips List<Property Map> - List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp. Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
- lifecycle
Details 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.
- state String
- Possible lifecycle states for connection.
- Map<String>
- 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}} - time
Created String - The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - time
Updated String - The time the resource was last updated. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z.
Look up Existing Connection Resource
Get an existing Connection resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ConnectionState, opts?: CustomResourceOptions): Connection@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
access_key_id: Optional[str] = None,
account_key: Optional[str] = None,
account_key_secret_id: Optional[str] = None,
account_name: Optional[str] = None,
additional_attributes: Optional[Sequence[ConnectionAdditionalAttributeArgs]] = None,
authentication_mode: Optional[str] = None,
authentication_type: Optional[str] = None,
azure_tenant_id: Optional[str] = None,
bootstrap_servers: Optional[Sequence[ConnectionBootstrapServerArgs]] = None,
client_id: Optional[str] = None,
client_secret: Optional[str] = None,
client_secret_secret_id: Optional[str] = None,
compartment_id: Optional[str] = None,
connection_factory: Optional[str] = None,
connection_string: Optional[str] = None,
connection_type: Optional[str] = None,
connection_url: Optional[str] = None,
consumer_properties: Optional[str] = None,
core_site_xml: Optional[str] = None,
database_id: Optional[str] = None,
database_name: Optional[str] = None,
db_system_id: Optional[str] = None,
defined_tags: Optional[Mapping[str, str]] = None,
deployment_id: Optional[str] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
does_use_secret_ids: Optional[bool] = None,
endpoint: Optional[str] = None,
fingerprint: Optional[str] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
host: Optional[str] = None,
ingress_ips: Optional[Sequence[ConnectionIngressIpArgs]] = None,
is_lock_override: Optional[bool] = None,
jndi_connection_factory: Optional[str] = None,
jndi_initial_context_factory: Optional[str] = None,
jndi_provider_url: Optional[str] = None,
jndi_security_credentials: Optional[str] = None,
jndi_security_credentials_secret_id: Optional[str] = None,
jndi_security_principal: Optional[str] = None,
key_id: Optional[str] = None,
key_store: Optional[str] = None,
key_store_password: Optional[str] = None,
key_store_password_secret_id: Optional[str] = None,
key_store_secret_id: Optional[str] = None,
lifecycle_details: Optional[str] = None,
locks: Optional[Sequence[ConnectionLockArgs]] = None,
nsg_ids: Optional[Sequence[str]] = None,
password: Optional[str] = None,
password_secret_id: Optional[str] = None,
port: Optional[int] = None,
private_ip: Optional[str] = None,
private_key_file: Optional[str] = None,
private_key_file_secret_id: Optional[str] = None,
private_key_passphrase: Optional[str] = None,
private_key_passphrase_secret_id: Optional[str] = None,
producer_properties: Optional[str] = None,
public_key_fingerprint: Optional[str] = None,
redis_cluster_id: Optional[str] = None,
region: Optional[str] = None,
routing_method: Optional[str] = None,
sas_token: Optional[str] = None,
sas_token_secret_id: Optional[str] = None,
secret_access_key: Optional[str] = None,
secret_access_key_secret_id: Optional[str] = None,
security_protocol: Optional[str] = None,
servers: Optional[str] = None,
service_account_key_file: Optional[str] = None,
service_account_key_file_secret_id: Optional[str] = None,
session_mode: Optional[str] = None,
should_use_jndi: Optional[bool] = None,
should_use_resource_principal: Optional[bool] = None,
should_validate_server_certificate: Optional[bool] = None,
ssl_ca: Optional[str] = None,
ssl_cert: Optional[str] = None,
ssl_client_keystash: Optional[str] = None,
ssl_client_keystash_secret_id: Optional[str] = None,
ssl_client_keystoredb: Optional[str] = None,
ssl_client_keystoredb_secret_id: Optional[str] = None,
ssl_crl: Optional[str] = None,
ssl_key: Optional[str] = None,
ssl_key_password: Optional[str] = None,
ssl_key_password_secret_id: Optional[str] = None,
ssl_key_secret_id: Optional[str] = None,
ssl_mode: Optional[str] = None,
ssl_server_certificate: Optional[str] = None,
state: Optional[str] = None,
storage_credential_name: Optional[str] = None,
stream_pool_id: Optional[str] = None,
subnet_id: Optional[str] = None,
system_tags: Optional[Mapping[str, str]] = None,
technology_type: Optional[str] = None,
tenancy_id: Optional[str] = None,
tenant_id: Optional[str] = None,
time_created: Optional[str] = None,
time_updated: Optional[str] = None,
tls_ca_file: Optional[str] = None,
tls_certificate_key_file: Optional[str] = None,
tls_certificate_key_file_password: Optional[str] = None,
tls_certificate_key_file_password_secret_id: Optional[str] = None,
tls_certificate_key_file_secret_id: Optional[str] = None,
trigger_refresh: Optional[bool] = None,
trust_store: Optional[str] = None,
trust_store_password: Optional[str] = None,
trust_store_password_secret_id: Optional[str] = None,
trust_store_secret_id: Optional[str] = None,
url: Optional[str] = None,
user_id: Optional[str] = None,
username: Optional[str] = None,
vault_id: Optional[str] = None,
wallet: Optional[str] = None,
wallet_secret_id: Optional[str] = None) -> Connectionfunc GetConnection(ctx *Context, name string, id IDInput, state *ConnectionState, opts ...ResourceOption) (*Connection, error)public static Connection Get(string name, Input<string> id, ConnectionState? state, CustomResourceOptions? opts = null)public static Connection get(String name, Output<String> id, ConnectionState state, CustomResourceOptions options)resources: _: type: oci:GoldenGate:Connection get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Access
Key stringId - (Updatable) Access key ID to access the Amazon S3 bucket. e.g.: "this-is-not-the-secret"
- Account
Key string - (Updatable) Azure storage account key. This property is required when 'authenticationType' is set to 'SHARED_KEY'. e.g.: pa3WbhVATzj56xD4DH1VjOUhApRGEGHvOo58eQJVWIzX+j8j4CUVFcTjpIqDSRaSa1Wo2LbWY5at+AStEgLOIQ== Deprecated: This field is deprecated and replaced by "accountKeySecretId". This field will be removed after February 15 2026.
- Account
Key stringSecret Id - (Updatable) The OCID of the Secret where the account key is stored. Note: When provided, 'accountKey' field must not be provided.
- Account
Name string - (Updatable) Sets the Azure storage account name.
- Additional
Attributes List<ConnectionAdditional Attribute> - (Updatable) An array of name-value pair attribute entries. Used as additional parameters in connection string.
- Authentication
Mode string - (Updatable) Authentication mode. It can be provided at creation of Oracle Autonomous Database Serverless connections, when a databaseId is provided. The default value is MTLS.
- Authentication
Type string - (Updatable) Authentication type for Java Message Service. If not provided, default is NONE. Optional until 2024-06-27, in the release after it will be made required.
- Azure
Tenant stringId - (Updatable) 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 List<ConnectionBootstrap Server> - (Updatable) 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 string - (Updatable) 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 string - (Updatable) Azure client secret (aka application password) for authentication. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: dO29Q~F5-VwnA.lZdd11xFF_t5NAXCaGwDl9NbT1 Deprecated: This field is deprecated and replaced by "clientSecretSecretId". This field will be removed after February 15 2026.
- Client
Secret stringSecret Id - (Updatable) The OCID of the Secret where the client secret is stored. Only applicable for authenticationType == OAUTH_M2M. Note: When provided, 'clientSecret' field must not be provided.
- Compartment
Id string - (Updatable) The OCID of the compartment being referenced.
- Connection
Factory string - (Updatable) The of Java class implementing javax.jms.ConnectionFactory interface supplied by the Java Message Service provider. e.g.: 'com.stc.jmsjca.core.JConnectionFactoryXA'
- Connection
String string - (Updatable) Connection string. AZURE_SYNAPSE_ANALYTICS e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;', MONGODB e.g.: 'mongodb://mongodb0.example.com:27017/recordsrecords'.
- Connection
Type string - (Updatable) The connection type.
- Connection
Url string - (Updatable) Connection URL. e.g.: 'jdbc:databricks://adb-33934.4.azuredatabricks.net:443/default;transportMode=http;ssl=1;httpPath=sql/protocolv1/o/3393########44/0##3-7-hlrb'
- Consumer
Properties string - (Updatable) The base64 encoded content of the consumer.properties file.
- Core
Site stringXml - (Updatable) The base64 encoded content of the Hadoop Distributed File System configuration file (core-site.xml).
- Database
Id string - (Updatable) The OCID of the Oracle Autonomous Json Database.
- Database
Name string - (Updatable) The name of the database.
- Db
System stringId - (Updatable) The OCID of the database system being referenced.
- Dictionary<string, string>
- (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - Deployment
Id string - (Updatable) The OCID of the deployment being referenced.
- Description string
- (Updatable) Metadata about this specific object.
- Display
Name string - (Updatable) An object's Display Name.
- Does
Use boolSecret Ids - (Updatable) Indicates that sensitive attributes are provided via Secrets.
- Endpoint string
- (Updatable)Azure Storage service endpoint. e.g: https://test.blob.core.windows.net, Optional Microsoft Fabric service endpoint. Default value: https://onelake.dfs.fabric.microsoft.com
- Fingerprint string
- (Updatable) Fingerprint required by TLS security protocol. Eg.: '6152b2dfbff200f973c5074a5b91d06ab3b472c07c09a1ea57bb7fd406cdce9c'
- Dictionary<string, string>
- (Updatable) 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
- (Updatable) The name or address of a host. In case of Generic connection type host and port separated by colon. Example:
"server.example.com:1234"For multiple hosts, provide a comma separated list. Example:"server1.example.com:1000,server1.example.com:2000" - Ingress
Ips List<ConnectionIngress Ip> - List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp. Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
- Is
Lock boolOverride - Jndi
Connection stringFactory - (Updatable) The Connection Factory can be looked up using this name. e.g.: 'ConnectionFactory'
- Jndi
Initial stringContext Factory - (Updatable) The implementation of javax.naming.spi.InitialContextFactory interface that the client uses to obtain initial naming context. e.g.: 'org.apache.activemq.jndi.ActiveMQInitialContextFactory'
- Jndi
Provider stringUrl - (Updatable) The URL that Java Message Service will use to contact the JNDI provider. e.g.: 'tcp://myjms.host.domain:61616?jms.prefetchPolicy.all=1000'
- Jndi
Security stringCredentials - (Updatable) The password associated to the principal. Deprecated: This field is deprecated and replaced by "jndiSecurityCredentialsSecretId". This field will be removed after February 15 2026.
- Jndi
Security stringCredentials Secret Id - (Updatable) The OCID of the Secret where the security credentials are stored associated to the principal. Note: When provided, 'jndiSecurityCredentials' field must not be provided.
- Jndi
Security stringPrincipal - (Updatable) Specifies the identity of the principal (user) to be authenticated. e.g.: 'admin2'
- Key
Id string - (Updatable) Refers to the customer's master key OCID. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
- Key
Store string - (Updatable) The base64 encoded content of the KeyStore file. Deprecated: This field is deprecated and replaced by "keyStoreSecretId". This field will be removed after February 15 2026.
- Key
Store stringPassword - (Updatable) The KeyStore password. Deprecated: This field is deprecated and replaced by "keyStorePasswordSecretId". This field will be removed after February 15 2026.
- Key
Store stringPassword Secret Id - (Updatable) The OCID of the Secret where the kafka Ssl KeyStore password is stored. Note: When provided, 'keyStorePassword' field must not be provided.
- Key
Store stringSecret Id - (Updatable) The OCID of the Secret where the content of the KeyStore file is stored. Note: When provided, 'keyStore' field must not be provided.
- Lifecycle
Details 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.
- Locks
List<Connection
Lock> - Locks associated with this resource.
- Nsg
Ids List<string> - (Updatable) An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
- Password string
- (Updatable) The password Oracle GoldenGate uses to connect the associated system of the given technology. It must conform to the specific security requirements including length, case sensitivity, and so on. Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
- Password
Secret stringId - (Updatable) The OCID of the Secret where the password is stored. The password Oracle GoldenGate uses to connect the associated system of the given technology. It must conform to the specific security requirements including length, case sensitivity, and so on. If secretId is used plaintext field must not be provided. Note: When provided, 'password' field must not be provided.
- Port int
- (Updatable) The port of an endpoint usually specified for a connection.
- Private
Ip string (Updatable) Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host field, or make sure the host name is resolvable in the target VCN.
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 stringFile - (Updatable) The base64 encoded content of the private key file (PEM file) corresponding to the API key of the fingerprint. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm Deprecated: This field is deprecated and replaced by "privateKeyFileSecretId". This field will be removed after February 15 2026.
- Private
Key stringFile Secret Id - (Updatable) The OCID of the Secret that stores the content of the private key file (PEM file) corresponding to the API key of the fingerprint. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm Note: When provided, 'privateKeyFile' field must not be provided.
- Private
Key stringPassphrase - (Updatable) Password if the private key file is encrypted. Deprecated: This field is deprecated and replaced by "privateKeyPassphraseSecretId". This field will be removed after February 15 2026.
- Private
Key stringPassphrase Secret Id - (Updatable) The OCID of the Secret that stores the password for the private key file. Note: When provided, 'privateKeyPassphrase' field must not be provided.
- Producer
Properties string - (Updatable) The base64 encoded content of the producer.properties file.
- Public
Key stringFingerprint - (Updatable) The fingerprint of the API Key of the user specified by the userId. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm
- Redis
Cluster stringId - (Updatable) The OCID of the Redis cluster.
- Region string
- (Updatable) The name of the region. e.g.: us-ashburn-1 If the region is not provided, backend will default to the default region.
- Routing
Method string - (Updatable) Controls the network traffic direction to the target: SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets. SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet. DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
- Sas
Token string - (Updatable) Credential that uses a shared access signature (SAS) to authenticate to an Azure Service. This property is required when 'authenticationType' is set to 'SHARED_ACCESS_SIGNATURE'. e.g.: ?sv=2020-06-08&ss=bfqt&srt=sco&sp=rwdlacupyx&se=2020-09-10T20:27:28Z&st=2022-08-05T12:27:28Z&spr=https&sig=C1IgHsiLBmTSStYkXXGLTP8it0xBrArcgCqOsZbXwIQ%3D Deprecated: This field is deprecated and replaced by "sasTokenSecretId". This field will be removed after February 15 2026.
- Sas
Token stringSecret Id - (Updatable) The OCID of the Secret where the sas token is stored. Note: When provided, 'sasToken' field must not be provided.
- Secret
Access stringKey - (Updatable) Secret access key to access the Amazon S3 bucket. e.g.: "this-is-not-the-secret" Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". This field will be removed after February 15 2026.
- Secret
Access stringKey Secret Id - (Updatable) The OCID of the Secret where the secret access key is stored. Note: When provided, 'secretAccessKey' field must not be provided.
- Security
Protocol string - (Updatable) Security protocol for Java Message Service. If not provided, default is PLAIN. Optional until 2024-06-27, in the release after it will be made required.
- Servers string
- (Updatable) Comma separated list of Elasticsearch server addresses, specified as host:port entries, where :port is optional. If port is not specified, it defaults to 9200. Used for establishing the initial connection to the Elasticsearch cluster. Example:
"server1.example.com:4000,server2.example.com:4000" - Service
Account stringKey File - (Updatable) The base64 encoded content of the service account key file containing the credentials required to use Google Cloud Storage. Deprecated: This field is deprecated and replaced by "serviceAccountKeyFileSecretId". This field will be removed after February 15 2026.
- Service
Account stringKey File Secret Id - (Updatable) The OCID of the Secret where the content of the service account key file is stored, which containing the credentials required to use Google Cloud Storage. Note: When provided, 'serviceAccountKeyFile' field must not be provided.
- Session
Mode string - (Updatable) 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.
- Should
Use boolJndi - (Updatable) If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.
- Should
Use boolResource Principal - (Updatable) Indicates that the user intents to connect to the instance through resource principal.
- Should
Validate boolServer Certificate - (Updatable) If set to true, the driver validates the certificate that is sent by the database server.
- Ssl
Ca string - (Updatable) The base64 encoded certificate of the trusted certificate authorities (Trusted CA) for PostgreSQL. The supported file formats are .pem and .crt.
- Ssl
Cert string - (Updatable) Client Certificate - The base64 encoded content of a .pem or .crt file. containing the client public key (for 2-way SSL).
- Ssl
Client stringKeystash - (Updatable) The base64 encoded keystash file which contains the encrypted password to the key database file. Deprecated: This field is deprecated and replaced by "sslClientKeystashSecretId". This field will be removed after February 15 2026.
- Ssl
Client stringKeystash Secret Id - (Updatable) The OCID of the Secret where the keystash file is stored, which contains the encrypted password to the key database file. Note: When provided, 'sslClientKeystash' field must not be provided.
- Ssl
Client stringKeystoredb - (Updatable) The base64 encoded keystore file created at the client containing the server certificate / CA root certificate. Deprecated: This field is deprecated and replaced by "sslClientKeystoredbSecretId". This field will be removed after February 15 2026.
- Ssl
Client stringKeystoredb Secret Id - (Updatable) The OCID of the Secret where the keystore file stored, which created at the client containing the server certificate / CA root certificate. Note: When provided, 'sslClientKeystoredb' field must not be provided.
- Ssl
Crl string - (Updatable) The base64 encoded list of certificates revoked by the trusted certificate authorities (Trusted CA). Note: This is an optional property and only applicable if TLS/MTLS option is selected.
- Ssl
Key string - (Updatable) Client Key - The base64 encoded content of a .pem or .crt file containing the client private key (for 2-way SSL). Deprecated: This field is deprecated and replaced by "sslKeySecretId". This field will be removed after February 15 2026.
- Ssl
Key stringPassword - (Updatable) The password for the cert inside of the KeyStore. In case it differs from the KeyStore password, it should be provided. Deprecated: This field is deprecated and replaced by "sslKeyPasswordSecretId". This field will be removed after February 15 2026.
- Ssl
Key stringPassword Secret Id - (Updatable) The OCID of the Secret where the password is stored for the cert inside of the Keystore. In case it differs from the KeyStore password, it should be provided. Note: When provided, 'sslKeyPassword' field must not be provided.
- Ssl
Key stringSecret Id - (Updatable) The OCID of the Secret that stores the Client Key
- The content of a .pem or .crt file containing the client private key (for 2-way SSL). Note: When provided, 'sslKey' field must not be provided.
- Ssl
Mode string - (Updatable) SSL modes for PostgreSQL.
- Ssl
Server stringCertificate - (Updatable) The base64 encoded file which contains the self-signed server certificate / Certificate Authority (CA) certificate.
- State string
- Possible lifecycle states for connection.
- Storage
Credential stringName - (Updatable) Optional. External storage credential name to access files on object storage such as ADLS Gen2, S3 or GCS.
- Stream
Pool stringId - (Updatable) The OCID of the stream pool being referenced.
- Subnet
Id string - (Updatable) The OCID of the target subnet of the dedicated connection.
- Dictionary<string, string>
- 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 string - The Kafka (e.g. Confluent) Schema Registry technology type.
- Tenancy
Id string - (Updatable) The OCID of the related Oracle Cloud Infrastructure tenancy.
- Tenant
Id string - (Updatable) Azure tenant ID of the application. e.g.: 14593954-d337-4a61-a364-9f758c64f97f
- Time
Created string - The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - Time
Updated string - The time the resource was last updated. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - Tls
Ca stringFile - (Updatable) Database Certificate - The base64 encoded content of a .pem file, containing the server public key (for 1 and 2-way SSL).
- Tls
Certificate stringKey File - (Updatable) Client Certificate - The base64 encoded content of a .pem file, containing the client public key (for 2-way SSL). Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFileSecretId". This field will be removed after February 15 2026.
- Tls
Certificate stringKey File Password - (Updatable) Client Certificate key file password. Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFilePasswordSecretId". This field will be removed after February 15 2026.
- Tls
Certificate stringKey File Password Secret Id - (Updatable) The OCID of the Secret that stores the password of the tls certificate key file. Note: When provided, 'tlsCertificateKeyFilePassword' field must not be provided.
- Tls
Certificate stringKey File Secret Id - (Updatable) The OCID of the Secret that stores the certificate key file of the mtls connection.
- The content of a .pem file containing the client private key (for 2-way SSL). Note: When provided, 'tlsCertificateKeyFile' field must not be provided.
- Trigger
Refresh bool (Updatable) If value is true, it triggers connection refresh action and this attribute change will always show up in the "update" plan and will apply steps in order to refresh secrets and dependent service properties (such as ADB connection strings, wallets, etc..).
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Trust
Store string - (Updatable) The base64 encoded content of the TrustStore file. Deprecated: This field is deprecated and replaced by "trustStoreSecretId". This field will be removed after February 15 2026.
- Trust
Store stringPassword - (Updatable) The TrustStore password. Deprecated: This field is deprecated and replaced by "trustStorePasswordSecretId". This field will be removed after February 15 2026.
- Trust
Store stringPassword Secret Id - (Updatable) The OCID of the Secret where the kafka Ssl TrustStore password is stored. Note: When provided, 'trustStorePassword' field must not be provided.
- Trust
Store stringSecret Id - (Updatable) The OCID of the Secret where the content of the TrustStore file is stored. Note: When provided, 'trustStore' field must not be provided.
- Url string
- (Updatable) Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'
- User
Id string - (Updatable) The OCID of the Oracle Cloud Infrastructure user who will access the Oracle NoSQL database. The user must have write access to the table they want to connect to. If the user is not provided, backend will default to the user who is calling the API endpoint.
- Username string
- (Updatable) The username Oracle GoldenGate uses to connect the associated system of the given technology. This username must already exist and be available by the system/application to be connected to and must conform to the case sensitivty requirments defined in it.
- Vault
Id string - (Updatable) Refers to the customer's vault OCID. If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate to manage secrets contained within this vault.
- Wallet string
- (Updatable) The wallet contents Oracle GoldenGate uses to make connections to a database. This attribute is expected to be base64 encoded. Deprecated: This field is deprecated and replaced by "walletSecretId". This field will be removed after February 15 2026.
- Wallet
Secret stringId - (Updatable) The OCID of the Secret where the wallet file is stored. The wallet contents Oracle GoldenGate uses to make connections to a database. Note: When provided, 'wallet' field must not be provided.
- Access
Key stringId - (Updatable) Access key ID to access the Amazon S3 bucket. e.g.: "this-is-not-the-secret"
- Account
Key string - (Updatable) Azure storage account key. This property is required when 'authenticationType' is set to 'SHARED_KEY'. e.g.: pa3WbhVATzj56xD4DH1VjOUhApRGEGHvOo58eQJVWIzX+j8j4CUVFcTjpIqDSRaSa1Wo2LbWY5at+AStEgLOIQ== Deprecated: This field is deprecated and replaced by "accountKeySecretId". This field will be removed after February 15 2026.
- Account
Key stringSecret Id - (Updatable) The OCID of the Secret where the account key is stored. Note: When provided, 'accountKey' field must not be provided.
- Account
Name string - (Updatable) Sets the Azure storage account name.
- Additional
Attributes []ConnectionAdditional Attribute Args - (Updatable) An array of name-value pair attribute entries. Used as additional parameters in connection string.
- Authentication
Mode string - (Updatable) Authentication mode. It can be provided at creation of Oracle Autonomous Database Serverless connections, when a databaseId is provided. The default value is MTLS.
- Authentication
Type string - (Updatable) Authentication type for Java Message Service. If not provided, default is NONE. Optional until 2024-06-27, in the release after it will be made required.
- Azure
Tenant stringId - (Updatable) 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 []ConnectionBootstrap Server Args - (Updatable) 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 string - (Updatable) 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 string - (Updatable) Azure client secret (aka application password) for authentication. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: dO29Q~F5-VwnA.lZdd11xFF_t5NAXCaGwDl9NbT1 Deprecated: This field is deprecated and replaced by "clientSecretSecretId". This field will be removed after February 15 2026.
- Client
Secret stringSecret Id - (Updatable) The OCID of the Secret where the client secret is stored. Only applicable for authenticationType == OAUTH_M2M. Note: When provided, 'clientSecret' field must not be provided.
- Compartment
Id string - (Updatable) The OCID of the compartment being referenced.
- Connection
Factory string - (Updatable) The of Java class implementing javax.jms.ConnectionFactory interface supplied by the Java Message Service provider. e.g.: 'com.stc.jmsjca.core.JConnectionFactoryXA'
- Connection
String string - (Updatable) Connection string. AZURE_SYNAPSE_ANALYTICS e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;', MONGODB e.g.: 'mongodb://mongodb0.example.com:27017/recordsrecords'.
- Connection
Type string - (Updatable) The connection type.
- Connection
Url string - (Updatable) Connection URL. e.g.: 'jdbc:databricks://adb-33934.4.azuredatabricks.net:443/default;transportMode=http;ssl=1;httpPath=sql/protocolv1/o/3393########44/0##3-7-hlrb'
- Consumer
Properties string - (Updatable) The base64 encoded content of the consumer.properties file.
- Core
Site stringXml - (Updatable) The base64 encoded content of the Hadoop Distributed File System configuration file (core-site.xml).
- Database
Id string - (Updatable) The OCID of the Oracle Autonomous Json Database.
- Database
Name string - (Updatable) The name of the database.
- Db
System stringId - (Updatable) The OCID of the database system being referenced.
- map[string]string
- (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - Deployment
Id string - (Updatable) The OCID of the deployment being referenced.
- Description string
- (Updatable) Metadata about this specific object.
- Display
Name string - (Updatable) An object's Display Name.
- Does
Use boolSecret Ids - (Updatable) Indicates that sensitive attributes are provided via Secrets.
- Endpoint string
- (Updatable)Azure Storage service endpoint. e.g: https://test.blob.core.windows.net, Optional Microsoft Fabric service endpoint. Default value: https://onelake.dfs.fabric.microsoft.com
- Fingerprint string
- (Updatable) Fingerprint required by TLS security protocol. Eg.: '6152b2dfbff200f973c5074a5b91d06ab3b472c07c09a1ea57bb7fd406cdce9c'
- map[string]string
- (Updatable) 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
- (Updatable) The name or address of a host. In case of Generic connection type host and port separated by colon. Example:
"server.example.com:1234"For multiple hosts, provide a comma separated list. Example:"server1.example.com:1000,server1.example.com:2000" - Ingress
Ips []ConnectionIngress Ip Args - List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp. Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
- Is
Lock boolOverride - Jndi
Connection stringFactory - (Updatable) The Connection Factory can be looked up using this name. e.g.: 'ConnectionFactory'
- Jndi
Initial stringContext Factory - (Updatable) The implementation of javax.naming.spi.InitialContextFactory interface that the client uses to obtain initial naming context. e.g.: 'org.apache.activemq.jndi.ActiveMQInitialContextFactory'
- Jndi
Provider stringUrl - (Updatable) The URL that Java Message Service will use to contact the JNDI provider. e.g.: 'tcp://myjms.host.domain:61616?jms.prefetchPolicy.all=1000'
- Jndi
Security stringCredentials - (Updatable) The password associated to the principal. Deprecated: This field is deprecated and replaced by "jndiSecurityCredentialsSecretId". This field will be removed after February 15 2026.
- Jndi
Security stringCredentials Secret Id - (Updatable) The OCID of the Secret where the security credentials are stored associated to the principal. Note: When provided, 'jndiSecurityCredentials' field must not be provided.
- Jndi
Security stringPrincipal - (Updatable) Specifies the identity of the principal (user) to be authenticated. e.g.: 'admin2'
- Key
Id string - (Updatable) Refers to the customer's master key OCID. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
- Key
Store string - (Updatable) The base64 encoded content of the KeyStore file. Deprecated: This field is deprecated and replaced by "keyStoreSecretId". This field will be removed after February 15 2026.
- Key
Store stringPassword - (Updatable) The KeyStore password. Deprecated: This field is deprecated and replaced by "keyStorePasswordSecretId". This field will be removed after February 15 2026.
- Key
Store stringPassword Secret Id - (Updatable) The OCID of the Secret where the kafka Ssl KeyStore password is stored. Note: When provided, 'keyStorePassword' field must not be provided.
- Key
Store stringSecret Id - (Updatable) The OCID of the Secret where the content of the KeyStore file is stored. Note: When provided, 'keyStore' field must not be provided.
- Lifecycle
Details 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.
- Locks
[]Connection
Lock Args - Locks associated with this resource.
- Nsg
Ids []string - (Updatable) An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
- Password string
- (Updatable) The password Oracle GoldenGate uses to connect the associated system of the given technology. It must conform to the specific security requirements including length, case sensitivity, and so on. Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
- Password
Secret stringId - (Updatable) The OCID of the Secret where the password is stored. The password Oracle GoldenGate uses to connect the associated system of the given technology. It must conform to the specific security requirements including length, case sensitivity, and so on. If secretId is used plaintext field must not be provided. Note: When provided, 'password' field must not be provided.
- Port int
- (Updatable) The port of an endpoint usually specified for a connection.
- Private
Ip string (Updatable) Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host field, or make sure the host name is resolvable in the target VCN.
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 stringFile - (Updatable) The base64 encoded content of the private key file (PEM file) corresponding to the API key of the fingerprint. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm Deprecated: This field is deprecated and replaced by "privateKeyFileSecretId". This field will be removed after February 15 2026.
- Private
Key stringFile Secret Id - (Updatable) The OCID of the Secret that stores the content of the private key file (PEM file) corresponding to the API key of the fingerprint. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm Note: When provided, 'privateKeyFile' field must not be provided.
- Private
Key stringPassphrase - (Updatable) Password if the private key file is encrypted. Deprecated: This field is deprecated and replaced by "privateKeyPassphraseSecretId". This field will be removed after February 15 2026.
- Private
Key stringPassphrase Secret Id - (Updatable) The OCID of the Secret that stores the password for the private key file. Note: When provided, 'privateKeyPassphrase' field must not be provided.
- Producer
Properties string - (Updatable) The base64 encoded content of the producer.properties file.
- Public
Key stringFingerprint - (Updatable) The fingerprint of the API Key of the user specified by the userId. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm
- Redis
Cluster stringId - (Updatable) The OCID of the Redis cluster.
- Region string
- (Updatable) The name of the region. e.g.: us-ashburn-1 If the region is not provided, backend will default to the default region.
- Routing
Method string - (Updatable) Controls the network traffic direction to the target: SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets. SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet. DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
- Sas
Token string - (Updatable) Credential that uses a shared access signature (SAS) to authenticate to an Azure Service. This property is required when 'authenticationType' is set to 'SHARED_ACCESS_SIGNATURE'. e.g.: ?sv=2020-06-08&ss=bfqt&srt=sco&sp=rwdlacupyx&se=2020-09-10T20:27:28Z&st=2022-08-05T12:27:28Z&spr=https&sig=C1IgHsiLBmTSStYkXXGLTP8it0xBrArcgCqOsZbXwIQ%3D Deprecated: This field is deprecated and replaced by "sasTokenSecretId". This field will be removed after February 15 2026.
- Sas
Token stringSecret Id - (Updatable) The OCID of the Secret where the sas token is stored. Note: When provided, 'sasToken' field must not be provided.
- Secret
Access stringKey - (Updatable) Secret access key to access the Amazon S3 bucket. e.g.: "this-is-not-the-secret" Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". This field will be removed after February 15 2026.
- Secret
Access stringKey Secret Id - (Updatable) The OCID of the Secret where the secret access key is stored. Note: When provided, 'secretAccessKey' field must not be provided.
- Security
Protocol string - (Updatable) Security protocol for Java Message Service. If not provided, default is PLAIN. Optional until 2024-06-27, in the release after it will be made required.
- Servers string
- (Updatable) Comma separated list of Elasticsearch server addresses, specified as host:port entries, where :port is optional. If port is not specified, it defaults to 9200. Used for establishing the initial connection to the Elasticsearch cluster. Example:
"server1.example.com:4000,server2.example.com:4000" - Service
Account stringKey File - (Updatable) The base64 encoded content of the service account key file containing the credentials required to use Google Cloud Storage. Deprecated: This field is deprecated and replaced by "serviceAccountKeyFileSecretId". This field will be removed after February 15 2026.
- Service
Account stringKey File Secret Id - (Updatable) The OCID of the Secret where the content of the service account key file is stored, which containing the credentials required to use Google Cloud Storage. Note: When provided, 'serviceAccountKeyFile' field must not be provided.
- Session
Mode string - (Updatable) 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.
- Should
Use boolJndi - (Updatable) If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.
- Should
Use boolResource Principal - (Updatable) Indicates that the user intents to connect to the instance through resource principal.
- Should
Validate boolServer Certificate - (Updatable) If set to true, the driver validates the certificate that is sent by the database server.
- Ssl
Ca string - (Updatable) The base64 encoded certificate of the trusted certificate authorities (Trusted CA) for PostgreSQL. The supported file formats are .pem and .crt.
- Ssl
Cert string - (Updatable) Client Certificate - The base64 encoded content of a .pem or .crt file. containing the client public key (for 2-way SSL).
- Ssl
Client stringKeystash - (Updatable) The base64 encoded keystash file which contains the encrypted password to the key database file. Deprecated: This field is deprecated and replaced by "sslClientKeystashSecretId". This field will be removed after February 15 2026.
- Ssl
Client stringKeystash Secret Id - (Updatable) The OCID of the Secret where the keystash file is stored, which contains the encrypted password to the key database file. Note: When provided, 'sslClientKeystash' field must not be provided.
- Ssl
Client stringKeystoredb - (Updatable) The base64 encoded keystore file created at the client containing the server certificate / CA root certificate. Deprecated: This field is deprecated and replaced by "sslClientKeystoredbSecretId". This field will be removed after February 15 2026.
- Ssl
Client stringKeystoredb Secret Id - (Updatable) The OCID of the Secret where the keystore file stored, which created at the client containing the server certificate / CA root certificate. Note: When provided, 'sslClientKeystoredb' field must not be provided.
- Ssl
Crl string - (Updatable) The base64 encoded list of certificates revoked by the trusted certificate authorities (Trusted CA). Note: This is an optional property and only applicable if TLS/MTLS option is selected.
- Ssl
Key string - (Updatable) Client Key - The base64 encoded content of a .pem or .crt file containing the client private key (for 2-way SSL). Deprecated: This field is deprecated and replaced by "sslKeySecretId". This field will be removed after February 15 2026.
- Ssl
Key stringPassword - (Updatable) The password for the cert inside of the KeyStore. In case it differs from the KeyStore password, it should be provided. Deprecated: This field is deprecated and replaced by "sslKeyPasswordSecretId". This field will be removed after February 15 2026.
- Ssl
Key stringPassword Secret Id - (Updatable) The OCID of the Secret where the password is stored for the cert inside of the Keystore. In case it differs from the KeyStore password, it should be provided. Note: When provided, 'sslKeyPassword' field must not be provided.
- Ssl
Key stringSecret Id - (Updatable) The OCID of the Secret that stores the Client Key
- The content of a .pem or .crt file containing the client private key (for 2-way SSL). Note: When provided, 'sslKey' field must not be provided.
- Ssl
Mode string - (Updatable) SSL modes for PostgreSQL.
- Ssl
Server stringCertificate - (Updatable) The base64 encoded file which contains the self-signed server certificate / Certificate Authority (CA) certificate.
- State string
- Possible lifecycle states for connection.
- Storage
Credential stringName - (Updatable) Optional. External storage credential name to access files on object storage such as ADLS Gen2, S3 or GCS.
- Stream
Pool stringId - (Updatable) The OCID of the stream pool being referenced.
- Subnet
Id string - (Updatable) The OCID of the target subnet of the dedicated connection.
- map[string]string
- 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 string - The Kafka (e.g. Confluent) Schema Registry technology type.
- Tenancy
Id string - (Updatable) The OCID of the related Oracle Cloud Infrastructure tenancy.
- Tenant
Id string - (Updatable) Azure tenant ID of the application. e.g.: 14593954-d337-4a61-a364-9f758c64f97f
- Time
Created string - The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - Time
Updated string - The time the resource was last updated. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - Tls
Ca stringFile - (Updatable) Database Certificate - The base64 encoded content of a .pem file, containing the server public key (for 1 and 2-way SSL).
- Tls
Certificate stringKey File - (Updatable) Client Certificate - The base64 encoded content of a .pem file, containing the client public key (for 2-way SSL). Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFileSecretId". This field will be removed after February 15 2026.
- Tls
Certificate stringKey File Password - (Updatable) Client Certificate key file password. Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFilePasswordSecretId". This field will be removed after February 15 2026.
- Tls
Certificate stringKey File Password Secret Id - (Updatable) The OCID of the Secret that stores the password of the tls certificate key file. Note: When provided, 'tlsCertificateKeyFilePassword' field must not be provided.
- Tls
Certificate stringKey File Secret Id - (Updatable) The OCID of the Secret that stores the certificate key file of the mtls connection.
- The content of a .pem file containing the client private key (for 2-way SSL). Note: When provided, 'tlsCertificateKeyFile' field must not be provided.
- Trigger
Refresh bool (Updatable) If value is true, it triggers connection refresh action and this attribute change will always show up in the "update" plan and will apply steps in order to refresh secrets and dependent service properties (such as ADB connection strings, wallets, etc..).
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Trust
Store string - (Updatable) The base64 encoded content of the TrustStore file. Deprecated: This field is deprecated and replaced by "trustStoreSecretId". This field will be removed after February 15 2026.
- Trust
Store stringPassword - (Updatable) The TrustStore password. Deprecated: This field is deprecated and replaced by "trustStorePasswordSecretId". This field will be removed after February 15 2026.
- Trust
Store stringPassword Secret Id - (Updatable) The OCID of the Secret where the kafka Ssl TrustStore password is stored. Note: When provided, 'trustStorePassword' field must not be provided.
- Trust
Store stringSecret Id - (Updatable) The OCID of the Secret where the content of the TrustStore file is stored. Note: When provided, 'trustStore' field must not be provided.
- Url string
- (Updatable) Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'
- User
Id string - (Updatable) The OCID of the Oracle Cloud Infrastructure user who will access the Oracle NoSQL database. The user must have write access to the table they want to connect to. If the user is not provided, backend will default to the user who is calling the API endpoint.
- Username string
- (Updatable) The username Oracle GoldenGate uses to connect the associated system of the given technology. This username must already exist and be available by the system/application to be connected to and must conform to the case sensitivty requirments defined in it.
- Vault
Id string - (Updatable) Refers to the customer's vault OCID. If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate to manage secrets contained within this vault.
- Wallet string
- (Updatable) The wallet contents Oracle GoldenGate uses to make connections to a database. This attribute is expected to be base64 encoded. Deprecated: This field is deprecated and replaced by "walletSecretId". This field will be removed after February 15 2026.
- Wallet
Secret stringId - (Updatable) The OCID of the Secret where the wallet file is stored. The wallet contents Oracle GoldenGate uses to make connections to a database. Note: When provided, 'wallet' field must not be provided.
- access
Key StringId - (Updatable) Access key ID to access the Amazon S3 bucket. e.g.: "this-is-not-the-secret"
- account
Key String - (Updatable) Azure storage account key. This property is required when 'authenticationType' is set to 'SHARED_KEY'. e.g.: pa3WbhVATzj56xD4DH1VjOUhApRGEGHvOo58eQJVWIzX+j8j4CUVFcTjpIqDSRaSa1Wo2LbWY5at+AStEgLOIQ== Deprecated: This field is deprecated and replaced by "accountKeySecretId". This field will be removed after February 15 2026.
- account
Key StringSecret Id - (Updatable) The OCID of the Secret where the account key is stored. Note: When provided, 'accountKey' field must not be provided.
- account
Name String - (Updatable) Sets the Azure storage account name.
- additional
Attributes List<ConnectionAdditional Attribute> - (Updatable) An array of name-value pair attribute entries. Used as additional parameters in connection string.
- authentication
Mode String - (Updatable) Authentication mode. It can be provided at creation of Oracle Autonomous Database Serverless connections, when a databaseId is provided. The default value is MTLS.
- authentication
Type String - (Updatable) Authentication type for Java Message Service. If not provided, default is NONE. Optional until 2024-06-27, in the release after it will be made required.
- azure
Tenant StringId - (Updatable) 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 List<ConnectionBootstrap Server> - (Updatable) 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 String - (Updatable) 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 String - (Updatable) Azure client secret (aka application password) for authentication. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: dO29Q~F5-VwnA.lZdd11xFF_t5NAXCaGwDl9NbT1 Deprecated: This field is deprecated and replaced by "clientSecretSecretId". This field will be removed after February 15 2026.
- client
Secret StringSecret Id - (Updatable) The OCID of the Secret where the client secret is stored. Only applicable for authenticationType == OAUTH_M2M. Note: When provided, 'clientSecret' field must not be provided.
- compartment
Id String - (Updatable) The OCID of the compartment being referenced.
- connection
Factory String - (Updatable) The of Java class implementing javax.jms.ConnectionFactory interface supplied by the Java Message Service provider. e.g.: 'com.stc.jmsjca.core.JConnectionFactoryXA'
- connection
String String - (Updatable) Connection string. AZURE_SYNAPSE_ANALYTICS e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;', MONGODB e.g.: 'mongodb://mongodb0.example.com:27017/recordsrecords'.
- connection
Type String - (Updatable) The connection type.
- connection
Url String - (Updatable) Connection URL. e.g.: 'jdbc:databricks://adb-33934.4.azuredatabricks.net:443/default;transportMode=http;ssl=1;httpPath=sql/protocolv1/o/3393########44/0##3-7-hlrb'
- consumer
Properties String - (Updatable) The base64 encoded content of the consumer.properties file.
- core
Site StringXml - (Updatable) The base64 encoded content of the Hadoop Distributed File System configuration file (core-site.xml).
- database
Id String - (Updatable) The OCID of the Oracle Autonomous Json Database.
- database
Name String - (Updatable) The name of the database.
- db
System StringId - (Updatable) The OCID of the database system being referenced.
- Map<String,String>
- (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - deployment
Id String - (Updatable) The OCID of the deployment being referenced.
- description String
- (Updatable) Metadata about this specific object.
- display
Name String - (Updatable) An object's Display Name.
- does
Use BooleanSecret Ids - (Updatable) Indicates that sensitive attributes are provided via Secrets.
- endpoint String
- (Updatable)Azure Storage service endpoint. e.g: https://test.blob.core.windows.net, Optional Microsoft Fabric service endpoint. Default value: https://onelake.dfs.fabric.microsoft.com
- fingerprint String
- (Updatable) Fingerprint required by TLS security protocol. Eg.: '6152b2dfbff200f973c5074a5b91d06ab3b472c07c09a1ea57bb7fd406cdce9c'
- Map<String,String>
- (Updatable) 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
- (Updatable) The name or address of a host. In case of Generic connection type host and port separated by colon. Example:
"server.example.com:1234"For multiple hosts, provide a comma separated list. Example:"server1.example.com:1000,server1.example.com:2000" - ingress
Ips List<ConnectionIngress Ip> - List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp. Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
- is
Lock BooleanOverride - jndi
Connection StringFactory - (Updatable) The Connection Factory can be looked up using this name. e.g.: 'ConnectionFactory'
- jndi
Initial StringContext Factory - (Updatable) The implementation of javax.naming.spi.InitialContextFactory interface that the client uses to obtain initial naming context. e.g.: 'org.apache.activemq.jndi.ActiveMQInitialContextFactory'
- jndi
Provider StringUrl - (Updatable) The URL that Java Message Service will use to contact the JNDI provider. e.g.: 'tcp://myjms.host.domain:61616?jms.prefetchPolicy.all=1000'
- jndi
Security StringCredentials - (Updatable) The password associated to the principal. Deprecated: This field is deprecated and replaced by "jndiSecurityCredentialsSecretId". This field will be removed after February 15 2026.
- jndi
Security StringCredentials Secret Id - (Updatable) The OCID of the Secret where the security credentials are stored associated to the principal. Note: When provided, 'jndiSecurityCredentials' field must not be provided.
- jndi
Security StringPrincipal - (Updatable) Specifies the identity of the principal (user) to be authenticated. e.g.: 'admin2'
- key
Id String - (Updatable) Refers to the customer's master key OCID. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
- key
Store String - (Updatable) The base64 encoded content of the KeyStore file. Deprecated: This field is deprecated and replaced by "keyStoreSecretId". This field will be removed after February 15 2026.
- key
Store StringPassword - (Updatable) The KeyStore password. Deprecated: This field is deprecated and replaced by "keyStorePasswordSecretId". This field will be removed after February 15 2026.
- key
Store StringPassword Secret Id - (Updatable) The OCID of the Secret where the kafka Ssl KeyStore password is stored. Note: When provided, 'keyStorePassword' field must not be provided.
- key
Store StringSecret Id - (Updatable) The OCID of the Secret where the content of the KeyStore file is stored. Note: When provided, 'keyStore' field must not be provided.
- lifecycle
Details 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.
- locks
List<Connection
Lock> - Locks associated with this resource.
- nsg
Ids List<String> - (Updatable) An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
- password String
- (Updatable) The password Oracle GoldenGate uses to connect the associated system of the given technology. It must conform to the specific security requirements including length, case sensitivity, and so on. Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
- password
Secret StringId - (Updatable) The OCID of the Secret where the password is stored. The password Oracle GoldenGate uses to connect the associated system of the given technology. It must conform to the specific security requirements including length, case sensitivity, and so on. If secretId is used plaintext field must not be provided. Note: When provided, 'password' field must not be provided.
- port Integer
- (Updatable) The port of an endpoint usually specified for a connection.
- private
Ip String (Updatable) Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host field, or make sure the host name is resolvable in the target VCN.
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 StringFile - (Updatable) The base64 encoded content of the private key file (PEM file) corresponding to the API key of the fingerprint. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm Deprecated: This field is deprecated and replaced by "privateKeyFileSecretId". This field will be removed after February 15 2026.
- private
Key StringFile Secret Id - (Updatable) The OCID of the Secret that stores the content of the private key file (PEM file) corresponding to the API key of the fingerprint. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm Note: When provided, 'privateKeyFile' field must not be provided.
- private
Key StringPassphrase - (Updatable) Password if the private key file is encrypted. Deprecated: This field is deprecated and replaced by "privateKeyPassphraseSecretId". This field will be removed after February 15 2026.
- private
Key StringPassphrase Secret Id - (Updatable) The OCID of the Secret that stores the password for the private key file. Note: When provided, 'privateKeyPassphrase' field must not be provided.
- producer
Properties String - (Updatable) The base64 encoded content of the producer.properties file.
- public
Key StringFingerprint - (Updatable) The fingerprint of the API Key of the user specified by the userId. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm
- redis
Cluster StringId - (Updatable) The OCID of the Redis cluster.
- region String
- (Updatable) The name of the region. e.g.: us-ashburn-1 If the region is not provided, backend will default to the default region.
- routing
Method String - (Updatable) Controls the network traffic direction to the target: SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets. SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet. DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
- sas
Token String - (Updatable) Credential that uses a shared access signature (SAS) to authenticate to an Azure Service. This property is required when 'authenticationType' is set to 'SHARED_ACCESS_SIGNATURE'. e.g.: ?sv=2020-06-08&ss=bfqt&srt=sco&sp=rwdlacupyx&se=2020-09-10T20:27:28Z&st=2022-08-05T12:27:28Z&spr=https&sig=C1IgHsiLBmTSStYkXXGLTP8it0xBrArcgCqOsZbXwIQ%3D Deprecated: This field is deprecated and replaced by "sasTokenSecretId". This field will be removed after February 15 2026.
- sas
Token StringSecret Id - (Updatable) The OCID of the Secret where the sas token is stored. Note: When provided, 'sasToken' field must not be provided.
- secret
Access StringKey - (Updatable) Secret access key to access the Amazon S3 bucket. e.g.: "this-is-not-the-secret" Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". This field will be removed after February 15 2026.
- secret
Access StringKey Secret Id - (Updatable) The OCID of the Secret where the secret access key is stored. Note: When provided, 'secretAccessKey' field must not be provided.
- security
Protocol String - (Updatable) Security protocol for Java Message Service. If not provided, default is PLAIN. Optional until 2024-06-27, in the release after it will be made required.
- servers String
- (Updatable) Comma separated list of Elasticsearch server addresses, specified as host:port entries, where :port is optional. If port is not specified, it defaults to 9200. Used for establishing the initial connection to the Elasticsearch cluster. Example:
"server1.example.com:4000,server2.example.com:4000" - service
Account StringKey File - (Updatable) The base64 encoded content of the service account key file containing the credentials required to use Google Cloud Storage. Deprecated: This field is deprecated and replaced by "serviceAccountKeyFileSecretId". This field will be removed after February 15 2026.
- service
Account StringKey File Secret Id - (Updatable) The OCID of the Secret where the content of the service account key file is stored, which containing the credentials required to use Google Cloud Storage. Note: When provided, 'serviceAccountKeyFile' field must not be provided.
- session
Mode String - (Updatable) 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.
- should
Use BooleanJndi - (Updatable) If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.
- should
Use BooleanResource Principal - (Updatable) Indicates that the user intents to connect to the instance through resource principal.
- should
Validate BooleanServer Certificate - (Updatable) If set to true, the driver validates the certificate that is sent by the database server.
- ssl
Ca String - (Updatable) The base64 encoded certificate of the trusted certificate authorities (Trusted CA) for PostgreSQL. The supported file formats are .pem and .crt.
- ssl
Cert String - (Updatable) Client Certificate - The base64 encoded content of a .pem or .crt file. containing the client public key (for 2-way SSL).
- ssl
Client StringKeystash - (Updatable) The base64 encoded keystash file which contains the encrypted password to the key database file. Deprecated: This field is deprecated and replaced by "sslClientKeystashSecretId". This field will be removed after February 15 2026.
- ssl
Client StringKeystash Secret Id - (Updatable) The OCID of the Secret where the keystash file is stored, which contains the encrypted password to the key database file. Note: When provided, 'sslClientKeystash' field must not be provided.
- ssl
Client StringKeystoredb - (Updatable) The base64 encoded keystore file created at the client containing the server certificate / CA root certificate. Deprecated: This field is deprecated and replaced by "sslClientKeystoredbSecretId". This field will be removed after February 15 2026.
- ssl
Client StringKeystoredb Secret Id - (Updatable) The OCID of the Secret where the keystore file stored, which created at the client containing the server certificate / CA root certificate. Note: When provided, 'sslClientKeystoredb' field must not be provided.
- ssl
Crl String - (Updatable) The base64 encoded list of certificates revoked by the trusted certificate authorities (Trusted CA). Note: This is an optional property and only applicable if TLS/MTLS option is selected.
- ssl
Key String - (Updatable) Client Key - The base64 encoded content of a .pem or .crt file containing the client private key (for 2-way SSL). Deprecated: This field is deprecated and replaced by "sslKeySecretId". This field will be removed after February 15 2026.
- ssl
Key StringPassword - (Updatable) The password for the cert inside of the KeyStore. In case it differs from the KeyStore password, it should be provided. Deprecated: This field is deprecated and replaced by "sslKeyPasswordSecretId". This field will be removed after February 15 2026.
- ssl
Key StringPassword Secret Id - (Updatable) The OCID of the Secret where the password is stored for the cert inside of the Keystore. In case it differs from the KeyStore password, it should be provided. Note: When provided, 'sslKeyPassword' field must not be provided.
- ssl
Key StringSecret Id - (Updatable) The OCID of the Secret that stores the Client Key
- The content of a .pem or .crt file containing the client private key (for 2-way SSL). Note: When provided, 'sslKey' field must not be provided.
- ssl
Mode String - (Updatable) SSL modes for PostgreSQL.
- ssl
Server StringCertificate - (Updatable) The base64 encoded file which contains the self-signed server certificate / Certificate Authority (CA) certificate.
- state String
- Possible lifecycle states for connection.
- storage
Credential StringName - (Updatable) Optional. External storage credential name to access files on object storage such as ADLS Gen2, S3 or GCS.
- stream
Pool StringId - (Updatable) The OCID of the stream pool being referenced.
- subnet
Id String - (Updatable) The OCID of the target subnet of the dedicated connection.
- Map<String,String>
- 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 String - The Kafka (e.g. Confluent) Schema Registry technology type.
- tenancy
Id String - (Updatable) The OCID of the related Oracle Cloud Infrastructure tenancy.
- tenant
Id String - (Updatable) Azure tenant ID of the application. e.g.: 14593954-d337-4a61-a364-9f758c64f97f
- time
Created String - The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - time
Updated String - The time the resource was last updated. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - tls
Ca StringFile - (Updatable) Database Certificate - The base64 encoded content of a .pem file, containing the server public key (for 1 and 2-way SSL).
- tls
Certificate StringKey File - (Updatable) Client Certificate - The base64 encoded content of a .pem file, containing the client public key (for 2-way SSL). Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFileSecretId". This field will be removed after February 15 2026.
- tls
Certificate StringKey File Password - (Updatable) Client Certificate key file password. Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFilePasswordSecretId". This field will be removed after February 15 2026.
- tls
Certificate StringKey File Password Secret Id - (Updatable) The OCID of the Secret that stores the password of the tls certificate key file. Note: When provided, 'tlsCertificateKeyFilePassword' field must not be provided.
- tls
Certificate StringKey File Secret Id - (Updatable) The OCID of the Secret that stores the certificate key file of the mtls connection.
- The content of a .pem file containing the client private key (for 2-way SSL). Note: When provided, 'tlsCertificateKeyFile' field must not be provided.
- trigger
Refresh Boolean (Updatable) If value is true, it triggers connection refresh action and this attribute change will always show up in the "update" plan and will apply steps in order to refresh secrets and dependent service properties (such as ADB connection strings, wallets, etc..).
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- trust
Store String - (Updatable) The base64 encoded content of the TrustStore file. Deprecated: This field is deprecated and replaced by "trustStoreSecretId". This field will be removed after February 15 2026.
- trust
Store StringPassword - (Updatable) The TrustStore password. Deprecated: This field is deprecated and replaced by "trustStorePasswordSecretId". This field will be removed after February 15 2026.
- trust
Store StringPassword Secret Id - (Updatable) The OCID of the Secret where the kafka Ssl TrustStore password is stored. Note: When provided, 'trustStorePassword' field must not be provided.
- trust
Store StringSecret Id - (Updatable) The OCID of the Secret where the content of the TrustStore file is stored. Note: When provided, 'trustStore' field must not be provided.
- url String
- (Updatable) Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'
- user
Id String - (Updatable) The OCID of the Oracle Cloud Infrastructure user who will access the Oracle NoSQL database. The user must have write access to the table they want to connect to. If the user is not provided, backend will default to the user who is calling the API endpoint.
- username String
- (Updatable) The username Oracle GoldenGate uses to connect the associated system of the given technology. This username must already exist and be available by the system/application to be connected to and must conform to the case sensitivty requirments defined in it.
- vault
Id String - (Updatable) Refers to the customer's vault OCID. If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate to manage secrets contained within this vault.
- wallet String
- (Updatable) The wallet contents Oracle GoldenGate uses to make connections to a database. This attribute is expected to be base64 encoded. Deprecated: This field is deprecated and replaced by "walletSecretId". This field will be removed after February 15 2026.
- wallet
Secret StringId - (Updatable) The OCID of the Secret where the wallet file is stored. The wallet contents Oracle GoldenGate uses to make connections to a database. Note: When provided, 'wallet' field must not be provided.
- access
Key stringId - (Updatable) Access key ID to access the Amazon S3 bucket. e.g.: "this-is-not-the-secret"
- account
Key string - (Updatable) Azure storage account key. This property is required when 'authenticationType' is set to 'SHARED_KEY'. e.g.: pa3WbhVATzj56xD4DH1VjOUhApRGEGHvOo58eQJVWIzX+j8j4CUVFcTjpIqDSRaSa1Wo2LbWY5at+AStEgLOIQ== Deprecated: This field is deprecated and replaced by "accountKeySecretId". This field will be removed after February 15 2026.
- account
Key stringSecret Id - (Updatable) The OCID of the Secret where the account key is stored. Note: When provided, 'accountKey' field must not be provided.
- account
Name string - (Updatable) Sets the Azure storage account name.
- additional
Attributes ConnectionAdditional Attribute[] - (Updatable) An array of name-value pair attribute entries. Used as additional parameters in connection string.
- authentication
Mode string - (Updatable) Authentication mode. It can be provided at creation of Oracle Autonomous Database Serverless connections, when a databaseId is provided. The default value is MTLS.
- authentication
Type string - (Updatable) Authentication type for Java Message Service. If not provided, default is NONE. Optional until 2024-06-27, in the release after it will be made required.
- azure
Tenant stringId - (Updatable) 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 ConnectionBootstrap Server[] - (Updatable) 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 string - (Updatable) 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 string - (Updatable) Azure client secret (aka application password) for authentication. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: dO29Q~F5-VwnA.lZdd11xFF_t5NAXCaGwDl9NbT1 Deprecated: This field is deprecated and replaced by "clientSecretSecretId". This field will be removed after February 15 2026.
- client
Secret stringSecret Id - (Updatable) The OCID of the Secret where the client secret is stored. Only applicable for authenticationType == OAUTH_M2M. Note: When provided, 'clientSecret' field must not be provided.
- compartment
Id string - (Updatable) The OCID of the compartment being referenced.
- connection
Factory string - (Updatable) The of Java class implementing javax.jms.ConnectionFactory interface supplied by the Java Message Service provider. e.g.: 'com.stc.jmsjca.core.JConnectionFactoryXA'
- connection
String string - (Updatable) Connection string. AZURE_SYNAPSE_ANALYTICS e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;', MONGODB e.g.: 'mongodb://mongodb0.example.com:27017/recordsrecords'.
- connection
Type string - (Updatable) The connection type.
- connection
Url string - (Updatable) Connection URL. e.g.: 'jdbc:databricks://adb-33934.4.azuredatabricks.net:443/default;transportMode=http;ssl=1;httpPath=sql/protocolv1/o/3393########44/0##3-7-hlrb'
- consumer
Properties string - (Updatable) The base64 encoded content of the consumer.properties file.
- core
Site stringXml - (Updatable) The base64 encoded content of the Hadoop Distributed File System configuration file (core-site.xml).
- database
Id string - (Updatable) The OCID of the Oracle Autonomous Json Database.
- database
Name string - (Updatable) The name of the database.
- db
System stringId - (Updatable) The OCID of the database system being referenced.
- {[key: string]: string}
- (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - deployment
Id string - (Updatable) The OCID of the deployment being referenced.
- description string
- (Updatable) Metadata about this specific object.
- display
Name string - (Updatable) An object's Display Name.
- does
Use booleanSecret Ids - (Updatable) Indicates that sensitive attributes are provided via Secrets.
- endpoint string
- (Updatable)Azure Storage service endpoint. e.g: https://test.blob.core.windows.net, Optional Microsoft Fabric service endpoint. Default value: https://onelake.dfs.fabric.microsoft.com
- fingerprint string
- (Updatable) Fingerprint required by TLS security protocol. Eg.: '6152b2dfbff200f973c5074a5b91d06ab3b472c07c09a1ea57bb7fd406cdce9c'
- {[key: string]: string}
- (Updatable) 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
- (Updatable) The name or address of a host. In case of Generic connection type host and port separated by colon. Example:
"server.example.com:1234"For multiple hosts, provide a comma separated list. Example:"server1.example.com:1000,server1.example.com:2000" - ingress
Ips ConnectionIngress Ip[] - List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp. Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
- is
Lock booleanOverride - jndi
Connection stringFactory - (Updatable) The Connection Factory can be looked up using this name. e.g.: 'ConnectionFactory'
- jndi
Initial stringContext Factory - (Updatable) The implementation of javax.naming.spi.InitialContextFactory interface that the client uses to obtain initial naming context. e.g.: 'org.apache.activemq.jndi.ActiveMQInitialContextFactory'
- jndi
Provider stringUrl - (Updatable) The URL that Java Message Service will use to contact the JNDI provider. e.g.: 'tcp://myjms.host.domain:61616?jms.prefetchPolicy.all=1000'
- jndi
Security stringCredentials - (Updatable) The password associated to the principal. Deprecated: This field is deprecated and replaced by "jndiSecurityCredentialsSecretId". This field will be removed after February 15 2026.
- jndi
Security stringCredentials Secret Id - (Updatable) The OCID of the Secret where the security credentials are stored associated to the principal. Note: When provided, 'jndiSecurityCredentials' field must not be provided.
- jndi
Security stringPrincipal - (Updatable) Specifies the identity of the principal (user) to be authenticated. e.g.: 'admin2'
- key
Id string - (Updatable) Refers to the customer's master key OCID. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
- key
Store string - (Updatable) The base64 encoded content of the KeyStore file. Deprecated: This field is deprecated and replaced by "keyStoreSecretId". This field will be removed after February 15 2026.
- key
Store stringPassword - (Updatable) The KeyStore password. Deprecated: This field is deprecated and replaced by "keyStorePasswordSecretId". This field will be removed after February 15 2026.
- key
Store stringPassword Secret Id - (Updatable) The OCID of the Secret where the kafka Ssl KeyStore password is stored. Note: When provided, 'keyStorePassword' field must not be provided.
- key
Store stringSecret Id - (Updatable) The OCID of the Secret where the content of the KeyStore file is stored. Note: When provided, 'keyStore' field must not be provided.
- lifecycle
Details 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.
- locks
Connection
Lock[] - Locks associated with this resource.
- nsg
Ids string[] - (Updatable) An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
- password string
- (Updatable) The password Oracle GoldenGate uses to connect the associated system of the given technology. It must conform to the specific security requirements including length, case sensitivity, and so on. Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
- password
Secret stringId - (Updatable) The OCID of the Secret where the password is stored. The password Oracle GoldenGate uses to connect the associated system of the given technology. It must conform to the specific security requirements including length, case sensitivity, and so on. If secretId is used plaintext field must not be provided. Note: When provided, 'password' field must not be provided.
- port number
- (Updatable) The port of an endpoint usually specified for a connection.
- private
Ip string (Updatable) Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host field, or make sure the host name is resolvable in the target VCN.
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 stringFile - (Updatable) The base64 encoded content of the private key file (PEM file) corresponding to the API key of the fingerprint. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm Deprecated: This field is deprecated and replaced by "privateKeyFileSecretId". This field will be removed after February 15 2026.
- private
Key stringFile Secret Id - (Updatable) The OCID of the Secret that stores the content of the private key file (PEM file) corresponding to the API key of the fingerprint. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm Note: When provided, 'privateKeyFile' field must not be provided.
- private
Key stringPassphrase - (Updatable) Password if the private key file is encrypted. Deprecated: This field is deprecated and replaced by "privateKeyPassphraseSecretId". This field will be removed after February 15 2026.
- private
Key stringPassphrase Secret Id - (Updatable) The OCID of the Secret that stores the password for the private key file. Note: When provided, 'privateKeyPassphrase' field must not be provided.
- producer
Properties string - (Updatable) The base64 encoded content of the producer.properties file.
- public
Key stringFingerprint - (Updatable) The fingerprint of the API Key of the user specified by the userId. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm
- redis
Cluster stringId - (Updatable) The OCID of the Redis cluster.
- region string
- (Updatable) The name of the region. e.g.: us-ashburn-1 If the region is not provided, backend will default to the default region.
- routing
Method string - (Updatable) Controls the network traffic direction to the target: SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets. SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet. DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
- sas
Token string - (Updatable) Credential that uses a shared access signature (SAS) to authenticate to an Azure Service. This property is required when 'authenticationType' is set to 'SHARED_ACCESS_SIGNATURE'. e.g.: ?sv=2020-06-08&ss=bfqt&srt=sco&sp=rwdlacupyx&se=2020-09-10T20:27:28Z&st=2022-08-05T12:27:28Z&spr=https&sig=C1IgHsiLBmTSStYkXXGLTP8it0xBrArcgCqOsZbXwIQ%3D Deprecated: This field is deprecated and replaced by "sasTokenSecretId". This field will be removed after February 15 2026.
- sas
Token stringSecret Id - (Updatable) The OCID of the Secret where the sas token is stored. Note: When provided, 'sasToken' field must not be provided.
- secret
Access stringKey - (Updatable) Secret access key to access the Amazon S3 bucket. e.g.: "this-is-not-the-secret" Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". This field will be removed after February 15 2026.
- secret
Access stringKey Secret Id - (Updatable) The OCID of the Secret where the secret access key is stored. Note: When provided, 'secretAccessKey' field must not be provided.
- security
Protocol string - (Updatable) Security protocol for Java Message Service. If not provided, default is PLAIN. Optional until 2024-06-27, in the release after it will be made required.
- servers string
- (Updatable) Comma separated list of Elasticsearch server addresses, specified as host:port entries, where :port is optional. If port is not specified, it defaults to 9200. Used for establishing the initial connection to the Elasticsearch cluster. Example:
"server1.example.com:4000,server2.example.com:4000" - service
Account stringKey File - (Updatable) The base64 encoded content of the service account key file containing the credentials required to use Google Cloud Storage. Deprecated: This field is deprecated and replaced by "serviceAccountKeyFileSecretId". This field will be removed after February 15 2026.
- service
Account stringKey File Secret Id - (Updatable) The OCID of the Secret where the content of the service account key file is stored, which containing the credentials required to use Google Cloud Storage. Note: When provided, 'serviceAccountKeyFile' field must not be provided.
- session
Mode string - (Updatable) 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.
- should
Use booleanJndi - (Updatable) If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.
- should
Use booleanResource Principal - (Updatable) Indicates that the user intents to connect to the instance through resource principal.
- should
Validate booleanServer Certificate - (Updatable) If set to true, the driver validates the certificate that is sent by the database server.
- ssl
Ca string - (Updatable) The base64 encoded certificate of the trusted certificate authorities (Trusted CA) for PostgreSQL. The supported file formats are .pem and .crt.
- ssl
Cert string - (Updatable) Client Certificate - The base64 encoded content of a .pem or .crt file. containing the client public key (for 2-way SSL).
- ssl
Client stringKeystash - (Updatable) The base64 encoded keystash file which contains the encrypted password to the key database file. Deprecated: This field is deprecated and replaced by "sslClientKeystashSecretId". This field will be removed after February 15 2026.
- ssl
Client stringKeystash Secret Id - (Updatable) The OCID of the Secret where the keystash file is stored, which contains the encrypted password to the key database file. Note: When provided, 'sslClientKeystash' field must not be provided.
- ssl
Client stringKeystoredb - (Updatable) The base64 encoded keystore file created at the client containing the server certificate / CA root certificate. Deprecated: This field is deprecated and replaced by "sslClientKeystoredbSecretId". This field will be removed after February 15 2026.
- ssl
Client stringKeystoredb Secret Id - (Updatable) The OCID of the Secret where the keystore file stored, which created at the client containing the server certificate / CA root certificate. Note: When provided, 'sslClientKeystoredb' field must not be provided.
- ssl
Crl string - (Updatable) The base64 encoded list of certificates revoked by the trusted certificate authorities (Trusted CA). Note: This is an optional property and only applicable if TLS/MTLS option is selected.
- ssl
Key string - (Updatable) Client Key - The base64 encoded content of a .pem or .crt file containing the client private key (for 2-way SSL). Deprecated: This field is deprecated and replaced by "sslKeySecretId". This field will be removed after February 15 2026.
- ssl
Key stringPassword - (Updatable) The password for the cert inside of the KeyStore. In case it differs from the KeyStore password, it should be provided. Deprecated: This field is deprecated and replaced by "sslKeyPasswordSecretId". This field will be removed after February 15 2026.
- ssl
Key stringPassword Secret Id - (Updatable) The OCID of the Secret where the password is stored for the cert inside of the Keystore. In case it differs from the KeyStore password, it should be provided. Note: When provided, 'sslKeyPassword' field must not be provided.
- ssl
Key stringSecret Id - (Updatable) The OCID of the Secret that stores the Client Key
- The content of a .pem or .crt file containing the client private key (for 2-way SSL). Note: When provided, 'sslKey' field must not be provided.
- ssl
Mode string - (Updatable) SSL modes for PostgreSQL.
- ssl
Server stringCertificate - (Updatable) The base64 encoded file which contains the self-signed server certificate / Certificate Authority (CA) certificate.
- state string
- Possible lifecycle states for connection.
- storage
Credential stringName - (Updatable) Optional. External storage credential name to access files on object storage such as ADLS Gen2, S3 or GCS.
- stream
Pool stringId - (Updatable) The OCID of the stream pool being referenced.
- subnet
Id string - (Updatable) The OCID of the target subnet of the dedicated connection.
- {[key: string]: string}
- 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 string - The Kafka (e.g. Confluent) Schema Registry technology type.
- tenancy
Id string - (Updatable) The OCID of the related Oracle Cloud Infrastructure tenancy.
- tenant
Id string - (Updatable) Azure tenant ID of the application. e.g.: 14593954-d337-4a61-a364-9f758c64f97f
- time
Created string - The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - time
Updated string - The time the resource was last updated. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - tls
Ca stringFile - (Updatable) Database Certificate - The base64 encoded content of a .pem file, containing the server public key (for 1 and 2-way SSL).
- tls
Certificate stringKey File - (Updatable) Client Certificate - The base64 encoded content of a .pem file, containing the client public key (for 2-way SSL). Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFileSecretId". This field will be removed after February 15 2026.
- tls
Certificate stringKey File Password - (Updatable) Client Certificate key file password. Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFilePasswordSecretId". This field will be removed after February 15 2026.
- tls
Certificate stringKey File Password Secret Id - (Updatable) The OCID of the Secret that stores the password of the tls certificate key file. Note: When provided, 'tlsCertificateKeyFilePassword' field must not be provided.
- tls
Certificate stringKey File Secret Id - (Updatable) The OCID of the Secret that stores the certificate key file of the mtls connection.
- The content of a .pem file containing the client private key (for 2-way SSL). Note: When provided, 'tlsCertificateKeyFile' field must not be provided.
- trigger
Refresh boolean (Updatable) If value is true, it triggers connection refresh action and this attribute change will always show up in the "update" plan and will apply steps in order to refresh secrets and dependent service properties (such as ADB connection strings, wallets, etc..).
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- trust
Store string - (Updatable) The base64 encoded content of the TrustStore file. Deprecated: This field is deprecated and replaced by "trustStoreSecretId". This field will be removed after February 15 2026.
- trust
Store stringPassword - (Updatable) The TrustStore password. Deprecated: This field is deprecated and replaced by "trustStorePasswordSecretId". This field will be removed after February 15 2026.
- trust
Store stringPassword Secret Id - (Updatable) The OCID of the Secret where the kafka Ssl TrustStore password is stored. Note: When provided, 'trustStorePassword' field must not be provided.
- trust
Store stringSecret Id - (Updatable) The OCID of the Secret where the content of the TrustStore file is stored. Note: When provided, 'trustStore' field must not be provided.
- url string
- (Updatable) Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'
- user
Id string - (Updatable) The OCID of the Oracle Cloud Infrastructure user who will access the Oracle NoSQL database. The user must have write access to the table they want to connect to. If the user is not provided, backend will default to the user who is calling the API endpoint.
- username string
- (Updatable) The username Oracle GoldenGate uses to connect the associated system of the given technology. This username must already exist and be available by the system/application to be connected to and must conform to the case sensitivty requirments defined in it.
- vault
Id string - (Updatable) Refers to the customer's vault OCID. If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate to manage secrets contained within this vault.
- wallet string
- (Updatable) The wallet contents Oracle GoldenGate uses to make connections to a database. This attribute is expected to be base64 encoded. Deprecated: This field is deprecated and replaced by "walletSecretId". This field will be removed after February 15 2026.
- wallet
Secret stringId - (Updatable) The OCID of the Secret where the wallet file is stored. The wallet contents Oracle GoldenGate uses to make connections to a database. Note: When provided, 'wallet' field must not be provided.
- access_
key_ strid - (Updatable) Access key ID to access the Amazon S3 bucket. e.g.: "this-is-not-the-secret"
- account_
key str - (Updatable) Azure storage account key. This property is required when 'authenticationType' is set to 'SHARED_KEY'. e.g.: pa3WbhVATzj56xD4DH1VjOUhApRGEGHvOo58eQJVWIzX+j8j4CUVFcTjpIqDSRaSa1Wo2LbWY5at+AStEgLOIQ== Deprecated: This field is deprecated and replaced by "accountKeySecretId". This field will be removed after February 15 2026.
- account_
key_ strsecret_ id - (Updatable) The OCID of the Secret where the account key is stored. Note: When provided, 'accountKey' field must not be provided.
- account_
name str - (Updatable) Sets the Azure storage account name.
- additional_
attributes Sequence[ConnectionAdditional Attribute Args] - (Updatable) An array of name-value pair attribute entries. Used as additional parameters in connection string.
- authentication_
mode str - (Updatable) Authentication mode. It can be provided at creation of Oracle Autonomous Database Serverless connections, when a databaseId is provided. The default value is MTLS.
- authentication_
type str - (Updatable) Authentication type for Java Message Service. If not provided, default is NONE. Optional until 2024-06-27, in the release after it will be made required.
- azure_
tenant_ strid - (Updatable) 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 Sequence[ConnectionBootstrap Server Args] - (Updatable) 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 - (Updatable) 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 - (Updatable) Azure client secret (aka application password) for authentication. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: dO29Q~F5-VwnA.lZdd11xFF_t5NAXCaGwDl9NbT1 Deprecated: This field is deprecated and replaced by "clientSecretSecretId". This field will be removed after February 15 2026.
- client_
secret_ strsecret_ id - (Updatable) The OCID of the Secret where the client secret is stored. Only applicable for authenticationType == OAUTH_M2M. Note: When provided, 'clientSecret' field must not be provided.
- compartment_
id str - (Updatable) The OCID of the compartment being referenced.
- connection_
factory str - (Updatable) The of Java class implementing javax.jms.ConnectionFactory interface supplied by the Java Message Service provider. e.g.: 'com.stc.jmsjca.core.JConnectionFactoryXA'
- connection_
string str - (Updatable) Connection string. AZURE_SYNAPSE_ANALYTICS e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;', MONGODB e.g.: 'mongodb://mongodb0.example.com:27017/recordsrecords'.
- connection_
type str - (Updatable) The connection type.
- connection_
url str - (Updatable) Connection URL. e.g.: 'jdbc:databricks://adb-33934.4.azuredatabricks.net:443/default;transportMode=http;ssl=1;httpPath=sql/protocolv1/o/3393########44/0##3-7-hlrb'
- consumer_
properties str - (Updatable) The base64 encoded content of the consumer.properties file.
- core_
site_ strxml - (Updatable) The base64 encoded content of the Hadoop Distributed File System configuration file (core-site.xml).
- database_
id str - (Updatable) The OCID of the Oracle Autonomous Json Database.
- database_
name str - (Updatable) The name of the database.
- db_
system_ strid - (Updatable) The OCID of the database system being referenced.
- Mapping[str, str]
- (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - deployment_
id str - (Updatable) The OCID of the deployment being referenced.
- description str
- (Updatable) Metadata about this specific object.
- display_
name str - (Updatable) An object's Display Name.
- does_
use_ boolsecret_ ids - (Updatable) Indicates that sensitive attributes are provided via Secrets.
- endpoint str
- (Updatable)Azure Storage service endpoint. e.g: https://test.blob.core.windows.net, Optional Microsoft Fabric service endpoint. Default value: https://onelake.dfs.fabric.microsoft.com
- fingerprint str
- (Updatable) Fingerprint required by TLS security protocol. Eg.: '6152b2dfbff200f973c5074a5b91d06ab3b472c07c09a1ea57bb7fd406cdce9c'
- Mapping[str, str]
- (Updatable) 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
- (Updatable) The name or address of a host. In case of Generic connection type host and port separated by colon. Example:
"server.example.com:1234"For multiple hosts, provide a comma separated list. Example:"server1.example.com:1000,server1.example.com:2000" - ingress_
ips Sequence[ConnectionIngress Ip Args] - List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp. Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
- is_
lock_ booloverride - jndi_
connection_ strfactory - (Updatable) The Connection Factory can be looked up using this name. e.g.: 'ConnectionFactory'
- jndi_
initial_ strcontext_ factory - (Updatable) The implementation of javax.naming.spi.InitialContextFactory interface that the client uses to obtain initial naming context. e.g.: 'org.apache.activemq.jndi.ActiveMQInitialContextFactory'
- jndi_
provider_ strurl - (Updatable) The URL that Java Message Service will use to contact the JNDI provider. e.g.: 'tcp://myjms.host.domain:61616?jms.prefetchPolicy.all=1000'
- jndi_
security_ strcredentials - (Updatable) The password associated to the principal. Deprecated: This field is deprecated and replaced by "jndiSecurityCredentialsSecretId". This field will be removed after February 15 2026.
- jndi_
security_ strcredentials_ secret_ id - (Updatable) The OCID of the Secret where the security credentials are stored associated to the principal. Note: When provided, 'jndiSecurityCredentials' field must not be provided.
- jndi_
security_ strprincipal - (Updatable) Specifies the identity of the principal (user) to be authenticated. e.g.: 'admin2'
- key_
id str - (Updatable) Refers to the customer's master key OCID. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
- key_
store str - (Updatable) The base64 encoded content of the KeyStore file. Deprecated: This field is deprecated and replaced by "keyStoreSecretId". This field will be removed after February 15 2026.
- key_
store_ strpassword - (Updatable) The KeyStore password. Deprecated: This field is deprecated and replaced by "keyStorePasswordSecretId". This field will be removed after February 15 2026.
- key_
store_ strpassword_ secret_ id - (Updatable) The OCID of the Secret where the kafka Ssl KeyStore password is stored. Note: When provided, 'keyStorePassword' field must not be provided.
- key_
store_ strsecret_ id - (Updatable) The OCID of the Secret where the content of the KeyStore file is stored. Note: When provided, 'keyStore' field must not be provided.
- 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.
- locks
Sequence[Connection
Lock Args] - Locks associated with this resource.
- nsg_
ids Sequence[str] - (Updatable) An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
- password str
- (Updatable) The password Oracle GoldenGate uses to connect the associated system of the given technology. It must conform to the specific security requirements including length, case sensitivity, and so on. Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
- password_
secret_ strid - (Updatable) The OCID of the Secret where the password is stored. The password Oracle GoldenGate uses to connect the associated system of the given technology. It must conform to the specific security requirements including length, case sensitivity, and so on. If secretId is used plaintext field must not be provided. Note: When provided, 'password' field must not be provided.
- port int
- (Updatable) The port of an endpoint usually specified for a connection.
- private_
ip str (Updatable) Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host field, or make sure the host name is resolvable in the target VCN.
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_ strfile - (Updatable) The base64 encoded content of the private key file (PEM file) corresponding to the API key of the fingerprint. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm Deprecated: This field is deprecated and replaced by "privateKeyFileSecretId". This field will be removed after February 15 2026.
- private_
key_ strfile_ secret_ id - (Updatable) The OCID of the Secret that stores the content of the private key file (PEM file) corresponding to the API key of the fingerprint. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm Note: When provided, 'privateKeyFile' field must not be provided.
- private_
key_ strpassphrase - (Updatable) Password if the private key file is encrypted. Deprecated: This field is deprecated and replaced by "privateKeyPassphraseSecretId". This field will be removed after February 15 2026.
- private_
key_ strpassphrase_ secret_ id - (Updatable) The OCID of the Secret that stores the password for the private key file. Note: When provided, 'privateKeyPassphrase' field must not be provided.
- producer_
properties str - (Updatable) The base64 encoded content of the producer.properties file.
- public_
key_ strfingerprint - (Updatable) The fingerprint of the API Key of the user specified by the userId. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm
- redis_
cluster_ strid - (Updatable) The OCID of the Redis cluster.
- region str
- (Updatable) The name of the region. e.g.: us-ashburn-1 If the region is not provided, backend will default to the default region.
- routing_
method str - (Updatable) Controls the network traffic direction to the target: SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets. SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet. DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
- sas_
token str - (Updatable) Credential that uses a shared access signature (SAS) to authenticate to an Azure Service. This property is required when 'authenticationType' is set to 'SHARED_ACCESS_SIGNATURE'. e.g.: ?sv=2020-06-08&ss=bfqt&srt=sco&sp=rwdlacupyx&se=2020-09-10T20:27:28Z&st=2022-08-05T12:27:28Z&spr=https&sig=C1IgHsiLBmTSStYkXXGLTP8it0xBrArcgCqOsZbXwIQ%3D Deprecated: This field is deprecated and replaced by "sasTokenSecretId". This field will be removed after February 15 2026.
- sas_
token_ strsecret_ id - (Updatable) The OCID of the Secret where the sas token is stored. Note: When provided, 'sasToken' field must not be provided.
- secret_
access_ strkey - (Updatable) Secret access key to access the Amazon S3 bucket. e.g.: "this-is-not-the-secret" Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". This field will be removed after February 15 2026.
- secret_
access_ strkey_ secret_ id - (Updatable) The OCID of the Secret where the secret access key is stored. Note: When provided, 'secretAccessKey' field must not be provided.
- security_
protocol str - (Updatable) Security protocol for Java Message Service. If not provided, default is PLAIN. Optional until 2024-06-27, in the release after it will be made required.
- servers str
- (Updatable) Comma separated list of Elasticsearch server addresses, specified as host:port entries, where :port is optional. If port is not specified, it defaults to 9200. Used for establishing the initial connection to the Elasticsearch cluster. Example:
"server1.example.com:4000,server2.example.com:4000" - service_
account_ strkey_ file - (Updatable) The base64 encoded content of the service account key file containing the credentials required to use Google Cloud Storage. Deprecated: This field is deprecated and replaced by "serviceAccountKeyFileSecretId". This field will be removed after February 15 2026.
- service_
account_ strkey_ file_ secret_ id - (Updatable) The OCID of the Secret where the content of the service account key file is stored, which containing the credentials required to use Google Cloud Storage. Note: When provided, 'serviceAccountKeyFile' field must not be provided.
- session_
mode str - (Updatable) 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.
- should_
use_ booljndi - (Updatable) If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.
- should_
use_ boolresource_ principal - (Updatable) Indicates that the user intents to connect to the instance through resource principal.
- should_
validate_ boolserver_ certificate - (Updatable) If set to true, the driver validates the certificate that is sent by the database server.
- ssl_
ca str - (Updatable) The base64 encoded certificate of the trusted certificate authorities (Trusted CA) for PostgreSQL. The supported file formats are .pem and .crt.
- ssl_
cert str - (Updatable) Client Certificate - The base64 encoded content of a .pem or .crt file. containing the client public key (for 2-way SSL).
- ssl_
client_ strkeystash - (Updatable) The base64 encoded keystash file which contains the encrypted password to the key database file. Deprecated: This field is deprecated and replaced by "sslClientKeystashSecretId". This field will be removed after February 15 2026.
- ssl_
client_ strkeystash_ secret_ id - (Updatable) The OCID of the Secret where the keystash file is stored, which contains the encrypted password to the key database file. Note: When provided, 'sslClientKeystash' field must not be provided.
- ssl_
client_ strkeystoredb - (Updatable) The base64 encoded keystore file created at the client containing the server certificate / CA root certificate. Deprecated: This field is deprecated and replaced by "sslClientKeystoredbSecretId". This field will be removed after February 15 2026.
- ssl_
client_ strkeystoredb_ secret_ id - (Updatable) The OCID of the Secret where the keystore file stored, which created at the client containing the server certificate / CA root certificate. Note: When provided, 'sslClientKeystoredb' field must not be provided.
- ssl_
crl str - (Updatable) The base64 encoded list of certificates revoked by the trusted certificate authorities (Trusted CA). Note: This is an optional property and only applicable if TLS/MTLS option is selected.
- ssl_
key str - (Updatable) Client Key - The base64 encoded content of a .pem or .crt file containing the client private key (for 2-way SSL). Deprecated: This field is deprecated and replaced by "sslKeySecretId". This field will be removed after February 15 2026.
- ssl_
key_ strpassword - (Updatable) The password for the cert inside of the KeyStore. In case it differs from the KeyStore password, it should be provided. Deprecated: This field is deprecated and replaced by "sslKeyPasswordSecretId". This field will be removed after February 15 2026.
- ssl_
key_ strpassword_ secret_ id - (Updatable) The OCID of the Secret where the password is stored for the cert inside of the Keystore. In case it differs from the KeyStore password, it should be provided. Note: When provided, 'sslKeyPassword' field must not be provided.
- ssl_
key_ strsecret_ id - (Updatable) The OCID of the Secret that stores the Client Key
- The content of a .pem or .crt file containing the client private key (for 2-way SSL). Note: When provided, 'sslKey' field must not be provided.
- ssl_
mode str - (Updatable) SSL modes for PostgreSQL.
- ssl_
server_ strcertificate - (Updatable) The base64 encoded file which contains the self-signed server certificate / Certificate Authority (CA) certificate.
- state str
- Possible lifecycle states for connection.
- storage_
credential_ strname - (Updatable) Optional. External storage credential name to access files on object storage such as ADLS Gen2, S3 or GCS.
- stream_
pool_ strid - (Updatable) The OCID of the stream pool being referenced.
- subnet_
id str - (Updatable) The OCID of the target subnet of the dedicated connection.
- Mapping[str, str]
- 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 - (Updatable) The OCID of the related Oracle Cloud Infrastructure tenancy.
- tenant_
id str - (Updatable) Azure tenant ID of the application. e.g.: 14593954-d337-4a61-a364-9f758c64f97f
- 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. - tls_
ca_ strfile - (Updatable) Database Certificate - The base64 encoded content of a .pem file, containing the server public key (for 1 and 2-way SSL).
- tls_
certificate_ strkey_ file - (Updatable) Client Certificate - The base64 encoded content of a .pem file, containing the client public key (for 2-way SSL). Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFileSecretId". This field will be removed after February 15 2026.
- tls_
certificate_ strkey_ file_ password - (Updatable) Client Certificate key file password. Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFilePasswordSecretId". This field will be removed after February 15 2026.
- tls_
certificate_ strkey_ file_ password_ secret_ id - (Updatable) The OCID of the Secret that stores the password of the tls certificate key file. Note: When provided, 'tlsCertificateKeyFilePassword' field must not be provided.
- tls_
certificate_ strkey_ file_ secret_ id - (Updatable) The OCID of the Secret that stores the certificate key file of the mtls connection.
- The content of a .pem file containing the client private key (for 2-way SSL). Note: When provided, 'tlsCertificateKeyFile' field must not be provided.
- trigger_
refresh bool (Updatable) If value is true, it triggers connection refresh action and this attribute change will always show up in the "update" plan and will apply steps in order to refresh secrets and dependent service properties (such as ADB connection strings, wallets, etc..).
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- trust_
store str - (Updatable) The base64 encoded content of the TrustStore file. Deprecated: This field is deprecated and replaced by "trustStoreSecretId". This field will be removed after February 15 2026.
- trust_
store_ strpassword - (Updatable) The TrustStore password. Deprecated: This field is deprecated and replaced by "trustStorePasswordSecretId". This field will be removed after February 15 2026.
- trust_
store_ strpassword_ secret_ id - (Updatable) The OCID of the Secret where the kafka Ssl TrustStore password is stored. Note: When provided, 'trustStorePassword' field must not be provided.
- trust_
store_ strsecret_ id - (Updatable) The OCID of the Secret where the content of the TrustStore file is stored. Note: When provided, 'trustStore' field must not be provided.
- url str
- (Updatable) Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'
- user_
id str - (Updatable) The OCID of the Oracle Cloud Infrastructure user who will access the Oracle NoSQL database. The user must have write access to the table they want to connect to. If the user is not provided, backend will default to the user who is calling the API endpoint.
- username str
- (Updatable) The username Oracle GoldenGate uses to connect the associated system of the given technology. This username must already exist and be available by the system/application to be connected to and must conform to the case sensitivty requirments defined in it.
- vault_
id str - (Updatable) Refers to the customer's vault OCID. If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate to manage secrets contained within this vault.
- wallet str
- (Updatable) The wallet contents Oracle GoldenGate uses to make connections to a database. This attribute is expected to be base64 encoded. Deprecated: This field is deprecated and replaced by "walletSecretId". This field will be removed after February 15 2026.
- wallet_
secret_ strid - (Updatable) The OCID of the Secret where the wallet file is stored. The wallet contents Oracle GoldenGate uses to make connections to a database. Note: When provided, 'wallet' field must not be provided.
- access
Key StringId - (Updatable) Access key ID to access the Amazon S3 bucket. e.g.: "this-is-not-the-secret"
- account
Key String - (Updatable) Azure storage account key. This property is required when 'authenticationType' is set to 'SHARED_KEY'. e.g.: pa3WbhVATzj56xD4DH1VjOUhApRGEGHvOo58eQJVWIzX+j8j4CUVFcTjpIqDSRaSa1Wo2LbWY5at+AStEgLOIQ== Deprecated: This field is deprecated and replaced by "accountKeySecretId". This field will be removed after February 15 2026.
- account
Key StringSecret Id - (Updatable) The OCID of the Secret where the account key is stored. Note: When provided, 'accountKey' field must not be provided.
- account
Name String - (Updatable) Sets the Azure storage account name.
- additional
Attributes List<Property Map> - (Updatable) An array of name-value pair attribute entries. Used as additional parameters in connection string.
- authentication
Mode String - (Updatable) Authentication mode. It can be provided at creation of Oracle Autonomous Database Serverless connections, when a databaseId is provided. The default value is MTLS.
- authentication
Type String - (Updatable) Authentication type for Java Message Service. If not provided, default is NONE. Optional until 2024-06-27, in the release after it will be made required.
- azure
Tenant StringId - (Updatable) 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 List<Property Map> - (Updatable) 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 String - (Updatable) 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 String - (Updatable) Azure client secret (aka application password) for authentication. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: dO29Q~F5-VwnA.lZdd11xFF_t5NAXCaGwDl9NbT1 Deprecated: This field is deprecated and replaced by "clientSecretSecretId". This field will be removed after February 15 2026.
- client
Secret StringSecret Id - (Updatable) The OCID of the Secret where the client secret is stored. Only applicable for authenticationType == OAUTH_M2M. Note: When provided, 'clientSecret' field must not be provided.
- compartment
Id String - (Updatable) The OCID of the compartment being referenced.
- connection
Factory String - (Updatable) The of Java class implementing javax.jms.ConnectionFactory interface supplied by the Java Message Service provider. e.g.: 'com.stc.jmsjca.core.JConnectionFactoryXA'
- connection
String String - (Updatable) Connection string. AZURE_SYNAPSE_ANALYTICS e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;', MONGODB e.g.: 'mongodb://mongodb0.example.com:27017/recordsrecords'.
- connection
Type String - (Updatable) The connection type.
- connection
Url String - (Updatable) Connection URL. e.g.: 'jdbc:databricks://adb-33934.4.azuredatabricks.net:443/default;transportMode=http;ssl=1;httpPath=sql/protocolv1/o/3393########44/0##3-7-hlrb'
- consumer
Properties String - (Updatable) The base64 encoded content of the consumer.properties file.
- core
Site StringXml - (Updatable) The base64 encoded content of the Hadoop Distributed File System configuration file (core-site.xml).
- database
Id String - (Updatable) The OCID of the Oracle Autonomous Json Database.
- database
Name String - (Updatable) The name of the database.
- db
System StringId - (Updatable) The OCID of the database system being referenced.
- Map<String>
- (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - deployment
Id String - (Updatable) The OCID of the deployment being referenced.
- description String
- (Updatable) Metadata about this specific object.
- display
Name String - (Updatable) An object's Display Name.
- does
Use BooleanSecret Ids - (Updatable) Indicates that sensitive attributes are provided via Secrets.
- endpoint String
- (Updatable)Azure Storage service endpoint. e.g: https://test.blob.core.windows.net, Optional Microsoft Fabric service endpoint. Default value: https://onelake.dfs.fabric.microsoft.com
- fingerprint String
- (Updatable) Fingerprint required by TLS security protocol. Eg.: '6152b2dfbff200f973c5074a5b91d06ab3b472c07c09a1ea57bb7fd406cdce9c'
- Map<String>
- (Updatable) 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
- (Updatable) The name or address of a host. In case of Generic connection type host and port separated by colon. Example:
"server.example.com:1234"For multiple hosts, provide a comma separated list. Example:"server1.example.com:1000,server1.example.com:2000" - ingress
Ips List<Property Map> - List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp. Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
- is
Lock BooleanOverride - jndi
Connection StringFactory - (Updatable) The Connection Factory can be looked up using this name. e.g.: 'ConnectionFactory'
- jndi
Initial StringContext Factory - (Updatable) The implementation of javax.naming.spi.InitialContextFactory interface that the client uses to obtain initial naming context. e.g.: 'org.apache.activemq.jndi.ActiveMQInitialContextFactory'
- jndi
Provider StringUrl - (Updatable) The URL that Java Message Service will use to contact the JNDI provider. e.g.: 'tcp://myjms.host.domain:61616?jms.prefetchPolicy.all=1000'
- jndi
Security StringCredentials - (Updatable) The password associated to the principal. Deprecated: This field is deprecated and replaced by "jndiSecurityCredentialsSecretId". This field will be removed after February 15 2026.
- jndi
Security StringCredentials Secret Id - (Updatable) The OCID of the Secret where the security credentials are stored associated to the principal. Note: When provided, 'jndiSecurityCredentials' field must not be provided.
- jndi
Security StringPrincipal - (Updatable) Specifies the identity of the principal (user) to be authenticated. e.g.: 'admin2'
- key
Id String - (Updatable) Refers to the customer's master key OCID. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
- key
Store String - (Updatable) The base64 encoded content of the KeyStore file. Deprecated: This field is deprecated and replaced by "keyStoreSecretId". This field will be removed after February 15 2026.
- key
Store StringPassword - (Updatable) The KeyStore password. Deprecated: This field is deprecated and replaced by "keyStorePasswordSecretId". This field will be removed after February 15 2026.
- key
Store StringPassword Secret Id - (Updatable) The OCID of the Secret where the kafka Ssl KeyStore password is stored. Note: When provided, 'keyStorePassword' field must not be provided.
- key
Store StringSecret Id - (Updatable) The OCID of the Secret where the content of the KeyStore file is stored. Note: When provided, 'keyStore' field must not be provided.
- lifecycle
Details 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.
- locks List<Property Map>
- Locks associated with this resource.
- nsg
Ids List<String> - (Updatable) An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
- password String
- (Updatable) The password Oracle GoldenGate uses to connect the associated system of the given technology. It must conform to the specific security requirements including length, case sensitivity, and so on. Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
- password
Secret StringId - (Updatable) The OCID of the Secret where the password is stored. The password Oracle GoldenGate uses to connect the associated system of the given technology. It must conform to the specific security requirements including length, case sensitivity, and so on. If secretId is used plaintext field must not be provided. Note: When provided, 'password' field must not be provided.
- port Number
- (Updatable) The port of an endpoint usually specified for a connection.
- private
Ip String (Updatable) Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host field, or make sure the host name is resolvable in the target VCN.
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 StringFile - (Updatable) The base64 encoded content of the private key file (PEM file) corresponding to the API key of the fingerprint. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm Deprecated: This field is deprecated and replaced by "privateKeyFileSecretId". This field will be removed after February 15 2026.
- private
Key StringFile Secret Id - (Updatable) The OCID of the Secret that stores the content of the private key file (PEM file) corresponding to the API key of the fingerprint. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm Note: When provided, 'privateKeyFile' field must not be provided.
- private
Key StringPassphrase - (Updatable) Password if the private key file is encrypted. Deprecated: This field is deprecated and replaced by "privateKeyPassphraseSecretId". This field will be removed after February 15 2026.
- private
Key StringPassphrase Secret Id - (Updatable) The OCID of the Secret that stores the password for the private key file. Note: When provided, 'privateKeyPassphrase' field must not be provided.
- producer
Properties String - (Updatable) The base64 encoded content of the producer.properties file.
- public
Key StringFingerprint - (Updatable) The fingerprint of the API Key of the user specified by the userId. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm
- redis
Cluster StringId - (Updatable) The OCID of the Redis cluster.
- region String
- (Updatable) The name of the region. e.g.: us-ashburn-1 If the region is not provided, backend will default to the default region.
- routing
Method String - (Updatable) Controls the network traffic direction to the target: SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets. SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet. DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
- sas
Token String - (Updatable) Credential that uses a shared access signature (SAS) to authenticate to an Azure Service. This property is required when 'authenticationType' is set to 'SHARED_ACCESS_SIGNATURE'. e.g.: ?sv=2020-06-08&ss=bfqt&srt=sco&sp=rwdlacupyx&se=2020-09-10T20:27:28Z&st=2022-08-05T12:27:28Z&spr=https&sig=C1IgHsiLBmTSStYkXXGLTP8it0xBrArcgCqOsZbXwIQ%3D Deprecated: This field is deprecated and replaced by "sasTokenSecretId". This field will be removed after February 15 2026.
- sas
Token StringSecret Id - (Updatable) The OCID of the Secret where the sas token is stored. Note: When provided, 'sasToken' field must not be provided.
- secret
Access StringKey - (Updatable) Secret access key to access the Amazon S3 bucket. e.g.: "this-is-not-the-secret" Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". This field will be removed after February 15 2026.
- secret
Access StringKey Secret Id - (Updatable) The OCID of the Secret where the secret access key is stored. Note: When provided, 'secretAccessKey' field must not be provided.
- security
Protocol String - (Updatable) Security protocol for Java Message Service. If not provided, default is PLAIN. Optional until 2024-06-27, in the release after it will be made required.
- servers String
- (Updatable) Comma separated list of Elasticsearch server addresses, specified as host:port entries, where :port is optional. If port is not specified, it defaults to 9200. Used for establishing the initial connection to the Elasticsearch cluster. Example:
"server1.example.com:4000,server2.example.com:4000" - service
Account StringKey File - (Updatable) The base64 encoded content of the service account key file containing the credentials required to use Google Cloud Storage. Deprecated: This field is deprecated and replaced by "serviceAccountKeyFileSecretId". This field will be removed after February 15 2026.
- service
Account StringKey File Secret Id - (Updatable) The OCID of the Secret where the content of the service account key file is stored, which containing the credentials required to use Google Cloud Storage. Note: When provided, 'serviceAccountKeyFile' field must not be provided.
- session
Mode String - (Updatable) 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.
- should
Use BooleanJndi - (Updatable) If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.
- should
Use BooleanResource Principal - (Updatable) Indicates that the user intents to connect to the instance through resource principal.
- should
Validate BooleanServer Certificate - (Updatable) If set to true, the driver validates the certificate that is sent by the database server.
- ssl
Ca String - (Updatable) The base64 encoded certificate of the trusted certificate authorities (Trusted CA) for PostgreSQL. The supported file formats are .pem and .crt.
- ssl
Cert String - (Updatable) Client Certificate - The base64 encoded content of a .pem or .crt file. containing the client public key (for 2-way SSL).
- ssl
Client StringKeystash - (Updatable) The base64 encoded keystash file which contains the encrypted password to the key database file. Deprecated: This field is deprecated and replaced by "sslClientKeystashSecretId". This field will be removed after February 15 2026.
- ssl
Client StringKeystash Secret Id - (Updatable) The OCID of the Secret where the keystash file is stored, which contains the encrypted password to the key database file. Note: When provided, 'sslClientKeystash' field must not be provided.
- ssl
Client StringKeystoredb - (Updatable) The base64 encoded keystore file created at the client containing the server certificate / CA root certificate. Deprecated: This field is deprecated and replaced by "sslClientKeystoredbSecretId". This field will be removed after February 15 2026.
- ssl
Client StringKeystoredb Secret Id - (Updatable) The OCID of the Secret where the keystore file stored, which created at the client containing the server certificate / CA root certificate. Note: When provided, 'sslClientKeystoredb' field must not be provided.
- ssl
Crl String - (Updatable) The base64 encoded list of certificates revoked by the trusted certificate authorities (Trusted CA). Note: This is an optional property and only applicable if TLS/MTLS option is selected.
- ssl
Key String - (Updatable) Client Key - The base64 encoded content of a .pem or .crt file containing the client private key (for 2-way SSL). Deprecated: This field is deprecated and replaced by "sslKeySecretId". This field will be removed after February 15 2026.
- ssl
Key StringPassword - (Updatable) The password for the cert inside of the KeyStore. In case it differs from the KeyStore password, it should be provided. Deprecated: This field is deprecated and replaced by "sslKeyPasswordSecretId". This field will be removed after February 15 2026.
- ssl
Key StringPassword Secret Id - (Updatable) The OCID of the Secret where the password is stored for the cert inside of the Keystore. In case it differs from the KeyStore password, it should be provided. Note: When provided, 'sslKeyPassword' field must not be provided.
- ssl
Key StringSecret Id - (Updatable) The OCID of the Secret that stores the Client Key
- The content of a .pem or .crt file containing the client private key (for 2-way SSL). Note: When provided, 'sslKey' field must not be provided.
- ssl
Mode String - (Updatable) SSL modes for PostgreSQL.
- ssl
Server StringCertificate - (Updatable) The base64 encoded file which contains the self-signed server certificate / Certificate Authority (CA) certificate.
- state String
- Possible lifecycle states for connection.
- storage
Credential StringName - (Updatable) Optional. External storage credential name to access files on object storage such as ADLS Gen2, S3 or GCS.
- stream
Pool StringId - (Updatable) The OCID of the stream pool being referenced.
- subnet
Id String - (Updatable) The OCID of the target subnet of the dedicated connection.
- Map<String>
- 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 String - The Kafka (e.g. Confluent) Schema Registry technology type.
- tenancy
Id String - (Updatable) The OCID of the related Oracle Cloud Infrastructure tenancy.
- tenant
Id String - (Updatable) Azure tenant ID of the application. e.g.: 14593954-d337-4a61-a364-9f758c64f97f
- time
Created String - The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - time
Updated String - The time the resource was last updated. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z. - tls
Ca StringFile - (Updatable) Database Certificate - The base64 encoded content of a .pem file, containing the server public key (for 1 and 2-way SSL).
- tls
Certificate StringKey File - (Updatable) Client Certificate - The base64 encoded content of a .pem file, containing the client public key (for 2-way SSL). Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFileSecretId". This field will be removed after February 15 2026.
- tls
Certificate StringKey File Password - (Updatable) Client Certificate key file password. Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFilePasswordSecretId". This field will be removed after February 15 2026.
- tls
Certificate StringKey File Password Secret Id - (Updatable) The OCID of the Secret that stores the password of the tls certificate key file. Note: When provided, 'tlsCertificateKeyFilePassword' field must not be provided.
- tls
Certificate StringKey File Secret Id - (Updatable) The OCID of the Secret that stores the certificate key file of the mtls connection.
- The content of a .pem file containing the client private key (for 2-way SSL). Note: When provided, 'tlsCertificateKeyFile' field must not be provided.
- trigger
Refresh Boolean (Updatable) If value is true, it triggers connection refresh action and this attribute change will always show up in the "update" plan and will apply steps in order to refresh secrets and dependent service properties (such as ADB connection strings, wallets, etc..).
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- trust
Store String - (Updatable) The base64 encoded content of the TrustStore file. Deprecated: This field is deprecated and replaced by "trustStoreSecretId". This field will be removed after February 15 2026.
- trust
Store StringPassword - (Updatable) The TrustStore password. Deprecated: This field is deprecated and replaced by "trustStorePasswordSecretId". This field will be removed after February 15 2026.
- trust
Store StringPassword Secret Id - (Updatable) The OCID of the Secret where the kafka Ssl TrustStore password is stored. Note: When provided, 'trustStorePassword' field must not be provided.
- trust
Store StringSecret Id - (Updatable) The OCID of the Secret where the content of the TrustStore file is stored. Note: When provided, 'trustStore' field must not be provided.
- url String
- (Updatable) Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'
- user
Id String - (Updatable) The OCID of the Oracle Cloud Infrastructure user who will access the Oracle NoSQL database. The user must have write access to the table they want to connect to. If the user is not provided, backend will default to the user who is calling the API endpoint.
- username String
- (Updatable) The username Oracle GoldenGate uses to connect the associated system of the given technology. This username must already exist and be available by the system/application to be connected to and must conform to the case sensitivty requirments defined in it.
- vault
Id String - (Updatable) Refers to the customer's vault OCID. If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate to manage secrets contained within this vault.
- wallet String
- (Updatable) The wallet contents Oracle GoldenGate uses to make connections to a database. This attribute is expected to be base64 encoded. Deprecated: This field is deprecated and replaced by "walletSecretId". This field will be removed after February 15 2026.
- wallet
Secret StringId - (Updatable) The OCID of the Secret where the wallet file is stored. The wallet contents Oracle GoldenGate uses to make connections to a database. Note: When provided, 'wallet' field must not be provided.
Supporting Types
ConnectionAdditionalAttribute, ConnectionAdditionalAttributeArgs
ConnectionBootstrapServer, ConnectionBootstrapServerArgs
- Host string
- (Updatable) The name or address of a host.
- Port int
- (Updatable) The port of an endpoint usually specified for a connection.
- Private
Ip string (Updatable) Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host field, or make sure the host name is resolvable in the target VCN.
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
- (Updatable) The name or address of a host.
- Port int
- (Updatable) The port of an endpoint usually specified for a connection.
- Private
Ip string (Updatable) Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host field, or make sure the host name is resolvable in the target VCN.
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
- (Updatable) The name or address of a host.
- port Integer
- (Updatable) The port of an endpoint usually specified for a connection.
- private
Ip String (Updatable) Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host field, or make sure the host name is resolvable in the target VCN.
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
- (Updatable) The name or address of a host.
- port number
- (Updatable) The port of an endpoint usually specified for a connection.
- private
Ip string (Updatable) Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host field, or make sure the host name is resolvable in the target VCN.
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
- (Updatable) The name or address of a host.
- port int
- (Updatable) The port of an endpoint usually specified for a connection.
- private_
ip str (Updatable) Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host field, or make sure the host name is resolvable in the target VCN.
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
- (Updatable) The name or address of a host.
- port Number
- (Updatable) The port of an endpoint usually specified for a connection.
- private
Ip String (Updatable) Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host field, or make sure the host name is resolvable in the target VCN.
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.
ConnectionIngressIp, ConnectionIngressIpArgs
- Ingress
Ip string - A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet.
- Ingress
Ip string - A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet.
- ingress
Ip String - A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet.
- ingress
Ip 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.
- ingress
Ip String - A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet.
ConnectionLock, ConnectionLockArgs
- Type string
- Type of the lock.
- Message string
- A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
- string
- The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
- Time
Created string - The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z.
- Type string
- Type of the lock.
- Message string
- A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
- string
- The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
- Time
Created string - The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z.
- type String
- Type of the lock.
- message String
- A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
- String
- The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
- time
Created String - The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z.
- type string
- Type of the lock.
- message string
- A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
- string
- The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
- time
Created string - The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z.
- type str
- Type of the lock.
- message str
- A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
- str
- The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
- time_
created str - The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z.
- type String
- Type of the lock.
- message String
- A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
- String
- The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
- time
Created String - The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z.
Import
Connections can be imported using the id, e.g.
$ pulumi import oci:GoldenGate/connection:Connection test_connection "id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
ociTerraform Provider.