published on Thursday, Nov 19, 2026 by Pulumi
published on Thursday, Nov 19, 2026 by Pulumi
This resource provides the Connection resource in Oracle Cloud Infrastructure Golden Gate service. Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/goldengate/latest/Connection
Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/goldengate
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,
}],
artifactLocation: {
configuration: {
authenticationType: connectionArtifactLocationConfigurationAuthenticationType,
accessKeyId: testKey.id,
bucket: connectionArtifactLocationConfigurationBucket,
namespace: connectionArtifactLocationConfigurationNamespace,
parUrl: connectionArtifactLocationConfigurationParUrl,
parUrlSecretId: testSecret.id,
path: connectionArtifactLocationConfigurationPath,
privateKeyFile: connectionArtifactLocationConfigurationPrivateKeyFile,
privateKeyFileSecretId: testSecret.id,
privateKeyPassphrase: connectionArtifactLocationConfigurationPrivateKeyPassphrase,
privateKeyPassphraseSecretId: testSecret.id,
publicKeyFingerprint: connectionArtifactLocationConfigurationPublicKeyFingerprint,
region: connectionArtifactLocationConfigurationRegion,
secretAccessKey: connectionArtifactLocationConfigurationSecretAccessKey,
secretAccessKeySecretId: testSecret.id,
tenancyId: testTenancy.id,
userId: testUser.id,
},
locationType: connectionArtifactLocationLocationType,
accountKey: connectionArtifactLocationAccountKey,
accountKeySecretId: testSecret.id,
endpointSuffix: connectionArtifactLocationEndpointSuffix,
filesystem: connectionArtifactLocationFilesystem,
path: connectionArtifactLocationPath,
shouldOverwriteExisting: connectionArtifactLocationShouldOverwriteExisting,
storageAccount: connectionArtifactLocationStorageAccount,
},
authDetails: {
authType: connectionAuthDetailsAuthType,
apiKey: connectionAuthDetailsApiKey,
apiKeySecretId: testSecret.id,
baseUrl: connectionAuthDetailsBaseUrl,
keyFingerprint: connectionAuthDetailsKeyFingerprint,
region: connectionAuthDetailsRegion,
tenancyId: testTenancy.id,
userId: testUser.id,
},
authSecret: connectionAuthSecret,
authSecretSecretId: testSecret.id,
authToken: connectionAuthToken,
authTokenSecretId: testSecret.id,
authenticationMode: connectionAuthenticationMode,
authenticationType: connectionAuthenticationType,
azureAuthorityHost: connectionAzureAuthorityHost,
azureTenantId: testAzureTenant.id,
bootstrapServers: [{
host: connectionBootstrapServersHost,
port: connectionBootstrapServersPort,
}],
catalog: {
catalogType: connectionCatalogCatalogType,
branch: connectionCatalogBranch,
clientId: testClient.id,
clientSecret: connectionCatalogClientSecret,
clientSecretSecretId: testSecret.id,
glueId: testGlue.id,
name: connectionCatalogName,
principalRole: connectionCatalogPrincipalRole,
properties: connectionCatalogProperties,
propertiesSecretId: testSecret.id,
uri: connectionCatalogUri,
},
clientId: testClient.id,
clientSecret: connectionClientSecret,
clientSecretSecretId: testSecret.id,
clusterEndpoint: connectionClusterEndpoint,
clusterId: testCluster.id,
clusterPlacementGroupId: testClusterPlacementGroup.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,
keyStorePasswordSecretId: testSecret.id,
keyStoreSecretId: testSecret.id,
keyStoreType: connectionKeyStoreType,
locks: [{
type: connectionLocksType,
message: connectionLocksMessage,
}],
maxInputChars: connectionMaxInputChars,
modelKey: connectionModelKey,
nsgIds: connectionNsgIds,
password: connectionPassword,
passwordSecretId: testSecret.id,
port: connectionPort,
privateKeyFile: connectionPrivateKeyFile,
privateKeyFileSecretId: testSecret.id,
privateKeyPassphrase: connectionPrivateKeyPassphrase,
privateKeyPassphraseSecretId: testSecret.id,
producerProperties: connectionProducerProperties,
providerId: testProvider.id,
providerType: connectionProviderType,
publicKeyFingerprint: connectionPublicKeyFingerprint,
redisClusterId: testRedisCluster.id,
region: connectionRegion,
restAuthSecretKey: connectionRestAuthSecretKey,
restAuthSecretKeySecretId: testSecret.id,
restEndpoint: connectionRestEndpoint,
routingMethod: connectionRoutingMethod,
rpcCipher: connectionRpcCipher,
sasToken: connectionSasToken,
sasTokenSecretId: testSecret.id,
secretAccessKey: connectionSecretAccessKey,
secretAccessKeySecretId: testSecret.id,
securityAttributes: connectionSecurityAttributes,
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,
storage: {
storageType: connectionStorageStorageType,
accessKeyId: testKey.id,
accountKey: connectionStorageAccountKey,
accountKeySecretId: testSecret.id,
accountName: connectionStorageAccountName,
bucket: connectionStorageBucket,
container: connectionStorageContainer,
endpoint: connectionStorageEndpoint,
projectId: testProject.id,
region: connectionStorageRegion,
schemeType: connectionStorageSchemeType,
secretAccessKey: connectionStorageSecretAccessKey,
secretAccessKeySecretId: testSecret.id,
serviceAccountKeyFile: connectionStorageServiceAccountKeyFile,
serviceAccountKeyFileSecretId: testSecret.id,
},
storageCredentialName: connectionStorageCredentialName,
streamPoolId: testStreamPool.id,
submitMode: connectionSubmitMode,
subnetId: testSubnet.id,
subscriptionId: testSubscription.id,
tenancyId: testTenancy.id,
tenantId: testTenant.id,
tlsCaFile: connectionTlsCaFile,
tlsCertificateKeyFile: connectionTlsCertificateKeyFile,
tlsCertificateKeyFilePassword: connectionTlsCertificateKeyFilePassword,
tlsCertificateKeyFilePasswordSecretId: testSecret.id,
tlsCertificateKeyFileSecretId: testSecret.id,
tlsProtocol: connectionTlsProtocol,
trustStore: connectionTrustStore,
trustStorePassword: connectionTrustStorePassword,
trustStorePasswordSecretId: testSecret.id,
trustStoreSecretId: testSecret.id,
trustStoreType: connectionTrustStoreType,
url: connectionUrl,
userId: testUser.id,
username: connectionUsername,
vaultId: testVault.id,
wallet: connectionWallet,
walletSecretId: testSecret.id,
workspaceUrl: connectionWorkspaceUrl,
});
import pulumi
import pulumi_oci as oci
test_connection = oci.goldengate.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,
}],
artifact_location={
"configuration": {
"authentication_type": connection_artifact_location_configuration_authentication_type,
"access_key_id": test_key["id"],
"bucket": connection_artifact_location_configuration_bucket,
"namespace": connection_artifact_location_configuration_namespace,
"par_url": connection_artifact_location_configuration_par_url,
"par_url_secret_id": test_secret["id"],
"path": connection_artifact_location_configuration_path,
"private_key_file": connection_artifact_location_configuration_private_key_file,
"private_key_file_secret_id": test_secret["id"],
"private_key_passphrase": connection_artifact_location_configuration_private_key_passphrase,
"private_key_passphrase_secret_id": test_secret["id"],
"public_key_fingerprint": connection_artifact_location_configuration_public_key_fingerprint,
"region": connection_artifact_location_configuration_region,
"secret_access_key": connection_artifact_location_configuration_secret_access_key,
"secret_access_key_secret_id": test_secret["id"],
"tenancy_id": test_tenancy["id"],
"user_id": test_user["id"],
},
"location_type": connection_artifact_location_location_type,
"account_key": connection_artifact_location_account_key,
"account_key_secret_id": test_secret["id"],
"endpoint_suffix": connection_artifact_location_endpoint_suffix,
"filesystem": connection_artifact_location_filesystem,
"path": connection_artifact_location_path,
"should_overwrite_existing": connection_artifact_location_should_overwrite_existing,
"storage_account": connection_artifact_location_storage_account,
},
auth_details={
"auth_type": connection_auth_details_auth_type,
"api_key": connection_auth_details_api_key,
"api_key_secret_id": test_secret["id"],
"base_url": connection_auth_details_base_url,
"key_fingerprint": connection_auth_details_key_fingerprint,
"region": connection_auth_details_region,
"tenancy_id": test_tenancy["id"],
"user_id": test_user["id"],
},
auth_secret=connection_auth_secret,
auth_secret_secret_id=test_secret["id"],
auth_token=connection_auth_token,
auth_token_secret_id=test_secret["id"],
authentication_mode=connection_authentication_mode,
authentication_type=connection_authentication_type,
azure_authority_host=connection_azure_authority_host,
azure_tenant_id=test_azure_tenant["id"],
bootstrap_servers=[{
"host": connection_bootstrap_servers_host,
"port": connection_bootstrap_servers_port,
}],
catalog={
"catalog_type": connection_catalog_catalog_type,
"branch": connection_catalog_branch,
"client_id": test_client["id"],
"client_secret": connection_catalog_client_secret,
"client_secret_secret_id": test_secret["id"],
"glue_id": test_glue["id"],
"name": connection_catalog_name,
"principal_role": connection_catalog_principal_role,
"properties": connection_catalog_properties,
"properties_secret_id": test_secret["id"],
"uri": connection_catalog_uri,
},
client_id=test_client["id"],
client_secret=connection_client_secret,
client_secret_secret_id=test_secret["id"],
cluster_endpoint=connection_cluster_endpoint,
cluster_id=test_cluster["id"],
cluster_placement_group_id=test_cluster_placement_group["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_password_secret_id=test_secret["id"],
key_store_secret_id=test_secret["id"],
key_store_type=connection_key_store_type,
locks=[{
"type": connection_locks_type,
"message": connection_locks_message,
}],
max_input_chars=connection_max_input_chars,
model_key=connection_model_key,
nsg_ids=connection_nsg_ids,
password=connection_password,
password_secret_id=test_secret["id"],
port=connection_port,
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,
provider_id=test_provider["id"],
provider_type=connection_provider_type,
public_key_fingerprint=connection_public_key_fingerprint,
redis_cluster_id=test_redis_cluster["id"],
region=connection_region,
rest_auth_secret_key=connection_rest_auth_secret_key,
rest_auth_secret_key_secret_id=test_secret["id"],
rest_endpoint=connection_rest_endpoint,
routing_method=connection_routing_method,
rpc_cipher=connection_rpc_cipher,
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_attributes=connection_security_attributes,
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={
"storage_type": connection_storage_storage_type,
"access_key_id": test_key["id"],
"account_key": connection_storage_account_key,
"account_key_secret_id": test_secret["id"],
"account_name": connection_storage_account_name,
"bucket": connection_storage_bucket,
"container": connection_storage_container,
"endpoint": connection_storage_endpoint,
"project_id": test_project["id"],
"region": connection_storage_region,
"scheme_type": connection_storage_scheme_type,
"secret_access_key": connection_storage_secret_access_key,
"secret_access_key_secret_id": test_secret["id"],
"service_account_key_file": connection_storage_service_account_key_file,
"service_account_key_file_secret_id": test_secret["id"],
},
storage_credential_name=connection_storage_credential_name,
stream_pool_id=test_stream_pool["id"],
submit_mode=connection_submit_mode,
subnet_id=test_subnet["id"],
subscription_id=test_subscription["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"],
tls_protocol=connection_tls_protocol,
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"],
trust_store_type=connection_trust_store_type,
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"],
workspace_url=connection_workspace_url)
package main
import (
"github.com/pulumi/pulumi-oci/sdk/v5/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),
},
},
ArtifactLocation: &goldengate.ConnectionArtifactLocationArgs{
Configuration: &goldengate.ConnectionArtifactLocationConfigurationArgs{
AuthenticationType: pulumi.Any(connectionArtifactLocationConfigurationAuthenticationType),
AccessKeyId: pulumi.Any(testKey.Id),
Bucket: pulumi.Any(connectionArtifactLocationConfigurationBucket),
Namespace: pulumi.Any(connectionArtifactLocationConfigurationNamespace),
ParUrl: pulumi.Any(connectionArtifactLocationConfigurationParUrl),
ParUrlSecretId: pulumi.Any(testSecret.Id),
Path: pulumi.Any(connectionArtifactLocationConfigurationPath),
PrivateKeyFile: pulumi.Any(connectionArtifactLocationConfigurationPrivateKeyFile),
PrivateKeyFileSecretId: pulumi.Any(testSecret.Id),
PrivateKeyPassphrase: pulumi.Any(connectionArtifactLocationConfigurationPrivateKeyPassphrase),
PrivateKeyPassphraseSecretId: pulumi.Any(testSecret.Id),
PublicKeyFingerprint: pulumi.Any(connectionArtifactLocationConfigurationPublicKeyFingerprint),
Region: pulumi.Any(connectionArtifactLocationConfigurationRegion),
SecretAccessKey: pulumi.Any(connectionArtifactLocationConfigurationSecretAccessKey),
SecretAccessKeySecretId: pulumi.Any(testSecret.Id),
TenancyId: pulumi.Any(testTenancy.Id),
UserId: pulumi.Any(testUser.Id),
},
LocationType: pulumi.Any(connectionArtifactLocationLocationType),
AccountKey: pulumi.Any(connectionArtifactLocationAccountKey),
AccountKeySecretId: pulumi.Any(testSecret.Id),
EndpointSuffix: pulumi.Any(connectionArtifactLocationEndpointSuffix),
Filesystem: pulumi.Any(connectionArtifactLocationFilesystem),
Path: pulumi.Any(connectionArtifactLocationPath),
ShouldOverwriteExisting: pulumi.Any(connectionArtifactLocationShouldOverwriteExisting),
StorageAccount: pulumi.Any(connectionArtifactLocationStorageAccount),
},
AuthDetails: &goldengate.ConnectionAuthDetailsArgs{
AuthType: pulumi.Any(connectionAuthDetailsAuthType),
ApiKey: pulumi.Any(connectionAuthDetailsApiKey),
ApiKeySecretId: pulumi.Any(testSecret.Id),
BaseUrl: pulumi.Any(connectionAuthDetailsBaseUrl),
KeyFingerprint: pulumi.Any(connectionAuthDetailsKeyFingerprint),
Region: pulumi.Any(connectionAuthDetailsRegion),
TenancyId: pulumi.Any(testTenancy.Id),
UserId: pulumi.Any(testUser.Id),
},
AuthSecret: pulumi.Any(connectionAuthSecret),
AuthSecretSecretId: pulumi.Any(testSecret.Id),
AuthToken: pulumi.Any(connectionAuthToken),
AuthTokenSecretId: pulumi.Any(testSecret.Id),
AuthenticationMode: pulumi.Any(connectionAuthenticationMode),
AuthenticationType: pulumi.Any(connectionAuthenticationType),
AzureAuthorityHost: pulumi.Any(connectionAzureAuthorityHost),
AzureTenantId: pulumi.Any(testAzureTenant.Id),
BootstrapServers: goldengate.ConnectionBootstrapServerArray{
&goldengate.ConnectionBootstrapServerArgs{
Host: pulumi.Any(connectionBootstrapServersHost),
Port: pulumi.Any(connectionBootstrapServersPort),
},
},
Catalog: &goldengate.ConnectionCatalogArgs{
CatalogType: pulumi.Any(connectionCatalogCatalogType),
Branch: pulumi.Any(connectionCatalogBranch),
ClientId: pulumi.Any(testClient.Id),
ClientSecret: pulumi.Any(connectionCatalogClientSecret),
ClientSecretSecretId: pulumi.Any(testSecret.Id),
GlueId: pulumi.Any(testGlue.Id),
Name: pulumi.Any(connectionCatalogName),
PrincipalRole: pulumi.Any(connectionCatalogPrincipalRole),
Properties: pulumi.Any(connectionCatalogProperties),
PropertiesSecretId: pulumi.Any(testSecret.Id),
Uri: pulumi.Any(connectionCatalogUri),
},
ClientId: pulumi.Any(testClient.Id),
ClientSecret: pulumi.Any(connectionClientSecret),
ClientSecretSecretId: pulumi.Any(testSecret.Id),
ClusterEndpoint: pulumi.Any(connectionClusterEndpoint),
ClusterId: pulumi.Any(testCluster.Id),
ClusterPlacementGroupId: pulumi.Any(testClusterPlacementGroup.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),
KeyStorePasswordSecretId: pulumi.Any(testSecret.Id),
KeyStoreSecretId: pulumi.Any(testSecret.Id),
KeyStoreType: pulumi.Any(connectionKeyStoreType),
Locks: goldengate.ConnectionLockArray{
&goldengate.ConnectionLockArgs{
Type: pulumi.Any(connectionLocksType),
Message: pulumi.Any(connectionLocksMessage),
},
},
MaxInputChars: pulumi.Any(connectionMaxInputChars),
ModelKey: pulumi.Any(connectionModelKey),
NsgIds: pulumi.Any(connectionNsgIds),
Password: pulumi.Any(connectionPassword),
PasswordSecretId: pulumi.Any(testSecret.Id),
Port: pulumi.Any(connectionPort),
PrivateKeyFile: pulumi.Any(connectionPrivateKeyFile),
PrivateKeyFileSecretId: pulumi.Any(testSecret.Id),
PrivateKeyPassphrase: pulumi.Any(connectionPrivateKeyPassphrase),
PrivateKeyPassphraseSecretId: pulumi.Any(testSecret.Id),
ProducerProperties: pulumi.Any(connectionProducerProperties),
ProviderId: pulumi.Any(testProvider.Id),
ProviderType: pulumi.Any(connectionProviderType),
PublicKeyFingerprint: pulumi.Any(connectionPublicKeyFingerprint),
RedisClusterId: pulumi.Any(testRedisCluster.Id),
Region: pulumi.Any(connectionRegion),
RestAuthSecretKey: pulumi.Any(connectionRestAuthSecretKey),
RestAuthSecretKeySecretId: pulumi.Any(testSecret.Id),
RestEndpoint: pulumi.Any(connectionRestEndpoint),
RoutingMethod: pulumi.Any(connectionRoutingMethod),
RpcCipher: pulumi.Any(connectionRpcCipher),
SasToken: pulumi.Any(connectionSasToken),
SasTokenSecretId: pulumi.Any(testSecret.Id),
SecretAccessKey: pulumi.Any(connectionSecretAccessKey),
SecretAccessKeySecretId: pulumi.Any(testSecret.Id),
SecurityAttributes: pulumi.Any(connectionSecurityAttributes),
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),
Storage: &goldengate.ConnectionStorageArgs{
StorageType: pulumi.Any(connectionStorageStorageType),
AccessKeyId: pulumi.Any(testKey.Id),
AccountKey: pulumi.Any(connectionStorageAccountKey),
AccountKeySecretId: pulumi.Any(testSecret.Id),
AccountName: pulumi.Any(connectionStorageAccountName),
Bucket: pulumi.Any(connectionStorageBucket),
Container: pulumi.Any(connectionStorageContainer),
Endpoint: pulumi.Any(connectionStorageEndpoint),
ProjectId: pulumi.Any(testProject.Id),
Region: pulumi.Any(connectionStorageRegion),
SchemeType: pulumi.Any(connectionStorageSchemeType),
SecretAccessKey: pulumi.Any(connectionStorageSecretAccessKey),
SecretAccessKeySecretId: pulumi.Any(testSecret.Id),
ServiceAccountKeyFile: pulumi.Any(connectionStorageServiceAccountKeyFile),
ServiceAccountKeyFileSecretId: pulumi.Any(testSecret.Id),
},
StorageCredentialName: pulumi.Any(connectionStorageCredentialName),
StreamPoolId: pulumi.Any(testStreamPool.Id),
SubmitMode: pulumi.Any(connectionSubmitMode),
SubnetId: pulumi.Any(testSubnet.Id),
SubscriptionId: pulumi.Any(testSubscription.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),
TlsProtocol: pulumi.Any(connectionTlsProtocol),
TrustStore: pulumi.Any(connectionTrustStore),
TrustStorePassword: pulumi.Any(connectionTrustStorePassword),
TrustStorePasswordSecretId: pulumi.Any(testSecret.Id),
TrustStoreSecretId: pulumi.Any(testSecret.Id),
TrustStoreType: pulumi.Any(connectionTrustStoreType),
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),
WorkspaceUrl: pulumi.Any(connectionWorkspaceUrl),
})
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,
},
},
ArtifactLocation = new Oci.GoldenGate.Inputs.ConnectionArtifactLocationArgs
{
Configuration = new Oci.GoldenGate.Inputs.ConnectionArtifactLocationConfigurationArgs
{
AuthenticationType = connectionArtifactLocationConfigurationAuthenticationType,
AccessKeyId = testKey.Id,
Bucket = connectionArtifactLocationConfigurationBucket,
Namespace = connectionArtifactLocationConfigurationNamespace,
ParUrl = connectionArtifactLocationConfigurationParUrl,
ParUrlSecretId = testSecret.Id,
Path = connectionArtifactLocationConfigurationPath,
PrivateKeyFile = connectionArtifactLocationConfigurationPrivateKeyFile,
PrivateKeyFileSecretId = testSecret.Id,
PrivateKeyPassphrase = connectionArtifactLocationConfigurationPrivateKeyPassphrase,
PrivateKeyPassphraseSecretId = testSecret.Id,
PublicKeyFingerprint = connectionArtifactLocationConfigurationPublicKeyFingerprint,
Region = connectionArtifactLocationConfigurationRegion,
SecretAccessKey = connectionArtifactLocationConfigurationSecretAccessKey,
SecretAccessKeySecretId = testSecret.Id,
TenancyId = testTenancy.Id,
UserId = testUser.Id,
},
LocationType = connectionArtifactLocationLocationType,
AccountKey = connectionArtifactLocationAccountKey,
AccountKeySecretId = testSecret.Id,
EndpointSuffix = connectionArtifactLocationEndpointSuffix,
Filesystem = connectionArtifactLocationFilesystem,
Path = connectionArtifactLocationPath,
ShouldOverwriteExisting = connectionArtifactLocationShouldOverwriteExisting,
StorageAccount = connectionArtifactLocationStorageAccount,
},
AuthDetails = new Oci.GoldenGate.Inputs.ConnectionAuthDetailsArgs
{
AuthType = connectionAuthDetailsAuthType,
ApiKey = connectionAuthDetailsApiKey,
ApiKeySecretId = testSecret.Id,
BaseUrl = connectionAuthDetailsBaseUrl,
KeyFingerprint = connectionAuthDetailsKeyFingerprint,
Region = connectionAuthDetailsRegion,
TenancyId = testTenancy.Id,
UserId = testUser.Id,
},
AuthSecret = connectionAuthSecret,
AuthSecretSecretId = testSecret.Id,
AuthToken = connectionAuthToken,
AuthTokenSecretId = testSecret.Id,
AuthenticationMode = connectionAuthenticationMode,
AuthenticationType = connectionAuthenticationType,
AzureAuthorityHost = connectionAzureAuthorityHost,
AzureTenantId = testAzureTenant.Id,
BootstrapServers = new[]
{
new Oci.GoldenGate.Inputs.ConnectionBootstrapServerArgs
{
Host = connectionBootstrapServersHost,
Port = connectionBootstrapServersPort,
},
},
Catalog = new Oci.GoldenGate.Inputs.ConnectionCatalogArgs
{
CatalogType = connectionCatalogCatalogType,
Branch = connectionCatalogBranch,
ClientId = testClient.Id,
ClientSecret = connectionCatalogClientSecret,
ClientSecretSecretId = testSecret.Id,
GlueId = testGlue.Id,
Name = connectionCatalogName,
PrincipalRole = connectionCatalogPrincipalRole,
Properties = connectionCatalogProperties,
PropertiesSecretId = testSecret.Id,
Uri = connectionCatalogUri,
},
ClientId = testClient.Id,
ClientSecret = connectionClientSecret,
ClientSecretSecretId = testSecret.Id,
ClusterEndpoint = connectionClusterEndpoint,
ClusterId = testCluster.Id,
ClusterPlacementGroupId = testClusterPlacementGroup.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,
KeyStorePasswordSecretId = testSecret.Id,
KeyStoreSecretId = testSecret.Id,
KeyStoreType = connectionKeyStoreType,
Locks = new[]
{
new Oci.GoldenGate.Inputs.ConnectionLockArgs
{
Type = connectionLocksType,
Message = connectionLocksMessage,
},
},
MaxInputChars = connectionMaxInputChars,
ModelKey = connectionModelKey,
NsgIds = connectionNsgIds,
Password = connectionPassword,
PasswordSecretId = testSecret.Id,
Port = connectionPort,
PrivateKeyFile = connectionPrivateKeyFile,
PrivateKeyFileSecretId = testSecret.Id,
PrivateKeyPassphrase = connectionPrivateKeyPassphrase,
PrivateKeyPassphraseSecretId = testSecret.Id,
ProducerProperties = connectionProducerProperties,
ProviderId = testProvider.Id,
ProviderType = connectionProviderType,
PublicKeyFingerprint = connectionPublicKeyFingerprint,
RedisClusterId = testRedisCluster.Id,
Region = connectionRegion,
RestAuthSecretKey = connectionRestAuthSecretKey,
RestAuthSecretKeySecretId = testSecret.Id,
RestEndpoint = connectionRestEndpoint,
RoutingMethod = connectionRoutingMethod,
RpcCipher = connectionRpcCipher,
SasToken = connectionSasToken,
SasTokenSecretId = testSecret.Id,
SecretAccessKey = connectionSecretAccessKey,
SecretAccessKeySecretId = testSecret.Id,
SecurityAttributes = connectionSecurityAttributes,
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,
Storage = new Oci.GoldenGate.Inputs.ConnectionStorageArgs
{
StorageType = connectionStorageStorageType,
AccessKeyId = testKey.Id,
AccountKey = connectionStorageAccountKey,
AccountKeySecretId = testSecret.Id,
AccountName = connectionStorageAccountName,
Bucket = connectionStorageBucket,
Container = connectionStorageContainer,
Endpoint = connectionStorageEndpoint,
ProjectId = testProject.Id,
Region = connectionStorageRegion,
SchemeType = connectionStorageSchemeType,
SecretAccessKey = connectionStorageSecretAccessKey,
SecretAccessKeySecretId = testSecret.Id,
ServiceAccountKeyFile = connectionStorageServiceAccountKeyFile,
ServiceAccountKeyFileSecretId = testSecret.Id,
},
StorageCredentialName = connectionStorageCredentialName,
StreamPoolId = testStreamPool.Id,
SubmitMode = connectionSubmitMode,
SubnetId = testSubnet.Id,
SubscriptionId = testSubscription.Id,
TenancyId = testTenancy.Id,
TenantId = testTenant.Id,
TlsCaFile = connectionTlsCaFile,
TlsCertificateKeyFile = connectionTlsCertificateKeyFile,
TlsCertificateKeyFilePassword = connectionTlsCertificateKeyFilePassword,
TlsCertificateKeyFilePasswordSecretId = testSecret.Id,
TlsCertificateKeyFileSecretId = testSecret.Id,
TlsProtocol = connectionTlsProtocol,
TrustStore = connectionTrustStore,
TrustStorePassword = connectionTrustStorePassword,
TrustStorePasswordSecretId = testSecret.Id,
TrustStoreSecretId = testSecret.Id,
TrustStoreType = connectionTrustStoreType,
Url = connectionUrl,
UserId = testUser.Id,
Username = connectionUsername,
VaultId = testVault.Id,
Wallet = connectionWallet,
WalletSecretId = testSecret.Id,
WorkspaceUrl = connectionWorkspaceUrl,
});
});
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.ConnectionArtifactLocationArgs;
import com.pulumi.oci.GoldenGate.inputs.ConnectionArtifactLocationConfigurationArgs;
import com.pulumi.oci.GoldenGate.inputs.ConnectionAuthDetailsArgs;
import com.pulumi.oci.GoldenGate.inputs.ConnectionBootstrapServerArgs;
import com.pulumi.oci.GoldenGate.inputs.ConnectionCatalogArgs;
import com.pulumi.oci.GoldenGate.inputs.ConnectionLockArgs;
import com.pulumi.oci.GoldenGate.inputs.ConnectionStorageArgs;
import java.util.ArrayList;
import java.util.Arrays;
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.get("id"))
.accountKey(connectionAccountKey)
.accountKeySecretId(testSecret.get("id"))
.accountName(connectionAccountName)
.additionalAttributes(ConnectionAdditionalAttributeArgs.builder()
.name(connectionAdditionalAttributesName)
.value(connectionAdditionalAttributesValue)
.build())
.artifactLocation(ConnectionArtifactLocationArgs.builder()
.configuration(ConnectionArtifactLocationConfigurationArgs.builder()
.authenticationType(connectionArtifactLocationConfigurationAuthenticationType)
.accessKeyId(testKey.get("id"))
.bucket(connectionArtifactLocationConfigurationBucket)
.namespace(connectionArtifactLocationConfigurationNamespace)
.parUrl(connectionArtifactLocationConfigurationParUrl)
.parUrlSecretId(testSecret.get("id"))
.path(connectionArtifactLocationConfigurationPath)
.privateKeyFile(connectionArtifactLocationConfigurationPrivateKeyFile)
.privateKeyFileSecretId(testSecret.get("id"))
.privateKeyPassphrase(connectionArtifactLocationConfigurationPrivateKeyPassphrase)
.privateKeyPassphraseSecretId(testSecret.get("id"))
.publicKeyFingerprint(connectionArtifactLocationConfigurationPublicKeyFingerprint)
.region(connectionArtifactLocationConfigurationRegion)
.secretAccessKey(connectionArtifactLocationConfigurationSecretAccessKey)
.secretAccessKeySecretId(testSecret.get("id"))
.tenancyId(testTenancy.get("id"))
.userId(testUser.get("id"))
.build())
.locationType(connectionArtifactLocationLocationType)
.accountKey(connectionArtifactLocationAccountKey)
.accountKeySecretId(testSecret.get("id"))
.endpointSuffix(connectionArtifactLocationEndpointSuffix)
.filesystem(connectionArtifactLocationFilesystem)
.path(connectionArtifactLocationPath)
.shouldOverwriteExisting(connectionArtifactLocationShouldOverwriteExisting)
.storageAccount(connectionArtifactLocationStorageAccount)
.build())
.authDetails(ConnectionAuthDetailsArgs.builder()
.authType(connectionAuthDetailsAuthType)
.apiKey(connectionAuthDetailsApiKey)
.apiKeySecretId(testSecret.get("id"))
.baseUrl(connectionAuthDetailsBaseUrl)
.keyFingerprint(connectionAuthDetailsKeyFingerprint)
.region(connectionAuthDetailsRegion)
.tenancyId(testTenancy.get("id"))
.userId(testUser.get("id"))
.build())
.authSecret(connectionAuthSecret)
.authSecretSecretId(testSecret.get("id"))
.authToken(connectionAuthToken)
.authTokenSecretId(testSecret.get("id"))
.authenticationMode(connectionAuthenticationMode)
.authenticationType(connectionAuthenticationType)
.azureAuthorityHost(connectionAzureAuthorityHost)
.azureTenantId(testAzureTenant.get("id"))
.bootstrapServers(ConnectionBootstrapServerArgs.builder()
.host(connectionBootstrapServersHost)
.port(connectionBootstrapServersPort)
.build())
.catalog(ConnectionCatalogArgs.builder()
.catalogType(connectionCatalogCatalogType)
.branch(connectionCatalogBranch)
.clientId(testClient.get("id"))
.clientSecret(connectionCatalogClientSecret)
.clientSecretSecretId(testSecret.get("id"))
.glueId(testGlue.get("id"))
.name(connectionCatalogName)
.principalRole(connectionCatalogPrincipalRole)
.properties(connectionCatalogProperties)
.propertiesSecretId(testSecret.get("id"))
.uri(connectionCatalogUri)
.build())
.clientId(testClient.get("id"))
.clientSecret(connectionClientSecret)
.clientSecretSecretId(testSecret.get("id"))
.clusterEndpoint(connectionClusterEndpoint)
.clusterId(testCluster.get("id"))
.clusterPlacementGroupId(testClusterPlacementGroup.get("id"))
.connectionFactory(connectionConnectionFactory)
.connectionString(connectionConnectionString)
.connectionUrl(connectionConnectionUrl)
.consumerProperties(connectionConsumerProperties)
.coreSiteXml(connectionCoreSiteXml)
.databaseId(testDatabase.get("id"))
.databaseName(testDatabase.get("name"))
.dbSystemId(testDbSystem.get("id"))
.definedTags(Map.of("foo-namespace.bar-key", "value"))
.deploymentId(testDeployment.get("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.get("id"))
.jndiSecurityPrincipal(connectionJndiSecurityPrincipal)
.keyId(testKey.get("id"))
.keyStore(connectionKeyStore)
.keyStorePassword(connectionKeyStorePassword)
.keyStorePasswordSecretId(testSecret.get("id"))
.keyStoreSecretId(testSecret.get("id"))
.keyStoreType(connectionKeyStoreType)
.locks(ConnectionLockArgs.builder()
.type(connectionLocksType)
.message(connectionLocksMessage)
.build())
.maxInputChars(connectionMaxInputChars)
.modelKey(connectionModelKey)
.nsgIds(connectionNsgIds)
.password(connectionPassword)
.passwordSecretId(testSecret.get("id"))
.port(connectionPort)
.privateKeyFile(connectionPrivateKeyFile)
.privateKeyFileSecretId(testSecret.get("id"))
.privateKeyPassphrase(connectionPrivateKeyPassphrase)
.privateKeyPassphraseSecretId(testSecret.get("id"))
.producerProperties(connectionProducerProperties)
.providerId(testProvider.get("id"))
.providerType(connectionProviderType)
.publicKeyFingerprint(connectionPublicKeyFingerprint)
.redisClusterId(testRedisCluster.get("id"))
.region(connectionRegion)
.restAuthSecretKey(connectionRestAuthSecretKey)
.restAuthSecretKeySecretId(testSecret.get("id"))
.restEndpoint(connectionRestEndpoint)
.routingMethod(connectionRoutingMethod)
.rpcCipher(connectionRpcCipher)
.sasToken(connectionSasToken)
.sasTokenSecretId(testSecret.get("id"))
.secretAccessKey(connectionSecretAccessKey)
.secretAccessKeySecretId(testSecret.get("id"))
.securityAttributes(connectionSecurityAttributes)
.securityProtocol(connectionSecurityProtocol)
.servers(connectionServers)
.serviceAccountKeyFile(connectionServiceAccountKeyFile)
.serviceAccountKeyFileSecretId(testSecret.get("id"))
.sessionMode(connectionSessionMode)
.shouldUseJndi(connectionShouldUseJndi)
.shouldUseResourcePrincipal(connectionShouldUseResourcePrincipal)
.shouldValidateServerCertificate(connectionShouldValidateServerCertificate)
.sslCa(connectionSslCa)
.sslCert(connectionSslCert)
.sslClientKeystash(connectionSslClientKeystash)
.sslClientKeystashSecretId(testSecret.get("id"))
.sslClientKeystoredb(connectionSslClientKeystoredb)
.sslClientKeystoredbSecretId(testSecret.get("id"))
.sslCrl(connectionSslCrl)
.sslKey(connectionSslKey)
.sslKeyPassword(connectionSslKeyPassword)
.sslKeyPasswordSecretId(testSecret.get("id"))
.sslKeySecretId(testSecret.get("id"))
.sslMode(connectionSslMode)
.sslServerCertificate(connectionSslServerCertificate)
.storage(ConnectionStorageArgs.builder()
.storageType(connectionStorageStorageType)
.accessKeyId(testKey.get("id"))
.accountKey(connectionStorageAccountKey)
.accountKeySecretId(testSecret.get("id"))
.accountName(connectionStorageAccountName)
.bucket(connectionStorageBucket)
.container(connectionStorageContainer)
.endpoint(connectionStorageEndpoint)
.projectId(testProject.get("id"))
.region(connectionStorageRegion)
.schemeType(connectionStorageSchemeType)
.secretAccessKey(connectionStorageSecretAccessKey)
.secretAccessKeySecretId(testSecret.get("id"))
.serviceAccountKeyFile(connectionStorageServiceAccountKeyFile)
.serviceAccountKeyFileSecretId(testSecret.get("id"))
.build())
.storageCredentialName(connectionStorageCredentialName)
.streamPoolId(testStreamPool.get("id"))
.submitMode(connectionSubmitMode)
.subnetId(testSubnet.get("id"))
.subscriptionId(testSubscription.get("id"))
.tenancyId(testTenancy.get("id"))
.tenantId(testTenant.get("id"))
.tlsCaFile(connectionTlsCaFile)
.tlsCertificateKeyFile(connectionTlsCertificateKeyFile)
.tlsCertificateKeyFilePassword(connectionTlsCertificateKeyFilePassword)
.tlsCertificateKeyFilePasswordSecretId(testSecret.get("id"))
.tlsCertificateKeyFileSecretId(testSecret.get("id"))
.tlsProtocol(connectionTlsProtocol)
.trustStore(connectionTrustStore)
.trustStorePassword(connectionTrustStorePassword)
.trustStorePasswordSecretId(testSecret.get("id"))
.trustStoreSecretId(testSecret.get("id"))
.trustStoreType(connectionTrustStoreType)
.url(connectionUrl)
.userId(testUser.get("id"))
.username(connectionUsername)
.vaultId(testVault.get("id"))
.wallet(connectionWallet)
.walletSecretId(testSecret.get("id"))
.workspaceUrl(connectionWorkspaceUrl)
.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}
artifactLocation:
configuration:
authenticationType: ${connectionArtifactLocationConfigurationAuthenticationType}
accessKeyId: ${testKey.id}
bucket: ${connectionArtifactLocationConfigurationBucket}
namespace: ${connectionArtifactLocationConfigurationNamespace}
parUrl: ${connectionArtifactLocationConfigurationParUrl}
parUrlSecretId: ${testSecret.id}
path: ${connectionArtifactLocationConfigurationPath}
privateKeyFile: ${connectionArtifactLocationConfigurationPrivateKeyFile}
privateKeyFileSecretId: ${testSecret.id}
privateKeyPassphrase: ${connectionArtifactLocationConfigurationPrivateKeyPassphrase}
privateKeyPassphraseSecretId: ${testSecret.id}
publicKeyFingerprint: ${connectionArtifactLocationConfigurationPublicKeyFingerprint}
region: ${connectionArtifactLocationConfigurationRegion}
secretAccessKey: ${connectionArtifactLocationConfigurationSecretAccessKey}
secretAccessKeySecretId: ${testSecret.id}
tenancyId: ${testTenancy.id}
userId: ${testUser.id}
locationType: ${connectionArtifactLocationLocationType}
accountKey: ${connectionArtifactLocationAccountKey}
accountKeySecretId: ${testSecret.id}
endpointSuffix: ${connectionArtifactLocationEndpointSuffix}
filesystem: ${connectionArtifactLocationFilesystem}
path: ${connectionArtifactLocationPath}
shouldOverwriteExisting: ${connectionArtifactLocationShouldOverwriteExisting}
storageAccount: ${connectionArtifactLocationStorageAccount}
authDetails:
authType: ${connectionAuthDetailsAuthType}
apiKey: ${connectionAuthDetailsApiKey}
apiKeySecretId: ${testSecret.id}
baseUrl: ${connectionAuthDetailsBaseUrl}
keyFingerprint: ${connectionAuthDetailsKeyFingerprint}
region: ${connectionAuthDetailsRegion}
tenancyId: ${testTenancy.id}
userId: ${testUser.id}
authSecret: ${connectionAuthSecret}
authSecretSecretId: ${testSecret.id}
authToken: ${connectionAuthToken}
authTokenSecretId: ${testSecret.id}
authenticationMode: ${connectionAuthenticationMode}
authenticationType: ${connectionAuthenticationType}
azureAuthorityHost: ${connectionAzureAuthorityHost}
azureTenantId: ${testAzureTenant.id}
bootstrapServers:
- host: ${connectionBootstrapServersHost}
port: ${connectionBootstrapServersPort}
catalog:
catalogType: ${connectionCatalogCatalogType}
branch: ${connectionCatalogBranch}
clientId: ${testClient.id}
clientSecret: ${connectionCatalogClientSecret}
clientSecretSecretId: ${testSecret.id}
glueId: ${testGlue.id}
name: ${connectionCatalogName}
principalRole: ${connectionCatalogPrincipalRole}
properties: ${connectionCatalogProperties}
propertiesSecretId: ${testSecret.id}
uri: ${connectionCatalogUri}
clientId: ${testClient.id}
clientSecret: ${connectionClientSecret}
clientSecretSecretId: ${testSecret.id}
clusterEndpoint: ${connectionClusterEndpoint}
clusterId: ${testCluster.id}
clusterPlacementGroupId: ${testClusterPlacementGroup.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}
keyStorePasswordSecretId: ${testSecret.id}
keyStoreSecretId: ${testSecret.id}
keyStoreType: ${connectionKeyStoreType}
locks:
- type: ${connectionLocksType}
message: ${connectionLocksMessage}
maxInputChars: ${connectionMaxInputChars}
modelKey: ${connectionModelKey}
nsgIds: ${connectionNsgIds}
password: ${connectionPassword}
passwordSecretId: ${testSecret.id}
port: ${connectionPort}
privateKeyFile: ${connectionPrivateKeyFile}
privateKeyFileSecretId: ${testSecret.id}
privateKeyPassphrase: ${connectionPrivateKeyPassphrase}
privateKeyPassphraseSecretId: ${testSecret.id}
producerProperties: ${connectionProducerProperties}
providerId: ${testProvider.id}
providerType: ${connectionProviderType}
publicKeyFingerprint: ${connectionPublicKeyFingerprint}
redisClusterId: ${testRedisCluster.id}
region: ${connectionRegion}
restAuthSecretKey: ${connectionRestAuthSecretKey}
restAuthSecretKeySecretId: ${testSecret.id}
restEndpoint: ${connectionRestEndpoint}
routingMethod: ${connectionRoutingMethod}
rpcCipher: ${connectionRpcCipher}
sasToken: ${connectionSasToken}
sasTokenSecretId: ${testSecret.id}
secretAccessKey: ${connectionSecretAccessKey}
secretAccessKeySecretId: ${testSecret.id}
securityAttributes: ${connectionSecurityAttributes}
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}
storage:
storageType: ${connectionStorageStorageType}
accessKeyId: ${testKey.id}
accountKey: ${connectionStorageAccountKey}
accountKeySecretId: ${testSecret.id}
accountName: ${connectionStorageAccountName}
bucket: ${connectionStorageBucket}
container: ${connectionStorageContainer}
endpoint: ${connectionStorageEndpoint}
projectId: ${testProject.id}
region: ${connectionStorageRegion}
schemeType: ${connectionStorageSchemeType}
secretAccessKey: ${connectionStorageSecretAccessKey}
secretAccessKeySecretId: ${testSecret.id}
serviceAccountKeyFile: ${connectionStorageServiceAccountKeyFile}
serviceAccountKeyFileSecretId: ${testSecret.id}
storageCredentialName: ${connectionStorageCredentialName}
streamPoolId: ${testStreamPool.id}
submitMode: ${connectionSubmitMode}
subnetId: ${testSubnet.id}
subscriptionId: ${testSubscription.id}
tenancyId: ${testTenancy.id}
tenantId: ${testTenant.id}
tlsCaFile: ${connectionTlsCaFile}
tlsCertificateKeyFile: ${connectionTlsCertificateKeyFile}
tlsCertificateKeyFilePassword: ${connectionTlsCertificateKeyFilePassword}
tlsCertificateKeyFilePasswordSecretId: ${testSecret.id}
tlsCertificateKeyFileSecretId: ${testSecret.id}
tlsProtocol: ${connectionTlsProtocol}
trustStore: ${connectionTrustStore}
trustStorePassword: ${connectionTrustStorePassword}
trustStorePasswordSecretId: ${testSecret.id}
trustStoreSecretId: ${testSecret.id}
trustStoreType: ${connectionTrustStoreType}
url: ${connectionUrl}
userId: ${testUser.id}
username: ${connectionUsername}
vaultId: ${testVault.id}
wallet: ${connectionWallet}
walletSecretId: ${testSecret.id}
workspaceUrl: ${connectionWorkspaceUrl}
terraform {
required_providers {
oci = {
source = "pulumi/oci"
}
}
}
resource "oci_golden_gate_connection" "test_connection" {
lifecycle {
create_before_destroy = true
}
compartment_id = compartmentId
connection_type = connectionConnectionType
display_name = connectionDisplayName
technology_type = connectionTechnologyType
access_key_id = testKey.id
account_key = connectionAccountKey
account_key_secret_id = testSecret.id
account_name = connectionAccountName
additional_attributes {
name = connectionAdditionalAttributesName
value = connectionAdditionalAttributesValue
}
#Optional
artifact_location {
configuration {
authentication_type = connectionArtifactLocationConfigurationAuthenticationType
access_key_id = testKey.id
bucket = connectionArtifactLocationConfigurationBucket
namespace = connectionArtifactLocationConfigurationNamespace
par_url = connectionArtifactLocationConfigurationParUrl
par_url_secret_id = testSecret.id
path = connectionArtifactLocationConfigurationPath
private_key_file = connectionArtifactLocationConfigurationPrivateKeyFile
private_key_file_secret_id = testSecret.id
private_key_passphrase = connectionArtifactLocationConfigurationPrivateKeyPassphrase
private_key_passphrase_secret_id = testSecret.id
public_key_fingerprint = connectionArtifactLocationConfigurationPublicKeyFingerprint
region = connectionArtifactLocationConfigurationRegion
secret_access_key = connectionArtifactLocationConfigurationSecretAccessKey
secret_access_key_secret_id = testSecret.id
tenancy_id = testTenancy.id
user_id = testUser.id
}
location_type = connectionArtifactLocationLocationType
account_key = connectionArtifactLocationAccountKey
account_key_secret_id = testSecret.id
endpoint_suffix = connectionArtifactLocationEndpointSuffix
filesystem = connectionArtifactLocationFilesystem
path = connectionArtifactLocationPath
should_overwrite_existing = connectionArtifactLocationShouldOverwriteExisting
storage_account = connectionArtifactLocationStorageAccount
}
#Required
#Optional
#Optional
auth_details {
auth_type = connectionAuthDetailsAuthType
api_key = connectionAuthDetailsApiKey
api_key_secret_id = testSecret.id
base_url = connectionAuthDetailsBaseUrl
key_fingerprint = connectionAuthDetailsKeyFingerprint
region = connectionAuthDetailsRegion
tenancy_id = testTenancy.id
user_id = testUser.id
}
#Required
#Optional
auth_secret = connectionAuthSecret
auth_secret_secret_id = testSecret.id
auth_token = connectionAuthToken
auth_token_secret_id = testSecret.id
authentication_mode = connectionAuthenticationMode
authentication_type = connectionAuthenticationType
azure_authority_host = connectionAzureAuthorityHost
azure_tenant_id = testAzureTenant.id
bootstrap_servers {
host = connectionBootstrapServersHost
port = connectionBootstrapServersPort
}
#Optional
catalog {
catalog_type = connectionCatalogCatalogType
branch = connectionCatalogBranch
client_id = testClient.id
client_secret = connectionCatalogClientSecret
client_secret_secret_id = testSecret.id
glue_id = testGlue.id
name = connectionCatalogName
principal_role = connectionCatalogPrincipalRole
properties = connectionCatalogProperties
properties_secret_id = testSecret.id
uri = connectionCatalogUri
}
#Required
#Optional
client_id = testClient.id
client_secret = connectionClientSecret
client_secret_secret_id = testSecret.id
cluster_endpoint = connectionClusterEndpoint
cluster_id = testCluster.id
cluster_placement_group_id = testClusterPlacementGroup.id
connection_factory = connectionConnectionFactory
connection_string = connectionConnectionString
connection_url = connectionConnectionUrl
consumer_properties = connectionConsumerProperties
core_site_xml = connectionCoreSiteXml
database_id = testDatabase.id
database_name = testDatabase.name
db_system_id = testDbSystem.id
defined_tags = {
"foo-namespace.bar-key" = "value"
}
deployment_id = testDeployment.id
description = connectionDescription
does_use_secret_ids = connectionDoesUseSecretIds
endpoint = connectionEndpoint
fingerprint = connectionFingerprint
freeform_tags = {
"bar-key" = "value"
}
host = connectionHost
jndi_connection_factory = connectionJndiConnectionFactory
jndi_initial_context_factory = connectionJndiInitialContextFactory
jndi_provider_url = connectionJndiProviderUrl
jndi_security_credentials = connectionJndiSecurityCredentials
jndi_security_credentials_secret_id = testSecret.id
jndi_security_principal = connectionJndiSecurityPrincipal
key_id = testKey.id
key_store = connectionKeyStore
key_store_password = connectionKeyStorePassword
key_store_password_secret_id = testSecret.id
key_store_secret_id = testSecret.id
key_store_type = connectionKeyStoreType
locks {
type = connectionLocksType
message = connectionLocksMessage
}
#Required
#Optional
max_input_chars = connectionMaxInputChars
model_key = connectionModelKey
nsg_ids = connectionNsgIds
password = connectionPassword
password_secret_id = testSecret.id
port = connectionPort
private_key_file = connectionPrivateKeyFile
private_key_file_secret_id = testSecret.id
private_key_passphrase = connectionPrivateKeyPassphrase
private_key_passphrase_secret_id = testSecret.id
producer_properties = connectionProducerProperties
provider_id = testProvider.id
provider_type = connectionProviderType
public_key_fingerprint = connectionPublicKeyFingerprint
redis_cluster_id = testRedisCluster.id
region = connectionRegion
rest_auth_secret_key = connectionRestAuthSecretKey
rest_auth_secret_key_secret_id = testSecret.id
rest_endpoint = connectionRestEndpoint
routing_method = connectionRoutingMethod
rpc_cipher = connectionRpcCipher
sas_token = connectionSasToken
sas_token_secret_id = testSecret.id
secret_access_key = connectionSecretAccessKey
secret_access_key_secret_id = testSecret.id
security_attributes = connectionSecurityAttributes
security_protocol = connectionSecurityProtocol
servers = connectionServers
service_account_key_file = connectionServiceAccountKeyFile
service_account_key_file_secret_id = testSecret.id
session_mode = connectionSessionMode
should_use_jndi = connectionShouldUseJndi
should_use_resource_principal = connectionShouldUseResourcePrincipal
should_validate_server_certificate = connectionShouldValidateServerCertificate
ssl_ca = connectionSslCa
ssl_cert = connectionSslCert
ssl_client_keystash = connectionSslClientKeystash
ssl_client_keystash_secret_id = testSecret.id
ssl_client_keystoredb = connectionSslClientKeystoredb
ssl_client_keystoredb_secret_id = testSecret.id
ssl_crl = connectionSslCrl
ssl_key = connectionSslKey
ssl_key_password = connectionSslKeyPassword
ssl_key_password_secret_id = testSecret.id
ssl_key_secret_id = testSecret.id
ssl_mode = connectionSslMode
ssl_server_certificate = connectionSslServerCertificate
storage {
storage_type = connectionStorageStorageType
access_key_id = testKey.id
account_key = connectionStorageAccountKey
account_key_secret_id = testSecret.id
account_name = connectionStorageAccountName
bucket = connectionStorageBucket
container = connectionStorageContainer
endpoint = connectionStorageEndpoint
project_id = testProject.id
region = connectionStorageRegion
scheme_type = connectionStorageSchemeType
secret_access_key = connectionStorageSecretAccessKey
secret_access_key_secret_id = testSecret.id
service_account_key_file = connectionStorageServiceAccountKeyFile
service_account_key_file_secret_id = testSecret.id
}
#Required
#Optional
storage_credential_name = connectionStorageCredentialName
stream_pool_id = testStreamPool.id
submit_mode = connectionSubmitMode
subnet_id = testSubnet.id
subscription_id = testSubscription.id
tenancy_id = testTenancy.id
tenant_id = testTenant.id
tls_ca_file = connectionTlsCaFile
tls_certificate_key_file = connectionTlsCertificateKeyFile
tls_certificate_key_file_password = connectionTlsCertificateKeyFilePassword
tls_certificate_key_file_password_secret_id = testSecret.id
tls_certificate_key_file_secret_id = testSecret.id
tls_protocol = connectionTlsProtocol
trust_store = connectionTrustStore
trust_store_password = connectionTrustStorePassword
trust_store_password_secret_id = testSecret.id
trust_store_secret_id = testSecret.id
trust_store_type = connectionTrustStoreType
url = connectionUrl
user_id = testUser.id
username = connectionUsername
vault_id = testVault.id
wallet = connectionWallet
wallet_secret_id = testSecret.id
workspace_url = connectionWorkspaceUrl
}
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,
artifact_location: Optional[ConnectionArtifactLocationArgs] = None,
auth_details: Optional[ConnectionAuthDetailsArgs] = None,
auth_secret: Optional[str] = None,
auth_secret_secret_id: Optional[str] = None,
auth_token: Optional[str] = None,
auth_token_secret_id: Optional[str] = None,
authentication_mode: Optional[str] = None,
authentication_type: Optional[str] = None,
azure_authority_host: Optional[str] = None,
azure_tenant_id: Optional[str] = None,
bootstrap_servers: Optional[Sequence[ConnectionBootstrapServerArgs]] = None,
catalog: Optional[ConnectionCatalogArgs] = None,
client_id: Optional[str] = None,
client_secret: Optional[str] = None,
client_secret_secret_id: Optional[str] = None,
cluster_endpoint: Optional[str] = None,
cluster_id: Optional[str] = None,
cluster_placement_group_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,
key_store_type: Optional[str] = None,
locks: Optional[Sequence[ConnectionLockArgs]] = None,
max_input_chars: Optional[int] = None,
model_key: Optional[str] = None,
nsg_ids: Optional[Sequence[str]] = None,
password: Optional[str] = None,
password_secret_id: Optional[str] = None,
port: Optional[int] = 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,
provider_id: Optional[str] = None,
provider_type: Optional[str] = None,
public_key_fingerprint: Optional[str] = None,
redis_cluster_id: Optional[str] = None,
region: Optional[str] = None,
rest_auth_secret_key: Optional[str] = None,
rest_auth_secret_key_secret_id: Optional[str] = None,
rest_endpoint: Optional[str] = None,
routing_method: Optional[str] = None,
rpc_cipher: 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_attributes: Optional[Mapping[str, 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: Optional[ConnectionStorageArgs] = None,
storage_credential_name: Optional[str] = None,
stream_pool_id: Optional[str] = None,
submit_mode: Optional[str] = None,
subnet_id: Optional[str] = None,
subscription_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,
tls_protocol: 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,
trust_store_type: 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,
workspace_url: 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.
resource "oci_golden_gate_connection" "name" {
# resource properties
}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",
AccountKeySecretId = "string",
AccountName = "string",
AdditionalAttributes = new[]
{
new Oci.GoldenGate.Inputs.ConnectionAdditionalAttributeArgs
{
Name = "string",
Value = "string",
},
},
ArtifactLocation = new Oci.GoldenGate.Inputs.ConnectionArtifactLocationArgs
{
LocationType = "string",
AccountKey = "string",
AccountKeySecretId = "string",
Configuration = new Oci.GoldenGate.Inputs.ConnectionArtifactLocationConfigurationArgs
{
AuthenticationType = "string",
PrivateKeyFileSecretId = "string",
PrivateKeyPassphraseSecretId = "string",
Namespace = "string",
ParUrlSecretId = "string",
Path = "string",
Bucket = "string",
AccessKeyId = "string",
PublicKeyFingerprint = "string",
Region = "string",
SecretAccessKeySecretId = "string",
TenancyId = "string",
UserId = "string",
},
EndpointSuffix = "string",
Filesystem = "string",
Path = "string",
ShouldOverwriteExisting = false,
StorageAccount = "string",
},
AuthDetails = new Oci.GoldenGate.Inputs.ConnectionAuthDetailsArgs
{
AuthType = "string",
ApiKey = "string",
ApiKeySecretId = "string",
BaseUrl = "string",
KeyFingerprint = "string",
Region = "string",
TenancyId = "string",
UserId = "string",
},
AuthSecretSecretId = "string",
AuthTokenSecretId = "string",
AuthenticationMode = "string",
AuthenticationType = "string",
AzureAuthorityHost = "string",
AzureTenantId = "string",
BootstrapServers = new[]
{
new Oci.GoldenGate.Inputs.ConnectionBootstrapServerArgs
{
Host = "string",
Port = 0,
PrivateIp = "string",
},
},
Catalog = new Oci.GoldenGate.Inputs.ConnectionCatalogArgs
{
CatalogType = "string",
Branch = "string",
ClientId = "string",
ClientSecretSecretId = "string",
GlueId = "string",
Name = "string",
PrincipalRole = "string",
PropertiesSecretId = "string",
Uri = "string",
},
ClientId = "string",
ClientSecretSecretId = "string",
ClusterEndpoint = "string",
ClusterId = "string",
ClusterPlacementGroupId = "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",
JndiSecurityCredentialsSecretId = "string",
JndiSecurityPrincipal = "string",
KeyId = "string",
KeyStorePasswordSecretId = "string",
KeyStoreSecretId = "string",
KeyStoreType = "string",
Locks = new[]
{
new Oci.GoldenGate.Inputs.ConnectionLockArgs
{
Type = "string",
Message = "string",
RelatedResourceId = "string",
TimeCreated = "string",
},
},
MaxInputChars = 0,
ModelKey = "string",
NsgIds = new[]
{
"string",
},
PasswordSecretId = "string",
Port = 0,
PrivateKeyFileSecretId = "string",
PrivateKeyPassphraseSecretId = "string",
ProducerProperties = "string",
ProviderId = "string",
ProviderType = "string",
PublicKeyFingerprint = "string",
RedisClusterId = "string",
Region = "string",
RestAuthSecretKeySecretId = "string",
RestEndpoint = "string",
RoutingMethod = "string",
RpcCipher = "string",
SasTokenSecretId = "string",
SecretAccessKeySecretId = "string",
SecurityAttributes =
{
{ "string", "string" },
},
SecurityProtocol = "string",
Servers = "string",
ServiceAccountKeyFileSecretId = "string",
SessionMode = "string",
ShouldUseJndi = false,
ShouldUseResourcePrincipal = false,
ShouldValidateServerCertificate = false,
SslCa = "string",
SslCert = "string",
SslClientKeystashSecretId = "string",
SslClientKeystoredbSecretId = "string",
SslCrl = "string",
SslKeyPasswordSecretId = "string",
SslKeySecretId = "string",
SslMode = "string",
SslServerCertificate = "string",
Storage = new Oci.GoldenGate.Inputs.ConnectionStorageArgs
{
StorageType = "string",
Endpoint = "string",
Region = "string",
AccountName = "string",
Bucket = "string",
Container = "string",
AccessKeyId = "string",
ProjectId = "string",
AccountKeySecretId = "string",
SchemeType = "string",
SecretAccessKeySecretId = "string",
ServiceAccountKeyFileSecretId = "string",
},
StorageCredentialName = "string",
StreamPoolId = "string",
SubmitMode = "string",
SubnetId = "string",
SubscriptionId = "string",
TenancyId = "string",
TenantId = "string",
TlsCaFile = "string",
TlsCertificateKeyFilePasswordSecretId = "string",
TlsCertificateKeyFileSecretId = "string",
TlsProtocol = "string",
TriggerRefresh = false,
TrustStorePasswordSecretId = "string",
TrustStoreSecretId = "string",
TrustStoreType = "string",
Url = "string",
UserId = "string",
Username = "string",
VaultId = "string",
WalletSecretId = "string",
WorkspaceUrl = "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"),
AccountKeySecretId: pulumi.String("string"),
AccountName: pulumi.String("string"),
AdditionalAttributes: goldengate.ConnectionAdditionalAttributeArray{
&goldengate.ConnectionAdditionalAttributeArgs{
Name: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
ArtifactLocation: &goldengate.ConnectionArtifactLocationArgs{
LocationType: pulumi.String("string"),
AccountKey: pulumi.String("string"),
AccountKeySecretId: pulumi.String("string"),
Configuration: &goldengate.ConnectionArtifactLocationConfigurationArgs{
AuthenticationType: pulumi.String("string"),
PrivateKeyFileSecretId: pulumi.String("string"),
PrivateKeyPassphraseSecretId: pulumi.String("string"),
Namespace: pulumi.String("string"),
ParUrlSecretId: pulumi.String("string"),
Path: pulumi.String("string"),
Bucket: pulumi.String("string"),
AccessKeyId: pulumi.String("string"),
PublicKeyFingerprint: pulumi.String("string"),
Region: pulumi.String("string"),
SecretAccessKeySecretId: pulumi.String("string"),
TenancyId: pulumi.String("string"),
UserId: pulumi.String("string"),
},
EndpointSuffix: pulumi.String("string"),
Filesystem: pulumi.String("string"),
Path: pulumi.String("string"),
ShouldOverwriteExisting: pulumi.Bool(false),
StorageAccount: pulumi.String("string"),
},
AuthDetails: &goldengate.ConnectionAuthDetailsArgs{
AuthType: pulumi.String("string"),
ApiKey: pulumi.String("string"),
ApiKeySecretId: pulumi.String("string"),
BaseUrl: pulumi.String("string"),
KeyFingerprint: pulumi.String("string"),
Region: pulumi.String("string"),
TenancyId: pulumi.String("string"),
UserId: pulumi.String("string"),
},
AuthSecretSecretId: pulumi.String("string"),
AuthTokenSecretId: pulumi.String("string"),
AuthenticationMode: pulumi.String("string"),
AuthenticationType: pulumi.String("string"),
AzureAuthorityHost: pulumi.String("string"),
AzureTenantId: pulumi.String("string"),
BootstrapServers: goldengate.ConnectionBootstrapServerArray{
&goldengate.ConnectionBootstrapServerArgs{
Host: pulumi.String("string"),
Port: pulumi.Int(0),
PrivateIp: pulumi.String("string"),
},
},
Catalog: &goldengate.ConnectionCatalogArgs{
CatalogType: pulumi.String("string"),
Branch: pulumi.String("string"),
ClientId: pulumi.String("string"),
ClientSecretSecretId: pulumi.String("string"),
GlueId: pulumi.String("string"),
Name: pulumi.String("string"),
PrincipalRole: pulumi.String("string"),
PropertiesSecretId: pulumi.String("string"),
Uri: pulumi.String("string"),
},
ClientId: pulumi.String("string"),
ClientSecretSecretId: pulumi.String("string"),
ClusterEndpoint: pulumi.String("string"),
ClusterId: pulumi.String("string"),
ClusterPlacementGroupId: 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"),
JndiSecurityCredentialsSecretId: pulumi.String("string"),
JndiSecurityPrincipal: pulumi.String("string"),
KeyId: pulumi.String("string"),
KeyStorePasswordSecretId: pulumi.String("string"),
KeyStoreSecretId: pulumi.String("string"),
KeyStoreType: pulumi.String("string"),
Locks: goldengate.ConnectionLockArray{
&goldengate.ConnectionLockArgs{
Type: pulumi.String("string"),
Message: pulumi.String("string"),
RelatedResourceId: pulumi.String("string"),
TimeCreated: pulumi.String("string"),
},
},
MaxInputChars: pulumi.Int(0),
ModelKey: pulumi.String("string"),
NsgIds: pulumi.StringArray{
pulumi.String("string"),
},
PasswordSecretId: pulumi.String("string"),
Port: pulumi.Int(0),
PrivateKeyFileSecretId: pulumi.String("string"),
PrivateKeyPassphraseSecretId: pulumi.String("string"),
ProducerProperties: pulumi.String("string"),
ProviderId: pulumi.String("string"),
ProviderType: pulumi.String("string"),
PublicKeyFingerprint: pulumi.String("string"),
RedisClusterId: pulumi.String("string"),
Region: pulumi.String("string"),
RestAuthSecretKeySecretId: pulumi.String("string"),
RestEndpoint: pulumi.String("string"),
RoutingMethod: pulumi.String("string"),
RpcCipher: pulumi.String("string"),
SasTokenSecretId: pulumi.String("string"),
SecretAccessKeySecretId: pulumi.String("string"),
SecurityAttributes: pulumi.StringMap{
"string": pulumi.String("string"),
},
SecurityProtocol: pulumi.String("string"),
Servers: 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"),
SslClientKeystashSecretId: pulumi.String("string"),
SslClientKeystoredbSecretId: pulumi.String("string"),
SslCrl: pulumi.String("string"),
SslKeyPasswordSecretId: pulumi.String("string"),
SslKeySecretId: pulumi.String("string"),
SslMode: pulumi.String("string"),
SslServerCertificate: pulumi.String("string"),
Storage: &goldengate.ConnectionStorageArgs{
StorageType: pulumi.String("string"),
Endpoint: pulumi.String("string"),
Region: pulumi.String("string"),
AccountName: pulumi.String("string"),
Bucket: pulumi.String("string"),
Container: pulumi.String("string"),
AccessKeyId: pulumi.String("string"),
ProjectId: pulumi.String("string"),
AccountKeySecretId: pulumi.String("string"),
SchemeType: pulumi.String("string"),
SecretAccessKeySecretId: pulumi.String("string"),
ServiceAccountKeyFileSecretId: pulumi.String("string"),
},
StorageCredentialName: pulumi.String("string"),
StreamPoolId: pulumi.String("string"),
SubmitMode: pulumi.String("string"),
SubnetId: pulumi.String("string"),
SubscriptionId: pulumi.String("string"),
TenancyId: pulumi.String("string"),
TenantId: pulumi.String("string"),
TlsCaFile: pulumi.String("string"),
TlsCertificateKeyFilePasswordSecretId: pulumi.String("string"),
TlsCertificateKeyFileSecretId: pulumi.String("string"),
TlsProtocol: pulumi.String("string"),
TriggerRefresh: pulumi.Bool(false),
TrustStorePasswordSecretId: pulumi.String("string"),
TrustStoreSecretId: pulumi.String("string"),
TrustStoreType: pulumi.String("string"),
Url: pulumi.String("string"),
UserId: pulumi.String("string"),
Username: pulumi.String("string"),
VaultId: pulumi.String("string"),
WalletSecretId: pulumi.String("string"),
WorkspaceUrl: pulumi.String("string"),
})
resource "oci_golden_gate_connection" "exampleconnectionResourceResourceFromGoldenGateconnection" {
lifecycle {
create_before_destroy = true
}
compartment_id = "string"
connection_type = "string"
display_name = "string"
technology_type = "string"
access_key_id = "string"
account_key_secret_id = "string"
account_name = "string"
additional_attributes {
name = "string"
value = "string"
}
artifact_location = {
location_type = "string"
account_key = "string"
account_key_secret_id = "string"
configuration = {
authentication_type = "string"
private_key_file_secret_id = "string"
private_key_passphrase_secret_id = "string"
namespace = "string"
par_url_secret_id = "string"
path = "string"
bucket = "string"
access_key_id = "string"
public_key_fingerprint = "string"
region = "string"
secret_access_key_secret_id = "string"
tenancy_id = "string"
user_id = "string"
}
endpoint_suffix = "string"
filesystem = "string"
path = "string"
should_overwrite_existing = false
storage_account = "string"
}
auth_details = {
auth_type = "string"
api_key = "string"
api_key_secret_id = "string"
base_url = "string"
key_fingerprint = "string"
region = "string"
tenancy_id = "string"
user_id = "string"
}
auth_secret_secret_id = "string"
auth_token_secret_id = "string"
authentication_mode = "string"
authentication_type = "string"
azure_authority_host = "string"
azure_tenant_id = "string"
bootstrap_servers {
host = "string"
port = 0
private_ip = "string"
}
catalog = {
catalog_type = "string"
branch = "string"
client_id = "string"
client_secret_secret_id = "string"
glue_id = "string"
name = "string"
principal_role = "string"
properties_secret_id = "string"
uri = "string"
}
client_id = "string"
client_secret_secret_id = "string"
cluster_endpoint = "string"
cluster_id = "string"
cluster_placement_group_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_secret_id = "string"
jndi_security_principal = "string"
key_id = "string"
key_store_password_secret_id = "string"
key_store_secret_id = "string"
key_store_type = "string"
locks {
type = "string"
message = "string"
related_resource_id = "string"
time_created = "string"
}
max_input_chars = 0
model_key = "string"
nsg_ids = ["string"]
password_secret_id = "string"
port = 0
private_key_file_secret_id = "string"
private_key_passphrase_secret_id = "string"
producer_properties = "string"
provider_id = "string"
provider_type = "string"
public_key_fingerprint = "string"
redis_cluster_id = "string"
region = "string"
rest_auth_secret_key_secret_id = "string"
rest_endpoint = "string"
routing_method = "string"
rpc_cipher = "string"
sas_token_secret_id = "string"
secret_access_key_secret_id = "string"
security_attributes = {
"string" = "string"
}
security_protocol = "string"
servers = "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_secret_id = "string"
ssl_client_keystoredb_secret_id = "string"
ssl_crl = "string"
ssl_key_password_secret_id = "string"
ssl_key_secret_id = "string"
ssl_mode = "string"
ssl_server_certificate = "string"
storage = {
storage_type = "string"
endpoint = "string"
region = "string"
account_name = "string"
bucket = "string"
container = "string"
access_key_id = "string"
project_id = "string"
account_key_secret_id = "string"
scheme_type = "string"
secret_access_key_secret_id = "string"
service_account_key_file_secret_id = "string"
}
storage_credential_name = "string"
stream_pool_id = "string"
submit_mode = "string"
subnet_id = "string"
subscription_id = "string"
tenancy_id = "string"
tenant_id = "string"
tls_ca_file = "string"
tls_certificate_key_file_password_secret_id = "string"
tls_certificate_key_file_secret_id = "string"
tls_protocol = "string"
trigger_refresh = false
trust_store_password_secret_id = "string"
trust_store_secret_id = "string"
trust_store_type = "string"
url = "string"
user_id = "string"
username = "string"
vault_id = "string"
wallet_secret_id = "string"
workspace_url = "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")
.accountKeySecretId("string")
.accountName("string")
.additionalAttributes(com.pulumi.oci.GoldenGate.inputs.ConnectionAdditionalAttributeArgs.builder()
.name("string")
.value("string")
.build())
.artifactLocation(ConnectionArtifactLocationArgs.builder()
.locationType("string")
.accountKey("string")
.accountKeySecretId("string")
.configuration(ConnectionArtifactLocationConfigurationArgs.builder()
.authenticationType("string")
.privateKeyFileSecretId("string")
.privateKeyPassphraseSecretId("string")
.namespace("string")
.parUrlSecretId("string")
.path("string")
.bucket("string")
.accessKeyId("string")
.publicKeyFingerprint("string")
.region("string")
.secretAccessKeySecretId("string")
.tenancyId("string")
.userId("string")
.build())
.endpointSuffix("string")
.filesystem("string")
.path("string")
.shouldOverwriteExisting(false)
.storageAccount("string")
.build())
.authDetails(ConnectionAuthDetailsArgs.builder()
.authType("string")
.apiKey("string")
.apiKeySecretId("string")
.baseUrl("string")
.keyFingerprint("string")
.region("string")
.tenancyId("string")
.userId("string")
.build())
.authSecretSecretId("string")
.authTokenSecretId("string")
.authenticationMode("string")
.authenticationType("string")
.azureAuthorityHost("string")
.azureTenantId("string")
.bootstrapServers(ConnectionBootstrapServerArgs.builder()
.host("string")
.port(0)
.privateIp("string")
.build())
.catalog(ConnectionCatalogArgs.builder()
.catalogType("string")
.branch("string")
.clientId("string")
.clientSecretSecretId("string")
.glueId("string")
.name("string")
.principalRole("string")
.propertiesSecretId("string")
.uri("string")
.build())
.clientId("string")
.clientSecretSecretId("string")
.clusterEndpoint("string")
.clusterId("string")
.clusterPlacementGroupId("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")
.jndiSecurityCredentialsSecretId("string")
.jndiSecurityPrincipal("string")
.keyId("string")
.keyStorePasswordSecretId("string")
.keyStoreSecretId("string")
.keyStoreType("string")
.locks(ConnectionLockArgs.builder()
.type("string")
.message("string")
.relatedResourceId("string")
.timeCreated("string")
.build())
.maxInputChars(0)
.modelKey("string")
.nsgIds("string")
.passwordSecretId("string")
.port(0)
.privateKeyFileSecretId("string")
.privateKeyPassphraseSecretId("string")
.producerProperties("string")
.providerId("string")
.providerType("string")
.publicKeyFingerprint("string")
.redisClusterId("string")
.region("string")
.restAuthSecretKeySecretId("string")
.restEndpoint("string")
.routingMethod("string")
.rpcCipher("string")
.sasTokenSecretId("string")
.secretAccessKeySecretId("string")
.securityAttributes(Map.of("string", "string"))
.securityProtocol("string")
.servers("string")
.serviceAccountKeyFileSecretId("string")
.sessionMode("string")
.shouldUseJndi(false)
.shouldUseResourcePrincipal(false)
.shouldValidateServerCertificate(false)
.sslCa("string")
.sslCert("string")
.sslClientKeystashSecretId("string")
.sslClientKeystoredbSecretId("string")
.sslCrl("string")
.sslKeyPasswordSecretId("string")
.sslKeySecretId("string")
.sslMode("string")
.sslServerCertificate("string")
.storage(ConnectionStorageArgs.builder()
.storageType("string")
.endpoint("string")
.region("string")
.accountName("string")
.bucket("string")
.container("string")
.accessKeyId("string")
.projectId("string")
.accountKeySecretId("string")
.schemeType("string")
.secretAccessKeySecretId("string")
.serviceAccountKeyFileSecretId("string")
.build())
.storageCredentialName("string")
.streamPoolId("string")
.submitMode("string")
.subnetId("string")
.subscriptionId("string")
.tenancyId("string")
.tenantId("string")
.tlsCaFile("string")
.tlsCertificateKeyFilePasswordSecretId("string")
.tlsCertificateKeyFileSecretId("string")
.tlsProtocol("string")
.triggerRefresh(false)
.trustStorePasswordSecretId("string")
.trustStoreSecretId("string")
.trustStoreType("string")
.url("string")
.userId("string")
.username("string")
.vaultId("string")
.walletSecretId("string")
.workspaceUrl("string")
.build());
exampleconnection_resource_resource_from_golden_gateconnection = oci.goldengate.Connection("exampleconnectionResourceResourceFromGoldenGateconnection",
compartment_id="string",
connection_type="string",
display_name="string",
technology_type="string",
access_key_id="string",
account_key_secret_id="string",
account_name="string",
additional_attributes=[{
"name": "string",
"value": "string",
}],
artifact_location={
"location_type": "string",
"account_key": "string",
"account_key_secret_id": "string",
"configuration": {
"authentication_type": "string",
"private_key_file_secret_id": "string",
"private_key_passphrase_secret_id": "string",
"namespace": "string",
"par_url_secret_id": "string",
"path": "string",
"bucket": "string",
"access_key_id": "string",
"public_key_fingerprint": "string",
"region": "string",
"secret_access_key_secret_id": "string",
"tenancy_id": "string",
"user_id": "string",
},
"endpoint_suffix": "string",
"filesystem": "string",
"path": "string",
"should_overwrite_existing": False,
"storage_account": "string",
},
auth_details={
"auth_type": "string",
"api_key": "string",
"api_key_secret_id": "string",
"base_url": "string",
"key_fingerprint": "string",
"region": "string",
"tenancy_id": "string",
"user_id": "string",
},
auth_secret_secret_id="string",
auth_token_secret_id="string",
authentication_mode="string",
authentication_type="string",
azure_authority_host="string",
azure_tenant_id="string",
bootstrap_servers=[{
"host": "string",
"port": 0,
"private_ip": "string",
}],
catalog={
"catalog_type": "string",
"branch": "string",
"client_id": "string",
"client_secret_secret_id": "string",
"glue_id": "string",
"name": "string",
"principal_role": "string",
"properties_secret_id": "string",
"uri": "string",
},
client_id="string",
client_secret_secret_id="string",
cluster_endpoint="string",
cluster_id="string",
cluster_placement_group_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_secret_id="string",
jndi_security_principal="string",
key_id="string",
key_store_password_secret_id="string",
key_store_secret_id="string",
key_store_type="string",
locks=[{
"type": "string",
"message": "string",
"related_resource_id": "string",
"time_created": "string",
}],
max_input_chars=0,
model_key="string",
nsg_ids=["string"],
password_secret_id="string",
port=0,
private_key_file_secret_id="string",
private_key_passphrase_secret_id="string",
producer_properties="string",
provider_id="string",
provider_type="string",
public_key_fingerprint="string",
redis_cluster_id="string",
region="string",
rest_auth_secret_key_secret_id="string",
rest_endpoint="string",
routing_method="string",
rpc_cipher="string",
sas_token_secret_id="string",
secret_access_key_secret_id="string",
security_attributes={
"string": "string",
},
security_protocol="string",
servers="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_secret_id="string",
ssl_client_keystoredb_secret_id="string",
ssl_crl="string",
ssl_key_password_secret_id="string",
ssl_key_secret_id="string",
ssl_mode="string",
ssl_server_certificate="string",
storage={
"storage_type": "string",
"endpoint": "string",
"region": "string",
"account_name": "string",
"bucket": "string",
"container": "string",
"access_key_id": "string",
"project_id": "string",
"account_key_secret_id": "string",
"scheme_type": "string",
"secret_access_key_secret_id": "string",
"service_account_key_file_secret_id": "string",
},
storage_credential_name="string",
stream_pool_id="string",
submit_mode="string",
subnet_id="string",
subscription_id="string",
tenancy_id="string",
tenant_id="string",
tls_ca_file="string",
tls_certificate_key_file_password_secret_id="string",
tls_certificate_key_file_secret_id="string",
tls_protocol="string",
trigger_refresh=False,
trust_store_password_secret_id="string",
trust_store_secret_id="string",
trust_store_type="string",
url="string",
user_id="string",
username="string",
vault_id="string",
wallet_secret_id="string",
workspace_url="string")
const exampleconnectionResourceResourceFromGoldenGateconnection = new oci.goldengate.Connection("exampleconnectionResourceResourceFromGoldenGateconnection", {
compartmentId: "string",
connectionType: "string",
displayName: "string",
technologyType: "string",
accessKeyId: "string",
accountKeySecretId: "string",
accountName: "string",
additionalAttributes: [{
name: "string",
value: "string",
}],
artifactLocation: {
locationType: "string",
accountKey: "string",
accountKeySecretId: "string",
configuration: {
authenticationType: "string",
privateKeyFileSecretId: "string",
privateKeyPassphraseSecretId: "string",
namespace: "string",
parUrlSecretId: "string",
path: "string",
bucket: "string",
accessKeyId: "string",
publicKeyFingerprint: "string",
region: "string",
secretAccessKeySecretId: "string",
tenancyId: "string",
userId: "string",
},
endpointSuffix: "string",
filesystem: "string",
path: "string",
shouldOverwriteExisting: false,
storageAccount: "string",
},
authDetails: {
authType: "string",
apiKey: "string",
apiKeySecretId: "string",
baseUrl: "string",
keyFingerprint: "string",
region: "string",
tenancyId: "string",
userId: "string",
},
authSecretSecretId: "string",
authTokenSecretId: "string",
authenticationMode: "string",
authenticationType: "string",
azureAuthorityHost: "string",
azureTenantId: "string",
bootstrapServers: [{
host: "string",
port: 0,
privateIp: "string",
}],
catalog: {
catalogType: "string",
branch: "string",
clientId: "string",
clientSecretSecretId: "string",
glueId: "string",
name: "string",
principalRole: "string",
propertiesSecretId: "string",
uri: "string",
},
clientId: "string",
clientSecretSecretId: "string",
clusterEndpoint: "string",
clusterId: "string",
clusterPlacementGroupId: "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",
jndiSecurityCredentialsSecretId: "string",
jndiSecurityPrincipal: "string",
keyId: "string",
keyStorePasswordSecretId: "string",
keyStoreSecretId: "string",
keyStoreType: "string",
locks: [{
type: "string",
message: "string",
relatedResourceId: "string",
timeCreated: "string",
}],
maxInputChars: 0,
modelKey: "string",
nsgIds: ["string"],
passwordSecretId: "string",
port: 0,
privateKeyFileSecretId: "string",
privateKeyPassphraseSecretId: "string",
producerProperties: "string",
providerId: "string",
providerType: "string",
publicKeyFingerprint: "string",
redisClusterId: "string",
region: "string",
restAuthSecretKeySecretId: "string",
restEndpoint: "string",
routingMethod: "string",
rpcCipher: "string",
sasTokenSecretId: "string",
secretAccessKeySecretId: "string",
securityAttributes: {
string: "string",
},
securityProtocol: "string",
servers: "string",
serviceAccountKeyFileSecretId: "string",
sessionMode: "string",
shouldUseJndi: false,
shouldUseResourcePrincipal: false,
shouldValidateServerCertificate: false,
sslCa: "string",
sslCert: "string",
sslClientKeystashSecretId: "string",
sslClientKeystoredbSecretId: "string",
sslCrl: "string",
sslKeyPasswordSecretId: "string",
sslKeySecretId: "string",
sslMode: "string",
sslServerCertificate: "string",
storage: {
storageType: "string",
endpoint: "string",
region: "string",
accountName: "string",
bucket: "string",
container: "string",
accessKeyId: "string",
projectId: "string",
accountKeySecretId: "string",
schemeType: "string",
secretAccessKeySecretId: "string",
serviceAccountKeyFileSecretId: "string",
},
storageCredentialName: "string",
streamPoolId: "string",
submitMode: "string",
subnetId: "string",
subscriptionId: "string",
tenancyId: "string",
tenantId: "string",
tlsCaFile: "string",
tlsCertificateKeyFilePasswordSecretId: "string",
tlsCertificateKeyFileSecretId: "string",
tlsProtocol: "string",
triggerRefresh: false,
trustStorePasswordSecretId: "string",
trustStoreSecretId: "string",
trustStoreType: "string",
url: "string",
userId: "string",
username: "string",
vaultId: "string",
walletSecretId: "string",
workspaceUrl: "string",
});
type: oci:GoldenGate:Connection
properties:
accessKeyId: string
accountKeySecretId: string
accountName: string
additionalAttributes:
- name: string
value: string
artifactLocation:
accountKey: string
accountKeySecretId: string
configuration:
accessKeyId: string
authenticationType: string
bucket: string
namespace: string
parUrlSecretId: string
path: string
privateKeyFileSecretId: string
privateKeyPassphraseSecretId: string
publicKeyFingerprint: string
region: string
secretAccessKeySecretId: string
tenancyId: string
userId: string
endpointSuffix: string
filesystem: string
locationType: string
path: string
shouldOverwriteExisting: false
storageAccount: string
authDetails:
apiKey: string
apiKeySecretId: string
authType: string
baseUrl: string
keyFingerprint: string
region: string
tenancyId: string
userId: string
authSecretSecretId: string
authTokenSecretId: string
authenticationMode: string
authenticationType: string
azureAuthorityHost: string
azureTenantId: string
bootstrapServers:
- host: string
port: 0
privateIp: string
catalog:
branch: string
catalogType: string
clientId: string
clientSecretSecretId: string
glueId: string
name: string
principalRole: string
propertiesSecretId: string
uri: string
clientId: string
clientSecretSecretId: string
clusterEndpoint: string
clusterId: string
clusterPlacementGroupId: 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
jndiSecurityCredentialsSecretId: string
jndiSecurityPrincipal: string
keyId: string
keyStorePasswordSecretId: string
keyStoreSecretId: string
keyStoreType: string
locks:
- message: string
relatedResourceId: string
timeCreated: string
type: string
maxInputChars: 0
modelKey: string
nsgIds:
- string
passwordSecretId: string
port: 0
privateKeyFileSecretId: string
privateKeyPassphraseSecretId: string
producerProperties: string
providerId: string
providerType: string
publicKeyFingerprint: string
redisClusterId: string
region: string
restAuthSecretKeySecretId: string
restEndpoint: string
routingMethod: string
rpcCipher: string
sasTokenSecretId: string
secretAccessKeySecretId: string
securityAttributes:
string: string
securityProtocol: string
servers: string
serviceAccountKeyFileSecretId: string
sessionMode: string
shouldUseJndi: false
shouldUseResourcePrincipal: false
shouldValidateServerCertificate: false
sslCa: string
sslCert: string
sslClientKeystashSecretId: string
sslClientKeystoredbSecretId: string
sslCrl: string
sslKeyPasswordSecretId: string
sslKeySecretId: string
sslMode: string
sslServerCertificate: string
storage:
accessKeyId: string
accountKeySecretId: string
accountName: string
bucket: string
container: string
endpoint: string
projectId: string
region: string
schemeType: string
secretAccessKeySecretId: string
serviceAccountKeyFileSecretId: string
storageType: string
storageCredentialName: string
streamPoolId: string
submitMode: string
subnetId: string
subscriptionId: string
technologyType: string
tenancyId: string
tenantId: string
tlsCaFile: string
tlsCertificateKeyFilePasswordSecretId: string
tlsCertificateKeyFileSecretId: string
tlsProtocol: string
triggerRefresh: false
trustStorePasswordSecretId: string
trustStoreSecretId: string
trustStoreType: string
url: string
userId: string
username: string
vaultId: string
walletSecretId: string
workspaceUrl: 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 - Technology type selected for the connection.
- AI_MODEL: AI Model technology type.
- AI_PROVIDER: AI Provider technology type.
- DATABRICKS_ENGINE: Databricks Engine technology type.
- ICEBERG: Iceberg technology type. APACHE_ICEBERG supports all catalog types; AMAZON_S3_TABLES supports only REST catalog and S3 storage.
- KAFKA_SCHEMA_REGISTRY: Kafka Schema Registry technology type.
- ORACLE_AI_DATA_PLATFORM_ENGINE: Oracle AI Data Platform Engine technology type.
- SPARK: Spark technology type.
- Access
Key stringId (Updatable)
- AMAZON_KINESIS: Access key ID used to access Amazon Kinesis.
- AMAZON_S3: Access key ID used to access the Amazon S3 bucket.
Note: Despite the "Id" suffix, this value is not an Oracle Cloud Infrastructure OCID.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- Artifact
Location ConnectionArtifact Location - (Updatable) Location used to share engine application artifacts.
- DATABRICKS_ENGINE: Location used to share Databricks application artifacts.
- SPARK: Location used to share Spark application artifacts with a remote cluster.
- Auth
Details ConnectionAuth Details - (Updatable) Authentication details for an AI Model or AI Provider connection.
- Auth
Secret string (Updatable) The shared secret used for Spark authentication. Applicable when authenticationType is SHARED_SECRET.
Deprecated: This field is deprecated and replaced by "authSecretSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Auth
Secret stringSecret Id - (Updatable) The OCID of the Secret that stores the Spark authentication shared secret. Applicable when authenticationType is SHARED_SECRET. Note: When provided, 'authSecret' field must not be provided.
- Auth
Token string - (Updatable) Personal access token used to connect to the Databricks Engine REST API. Only applicable for authenticationType == PERSONAL_ACCESS_TOKEN. Deprecated: This field is deprecated and replaced by "authTokenSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Auth
Token stringSecret Id - (Updatable) The OCID of the Secret where the personal access token is stored. Only applicable for authenticationType == PERSONAL_ACCESS_TOKEN. Note: When provided, 'authToken' field must not be provided.
- 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 mechanism; supported values depend on
connectionType.- DATABRICKS: Use PERSONAL_ACCESS_TOKEN or OAUTH_M2M.
- DATABRICKS_ENGINE: Use PERSONAL_ACCESS_TOKEN or OAUTH_M2M for the Databricks Engine REST API.
- JAVA_MESSAGE_SERVICE: Authentication type for Java Message Service. The default is NONE.
- SPARK: Use SHARED_SECRET only when the target cluster has
spark.authenticate=true. AES_RPC and SASL_ENCRYPTED require SHARED_SECRET. - AZURE_DATA_LAKE_STORAGE, ELASTICSEARCH, KAFKA_SCHEMA_REGISTRY, REDIS, SNOWFLAKE: Use the authentication type supported by the target service.
- string
- (Updatable) The endpoint used for authentication with Microsoft Entra ID (formerly Azure Active Directory). Default value: https://login.microsoftonline.com When connecting to a non-public Azure Cloud, the endpoint must be provided, eg:
- Azure China: https://login.chinacloudapi.cn/
- Azure US Government: https://login.microsoftonline.us/
- 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" - Catalog
Connection
Catalog - (Updatable) The information about a new catalog of given type used in an Iceberg connection.
- Client
Id string - (Updatable)
- AZURE_DATA_LAKE_STORAGE: Azure application client ID, required for AZURE_ACTIVE_DIRECTORY authentication.
- DATABRICKS, DATABRICKS_ENGINE: OAuth client ID, applicable to OAUTH_M2M authentication.
- MICROSOFT_FABRIC: Azure application client ID.
- Client
Secret string - (Updatable) Plaintext client secret for the selected connection type. For DATABRICKS and DATABRICKS_ENGINE it applies to OAUTH_M2M authentication. Deprecated: use
clientSecretSecretId. - Client
Secret stringSecret Id - (Updatable) Secret OCID containing the client secret. For DATABRICKS and DATABRICKS_ENGINE it applies to OAUTH_M2M authentication. When provided,
clientSecretmust not be provided. - Cluster
Endpoint string - (Updatable) Spark master URL used for job submission. Required for both submitMode SUBMIT and REST. e.g.: 'spark://spark-master.example.com:7077' High availability can be configured with a comma-separated list, for example: 'spark://h1.example.com:7077,h2.example.com:7077'
- Cluster
Id string - (Updatable) The OCID of the Kafka cluster being referenced from Oracle Cloud Infrastructure Streaming with Apache Kafka.
- Cluster
Placement stringGroup Id - The OCID(https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cluster placement group for the resource. Only applicable for multicloud subscriptions. The cluster placement group id must be provided when a multicloud subscription id is provided. Otherwise the cluster placement group 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) JDBC connection string. e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'
- Connection
Url string - (Updatable)
- AMAZON_REDSHIFT: JDBC connection URL. e.g.:
jdbc:redshift://aws-redshift-instance.aaaaaaaaaaaa.us-east-2.redshift.amazonaws.com:5439/mydb - DATABRICKS: JDBC 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 - JAVA_MESSAGE_SERVICE: Connection URL specifying the protocol, host, and port. e.g.:
mq://myjms.host.domain:7676 - ORACLE_AI_DATA_PLATFORM: Connection URL beginning with
jdbc:spark://. - SNOWFLAKE: JDBC connection URL. e.g.:
jdbc:snowflake://<account_name>.snowflakecomputing.com/?warehouse=<warehouse-name>&db=<db-name>
- AMAZON_REDSHIFT: JDBC connection URL. e.g.:
- 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). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - 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.
Deprecated: This field is deprecated. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example,
passwordSecretId) instead of plain-text attributes. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGateWhen set to
true, all sensitive information must be provided as Oracle Cloud Infrastructure Vault secrets using the corresponding*SecretIdattributes of the connection (for example,passwordSecretId). Plain-text sensitive attributes (for example,password) must not be used. This ensures that sensitive information remains stored and managed in the customer's Oracle Cloud Infrastructure Vault rather than by the GoldenGate service.When set to false, sensitive information must be provided in the corresponding plain-text attributes (for example,
password) rather than in secret OCID attributes. In this mode, the sensitive information is stored by the GoldenGate service. IfvaultIdandkeyIdare not specified, the GoldenGate service uses Oracle-managed encryption keys to encrypt the stored data.If
vaultIdandkeyIdare provided, the specified customer-managed key is used.- Endpoint string
- (Updatable)
- AMAZON_KINESIS: The endpoint URL of the Amazon Kinesis service. e.g.: 'https://kinesis.us-east-1.amazonaws.com' If not provided, GoldenGate will default to 'https://kinesis..amazonaws.com'.
- AMAZON_S3: The Amazon Endpoint for S3. e.g.: 'https://my-bucket.s3.us-east-1.amazonaws.com' If not provided, GoldenGate will default to 'https://s3..amazonaws.com'.
- AZURE_DATA_LAKE_STORAGE: Azure Storage service endpoint. e.g: https://test.blob.core.windows.net
- GOOGLE_BIGQUERY: A legal URL to connect to BigQuery including scheme, server name and port, if not the default port. Default: https://bigquery.googleapis.com
- GOOGLE_CLOUD_STORAGE: A legal URL to connect to Google Cloud Storage including scheme, server name and port, if not the default port. Default: https://storage.googleapis.com
- MICROSOFT_FABRIC: 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) 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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) References the Oracle Cloud Infrastructure Vault key in the Oracle Cloud Infrastructure Vault identified by
vaultId.Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example,
passwordSecretId) instead of plain-text attributes encrypted withvaultIdandkeyId. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGateThe GoldenGate service uses this key to encrypt sensitive information (for example,
password) that is provided in plain-text connection attributes through the API. This field is applicable only whendoesUseSecretIdsis set tofalse. If bothvaultIdandkeyIdare provided, the GoldenGate service uses the specified customer-managed key to encrypt the sensitive data. If neithervaultIdnorkeyIdis provided, the GoldenGate service uses Oracle-managed encryption keys.- Key
Store string (Updatable) Base64-encoded key store content.
- SPARK: Client key store used for mutual TLS when
securityProtocolis TLS. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY, REDIS: KeyStore file used by the target connection.
Deprecated: This field is deprecated and replaced by "keyStoreSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- SPARK: Client key store used for mutual TLS when
- Key
Store stringPassword (Updatable) Password for
keyStore. For SPARK, it is required when a client key store is supplied.Deprecated: This field is deprecated and replaced by "keyStorePasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Key
Store stringPassword Secret Id - (Updatable) Secret OCID containing the key store password. For SPARK, it is required when
keyStoreSecretIdis supplied. When provided,keyStorePasswordmust not be provided. - Key
Store stringSecret Id - (Updatable) Secret OCID containing the key store content. For SPARK, it applies when
securityProtocolis TLS. When provided,keyStoremust not be provided. - Key
Store stringType - (Updatable) Client key store format used for mutual TLS. Applicable when securityProtocol is TLS and a client key store is provided. Defaults to JKS when not provided. Provide this only when a client key store is provided.
- Locks
List<Connection
Lock> - Locks associated with this resource.
- Max
Input intChars - (Updatable) Maximum number of input characters supported by this AI model connection.
- Model
Key string - (Updatable) AI model identifier.
- 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 to Snowflake platform. Deprecated: This field is deprecated and replaced by "passwordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate Snowflake is phasing out password authentication for legacy service users. Oracle GoldenGate Snowflake connections will support only key-pair authentication. See the Snowflake documentation for details: https://docs.snowflake.com/en/user-guide/security-mfa-rollout
- 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
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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- Provider
Id string - Optional identifier of the AI Provider Connection backing this AI Model Connection. When provided, it must reference an existing Active connection of type
AI_PROVIDER. WhenproviderIdis set,providerTypeandauthDetailsmust not be provided on the AI Model Connection, because provider metadata is resolved from the referenced AI Provider Connection. WhenproviderIdis not set, the AI Model Connection must provide inline provider metadata usingproviderTypeandauthDetails. - Provider
Type string - AI Provider type used by the AI Model Connection.
- 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 AWS region where the bucket is created. If not provided, GoldenGate will default to 'us-west-2'. Note: this property will become mandatory after May 20, 2026.
- Rest
Auth stringSecret Key (Updatable) The BASE64URL-encoded HMAC secret key used to sign REST submission requests when the Spark master's REST endpoint is protected by the JWS filter. Applicable only when submitMode is REST and the cluster enforces REST request signing. This setting is independent of authenticationType.
Deprecated: This field is deprecated and replaced by "restAuthSecretKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Rest
Auth stringSecret Key Secret Id - (Updatable) The OCID of the Secret that stores the REST submission signing key. Applicable only when submitMode is REST and the cluster enforces REST request signing. This setting is independent of authenticationType. Note: When provided, 'restAuthSecretKey' field must not be provided.
- Rest
Endpoint string - (Updatable) Spark standalone REST submission base URL. e.g.: 'https://spark-master.example.com:6066' Applicable only and required when submitMode is REST.
- Routing
Method string (Updatable) Controls the network traffic direction to the target: 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. SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
Deprecated: SHARED_SERVICE_ENDPOINT is deprecated. Use another supported routingMethod value, or update existing connections to use a supported routing method. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Rpc
Cipher string - (Updatable) Cipher transform used for Spark RPC encryption. Applicable when securityProtocol is AES_RPC. Defaults to AES_CTR_NOPADDING when not provided.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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
Attributes Dictionary<string, string> - (Updatable) Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}} - Security
Protocol string - (Updatable) Security protocol; supported values depend on
connectionType.- SPARK: PLAINTEXT, TLS, AES_RPC, or SASL_ENCRYPTED. AES_RPC and SASL_ENCRYPTED require SHARED_SECRET authentication.
- DB2, ELASTICSEARCH, JAVA_MESSAGE_SERVICE, KAFKA, MICROSOFT_SQLSERVER, MONGODB, MYSQL, POSTGRESQL, REDIS: Use the protocol supported by the target service.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Service
Account stringKey File Secret Id - (Updatable) The OCID of the Secret where the content of the service account key file is stored, which contains the credentials required to use Google Cloud Storage. Note: When provided, 'serviceAccountKeyFile' field must not be provided.
- Session
Mode string (Updatable) Specifies the session mode for the database connection. Use REDIRECT only for RAC databases with SCAN listeners that return IP addresses. For RAC databases with SCAN listeners that return FQDNs, and for all other Oracle database technologies, use DIRECT. In RAC deployments, SCAN listeners redirects a connection to a specific database node, identified by either IP address or FQDN. It is recommended to configure RAC with FQDN-based SCAN listeners.
The default is DIRECT, except when databaseId is provided and the discovered database relies on the SCAN listener. In this case, the default is REDIRECT.
Deprecated: Defaulting to the REDIRECT session mode will be removed after April 21, 2027.
- Should
Use boolJndi - (Updatable) If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.
- Should
Use boolResource Principal - (Updatable)
- KAFKA: Specifies that the user intends to authenticate to the instance using a resource principal. Applicable only for Oracle Cloud Infrastructure Streaming connections. Only available from 23.9.0.0.0 GoldenGate versions. Note: When specified, 'username'/'password'/'passwordSecretId' fields must not be provided. Default: false
- OCI_OBJECT_STORAGE, ORACLE_AI_DATA_PLATFORM, ORACLE_NOSQL: Specifies that the user intends to authenticate to the instance using a resource principal. Default: false
- 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)
- MICROSOFT_SQLSERVER: Database Certificate - The base64 encoded content of a .pem or .crt file containing the server public key (for 1-way SSL).
- MYSQL: Database Certificate - The base64 encoded content of a .pem or .crt file containing the server public key (for 1 and 2-way SSL). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - POSTGRESQL: The base64 encoded certificate of the trusted certificate authorities (Trusted CA) for PostgreSQL. The supported file formats are .pem and .crt. It is not included in GET responses if the
view=COMPACTquery parameter is specified.
- Ssl
Cert string - (Updatable)
- MYSQL: Client Certificate - The base64 encoded content of a .pem or .crt file containing the client public key (for 2-way SSL). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - POSTGRESQL: The base64 encoded certificate of the PostgreSQL server. The supported file formats are .pem and .crt. It is not included in GET responses if the
view=COMPACTquery parameter is specified.
- MYSQL: Client Certificate - The base64 encoded content of a .pem or .crt file containing the client public key (for 2-way SSL). It is not included in GET responses if the
- Ssl
Client stringKeystash (Updatable) The base64 encoded keystash file which contains the encrypted password to the key database file. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
Deprecated: This field is deprecated and replaced by "sslClientKeystashSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
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. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
Deprecated: This field is deprecated and replaced by "sslClientKeystoredbSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
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. It is not included in GET responses if the
view=COMPACTquery parameter is specified. - 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Ssl
Key stringPassword (Updatable) Password for the certificate private key inside the client key store.
- SPARK: Applicable when
securityProtocolis TLS and a client key store is provided. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY: Provide it when the private-key password differs from the key store password.
Deprecated: This field is deprecated and replaced by "sslKeyPasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- SPARK: Applicable when
- Ssl
Key stringPassword Secret Id (Updatable) Secret OCID containing the certificate private-key password inside the client key store.
- SPARK: Applicable when
securityProtocolis TLS and a client key store is provided. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY: Provide it when the private-key password differs from the key store password.
When provided,
sslKeyPasswordmust not be provided.- SPARK: Applicable when
- 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. It is not included in GET responses if the
view=COMPACTquery parameter is specified. - Storage
Connection
Storage - (Updatable) The information about a new storage of given type used in an Iceberg 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.
- Submit
Mode string - (Updatable) Selects the submission channel. SUBMIT uses the Spark master RPC endpoint. REST uses the Spark standalone REST submission gateway.
- Subnet
Id string - (Updatable) The OCID of the target subnet of the dedicated connection.
- Subscription
Id string - The OCID of the subscription with which resource needs to be associated with.
- 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). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Tls
Certificate stringKey File Password - (Updatable) Client Certificate key file password. Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFilePasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- Tls
Protocol string - (Updatable) TLS protocol negotiated by the Spark client. Applicable when securityProtocol is TLS. Defaults to TLS_V1_3 when not provided. Must be supported by the target cluster.
- Trigger
Refresh bool - Trust
Store string (Updatable) Base64-encoded trust store content.
- SPARK: Trust store used to validate the Spark server certificate when
securityProtocolis TLS. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY, REDIS: TrustStore file used by the target connection.
Deprecated: This field is deprecated and replaced by "trustStoreSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- SPARK: Trust store used to validate the Spark server certificate when
- Trust
Store stringPassword (Updatable) Password for
trustStore. For SPARK, it is required when a trust store is supplied.Deprecated: This field is deprecated and replaced by "trustStorePasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Trust
Store stringPassword Secret Id - (Updatable) Secret OCID containing the trust store password. For SPARK, it is required when
trustStoreSecretIdis supplied. When provided,trustStorePasswordmust not be provided. - Trust
Store stringSecret Id - (Updatable) Secret OCID containing the trust store content. For SPARK, it applies when
securityProtocolis TLS. When provided,trustStoremust not be provided. - Trust
Store stringType - (Updatable) Trust store format used by the Spark client. Applicable when securityProtocol is TLS and a trust store is provided. Defaults to JKS when not provided. Provide this only when a trust store is provided.
- Url string
- (Updatable) Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'
- User
Id string - (Updatable)
- OCI_OBJECT_STORAGE, ORACLE_AI_DATA_PLATFORM: The OCID of the Oracle Cloud Infrastructure user who accesses Object Storage. The user must have write access to the bucket. If omitted, the service defaults to the user calling the API.
- ORACLE_NOSQL: The OCID of the Oracle Cloud Infrastructure user who accesses the Oracle NoSQL database. The user must have write access to the table. If omitted, the service defaults to the user calling the API.
- 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) References the Oracle Cloud Infrastructure Vault that contains the customer-managed encryption key identified by
keyId.Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example,
passwordSecretId) instead of plain-text attributes encrypted withvaultIdandkeyId. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGateThis field is applicable only when
doesUseSecretIdsis set tofalse. IfvaultIdis provided,keyIdmust also be provided.- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- Workspace
Url string (Updatable)
- DATABRICKS_ENGINE: Databricks workspace base URL for the REST API, for example
https://<workspace>.cloud.databricks.com/api/2.0/. - ORACLE_AI_DATA_PLATFORM_ENGINE: Oracle AI Data Platform workspace URL.
** 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
- DATABRICKS_ENGINE: Databricks workspace base URL for the REST API, for example
- 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 - Technology type selected for the connection.
- AI_MODEL: AI Model technology type.
- AI_PROVIDER: AI Provider technology type.
- DATABRICKS_ENGINE: Databricks Engine technology type.
- ICEBERG: Iceberg technology type. APACHE_ICEBERG supports all catalog types; AMAZON_S3_TABLES supports only REST catalog and S3 storage.
- KAFKA_SCHEMA_REGISTRY: Kafka Schema Registry technology type.
- ORACLE_AI_DATA_PLATFORM_ENGINE: Oracle AI Data Platform Engine technology type.
- SPARK: Spark technology type.
- Access
Key stringId (Updatable)
- AMAZON_KINESIS: Access key ID used to access Amazon Kinesis.
- AMAZON_S3: Access key ID used to access the Amazon S3 bucket.
Note: Despite the "Id" suffix, this value is not an Oracle Cloud Infrastructure OCID.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- Artifact
Location ConnectionArtifact Location Args - (Updatable) Location used to share engine application artifacts.
- DATABRICKS_ENGINE: Location used to share Databricks application artifacts.
- SPARK: Location used to share Spark application artifacts with a remote cluster.
- Auth
Details ConnectionAuth Details Args - (Updatable) Authentication details for an AI Model or AI Provider connection.
- Auth
Secret string (Updatable) The shared secret used for Spark authentication. Applicable when authenticationType is SHARED_SECRET.
Deprecated: This field is deprecated and replaced by "authSecretSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Auth
Secret stringSecret Id - (Updatable) The OCID of the Secret that stores the Spark authentication shared secret. Applicable when authenticationType is SHARED_SECRET. Note: When provided, 'authSecret' field must not be provided.
- Auth
Token string - (Updatable) Personal access token used to connect to the Databricks Engine REST API. Only applicable for authenticationType == PERSONAL_ACCESS_TOKEN. Deprecated: This field is deprecated and replaced by "authTokenSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Auth
Token stringSecret Id - (Updatable) The OCID of the Secret where the personal access token is stored. Only applicable for authenticationType == PERSONAL_ACCESS_TOKEN. Note: When provided, 'authToken' field must not be provided.
- 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 mechanism; supported values depend on
connectionType.- DATABRICKS: Use PERSONAL_ACCESS_TOKEN or OAUTH_M2M.
- DATABRICKS_ENGINE: Use PERSONAL_ACCESS_TOKEN or OAUTH_M2M for the Databricks Engine REST API.
- JAVA_MESSAGE_SERVICE: Authentication type for Java Message Service. The default is NONE.
- SPARK: Use SHARED_SECRET only when the target cluster has
spark.authenticate=true. AES_RPC and SASL_ENCRYPTED require SHARED_SECRET. - AZURE_DATA_LAKE_STORAGE, ELASTICSEARCH, KAFKA_SCHEMA_REGISTRY, REDIS, SNOWFLAKE: Use the authentication type supported by the target service.
- string
- (Updatable) The endpoint used for authentication with Microsoft Entra ID (formerly Azure Active Directory). Default value: https://login.microsoftonline.com When connecting to a non-public Azure Cloud, the endpoint must be provided, eg:
- Azure China: https://login.chinacloudapi.cn/
- Azure US Government: https://login.microsoftonline.us/
- 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" - Catalog
Connection
Catalog Args - (Updatable) The information about a new catalog of given type used in an Iceberg connection.
- Client
Id string - (Updatable)
- AZURE_DATA_LAKE_STORAGE: Azure application client ID, required for AZURE_ACTIVE_DIRECTORY authentication.
- DATABRICKS, DATABRICKS_ENGINE: OAuth client ID, applicable to OAUTH_M2M authentication.
- MICROSOFT_FABRIC: Azure application client ID.
- Client
Secret string - (Updatable) Plaintext client secret for the selected connection type. For DATABRICKS and DATABRICKS_ENGINE it applies to OAUTH_M2M authentication. Deprecated: use
clientSecretSecretId. - Client
Secret stringSecret Id - (Updatable) Secret OCID containing the client secret. For DATABRICKS and DATABRICKS_ENGINE it applies to OAUTH_M2M authentication. When provided,
clientSecretmust not be provided. - Cluster
Endpoint string - (Updatable) Spark master URL used for job submission. Required for both submitMode SUBMIT and REST. e.g.: 'spark://spark-master.example.com:7077' High availability can be configured with a comma-separated list, for example: 'spark://h1.example.com:7077,h2.example.com:7077'
- Cluster
Id string - (Updatable) The OCID of the Kafka cluster being referenced from Oracle Cloud Infrastructure Streaming with Apache Kafka.
- Cluster
Placement stringGroup Id - The OCID(https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cluster placement group for the resource. Only applicable for multicloud subscriptions. The cluster placement group id must be provided when a multicloud subscription id is provided. Otherwise the cluster placement group 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) JDBC connection string. e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'
- Connection
Url string - (Updatable)
- AMAZON_REDSHIFT: JDBC connection URL. e.g.:
jdbc:redshift://aws-redshift-instance.aaaaaaaaaaaa.us-east-2.redshift.amazonaws.com:5439/mydb - DATABRICKS: JDBC 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 - JAVA_MESSAGE_SERVICE: Connection URL specifying the protocol, host, and port. e.g.:
mq://myjms.host.domain:7676 - ORACLE_AI_DATA_PLATFORM: Connection URL beginning with
jdbc:spark://. - SNOWFLAKE: JDBC connection URL. e.g.:
jdbc:snowflake://<account_name>.snowflakecomputing.com/?warehouse=<warehouse-name>&db=<db-name>
- AMAZON_REDSHIFT: JDBC connection URL. e.g.:
- 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). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - 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.
Deprecated: This field is deprecated. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example,
passwordSecretId) instead of plain-text attributes. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGateWhen set to
true, all sensitive information must be provided as Oracle Cloud Infrastructure Vault secrets using the corresponding*SecretIdattributes of the connection (for example,passwordSecretId). Plain-text sensitive attributes (for example,password) must not be used. This ensures that sensitive information remains stored and managed in the customer's Oracle Cloud Infrastructure Vault rather than by the GoldenGate service.When set to false, sensitive information must be provided in the corresponding plain-text attributes (for example,
password) rather than in secret OCID attributes. In this mode, the sensitive information is stored by the GoldenGate service. IfvaultIdandkeyIdare not specified, the GoldenGate service uses Oracle-managed encryption keys to encrypt the stored data.If
vaultIdandkeyIdare provided, the specified customer-managed key is used.- Endpoint string
- (Updatable)
- AMAZON_KINESIS: The endpoint URL of the Amazon Kinesis service. e.g.: 'https://kinesis.us-east-1.amazonaws.com' If not provided, GoldenGate will default to 'https://kinesis..amazonaws.com'.
- AMAZON_S3: The Amazon Endpoint for S3. e.g.: 'https://my-bucket.s3.us-east-1.amazonaws.com' If not provided, GoldenGate will default to 'https://s3..amazonaws.com'.
- AZURE_DATA_LAKE_STORAGE: Azure Storage service endpoint. e.g: https://test.blob.core.windows.net
- GOOGLE_BIGQUERY: A legal URL to connect to BigQuery including scheme, server name and port, if not the default port. Default: https://bigquery.googleapis.com
- GOOGLE_CLOUD_STORAGE: A legal URL to connect to Google Cloud Storage including scheme, server name and port, if not the default port. Default: https://storage.googleapis.com
- MICROSOFT_FABRIC: 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) 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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) References the Oracle Cloud Infrastructure Vault key in the Oracle Cloud Infrastructure Vault identified by
vaultId.Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example,
passwordSecretId) instead of plain-text attributes encrypted withvaultIdandkeyId. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGateThe GoldenGate service uses this key to encrypt sensitive information (for example,
password) that is provided in plain-text connection attributes through the API. This field is applicable only whendoesUseSecretIdsis set tofalse. If bothvaultIdandkeyIdare provided, the GoldenGate service uses the specified customer-managed key to encrypt the sensitive data. If neithervaultIdnorkeyIdis provided, the GoldenGate service uses Oracle-managed encryption keys.- Key
Store string (Updatable) Base64-encoded key store content.
- SPARK: Client key store used for mutual TLS when
securityProtocolis TLS. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY, REDIS: KeyStore file used by the target connection.
Deprecated: This field is deprecated and replaced by "keyStoreSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- SPARK: Client key store used for mutual TLS when
- Key
Store stringPassword (Updatable) Password for
keyStore. For SPARK, it is required when a client key store is supplied.Deprecated: This field is deprecated and replaced by "keyStorePasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Key
Store stringPassword Secret Id - (Updatable) Secret OCID containing the key store password. For SPARK, it is required when
keyStoreSecretIdis supplied. When provided,keyStorePasswordmust not be provided. - Key
Store stringSecret Id - (Updatable) Secret OCID containing the key store content. For SPARK, it applies when
securityProtocolis TLS. When provided,keyStoremust not be provided. - Key
Store stringType - (Updatable) Client key store format used for mutual TLS. Applicable when securityProtocol is TLS and a client key store is provided. Defaults to JKS when not provided. Provide this only when a client key store is provided.
- Locks
[]Connection
Lock Args - Locks associated with this resource.
- Max
Input intChars - (Updatable) Maximum number of input characters supported by this AI model connection.
- Model
Key string - (Updatable) AI model identifier.
- 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 to Snowflake platform. Deprecated: This field is deprecated and replaced by "passwordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate Snowflake is phasing out password authentication for legacy service users. Oracle GoldenGate Snowflake connections will support only key-pair authentication. See the Snowflake documentation for details: https://docs.snowflake.com/en/user-guide/security-mfa-rollout
- 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
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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- Provider
Id string - Optional identifier of the AI Provider Connection backing this AI Model Connection. When provided, it must reference an existing Active connection of type
AI_PROVIDER. WhenproviderIdis set,providerTypeandauthDetailsmust not be provided on the AI Model Connection, because provider metadata is resolved from the referenced AI Provider Connection. WhenproviderIdis not set, the AI Model Connection must provide inline provider metadata usingproviderTypeandauthDetails. - Provider
Type string - AI Provider type used by the AI Model Connection.
- 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 AWS region where the bucket is created. If not provided, GoldenGate will default to 'us-west-2'. Note: this property will become mandatory after May 20, 2026.
- Rest
Auth stringSecret Key (Updatable) The BASE64URL-encoded HMAC secret key used to sign REST submission requests when the Spark master's REST endpoint is protected by the JWS filter. Applicable only when submitMode is REST and the cluster enforces REST request signing. This setting is independent of authenticationType.
Deprecated: This field is deprecated and replaced by "restAuthSecretKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Rest
Auth stringSecret Key Secret Id - (Updatable) The OCID of the Secret that stores the REST submission signing key. Applicable only when submitMode is REST and the cluster enforces REST request signing. This setting is independent of authenticationType. Note: When provided, 'restAuthSecretKey' field must not be provided.
- Rest
Endpoint string - (Updatable) Spark standalone REST submission base URL. e.g.: 'https://spark-master.example.com:6066' Applicable only and required when submitMode is REST.
- Routing
Method string (Updatable) Controls the network traffic direction to the target: 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. SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
Deprecated: SHARED_SERVICE_ENDPOINT is deprecated. Use another supported routingMethod value, or update existing connections to use a supported routing method. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Rpc
Cipher string - (Updatable) Cipher transform used for Spark RPC encryption. Applicable when securityProtocol is AES_RPC. Defaults to AES_CTR_NOPADDING when not provided.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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
Attributes map[string]string - (Updatable) Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}} - Security
Protocol string - (Updatable) Security protocol; supported values depend on
connectionType.- SPARK: PLAINTEXT, TLS, AES_RPC, or SASL_ENCRYPTED. AES_RPC and SASL_ENCRYPTED require SHARED_SECRET authentication.
- DB2, ELASTICSEARCH, JAVA_MESSAGE_SERVICE, KAFKA, MICROSOFT_SQLSERVER, MONGODB, MYSQL, POSTGRESQL, REDIS: Use the protocol supported by the target service.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Service
Account stringKey File Secret Id - (Updatable) The OCID of the Secret where the content of the service account key file is stored, which contains the credentials required to use Google Cloud Storage. Note: When provided, 'serviceAccountKeyFile' field must not be provided.
- Session
Mode string (Updatable) Specifies the session mode for the database connection. Use REDIRECT only for RAC databases with SCAN listeners that return IP addresses. For RAC databases with SCAN listeners that return FQDNs, and for all other Oracle database technologies, use DIRECT. In RAC deployments, SCAN listeners redirects a connection to a specific database node, identified by either IP address or FQDN. It is recommended to configure RAC with FQDN-based SCAN listeners.
The default is DIRECT, except when databaseId is provided and the discovered database relies on the SCAN listener. In this case, the default is REDIRECT.
Deprecated: Defaulting to the REDIRECT session mode will be removed after April 21, 2027.
- Should
Use boolJndi - (Updatable) If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.
- Should
Use boolResource Principal - (Updatable)
- KAFKA: Specifies that the user intends to authenticate to the instance using a resource principal. Applicable only for Oracle Cloud Infrastructure Streaming connections. Only available from 23.9.0.0.0 GoldenGate versions. Note: When specified, 'username'/'password'/'passwordSecretId' fields must not be provided. Default: false
- OCI_OBJECT_STORAGE, ORACLE_AI_DATA_PLATFORM, ORACLE_NOSQL: Specifies that the user intends to authenticate to the instance using a resource principal. Default: false
- 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)
- MICROSOFT_SQLSERVER: Database Certificate - The base64 encoded content of a .pem or .crt file containing the server public key (for 1-way SSL).
- MYSQL: Database Certificate - The base64 encoded content of a .pem or .crt file containing the server public key (for 1 and 2-way SSL). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - POSTGRESQL: The base64 encoded certificate of the trusted certificate authorities (Trusted CA) for PostgreSQL. The supported file formats are .pem and .crt. It is not included in GET responses if the
view=COMPACTquery parameter is specified.
- Ssl
Cert string - (Updatable)
- MYSQL: Client Certificate - The base64 encoded content of a .pem or .crt file containing the client public key (for 2-way SSL). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - POSTGRESQL: The base64 encoded certificate of the PostgreSQL server. The supported file formats are .pem and .crt. It is not included in GET responses if the
view=COMPACTquery parameter is specified.
- MYSQL: Client Certificate - The base64 encoded content of a .pem or .crt file containing the client public key (for 2-way SSL). It is not included in GET responses if the
- Ssl
Client stringKeystash (Updatable) The base64 encoded keystash file which contains the encrypted password to the key database file. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
Deprecated: This field is deprecated and replaced by "sslClientKeystashSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
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. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
Deprecated: This field is deprecated and replaced by "sslClientKeystoredbSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
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. It is not included in GET responses if the
view=COMPACTquery parameter is specified. - 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Ssl
Key stringPassword (Updatable) Password for the certificate private key inside the client key store.
- SPARK: Applicable when
securityProtocolis TLS and a client key store is provided. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY: Provide it when the private-key password differs from the key store password.
Deprecated: This field is deprecated and replaced by "sslKeyPasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- SPARK: Applicable when
- Ssl
Key stringPassword Secret Id (Updatable) Secret OCID containing the certificate private-key password inside the client key store.
- SPARK: Applicable when
securityProtocolis TLS and a client key store is provided. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY: Provide it when the private-key password differs from the key store password.
When provided,
sslKeyPasswordmust not be provided.- SPARK: Applicable when
- 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. It is not included in GET responses if the
view=COMPACTquery parameter is specified. - Storage
Connection
Storage Args - (Updatable) The information about a new storage of given type used in an Iceberg 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.
- Submit
Mode string - (Updatable) Selects the submission channel. SUBMIT uses the Spark master RPC endpoint. REST uses the Spark standalone REST submission gateway.
- Subnet
Id string - (Updatable) The OCID of the target subnet of the dedicated connection.
- Subscription
Id string - The OCID of the subscription with which resource needs to be associated with.
- 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). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Tls
Certificate stringKey File Password - (Updatable) Client Certificate key file password. Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFilePasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- Tls
Protocol string - (Updatable) TLS protocol negotiated by the Spark client. Applicable when securityProtocol is TLS. Defaults to TLS_V1_3 when not provided. Must be supported by the target cluster.
- Trigger
Refresh bool - Trust
Store string (Updatable) Base64-encoded trust store content.
- SPARK: Trust store used to validate the Spark server certificate when
securityProtocolis TLS. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY, REDIS: TrustStore file used by the target connection.
Deprecated: This field is deprecated and replaced by "trustStoreSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- SPARK: Trust store used to validate the Spark server certificate when
- Trust
Store stringPassword (Updatable) Password for
trustStore. For SPARK, it is required when a trust store is supplied.Deprecated: This field is deprecated and replaced by "trustStorePasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Trust
Store stringPassword Secret Id - (Updatable) Secret OCID containing the trust store password. For SPARK, it is required when
trustStoreSecretIdis supplied. When provided,trustStorePasswordmust not be provided. - Trust
Store stringSecret Id - (Updatable) Secret OCID containing the trust store content. For SPARK, it applies when
securityProtocolis TLS. When provided,trustStoremust not be provided. - Trust
Store stringType - (Updatable) Trust store format used by the Spark client. Applicable when securityProtocol is TLS and a trust store is provided. Defaults to JKS when not provided. Provide this only when a trust store is provided.
- Url string
- (Updatable) Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'
- User
Id string - (Updatable)
- OCI_OBJECT_STORAGE, ORACLE_AI_DATA_PLATFORM: The OCID of the Oracle Cloud Infrastructure user who accesses Object Storage. The user must have write access to the bucket. If omitted, the service defaults to the user calling the API.
- ORACLE_NOSQL: The OCID of the Oracle Cloud Infrastructure user who accesses the Oracle NoSQL database. The user must have write access to the table. If omitted, the service defaults to the user calling the API.
- 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) References the Oracle Cloud Infrastructure Vault that contains the customer-managed encryption key identified by
keyId.Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example,
passwordSecretId) instead of plain-text attributes encrypted withvaultIdandkeyId. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGateThis field is applicable only when
doesUseSecretIdsis set tofalse. IfvaultIdis provided,keyIdmust also be provided.- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- Workspace
Url string (Updatable)
- DATABRICKS_ENGINE: Databricks workspace base URL for the REST API, for example
https://<workspace>.cloud.databricks.com/api/2.0/. - ORACLE_AI_DATA_PLATFORM_ENGINE: Oracle AI Data Platform workspace URL.
** 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
- DATABRICKS_ENGINE: Databricks workspace base URL for the REST API, for example
- 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 - Technology type selected for the connection.
- AI_MODEL: AI Model technology type.
- AI_PROVIDER: AI Provider technology type.
- DATABRICKS_ENGINE: Databricks Engine technology type.
- ICEBERG: Iceberg technology type. APACHE_ICEBERG supports all catalog types; AMAZON_S3_TABLES supports only REST catalog and S3 storage.
- KAFKA_SCHEMA_REGISTRY: Kafka Schema Registry technology type.
- ORACLE_AI_DATA_PLATFORM_ENGINE: Oracle AI Data Platform Engine technology type.
- SPARK: Spark technology type.
- access_
key_ stringid (Updatable)
- AMAZON_KINESIS: Access key ID used to access Amazon Kinesis.
- AMAZON_S3: Access key ID used to access the Amazon S3 bucket.
Note: Despite the "Id" suffix, this value is not an Oracle Cloud Infrastructure OCID.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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(object) - (Updatable) An array of name-value pair attribute entries. Used as additional parameters in connection string.
- artifact_
location object - (Updatable) Location used to share engine application artifacts.
- DATABRICKS_ENGINE: Location used to share Databricks application artifacts.
- SPARK: Location used to share Spark application artifacts with a remote cluster.
- auth_
details object - (Updatable) Authentication details for an AI Model or AI Provider connection.
- auth_
secret string (Updatable) The shared secret used for Spark authentication. Applicable when authenticationType is SHARED_SECRET.
Deprecated: This field is deprecated and replaced by "authSecretSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- auth_
secret_ stringsecret_ id - (Updatable) The OCID of the Secret that stores the Spark authentication shared secret. Applicable when authenticationType is SHARED_SECRET. Note: When provided, 'authSecret' field must not be provided.
- auth_
token string - (Updatable) Personal access token used to connect to the Databricks Engine REST API. Only applicable for authenticationType == PERSONAL_ACCESS_TOKEN. Deprecated: This field is deprecated and replaced by "authTokenSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- auth_
token_ stringsecret_ id - (Updatable) The OCID of the Secret where the personal access token is stored. Only applicable for authenticationType == PERSONAL_ACCESS_TOKEN. Note: When provided, 'authToken' field must not be provided.
- 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 mechanism; supported values depend on
connectionType.- DATABRICKS: Use PERSONAL_ACCESS_TOKEN or OAUTH_M2M.
- DATABRICKS_ENGINE: Use PERSONAL_ACCESS_TOKEN or OAUTH_M2M for the Databricks Engine REST API.
- JAVA_MESSAGE_SERVICE: Authentication type for Java Message Service. The default is NONE.
- SPARK: Use SHARED_SECRET only when the target cluster has
spark.authenticate=true. AES_RPC and SASL_ENCRYPTED require SHARED_SECRET. - AZURE_DATA_LAKE_STORAGE, ELASTICSEARCH, KAFKA_SCHEMA_REGISTRY, REDIS, SNOWFLAKE: Use the authentication type supported by the target service.
- string
- (Updatable) The endpoint used for authentication with Microsoft Entra ID (formerly Azure Active Directory). Default value: https://login.microsoftonline.com When connecting to a non-public Azure Cloud, the endpoint must be provided, eg:
- Azure China: https://login.chinacloudapi.cn/
- Azure US Government: https://login.microsoftonline.us/
- 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(object) - (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" - catalog object
- (Updatable) The information about a new catalog of given type used in an Iceberg connection.
- client_
id string - (Updatable)
- AZURE_DATA_LAKE_STORAGE: Azure application client ID, required for AZURE_ACTIVE_DIRECTORY authentication.
- DATABRICKS, DATABRICKS_ENGINE: OAuth client ID, applicable to OAUTH_M2M authentication.
- MICROSOFT_FABRIC: Azure application client ID.
- client_
secret string - (Updatable) Plaintext client secret for the selected connection type. For DATABRICKS and DATABRICKS_ENGINE it applies to OAUTH_M2M authentication. Deprecated: use
clientSecretSecretId. - client_
secret_ stringsecret_ id - (Updatable) Secret OCID containing the client secret. For DATABRICKS and DATABRICKS_ENGINE it applies to OAUTH_M2M authentication. When provided,
clientSecretmust not be provided. - cluster_
endpoint string - (Updatable) Spark master URL used for job submission. Required for both submitMode SUBMIT and REST. e.g.: 'spark://spark-master.example.com:7077' High availability can be configured with a comma-separated list, for example: 'spark://h1.example.com:7077,h2.example.com:7077'
- cluster_
id string - (Updatable) The OCID of the Kafka cluster being referenced from Oracle Cloud Infrastructure Streaming with Apache Kafka.
- cluster_
placement_ stringgroup_ id - The OCID(https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cluster placement group for the resource. Only applicable for multicloud subscriptions. The cluster placement group id must be provided when a multicloud subscription id is provided. Otherwise the cluster placement group 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) JDBC connection string. e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'
- connection_
url string - (Updatable)
- AMAZON_REDSHIFT: JDBC connection URL. e.g.:
jdbc:redshift://aws-redshift-instance.aaaaaaaaaaaa.us-east-2.redshift.amazonaws.com:5439/mydb - DATABRICKS: JDBC 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 - JAVA_MESSAGE_SERVICE: Connection URL specifying the protocol, host, and port. e.g.:
mq://myjms.host.domain:7676 - ORACLE_AI_DATA_PLATFORM: Connection URL beginning with
jdbc:spark://. - SNOWFLAKE: JDBC connection URL. e.g.:
jdbc:snowflake://<account_name>.snowflakecomputing.com/?warehouse=<warehouse-name>&db=<db-name>
- AMAZON_REDSHIFT: JDBC connection URL. e.g.:
- 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). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - 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_ boolsecret_ ids (Updatable) Indicates that sensitive attributes are provided via Secrets.
Deprecated: This field is deprecated. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example,
passwordSecretId) instead of plain-text attributes. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGateWhen set to
true, all sensitive information must be provided as Oracle Cloud Infrastructure Vault secrets using the corresponding*SecretIdattributes of the connection (for example,passwordSecretId). Plain-text sensitive attributes (for example,password) must not be used. This ensures that sensitive information remains stored and managed in the customer's Oracle Cloud Infrastructure Vault rather than by the GoldenGate service.When set to false, sensitive information must be provided in the corresponding plain-text attributes (for example,
password) rather than in secret OCID attributes. In this mode, the sensitive information is stored by the GoldenGate service. IfvaultIdandkeyIdare not specified, the GoldenGate service uses Oracle-managed encryption keys to encrypt the stored data.If
vaultIdandkeyIdare provided, the specified customer-managed key is used.- endpoint string
- (Updatable)
- AMAZON_KINESIS: The endpoint URL of the Amazon Kinesis service. e.g.: 'https://kinesis.us-east-1.amazonaws.com' If not provided, GoldenGate will default to 'https://kinesis..amazonaws.com'.
- AMAZON_S3: The Amazon Endpoint for S3. e.g.: 'https://my-bucket.s3.us-east-1.amazonaws.com' If not provided, GoldenGate will default to 'https://s3..amazonaws.com'.
- AZURE_DATA_LAKE_STORAGE: Azure Storage service endpoint. e.g: https://test.blob.core.windows.net
- GOOGLE_BIGQUERY: A legal URL to connect to BigQuery including scheme, server name and port, if not the default port. Default: https://bigquery.googleapis.com
- GOOGLE_CLOUD_STORAGE: A legal URL to connect to Google Cloud Storage including scheme, server name and port, if not the default port. Default: https://storage.googleapis.com
- MICROSOFT_FABRIC: 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) 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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) References the Oracle Cloud Infrastructure Vault key in the Oracle Cloud Infrastructure Vault identified by
vaultId.Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example,
passwordSecretId) instead of plain-text attributes encrypted withvaultIdandkeyId. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGateThe GoldenGate service uses this key to encrypt sensitive information (for example,
password) that is provided in plain-text connection attributes through the API. This field is applicable only whendoesUseSecretIdsis set tofalse. If bothvaultIdandkeyIdare provided, the GoldenGate service uses the specified customer-managed key to encrypt the sensitive data. If neithervaultIdnorkeyIdis provided, the GoldenGate service uses Oracle-managed encryption keys.- key_
store string (Updatable) Base64-encoded key store content.
- SPARK: Client key store used for mutual TLS when
securityProtocolis TLS. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY, REDIS: KeyStore file used by the target connection.
Deprecated: This field is deprecated and replaced by "keyStoreSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- SPARK: Client key store used for mutual TLS when
- key_
store_ stringpassword (Updatable) Password for
keyStore. For SPARK, it is required when a client key store is supplied.Deprecated: This field is deprecated and replaced by "keyStorePasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- key_
store_ stringpassword_ secret_ id - (Updatable) Secret OCID containing the key store password. For SPARK, it is required when
keyStoreSecretIdis supplied. When provided,keyStorePasswordmust not be provided. - key_
store_ stringsecret_ id - (Updatable) Secret OCID containing the key store content. For SPARK, it applies when
securityProtocolis TLS. When provided,keyStoremust not be provided. - key_
store_ stringtype - (Updatable) Client key store format used for mutual TLS. Applicable when securityProtocol is TLS and a client key store is provided. Defaults to JKS when not provided. Provide this only when a client key store is provided.
- locks list(object)
- Locks associated with this resource.
- max_
input_ numberchars - (Updatable) Maximum number of input characters supported by this AI model connection.
- model_
key string - (Updatable) AI model identifier.
- 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 to Snowflake platform. Deprecated: This field is deprecated and replaced by "passwordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate Snowflake is phasing out password authentication for legacy service users. Oracle GoldenGate Snowflake connections will support only key-pair authentication. See the Snowflake documentation for details: https://docs.snowflake.com/en/user-guide/security-mfa-rollout
- 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_
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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- provider_
id string - Optional identifier of the AI Provider Connection backing this AI Model Connection. When provided, it must reference an existing Active connection of type
AI_PROVIDER. WhenproviderIdis set,providerTypeandauthDetailsmust not be provided on the AI Model Connection, because provider metadata is resolved from the referenced AI Provider Connection. WhenproviderIdis not set, the AI Model Connection must provide inline provider metadata usingproviderTypeandauthDetails. - provider_
type string - AI Provider type used by the AI Model Connection.
- 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 AWS region where the bucket is created. If not provided, GoldenGate will default to 'us-west-2'. Note: this property will become mandatory after May 20, 2026.
- rest_
auth_ stringsecret_ key (Updatable) The BASE64URL-encoded HMAC secret key used to sign REST submission requests when the Spark master's REST endpoint is protected by the JWS filter. Applicable only when submitMode is REST and the cluster enforces REST request signing. This setting is independent of authenticationType.
Deprecated: This field is deprecated and replaced by "restAuthSecretKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- rest_
auth_ stringsecret_ key_ secret_ id - (Updatable) The OCID of the Secret that stores the REST submission signing key. Applicable only when submitMode is REST and the cluster enforces REST request signing. This setting is independent of authenticationType. Note: When provided, 'restAuthSecretKey' field must not be provided.
- rest_
endpoint string - (Updatable) Spark standalone REST submission base URL. e.g.: 'https://spark-master.example.com:6066' Applicable only and required when submitMode is REST.
- routing_
method string (Updatable) Controls the network traffic direction to the target: 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. SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
Deprecated: SHARED_SERVICE_ENDPOINT is deprecated. Use another supported routingMethod value, or update existing connections to use a supported routing method. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- rpc_
cipher string - (Updatable) Cipher transform used for Spark RPC encryption. Applicable when securityProtocol is AES_RPC. Defaults to AES_CTR_NOPADDING when not provided.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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_
attributes map(string) - (Updatable) Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}} - security_
protocol string - (Updatable) Security protocol; supported values depend on
connectionType.- SPARK: PLAINTEXT, TLS, AES_RPC, or SASL_ENCRYPTED. AES_RPC and SASL_ENCRYPTED require SHARED_SECRET authentication.
- DB2, ELASTICSEARCH, JAVA_MESSAGE_SERVICE, KAFKA, MICROSOFT_SQLSERVER, MONGODB, MYSQL, POSTGRESQL, REDIS: Use the protocol supported by the target service.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- service_
account_ stringkey_ file_ secret_ id - (Updatable) The OCID of the Secret where the content of the service account key file is stored, which contains the credentials required to use Google Cloud Storage. Note: When provided, 'serviceAccountKeyFile' field must not be provided.
- session_
mode string (Updatable) Specifies the session mode for the database connection. Use REDIRECT only for RAC databases with SCAN listeners that return IP addresses. For RAC databases with SCAN listeners that return FQDNs, and for all other Oracle database technologies, use DIRECT. In RAC deployments, SCAN listeners redirects a connection to a specific database node, identified by either IP address or FQDN. It is recommended to configure RAC with FQDN-based SCAN listeners.
The default is DIRECT, except when databaseId is provided and the discovered database relies on the SCAN listener. In this case, the default is REDIRECT.
Deprecated: Defaulting to the REDIRECT session mode will be removed after April 21, 2027.
- should_
use_ booljndi - (Updatable) If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.
- should_
use_ boolresource_ principal - (Updatable)
- KAFKA: Specifies that the user intends to authenticate to the instance using a resource principal. Applicable only for Oracle Cloud Infrastructure Streaming connections. Only available from 23.9.0.0.0 GoldenGate versions. Note: When specified, 'username'/'password'/'passwordSecretId' fields must not be provided. Default: false
- OCI_OBJECT_STORAGE, ORACLE_AI_DATA_PLATFORM, ORACLE_NOSQL: Specifies that the user intends to authenticate to the instance using a resource principal. Default: false
- 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)
- MICROSOFT_SQLSERVER: Database Certificate - The base64 encoded content of a .pem or .crt file containing the server public key (for 1-way SSL).
- MYSQL: Database Certificate - The base64 encoded content of a .pem or .crt file containing the server public key (for 1 and 2-way SSL). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - POSTGRESQL: The base64 encoded certificate of the trusted certificate authorities (Trusted CA) for PostgreSQL. The supported file formats are .pem and .crt. It is not included in GET responses if the
view=COMPACTquery parameter is specified.
- ssl_
cert string - (Updatable)
- MYSQL: Client Certificate - The base64 encoded content of a .pem or .crt file containing the client public key (for 2-way SSL). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - POSTGRESQL: The base64 encoded certificate of the PostgreSQL server. The supported file formats are .pem and .crt. It is not included in GET responses if the
view=COMPACTquery parameter is specified.
- MYSQL: Client Certificate - The base64 encoded content of a .pem or .crt file containing the client public key (for 2-way SSL). It is not included in GET responses if the
- ssl_
client_ stringkeystash (Updatable) The base64 encoded keystash file which contains the encrypted password to the key database file. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
Deprecated: This field is deprecated and replaced by "sslClientKeystashSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
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. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
Deprecated: This field is deprecated and replaced by "sslClientKeystoredbSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
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. It is not included in GET responses if the
view=COMPACTquery parameter is specified. - 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- ssl_
key_ stringpassword (Updatable) Password for the certificate private key inside the client key store.
- SPARK: Applicable when
securityProtocolis TLS and a client key store is provided. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY: Provide it when the private-key password differs from the key store password.
Deprecated: This field is deprecated and replaced by "sslKeyPasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- SPARK: Applicable when
- ssl_
key_ stringpassword_ secret_ id (Updatable) Secret OCID containing the certificate private-key password inside the client key store.
- SPARK: Applicable when
securityProtocolis TLS and a client key store is provided. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY: Provide it when the private-key password differs from the key store password.
When provided,
sslKeyPasswordmust not be provided.- SPARK: Applicable when
- 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. It is not included in GET responses if the
view=COMPACTquery parameter is specified. - storage object
- (Updatable) The information about a new storage of given type used in an Iceberg 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.
- submit_
mode string - (Updatable) Selects the submission channel. SUBMIT uses the Spark master RPC endpoint. REST uses the Spark standalone REST submission gateway.
- subnet_
id string - (Updatable) The OCID of the target subnet of the dedicated connection.
- subscription_
id string - The OCID of the subscription with which resource needs to be associated with.
- 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). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- tls_
certificate_ stringkey_ file_ password - (Updatable) Client Certificate key file password. Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFilePasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- tls_
protocol string - (Updatable) TLS protocol negotiated by the Spark client. Applicable when securityProtocol is TLS. Defaults to TLS_V1_3 when not provided. Must be supported by the target cluster.
- trigger_
refresh bool - trust_
store string (Updatable) Base64-encoded trust store content.
- SPARK: Trust store used to validate the Spark server certificate when
securityProtocolis TLS. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY, REDIS: TrustStore file used by the target connection.
Deprecated: This field is deprecated and replaced by "trustStoreSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- SPARK: Trust store used to validate the Spark server certificate when
- trust_
store_ stringpassword (Updatable) Password for
trustStore. For SPARK, it is required when a trust store is supplied.Deprecated: This field is deprecated and replaced by "trustStorePasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- trust_
store_ stringpassword_ secret_ id - (Updatable) Secret OCID containing the trust store password. For SPARK, it is required when
trustStoreSecretIdis supplied. When provided,trustStorePasswordmust not be provided. - trust_
store_ stringsecret_ id - (Updatable) Secret OCID containing the trust store content. For SPARK, it applies when
securityProtocolis TLS. When provided,trustStoremust not be provided. - trust_
store_ stringtype - (Updatable) Trust store format used by the Spark client. Applicable when securityProtocol is TLS and a trust store is provided. Defaults to JKS when not provided. Provide this only when a trust store is provided.
- url string
- (Updatable) Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'
- user_
id string - (Updatable)
- OCI_OBJECT_STORAGE, ORACLE_AI_DATA_PLATFORM: The OCID of the Oracle Cloud Infrastructure user who accesses Object Storage. The user must have write access to the bucket. If omitted, the service defaults to the user calling the API.
- ORACLE_NOSQL: The OCID of the Oracle Cloud Infrastructure user who accesses the Oracle NoSQL database. The user must have write access to the table. If omitted, the service defaults to the user calling the API.
- 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) References the Oracle Cloud Infrastructure Vault that contains the customer-managed encryption key identified by
keyId.Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example,
passwordSecretId) instead of plain-text attributes encrypted withvaultIdandkeyId. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGateThis field is applicable only when
doesUseSecretIdsis set tofalse. IfvaultIdis provided,keyIdmust also be provided.- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- workspace_
url string (Updatable)
- DATABRICKS_ENGINE: Databricks workspace base URL for the REST API, for example
https://<workspace>.cloud.databricks.com/api/2.0/. - ORACLE_AI_DATA_PLATFORM_ENGINE: Oracle AI Data Platform workspace URL.
** 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
- DATABRICKS_ENGINE: Databricks workspace base URL for the REST API, for example
- 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 - Technology type selected for the connection.
- AI_MODEL: AI Model technology type.
- AI_PROVIDER: AI Provider technology type.
- DATABRICKS_ENGINE: Databricks Engine technology type.
- ICEBERG: Iceberg technology type. APACHE_ICEBERG supports all catalog types; AMAZON_S3_TABLES supports only REST catalog and S3 storage.
- KAFKA_SCHEMA_REGISTRY: Kafka Schema Registry technology type.
- ORACLE_AI_DATA_PLATFORM_ENGINE: Oracle AI Data Platform Engine technology type.
- SPARK: Spark technology type.
- access
Key StringId (Updatable)
- AMAZON_KINESIS: Access key ID used to access Amazon Kinesis.
- AMAZON_S3: Access key ID used to access the Amazon S3 bucket.
Note: Despite the "Id" suffix, this value is not an Oracle Cloud Infrastructure OCID.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- artifact
Location ConnectionArtifact Location - (Updatable) Location used to share engine application artifacts.
- DATABRICKS_ENGINE: Location used to share Databricks application artifacts.
- SPARK: Location used to share Spark application artifacts with a remote cluster.
- auth
Details ConnectionAuth Details - (Updatable) Authentication details for an AI Model or AI Provider connection.
- auth
Secret String (Updatable) The shared secret used for Spark authentication. Applicable when authenticationType is SHARED_SECRET.
Deprecated: This field is deprecated and replaced by "authSecretSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- auth
Secret StringSecret Id - (Updatable) The OCID of the Secret that stores the Spark authentication shared secret. Applicable when authenticationType is SHARED_SECRET. Note: When provided, 'authSecret' field must not be provided.
- auth
Token String - (Updatable) Personal access token used to connect to the Databricks Engine REST API. Only applicable for authenticationType == PERSONAL_ACCESS_TOKEN. Deprecated: This field is deprecated and replaced by "authTokenSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- auth
Token StringSecret Id - (Updatable) The OCID of the Secret where the personal access token is stored. Only applicable for authenticationType == PERSONAL_ACCESS_TOKEN. Note: When provided, 'authToken' field must not be provided.
- 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 mechanism; supported values depend on
connectionType.- DATABRICKS: Use PERSONAL_ACCESS_TOKEN or OAUTH_M2M.
- DATABRICKS_ENGINE: Use PERSONAL_ACCESS_TOKEN or OAUTH_M2M for the Databricks Engine REST API.
- JAVA_MESSAGE_SERVICE: Authentication type for Java Message Service. The default is NONE.
- SPARK: Use SHARED_SECRET only when the target cluster has
spark.authenticate=true. AES_RPC and SASL_ENCRYPTED require SHARED_SECRET. - AZURE_DATA_LAKE_STORAGE, ELASTICSEARCH, KAFKA_SCHEMA_REGISTRY, REDIS, SNOWFLAKE: Use the authentication type supported by the target service.
- String
- (Updatable) The endpoint used for authentication with Microsoft Entra ID (formerly Azure Active Directory). Default value: https://login.microsoftonline.com When connecting to a non-public Azure Cloud, the endpoint must be provided, eg:
- Azure China: https://login.chinacloudapi.cn/
- Azure US Government: https://login.microsoftonline.us/
- 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" - catalog
Connection
Catalog - (Updatable) The information about a new catalog of given type used in an Iceberg connection.
- client
Id String - (Updatable)
- AZURE_DATA_LAKE_STORAGE: Azure application client ID, required for AZURE_ACTIVE_DIRECTORY authentication.
- DATABRICKS, DATABRICKS_ENGINE: OAuth client ID, applicable to OAUTH_M2M authentication.
- MICROSOFT_FABRIC: Azure application client ID.
- client
Secret String - (Updatable) Plaintext client secret for the selected connection type. For DATABRICKS and DATABRICKS_ENGINE it applies to OAUTH_M2M authentication. Deprecated: use
clientSecretSecretId. - client
Secret StringSecret Id - (Updatable) Secret OCID containing the client secret. For DATABRICKS and DATABRICKS_ENGINE it applies to OAUTH_M2M authentication. When provided,
clientSecretmust not be provided. - cluster
Endpoint String - (Updatable) Spark master URL used for job submission. Required for both submitMode SUBMIT and REST. e.g.: 'spark://spark-master.example.com:7077' High availability can be configured with a comma-separated list, for example: 'spark://h1.example.com:7077,h2.example.com:7077'
- cluster
Id String - (Updatable) The OCID of the Kafka cluster being referenced from Oracle Cloud Infrastructure Streaming with Apache Kafka.
- cluster
Placement StringGroup Id - The OCID(https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cluster placement group for the resource. Only applicable for multicloud subscriptions. The cluster placement group id must be provided when a multicloud subscription id is provided. Otherwise the cluster placement group 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) JDBC connection string. e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'
- connection
Url String - (Updatable)
- AMAZON_REDSHIFT: JDBC connection URL. e.g.:
jdbc:redshift://aws-redshift-instance.aaaaaaaaaaaa.us-east-2.redshift.amazonaws.com:5439/mydb - DATABRICKS: JDBC 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 - JAVA_MESSAGE_SERVICE: Connection URL specifying the protocol, host, and port. e.g.:
mq://myjms.host.domain:7676 - ORACLE_AI_DATA_PLATFORM: Connection URL beginning with
jdbc:spark://. - SNOWFLAKE: JDBC connection URL. e.g.:
jdbc:snowflake://<account_name>.snowflakecomputing.com/?warehouse=<warehouse-name>&db=<db-name>
- AMAZON_REDSHIFT: JDBC connection URL. e.g.:
- 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). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - 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.
Deprecated: This field is deprecated. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example,
passwordSecretId) instead of plain-text attributes. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGateWhen set to
true, all sensitive information must be provided as Oracle Cloud Infrastructure Vault secrets using the corresponding*SecretIdattributes of the connection (for example,passwordSecretId). Plain-text sensitive attributes (for example,password) must not be used. This ensures that sensitive information remains stored and managed in the customer's Oracle Cloud Infrastructure Vault rather than by the GoldenGate service.When set to false, sensitive information must be provided in the corresponding plain-text attributes (for example,
password) rather than in secret OCID attributes. In this mode, the sensitive information is stored by the GoldenGate service. IfvaultIdandkeyIdare not specified, the GoldenGate service uses Oracle-managed encryption keys to encrypt the stored data.If
vaultIdandkeyIdare provided, the specified customer-managed key is used.- endpoint String
- (Updatable)
- AMAZON_KINESIS: The endpoint URL of the Amazon Kinesis service. e.g.: 'https://kinesis.us-east-1.amazonaws.com' If not provided, GoldenGate will default to 'https://kinesis..amazonaws.com'.
- AMAZON_S3: The Amazon Endpoint for S3. e.g.: 'https://my-bucket.s3.us-east-1.amazonaws.com' If not provided, GoldenGate will default to 'https://s3..amazonaws.com'.
- AZURE_DATA_LAKE_STORAGE: Azure Storage service endpoint. e.g: https://test.blob.core.windows.net
- GOOGLE_BIGQUERY: A legal URL to connect to BigQuery including scheme, server name and port, if not the default port. Default: https://bigquery.googleapis.com
- GOOGLE_CLOUD_STORAGE: A legal URL to connect to Google Cloud Storage including scheme, server name and port, if not the default port. Default: https://storage.googleapis.com
- MICROSOFT_FABRIC: 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) 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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) References the Oracle Cloud Infrastructure Vault key in the Oracle Cloud Infrastructure Vault identified by
vaultId.Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example,
passwordSecretId) instead of plain-text attributes encrypted withvaultIdandkeyId. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGateThe GoldenGate service uses this key to encrypt sensitive information (for example,
password) that is provided in plain-text connection attributes through the API. This field is applicable only whendoesUseSecretIdsis set tofalse. If bothvaultIdandkeyIdare provided, the GoldenGate service uses the specified customer-managed key to encrypt the sensitive data. If neithervaultIdnorkeyIdis provided, the GoldenGate service uses Oracle-managed encryption keys.- key
Store String (Updatable) Base64-encoded key store content.
- SPARK: Client key store used for mutual TLS when
securityProtocolis TLS. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY, REDIS: KeyStore file used by the target connection.
Deprecated: This field is deprecated and replaced by "keyStoreSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- SPARK: Client key store used for mutual TLS when
- key
Store StringPassword (Updatable) Password for
keyStore. For SPARK, it is required when a client key store is supplied.Deprecated: This field is deprecated and replaced by "keyStorePasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- key
Store StringPassword Secret Id - (Updatable) Secret OCID containing the key store password. For SPARK, it is required when
keyStoreSecretIdis supplied. When provided,keyStorePasswordmust not be provided. - key
Store StringSecret Id - (Updatable) Secret OCID containing the key store content. For SPARK, it applies when
securityProtocolis TLS. When provided,keyStoremust not be provided. - key
Store StringType - (Updatable) Client key store format used for mutual TLS. Applicable when securityProtocol is TLS and a client key store is provided. Defaults to JKS when not provided. Provide this only when a client key store is provided.
- locks
List<Connection
Lock> - Locks associated with this resource.
- max
Input IntegerChars - (Updatable) Maximum number of input characters supported by this AI model connection.
- model
Key String - (Updatable) AI model identifier.
- 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 to Snowflake platform. Deprecated: This field is deprecated and replaced by "passwordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate Snowflake is phasing out password authentication for legacy service users. Oracle GoldenGate Snowflake connections will support only key-pair authentication. See the Snowflake documentation for details: https://docs.snowflake.com/en/user-guide/security-mfa-rollout
- 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
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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- provider
Id String - Optional identifier of the AI Provider Connection backing this AI Model Connection. When provided, it must reference an existing Active connection of type
AI_PROVIDER. WhenproviderIdis set,providerTypeandauthDetailsmust not be provided on the AI Model Connection, because provider metadata is resolved from the referenced AI Provider Connection. WhenproviderIdis not set, the AI Model Connection must provide inline provider metadata usingproviderTypeandauthDetails. - provider
Type String - AI Provider type used by the AI Model Connection.
- 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 AWS region where the bucket is created. If not provided, GoldenGate will default to 'us-west-2'. Note: this property will become mandatory after May 20, 2026.
- rest
Auth StringSecret Key (Updatable) The BASE64URL-encoded HMAC secret key used to sign REST submission requests when the Spark master's REST endpoint is protected by the JWS filter. Applicable only when submitMode is REST and the cluster enforces REST request signing. This setting is independent of authenticationType.
Deprecated: This field is deprecated and replaced by "restAuthSecretKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- rest
Auth StringSecret Key Secret Id - (Updatable) The OCID of the Secret that stores the REST submission signing key. Applicable only when submitMode is REST and the cluster enforces REST request signing. This setting is independent of authenticationType. Note: When provided, 'restAuthSecretKey' field must not be provided.
- rest
Endpoint String - (Updatable) Spark standalone REST submission base URL. e.g.: 'https://spark-master.example.com:6066' Applicable only and required when submitMode is REST.
- routing
Method String (Updatable) Controls the network traffic direction to the target: 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. SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
Deprecated: SHARED_SERVICE_ENDPOINT is deprecated. Use another supported routingMethod value, or update existing connections to use a supported routing method. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- rpc
Cipher String - (Updatable) Cipher transform used for Spark RPC encryption. Applicable when securityProtocol is AES_RPC. Defaults to AES_CTR_NOPADDING when not provided.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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
Attributes Map<String,String> - (Updatable) Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}} - security
Protocol String - (Updatable) Security protocol; supported values depend on
connectionType.- SPARK: PLAINTEXT, TLS, AES_RPC, or SASL_ENCRYPTED. AES_RPC and SASL_ENCRYPTED require SHARED_SECRET authentication.
- DB2, ELASTICSEARCH, JAVA_MESSAGE_SERVICE, KAFKA, MICROSOFT_SQLSERVER, MONGODB, MYSQL, POSTGRESQL, REDIS: Use the protocol supported by the target service.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- service
Account StringKey File Secret Id - (Updatable) The OCID of the Secret where the content of the service account key file is stored, which contains the credentials required to use Google Cloud Storage. Note: When provided, 'serviceAccountKeyFile' field must not be provided.
- session
Mode String (Updatable) Specifies the session mode for the database connection. Use REDIRECT only for RAC databases with SCAN listeners that return IP addresses. For RAC databases with SCAN listeners that return FQDNs, and for all other Oracle database technologies, use DIRECT. In RAC deployments, SCAN listeners redirects a connection to a specific database node, identified by either IP address or FQDN. It is recommended to configure RAC with FQDN-based SCAN listeners.
The default is DIRECT, except when databaseId is provided and the discovered database relies on the SCAN listener. In this case, the default is REDIRECT.
Deprecated: Defaulting to the REDIRECT session mode will be removed after April 21, 2027.
- should
Use BooleanJndi - (Updatable) If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.
- should
Use BooleanResource Principal - (Updatable)
- KAFKA: Specifies that the user intends to authenticate to the instance using a resource principal. Applicable only for Oracle Cloud Infrastructure Streaming connections. Only available from 23.9.0.0.0 GoldenGate versions. Note: When specified, 'username'/'password'/'passwordSecretId' fields must not be provided. Default: false
- OCI_OBJECT_STORAGE, ORACLE_AI_DATA_PLATFORM, ORACLE_NOSQL: Specifies that the user intends to authenticate to the instance using a resource principal. Default: false
- 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)
- MICROSOFT_SQLSERVER: Database Certificate - The base64 encoded content of a .pem or .crt file containing the server public key (for 1-way SSL).
- MYSQL: Database Certificate - The base64 encoded content of a .pem or .crt file containing the server public key (for 1 and 2-way SSL). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - POSTGRESQL: The base64 encoded certificate of the trusted certificate authorities (Trusted CA) for PostgreSQL. The supported file formats are .pem and .crt. It is not included in GET responses if the
view=COMPACTquery parameter is specified.
- ssl
Cert String - (Updatable)
- MYSQL: Client Certificate - The base64 encoded content of a .pem or .crt file containing the client public key (for 2-way SSL). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - POSTGRESQL: The base64 encoded certificate of the PostgreSQL server. The supported file formats are .pem and .crt. It is not included in GET responses if the
view=COMPACTquery parameter is specified.
- MYSQL: Client Certificate - The base64 encoded content of a .pem or .crt file containing the client public key (for 2-way SSL). It is not included in GET responses if the
- ssl
Client StringKeystash (Updatable) The base64 encoded keystash file which contains the encrypted password to the key database file. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
Deprecated: This field is deprecated and replaced by "sslClientKeystashSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
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. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
Deprecated: This field is deprecated and replaced by "sslClientKeystoredbSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
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. It is not included in GET responses if the
view=COMPACTquery parameter is specified. - 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- ssl
Key StringPassword (Updatable) Password for the certificate private key inside the client key store.
- SPARK: Applicable when
securityProtocolis TLS and a client key store is provided. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY: Provide it when the private-key password differs from the key store password.
Deprecated: This field is deprecated and replaced by "sslKeyPasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- SPARK: Applicable when
- ssl
Key StringPassword Secret Id (Updatable) Secret OCID containing the certificate private-key password inside the client key store.
- SPARK: Applicable when
securityProtocolis TLS and a client key store is provided. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY: Provide it when the private-key password differs from the key store password.
When provided,
sslKeyPasswordmust not be provided.- SPARK: Applicable when
- 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. It is not included in GET responses if the
view=COMPACTquery parameter is specified. - storage
Connection
Storage - (Updatable) The information about a new storage of given type used in an Iceberg 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.
- submit
Mode String - (Updatable) Selects the submission channel. SUBMIT uses the Spark master RPC endpoint. REST uses the Spark standalone REST submission gateway.
- subnet
Id String - (Updatable) The OCID of the target subnet of the dedicated connection.
- subscription
Id String - The OCID of the subscription with which resource needs to be associated with.
- 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). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- tls
Certificate StringKey File Password - (Updatable) Client Certificate key file password. Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFilePasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- tls
Protocol String - (Updatable) TLS protocol negotiated by the Spark client. Applicable when securityProtocol is TLS. Defaults to TLS_V1_3 when not provided. Must be supported by the target cluster.
- trigger
Refresh Boolean - trust
Store String (Updatable) Base64-encoded trust store content.
- SPARK: Trust store used to validate the Spark server certificate when
securityProtocolis TLS. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY, REDIS: TrustStore file used by the target connection.
Deprecated: This field is deprecated and replaced by "trustStoreSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- SPARK: Trust store used to validate the Spark server certificate when
- trust
Store StringPassword (Updatable) Password for
trustStore. For SPARK, it is required when a trust store is supplied.Deprecated: This field is deprecated and replaced by "trustStorePasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- trust
Store StringPassword Secret Id - (Updatable) Secret OCID containing the trust store password. For SPARK, it is required when
trustStoreSecretIdis supplied. When provided,trustStorePasswordmust not be provided. - trust
Store StringSecret Id - (Updatable) Secret OCID containing the trust store content. For SPARK, it applies when
securityProtocolis TLS. When provided,trustStoremust not be provided. - trust
Store StringType - (Updatable) Trust store format used by the Spark client. Applicable when securityProtocol is TLS and a trust store is provided. Defaults to JKS when not provided. Provide this only when a trust store is provided.
- url String
- (Updatable) Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'
- user
Id String - (Updatable)
- OCI_OBJECT_STORAGE, ORACLE_AI_DATA_PLATFORM: The OCID of the Oracle Cloud Infrastructure user who accesses Object Storage. The user must have write access to the bucket. If omitted, the service defaults to the user calling the API.
- ORACLE_NOSQL: The OCID of the Oracle Cloud Infrastructure user who accesses the Oracle NoSQL database. The user must have write access to the table. If omitted, the service defaults to the user calling the API.
- 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) References the Oracle Cloud Infrastructure Vault that contains the customer-managed encryption key identified by
keyId.Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example,
passwordSecretId) instead of plain-text attributes encrypted withvaultIdandkeyId. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGateThis field is applicable only when
doesUseSecretIdsis set tofalse. IfvaultIdis provided,keyIdmust also be provided.- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- workspace
Url String (Updatable)
- DATABRICKS_ENGINE: Databricks workspace base URL for the REST API, for example
https://<workspace>.cloud.databricks.com/api/2.0/. - ORACLE_AI_DATA_PLATFORM_ENGINE: Oracle AI Data Platform workspace URL.
** 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
- DATABRICKS_ENGINE: Databricks workspace base URL for the REST API, for example
- 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 - Technology type selected for the connection.
- AI_MODEL: AI Model technology type.
- AI_PROVIDER: AI Provider technology type.
- DATABRICKS_ENGINE: Databricks Engine technology type.
- ICEBERG: Iceberg technology type. APACHE_ICEBERG supports all catalog types; AMAZON_S3_TABLES supports only REST catalog and S3 storage.
- KAFKA_SCHEMA_REGISTRY: Kafka Schema Registry technology type.
- ORACLE_AI_DATA_PLATFORM_ENGINE: Oracle AI Data Platform Engine technology type.
- SPARK: Spark technology type.
- access
Key stringId (Updatable)
- AMAZON_KINESIS: Access key ID used to access Amazon Kinesis.
- AMAZON_S3: Access key ID used to access the Amazon S3 bucket.
Note: Despite the "Id" suffix, this value is not an Oracle Cloud Infrastructure OCID.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- artifact
Location ConnectionArtifact Location - (Updatable) Location used to share engine application artifacts.
- DATABRICKS_ENGINE: Location used to share Databricks application artifacts.
- SPARK: Location used to share Spark application artifacts with a remote cluster.
- auth
Details ConnectionAuth Details - (Updatable) Authentication details for an AI Model or AI Provider connection.
- auth
Secret string (Updatable) The shared secret used for Spark authentication. Applicable when authenticationType is SHARED_SECRET.
Deprecated: This field is deprecated and replaced by "authSecretSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- auth
Secret stringSecret Id - (Updatable) The OCID of the Secret that stores the Spark authentication shared secret. Applicable when authenticationType is SHARED_SECRET. Note: When provided, 'authSecret' field must not be provided.
- auth
Token string - (Updatable) Personal access token used to connect to the Databricks Engine REST API. Only applicable for authenticationType == PERSONAL_ACCESS_TOKEN. Deprecated: This field is deprecated and replaced by "authTokenSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- auth
Token stringSecret Id - (Updatable) The OCID of the Secret where the personal access token is stored. Only applicable for authenticationType == PERSONAL_ACCESS_TOKEN. Note: When provided, 'authToken' field must not be provided.
- 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 mechanism; supported values depend on
connectionType.- DATABRICKS: Use PERSONAL_ACCESS_TOKEN or OAUTH_M2M.
- DATABRICKS_ENGINE: Use PERSONAL_ACCESS_TOKEN or OAUTH_M2M for the Databricks Engine REST API.
- JAVA_MESSAGE_SERVICE: Authentication type for Java Message Service. The default is NONE.
- SPARK: Use SHARED_SECRET only when the target cluster has
spark.authenticate=true. AES_RPC and SASL_ENCRYPTED require SHARED_SECRET. - AZURE_DATA_LAKE_STORAGE, ELASTICSEARCH, KAFKA_SCHEMA_REGISTRY, REDIS, SNOWFLAKE: Use the authentication type supported by the target service.
- string
- (Updatable) The endpoint used for authentication with Microsoft Entra ID (formerly Azure Active Directory). Default value: https://login.microsoftonline.com When connecting to a non-public Azure Cloud, the endpoint must be provided, eg:
- Azure China: https://login.chinacloudapi.cn/
- Azure US Government: https://login.microsoftonline.us/
- 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" - catalog
Connection
Catalog - (Updatable) The information about a new catalog of given type used in an Iceberg connection.
- client
Id string - (Updatable)
- AZURE_DATA_LAKE_STORAGE: Azure application client ID, required for AZURE_ACTIVE_DIRECTORY authentication.
- DATABRICKS, DATABRICKS_ENGINE: OAuth client ID, applicable to OAUTH_M2M authentication.
- MICROSOFT_FABRIC: Azure application client ID.
- client
Secret string - (Updatable) Plaintext client secret for the selected connection type. For DATABRICKS and DATABRICKS_ENGINE it applies to OAUTH_M2M authentication. Deprecated: use
clientSecretSecretId. - client
Secret stringSecret Id - (Updatable) Secret OCID containing the client secret. For DATABRICKS and DATABRICKS_ENGINE it applies to OAUTH_M2M authentication. When provided,
clientSecretmust not be provided. - cluster
Endpoint string - (Updatable) Spark master URL used for job submission. Required for both submitMode SUBMIT and REST. e.g.: 'spark://spark-master.example.com:7077' High availability can be configured with a comma-separated list, for example: 'spark://h1.example.com:7077,h2.example.com:7077'
- cluster
Id string - (Updatable) The OCID of the Kafka cluster being referenced from Oracle Cloud Infrastructure Streaming with Apache Kafka.
- cluster
Placement stringGroup Id - The OCID(https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cluster placement group for the resource. Only applicable for multicloud subscriptions. The cluster placement group id must be provided when a multicloud subscription id is provided. Otherwise the cluster placement group 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) JDBC connection string. e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'
- connection
Url string - (Updatable)
- AMAZON_REDSHIFT: JDBC connection URL. e.g.:
jdbc:redshift://aws-redshift-instance.aaaaaaaaaaaa.us-east-2.redshift.amazonaws.com:5439/mydb - DATABRICKS: JDBC 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 - JAVA_MESSAGE_SERVICE: Connection URL specifying the protocol, host, and port. e.g.:
mq://myjms.host.domain:7676 - ORACLE_AI_DATA_PLATFORM: Connection URL beginning with
jdbc:spark://. - SNOWFLAKE: JDBC connection URL. e.g.:
jdbc:snowflake://<account_name>.snowflakecomputing.com/?warehouse=<warehouse-name>&db=<db-name>
- AMAZON_REDSHIFT: JDBC connection URL. e.g.:
- 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). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - 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.
Deprecated: This field is deprecated. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example,
passwordSecretId) instead of plain-text attributes. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGateWhen set to
true, all sensitive information must be provided as Oracle Cloud Infrastructure Vault secrets using the corresponding*SecretIdattributes of the connection (for example,passwordSecretId). Plain-text sensitive attributes (for example,password) must not be used. This ensures that sensitive information remains stored and managed in the customer's Oracle Cloud Infrastructure Vault rather than by the GoldenGate service.When set to false, sensitive information must be provided in the corresponding plain-text attributes (for example,
password) rather than in secret OCID attributes. In this mode, the sensitive information is stored by the GoldenGate service. IfvaultIdandkeyIdare not specified, the GoldenGate service uses Oracle-managed encryption keys to encrypt the stored data.If
vaultIdandkeyIdare provided, the specified customer-managed key is used.- endpoint string
- (Updatable)
- AMAZON_KINESIS: The endpoint URL of the Amazon Kinesis service. e.g.: 'https://kinesis.us-east-1.amazonaws.com' If not provided, GoldenGate will default to 'https://kinesis..amazonaws.com'.
- AMAZON_S3: The Amazon Endpoint for S3. e.g.: 'https://my-bucket.s3.us-east-1.amazonaws.com' If not provided, GoldenGate will default to 'https://s3..amazonaws.com'.
- AZURE_DATA_LAKE_STORAGE: Azure Storage service endpoint. e.g: https://test.blob.core.windows.net
- GOOGLE_BIGQUERY: A legal URL to connect to BigQuery including scheme, server name and port, if not the default port. Default: https://bigquery.googleapis.com
- GOOGLE_CLOUD_STORAGE: A legal URL to connect to Google Cloud Storage including scheme, server name and port, if not the default port. Default: https://storage.googleapis.com
- MICROSOFT_FABRIC: 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) 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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) References the Oracle Cloud Infrastructure Vault key in the Oracle Cloud Infrastructure Vault identified by
vaultId.Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example,
passwordSecretId) instead of plain-text attributes encrypted withvaultIdandkeyId. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGateThe GoldenGate service uses this key to encrypt sensitive information (for example,
password) that is provided in plain-text connection attributes through the API. This field is applicable only whendoesUseSecretIdsis set tofalse. If bothvaultIdandkeyIdare provided, the GoldenGate service uses the specified customer-managed key to encrypt the sensitive data. If neithervaultIdnorkeyIdis provided, the GoldenGate service uses Oracle-managed encryption keys.- key
Store string (Updatable) Base64-encoded key store content.
- SPARK: Client key store used for mutual TLS when
securityProtocolis TLS. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY, REDIS: KeyStore file used by the target connection.
Deprecated: This field is deprecated and replaced by "keyStoreSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- SPARK: Client key store used for mutual TLS when
- key
Store stringPassword (Updatable) Password for
keyStore. For SPARK, it is required when a client key store is supplied.Deprecated: This field is deprecated and replaced by "keyStorePasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- key
Store stringPassword Secret Id - (Updatable) Secret OCID containing the key store password. For SPARK, it is required when
keyStoreSecretIdis supplied. When provided,keyStorePasswordmust not be provided. - key
Store stringSecret Id - (Updatable) Secret OCID containing the key store content. For SPARK, it applies when
securityProtocolis TLS. When provided,keyStoremust not be provided. - key
Store stringType - (Updatable) Client key store format used for mutual TLS. Applicable when securityProtocol is TLS and a client key store is provided. Defaults to JKS when not provided. Provide this only when a client key store is provided.
- locks
Connection
Lock[] - Locks associated with this resource.
- max
Input numberChars - (Updatable) Maximum number of input characters supported by this AI model connection.
- model
Key string - (Updatable) AI model identifier.
- 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 to Snowflake platform. Deprecated: This field is deprecated and replaced by "passwordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate Snowflake is phasing out password authentication for legacy service users. Oracle GoldenGate Snowflake connections will support only key-pair authentication. See the Snowflake documentation for details: https://docs.snowflake.com/en/user-guide/security-mfa-rollout
- 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
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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- provider
Id string - Optional identifier of the AI Provider Connection backing this AI Model Connection. When provided, it must reference an existing Active connection of type
AI_PROVIDER. WhenproviderIdis set,providerTypeandauthDetailsmust not be provided on the AI Model Connection, because provider metadata is resolved from the referenced AI Provider Connection. WhenproviderIdis not set, the AI Model Connection must provide inline provider metadata usingproviderTypeandauthDetails. - provider
Type string - AI Provider type used by the AI Model Connection.
- 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 AWS region where the bucket is created. If not provided, GoldenGate will default to 'us-west-2'. Note: this property will become mandatory after May 20, 2026.
- rest
Auth stringSecret Key (Updatable) The BASE64URL-encoded HMAC secret key used to sign REST submission requests when the Spark master's REST endpoint is protected by the JWS filter. Applicable only when submitMode is REST and the cluster enforces REST request signing. This setting is independent of authenticationType.
Deprecated: This field is deprecated and replaced by "restAuthSecretKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- rest
Auth stringSecret Key Secret Id - (Updatable) The OCID of the Secret that stores the REST submission signing key. Applicable only when submitMode is REST and the cluster enforces REST request signing. This setting is independent of authenticationType. Note: When provided, 'restAuthSecretKey' field must not be provided.
- rest
Endpoint string - (Updatable) Spark standalone REST submission base URL. e.g.: 'https://spark-master.example.com:6066' Applicable only and required when submitMode is REST.
- routing
Method string (Updatable) Controls the network traffic direction to the target: 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. SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
Deprecated: SHARED_SERVICE_ENDPOINT is deprecated. Use another supported routingMethod value, or update existing connections to use a supported routing method. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- rpc
Cipher string - (Updatable) Cipher transform used for Spark RPC encryption. Applicable when securityProtocol is AES_RPC. Defaults to AES_CTR_NOPADDING when not provided.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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
Attributes {[key: string]: string} - (Updatable) Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}} - security
Protocol string - (Updatable) Security protocol; supported values depend on
connectionType.- SPARK: PLAINTEXT, TLS, AES_RPC, or SASL_ENCRYPTED. AES_RPC and SASL_ENCRYPTED require SHARED_SECRET authentication.
- DB2, ELASTICSEARCH, JAVA_MESSAGE_SERVICE, KAFKA, MICROSOFT_SQLSERVER, MONGODB, MYSQL, POSTGRESQL, REDIS: Use the protocol supported by the target service.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- service
Account stringKey File Secret Id - (Updatable) The OCID of the Secret where the content of the service account key file is stored, which contains the credentials required to use Google Cloud Storage. Note: When provided, 'serviceAccountKeyFile' field must not be provided.
- session
Mode string (Updatable) Specifies the session mode for the database connection. Use REDIRECT only for RAC databases with SCAN listeners that return IP addresses. For RAC databases with SCAN listeners that return FQDNs, and for all other Oracle database technologies, use DIRECT. In RAC deployments, SCAN listeners redirects a connection to a specific database node, identified by either IP address or FQDN. It is recommended to configure RAC with FQDN-based SCAN listeners.
The default is DIRECT, except when databaseId is provided and the discovered database relies on the SCAN listener. In this case, the default is REDIRECT.
Deprecated: Defaulting to the REDIRECT session mode will be removed after April 21, 2027.
- should
Use booleanJndi - (Updatable) If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.
- should
Use booleanResource Principal - (Updatable)
- KAFKA: Specifies that the user intends to authenticate to the instance using a resource principal. Applicable only for Oracle Cloud Infrastructure Streaming connections. Only available from 23.9.0.0.0 GoldenGate versions. Note: When specified, 'username'/'password'/'passwordSecretId' fields must not be provided. Default: false
- OCI_OBJECT_STORAGE, ORACLE_AI_DATA_PLATFORM, ORACLE_NOSQL: Specifies that the user intends to authenticate to the instance using a resource principal. Default: false
- 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)
- MICROSOFT_SQLSERVER: Database Certificate - The base64 encoded content of a .pem or .crt file containing the server public key (for 1-way SSL).
- MYSQL: Database Certificate - The base64 encoded content of a .pem or .crt file containing the server public key (for 1 and 2-way SSL). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - POSTGRESQL: The base64 encoded certificate of the trusted certificate authorities (Trusted CA) for PostgreSQL. The supported file formats are .pem and .crt. It is not included in GET responses if the
view=COMPACTquery parameter is specified.
- ssl
Cert string - (Updatable)
- MYSQL: Client Certificate - The base64 encoded content of a .pem or .crt file containing the client public key (for 2-way SSL). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - POSTGRESQL: The base64 encoded certificate of the PostgreSQL server. The supported file formats are .pem and .crt. It is not included in GET responses if the
view=COMPACTquery parameter is specified.
- MYSQL: Client Certificate - The base64 encoded content of a .pem or .crt file containing the client public key (for 2-way SSL). It is not included in GET responses if the
- ssl
Client stringKeystash (Updatable) The base64 encoded keystash file which contains the encrypted password to the key database file. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
Deprecated: This field is deprecated and replaced by "sslClientKeystashSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
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. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
Deprecated: This field is deprecated and replaced by "sslClientKeystoredbSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
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. It is not included in GET responses if the
view=COMPACTquery parameter is specified. - 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- ssl
Key stringPassword (Updatable) Password for the certificate private key inside the client key store.
- SPARK: Applicable when
securityProtocolis TLS and a client key store is provided. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY: Provide it when the private-key password differs from the key store password.
Deprecated: This field is deprecated and replaced by "sslKeyPasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- SPARK: Applicable when
- ssl
Key stringPassword Secret Id (Updatable) Secret OCID containing the certificate private-key password inside the client key store.
- SPARK: Applicable when
securityProtocolis TLS and a client key store is provided. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY: Provide it when the private-key password differs from the key store password.
When provided,
sslKeyPasswordmust not be provided.- SPARK: Applicable when
- 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. It is not included in GET responses if the
view=COMPACTquery parameter is specified. - storage
Connection
Storage - (Updatable) The information about a new storage of given type used in an Iceberg 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.
- submit
Mode string - (Updatable) Selects the submission channel. SUBMIT uses the Spark master RPC endpoint. REST uses the Spark standalone REST submission gateway.
- subnet
Id string - (Updatable) The OCID of the target subnet of the dedicated connection.
- subscription
Id string - The OCID of the subscription with which resource needs to be associated with.
- 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). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- tls
Certificate stringKey File Password - (Updatable) Client Certificate key file password. Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFilePasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- tls
Protocol string - (Updatable) TLS protocol negotiated by the Spark client. Applicable when securityProtocol is TLS. Defaults to TLS_V1_3 when not provided. Must be supported by the target cluster.
- trigger
Refresh boolean - trust
Store string (Updatable) Base64-encoded trust store content.
- SPARK: Trust store used to validate the Spark server certificate when
securityProtocolis TLS. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY, REDIS: TrustStore file used by the target connection.
Deprecated: This field is deprecated and replaced by "trustStoreSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- SPARK: Trust store used to validate the Spark server certificate when
- trust
Store stringPassword (Updatable) Password for
trustStore. For SPARK, it is required when a trust store is supplied.Deprecated: This field is deprecated and replaced by "trustStorePasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- trust
Store stringPassword Secret Id - (Updatable) Secret OCID containing the trust store password. For SPARK, it is required when
trustStoreSecretIdis supplied. When provided,trustStorePasswordmust not be provided. - trust
Store stringSecret Id - (Updatable) Secret OCID containing the trust store content. For SPARK, it applies when
securityProtocolis TLS. When provided,trustStoremust not be provided. - trust
Store stringType - (Updatable) Trust store format used by the Spark client. Applicable when securityProtocol is TLS and a trust store is provided. Defaults to JKS when not provided. Provide this only when a trust store is provided.
- url string
- (Updatable) Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'
- user
Id string - (Updatable)
- OCI_OBJECT_STORAGE, ORACLE_AI_DATA_PLATFORM: The OCID of the Oracle Cloud Infrastructure user who accesses Object Storage. The user must have write access to the bucket. If omitted, the service defaults to the user calling the API.
- ORACLE_NOSQL: The OCID of the Oracle Cloud Infrastructure user who accesses the Oracle NoSQL database. The user must have write access to the table. If omitted, the service defaults to the user calling the API.
- 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) References the Oracle Cloud Infrastructure Vault that contains the customer-managed encryption key identified by
keyId.Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example,
passwordSecretId) instead of plain-text attributes encrypted withvaultIdandkeyId. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGateThis field is applicable only when
doesUseSecretIdsis set tofalse. IfvaultIdis provided,keyIdmust also be provided.- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- workspace
Url string (Updatable)
- DATABRICKS_ENGINE: Databricks workspace base URL for the REST API, for example
https://<workspace>.cloud.databricks.com/api/2.0/. - ORACLE_AI_DATA_PLATFORM_ENGINE: Oracle AI Data Platform workspace URL.
** 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
- DATABRICKS_ENGINE: Databricks workspace base URL for the REST API, for example
- 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 - Technology type selected for the connection.
- AI_MODEL: AI Model technology type.
- AI_PROVIDER: AI Provider technology type.
- DATABRICKS_ENGINE: Databricks Engine technology type.
- ICEBERG: Iceberg technology type. APACHE_ICEBERG supports all catalog types; AMAZON_S3_TABLES supports only REST catalog and S3 storage.
- KAFKA_SCHEMA_REGISTRY: Kafka Schema Registry technology type.
- ORACLE_AI_DATA_PLATFORM_ENGINE: Oracle AI Data Platform Engine technology type.
- SPARK: Spark technology type.
- access_
key_ strid (Updatable)
- AMAZON_KINESIS: Access key ID used to access Amazon Kinesis.
- AMAZON_S3: Access key ID used to access the Amazon S3 bucket.
Note: Despite the "Id" suffix, this value is not an Oracle Cloud Infrastructure OCID.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- artifact_
location ConnectionArtifact Location Args - (Updatable) Location used to share engine application artifacts.
- DATABRICKS_ENGINE: Location used to share Databricks application artifacts.
- SPARK: Location used to share Spark application artifacts with a remote cluster.
- auth_
details ConnectionAuth Details Args - (Updatable) Authentication details for an AI Model or AI Provider connection.
- auth_
secret str (Updatable) The shared secret used for Spark authentication. Applicable when authenticationType is SHARED_SECRET.
Deprecated: This field is deprecated and replaced by "authSecretSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- auth_
secret_ strsecret_ id - (Updatable) The OCID of the Secret that stores the Spark authentication shared secret. Applicable when authenticationType is SHARED_SECRET. Note: When provided, 'authSecret' field must not be provided.
- auth_
token str - (Updatable) Personal access token used to connect to the Databricks Engine REST API. Only applicable for authenticationType == PERSONAL_ACCESS_TOKEN. Deprecated: This field is deprecated and replaced by "authTokenSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- auth_
token_ strsecret_ id - (Updatable) The OCID of the Secret where the personal access token is stored. Only applicable for authenticationType == PERSONAL_ACCESS_TOKEN. Note: When provided, 'authToken' field must not be provided.
- 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 mechanism; supported values depend on
connectionType.- DATABRICKS: Use PERSONAL_ACCESS_TOKEN or OAUTH_M2M.
- DATABRICKS_ENGINE: Use PERSONAL_ACCESS_TOKEN or OAUTH_M2M for the Databricks Engine REST API.
- JAVA_MESSAGE_SERVICE: Authentication type for Java Message Service. The default is NONE.
- SPARK: Use SHARED_SECRET only when the target cluster has
spark.authenticate=true. AES_RPC and SASL_ENCRYPTED require SHARED_SECRET. - AZURE_DATA_LAKE_STORAGE, ELASTICSEARCH, KAFKA_SCHEMA_REGISTRY, REDIS, SNOWFLAKE: Use the authentication type supported by the target service.
- str
- (Updatable) The endpoint used for authentication with Microsoft Entra ID (formerly Azure Active Directory). Default value: https://login.microsoftonline.com When connecting to a non-public Azure Cloud, the endpoint must be provided, eg:
- Azure China: https://login.chinacloudapi.cn/
- Azure US Government: https://login.microsoftonline.us/
- 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" - catalog
Connection
Catalog Args - (Updatable) The information about a new catalog of given type used in an Iceberg connection.
- client_
id str - (Updatable)
- AZURE_DATA_LAKE_STORAGE: Azure application client ID, required for AZURE_ACTIVE_DIRECTORY authentication.
- DATABRICKS, DATABRICKS_ENGINE: OAuth client ID, applicable to OAUTH_M2M authentication.
- MICROSOFT_FABRIC: Azure application client ID.
- client_
secret str - (Updatable) Plaintext client secret for the selected connection type. For DATABRICKS and DATABRICKS_ENGINE it applies to OAUTH_M2M authentication. Deprecated: use
clientSecretSecretId. - client_
secret_ strsecret_ id - (Updatable) Secret OCID containing the client secret. For DATABRICKS and DATABRICKS_ENGINE it applies to OAUTH_M2M authentication. When provided,
clientSecretmust not be provided. - cluster_
endpoint str - (Updatable) Spark master URL used for job submission. Required for both submitMode SUBMIT and REST. e.g.: 'spark://spark-master.example.com:7077' High availability can be configured with a comma-separated list, for example: 'spark://h1.example.com:7077,h2.example.com:7077'
- cluster_
id str - (Updatable) The OCID of the Kafka cluster being referenced from Oracle Cloud Infrastructure Streaming with Apache Kafka.
- cluster_
placement_ strgroup_ id - The OCID(https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cluster placement group for the resource. Only applicable for multicloud subscriptions. The cluster placement group id must be provided when a multicloud subscription id is provided. Otherwise the cluster placement group 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) JDBC connection string. e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'
- connection_
url str - (Updatable)
- AMAZON_REDSHIFT: JDBC connection URL. e.g.:
jdbc:redshift://aws-redshift-instance.aaaaaaaaaaaa.us-east-2.redshift.amazonaws.com:5439/mydb - DATABRICKS: JDBC 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 - JAVA_MESSAGE_SERVICE: Connection URL specifying the protocol, host, and port. e.g.:
mq://myjms.host.domain:7676 - ORACLE_AI_DATA_PLATFORM: Connection URL beginning with
jdbc:spark://. - SNOWFLAKE: JDBC connection URL. e.g.:
jdbc:snowflake://<account_name>.snowflakecomputing.com/?warehouse=<warehouse-name>&db=<db-name>
- AMAZON_REDSHIFT: JDBC connection URL. e.g.:
- 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). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - 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.
Deprecated: This field is deprecated. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example,
passwordSecretId) instead of plain-text attributes. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGateWhen set to
true, all sensitive information must be provided as Oracle Cloud Infrastructure Vault secrets using the corresponding*SecretIdattributes of the connection (for example,passwordSecretId). Plain-text sensitive attributes (for example,password) must not be used. This ensures that sensitive information remains stored and managed in the customer's Oracle Cloud Infrastructure Vault rather than by the GoldenGate service.When set to false, sensitive information must be provided in the corresponding plain-text attributes (for example,
password) rather than in secret OCID attributes. In this mode, the sensitive information is stored by the GoldenGate service. IfvaultIdandkeyIdare not specified, the GoldenGate service uses Oracle-managed encryption keys to encrypt the stored data.If
vaultIdandkeyIdare provided, the specified customer-managed key is used.- endpoint str
- (Updatable)
- AMAZON_KINESIS: The endpoint URL of the Amazon Kinesis service. e.g.: 'https://kinesis.us-east-1.amazonaws.com' If not provided, GoldenGate will default to 'https://kinesis..amazonaws.com'.
- AMAZON_S3: The Amazon Endpoint for S3. e.g.: 'https://my-bucket.s3.us-east-1.amazonaws.com' If not provided, GoldenGate will default to 'https://s3..amazonaws.com'.
- AZURE_DATA_LAKE_STORAGE: Azure Storage service endpoint. e.g: https://test.blob.core.windows.net
- GOOGLE_BIGQUERY: A legal URL to connect to BigQuery including scheme, server name and port, if not the default port. Default: https://bigquery.googleapis.com
- GOOGLE_CLOUD_STORAGE: A legal URL to connect to Google Cloud Storage including scheme, server name and port, if not the default port. Default: https://storage.googleapis.com
- MICROSOFT_FABRIC: 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) 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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) References the Oracle Cloud Infrastructure Vault key in the Oracle Cloud Infrastructure Vault identified by
vaultId.Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example,
passwordSecretId) instead of plain-text attributes encrypted withvaultIdandkeyId. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGateThe GoldenGate service uses this key to encrypt sensitive information (for example,
password) that is provided in plain-text connection attributes through the API. This field is applicable only whendoesUseSecretIdsis set tofalse. If bothvaultIdandkeyIdare provided, the GoldenGate service uses the specified customer-managed key to encrypt the sensitive data. If neithervaultIdnorkeyIdis provided, the GoldenGate service uses Oracle-managed encryption keys.- key_
store str (Updatable) Base64-encoded key store content.
- SPARK: Client key store used for mutual TLS when
securityProtocolis TLS. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY, REDIS: KeyStore file used by the target connection.
Deprecated: This field is deprecated and replaced by "keyStoreSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- SPARK: Client key store used for mutual TLS when
- key_
store_ strpassword (Updatable) Password for
keyStore. For SPARK, it is required when a client key store is supplied.Deprecated: This field is deprecated and replaced by "keyStorePasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- key_
store_ strpassword_ secret_ id - (Updatable) Secret OCID containing the key store password. For SPARK, it is required when
keyStoreSecretIdis supplied. When provided,keyStorePasswordmust not be provided. - key_
store_ strsecret_ id - (Updatable) Secret OCID containing the key store content. For SPARK, it applies when
securityProtocolis TLS. When provided,keyStoremust not be provided. - key_
store_ strtype - (Updatable) Client key store format used for mutual TLS. Applicable when securityProtocol is TLS and a client key store is provided. Defaults to JKS when not provided. Provide this only when a client key store is provided.
- locks
Sequence[Connection
Lock Args] - Locks associated with this resource.
- max_
input_ intchars - (Updatable) Maximum number of input characters supported by this AI model connection.
- model_
key str - (Updatable) AI model identifier.
- 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 to Snowflake platform. Deprecated: This field is deprecated and replaced by "passwordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate Snowflake is phasing out password authentication for legacy service users. Oracle GoldenGate Snowflake connections will support only key-pair authentication. See the Snowflake documentation for details: https://docs.snowflake.com/en/user-guide/security-mfa-rollout
- 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_
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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- provider_
id str - Optional identifier of the AI Provider Connection backing this AI Model Connection. When provided, it must reference an existing Active connection of type
AI_PROVIDER. WhenproviderIdis set,providerTypeandauthDetailsmust not be provided on the AI Model Connection, because provider metadata is resolved from the referenced AI Provider Connection. WhenproviderIdis not set, the AI Model Connection must provide inline provider metadata usingproviderTypeandauthDetails. - provider_
type str - AI Provider type used by the AI Model Connection.
- 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 AWS region where the bucket is created. If not provided, GoldenGate will default to 'us-west-2'. Note: this property will become mandatory after May 20, 2026.
- rest_
auth_ strsecret_ key (Updatable) The BASE64URL-encoded HMAC secret key used to sign REST submission requests when the Spark master's REST endpoint is protected by the JWS filter. Applicable only when submitMode is REST and the cluster enforces REST request signing. This setting is independent of authenticationType.
Deprecated: This field is deprecated and replaced by "restAuthSecretKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- rest_
auth_ strsecret_ key_ secret_ id - (Updatable) The OCID of the Secret that stores the REST submission signing key. Applicable only when submitMode is REST and the cluster enforces REST request signing. This setting is independent of authenticationType. Note: When provided, 'restAuthSecretKey' field must not be provided.
- rest_
endpoint str - (Updatable) Spark standalone REST submission base URL. e.g.: 'https://spark-master.example.com:6066' Applicable only and required when submitMode is REST.
- routing_
method str (Updatable) Controls the network traffic direction to the target: 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. SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
Deprecated: SHARED_SERVICE_ENDPOINT is deprecated. Use another supported routingMethod value, or update existing connections to use a supported routing method. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- rpc_
cipher str - (Updatable) Cipher transform used for Spark RPC encryption. Applicable when securityProtocol is AES_RPC. Defaults to AES_CTR_NOPADDING when not provided.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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_
attributes Mapping[str, str] - (Updatable) Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}} - security_
protocol str - (Updatable) Security protocol; supported values depend on
connectionType.- SPARK: PLAINTEXT, TLS, AES_RPC, or SASL_ENCRYPTED. AES_RPC and SASL_ENCRYPTED require SHARED_SECRET authentication.
- DB2, ELASTICSEARCH, JAVA_MESSAGE_SERVICE, KAFKA, MICROSOFT_SQLSERVER, MONGODB, MYSQL, POSTGRESQL, REDIS: Use the protocol supported by the target service.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- service_
account_ strkey_ file_ secret_ id - (Updatable) The OCID of the Secret where the content of the service account key file is stored, which contains the credentials required to use Google Cloud Storage. Note: When provided, 'serviceAccountKeyFile' field must not be provided.
- session_
mode str (Updatable) Specifies the session mode for the database connection. Use REDIRECT only for RAC databases with SCAN listeners that return IP addresses. For RAC databases with SCAN listeners that return FQDNs, and for all other Oracle database technologies, use DIRECT. In RAC deployments, SCAN listeners redirects a connection to a specific database node, identified by either IP address or FQDN. It is recommended to configure RAC with FQDN-based SCAN listeners.
The default is DIRECT, except when databaseId is provided and the discovered database relies on the SCAN listener. In this case, the default is REDIRECT.
Deprecated: Defaulting to the REDIRECT session mode will be removed after April 21, 2027.
- should_
use_ booljndi - (Updatable) If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.
- should_
use_ boolresource_ principal - (Updatable)
- KAFKA: Specifies that the user intends to authenticate to the instance using a resource principal. Applicable only for Oracle Cloud Infrastructure Streaming connections. Only available from 23.9.0.0.0 GoldenGate versions. Note: When specified, 'username'/'password'/'passwordSecretId' fields must not be provided. Default: false
- OCI_OBJECT_STORAGE, ORACLE_AI_DATA_PLATFORM, ORACLE_NOSQL: Specifies that the user intends to authenticate to the instance using a resource principal. Default: false
- 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)
- MICROSOFT_SQLSERVER: Database Certificate - The base64 encoded content of a .pem or .crt file containing the server public key (for 1-way SSL).
- MYSQL: Database Certificate - The base64 encoded content of a .pem or .crt file containing the server public key (for 1 and 2-way SSL). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - POSTGRESQL: The base64 encoded certificate of the trusted certificate authorities (Trusted CA) for PostgreSQL. The supported file formats are .pem and .crt. It is not included in GET responses if the
view=COMPACTquery parameter is specified.
- ssl_
cert str - (Updatable)
- MYSQL: Client Certificate - The base64 encoded content of a .pem or .crt file containing the client public key (for 2-way SSL). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - POSTGRESQL: The base64 encoded certificate of the PostgreSQL server. The supported file formats are .pem and .crt. It is not included in GET responses if the
view=COMPACTquery parameter is specified.
- MYSQL: Client Certificate - The base64 encoded content of a .pem or .crt file containing the client public key (for 2-way SSL). It is not included in GET responses if the
- ssl_
client_ strkeystash (Updatable) The base64 encoded keystash file which contains the encrypted password to the key database file. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
Deprecated: This field is deprecated and replaced by "sslClientKeystashSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
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. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
Deprecated: This field is deprecated and replaced by "sslClientKeystoredbSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
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. It is not included in GET responses if the
view=COMPACTquery parameter is specified. - 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- ssl_
key_ strpassword (Updatable) Password for the certificate private key inside the client key store.
- SPARK: Applicable when
securityProtocolis TLS and a client key store is provided. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY: Provide it when the private-key password differs from the key store password.
Deprecated: This field is deprecated and replaced by "sslKeyPasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- SPARK: Applicable when
- ssl_
key_ strpassword_ secret_ id (Updatable) Secret OCID containing the certificate private-key password inside the client key store.
- SPARK: Applicable when
securityProtocolis TLS and a client key store is provided. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY: Provide it when the private-key password differs from the key store password.
When provided,
sslKeyPasswordmust not be provided.- SPARK: Applicable when
- 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. It is not included in GET responses if the
view=COMPACTquery parameter is specified. - storage
Connection
Storage Args - (Updatable) The information about a new storage of given type used in an Iceberg 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.
- submit_
mode str - (Updatable) Selects the submission channel. SUBMIT uses the Spark master RPC endpoint. REST uses the Spark standalone REST submission gateway.
- subnet_
id str - (Updatable) The OCID of the target subnet of the dedicated connection.
- subscription_
id str - The OCID of the subscription with which resource needs to be associated with.
- 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). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- tls_
certificate_ strkey_ file_ password - (Updatable) Client Certificate key file password. Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFilePasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- tls_
protocol str - (Updatable) TLS protocol negotiated by the Spark client. Applicable when securityProtocol is TLS. Defaults to TLS_V1_3 when not provided. Must be supported by the target cluster.
- trigger_
refresh bool - trust_
store str (Updatable) Base64-encoded trust store content.
- SPARK: Trust store used to validate the Spark server certificate when
securityProtocolis TLS. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY, REDIS: TrustStore file used by the target connection.
Deprecated: This field is deprecated and replaced by "trustStoreSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- SPARK: Trust store used to validate the Spark server certificate when
- trust_
store_ strpassword (Updatable) Password for
trustStore. For SPARK, it is required when a trust store is supplied.Deprecated: This field is deprecated and replaced by "trustStorePasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- trust_
store_ strpassword_ secret_ id - (Updatable) Secret OCID containing the trust store password. For SPARK, it is required when
trustStoreSecretIdis supplied. When provided,trustStorePasswordmust not be provided. - trust_
store_ strsecret_ id - (Updatable) Secret OCID containing the trust store content. For SPARK, it applies when
securityProtocolis TLS. When provided,trustStoremust not be provided. - trust_
store_ strtype - (Updatable) Trust store format used by the Spark client. Applicable when securityProtocol is TLS and a trust store is provided. Defaults to JKS when not provided. Provide this only when a trust store is provided.
- url str
- (Updatable) Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'
- user_
id str - (Updatable)
- OCI_OBJECT_STORAGE, ORACLE_AI_DATA_PLATFORM: The OCID of the Oracle Cloud Infrastructure user who accesses Object Storage. The user must have write access to the bucket. If omitted, the service defaults to the user calling the API.
- ORACLE_NOSQL: The OCID of the Oracle Cloud Infrastructure user who accesses the Oracle NoSQL database. The user must have write access to the table. If omitted, the service defaults to the user calling the API.
- 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) References the Oracle Cloud Infrastructure Vault that contains the customer-managed encryption key identified by
keyId.Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example,
passwordSecretId) instead of plain-text attributes encrypted withvaultIdandkeyId. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGateThis field is applicable only when
doesUseSecretIdsis set tofalse. IfvaultIdis provided,keyIdmust also be provided.- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- workspace_
url str (Updatable)
- DATABRICKS_ENGINE: Databricks workspace base URL for the REST API, for example
https://<workspace>.cloud.databricks.com/api/2.0/. - ORACLE_AI_DATA_PLATFORM_ENGINE: Oracle AI Data Platform workspace URL.
** 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
- DATABRICKS_ENGINE: Databricks workspace base URL for the REST API, for example
- 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 - Technology type selected for the connection.
- AI_MODEL: AI Model technology type.
- AI_PROVIDER: AI Provider technology type.
- DATABRICKS_ENGINE: Databricks Engine technology type.
- ICEBERG: Iceberg technology type. APACHE_ICEBERG supports all catalog types; AMAZON_S3_TABLES supports only REST catalog and S3 storage.
- KAFKA_SCHEMA_REGISTRY: Kafka Schema Registry technology type.
- ORACLE_AI_DATA_PLATFORM_ENGINE: Oracle AI Data Platform Engine technology type.
- SPARK: Spark technology type.
- access
Key StringId (Updatable)
- AMAZON_KINESIS: Access key ID used to access Amazon Kinesis.
- AMAZON_S3: Access key ID used to access the Amazon S3 bucket.
Note: Despite the "Id" suffix, this value is not an Oracle Cloud Infrastructure OCID.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- artifact
Location Property Map - (Updatable) Location used to share engine application artifacts.
- DATABRICKS_ENGINE: Location used to share Databricks application artifacts.
- SPARK: Location used to share Spark application artifacts with a remote cluster.
- auth
Details Property Map - (Updatable) Authentication details for an AI Model or AI Provider connection.
- auth
Secret String (Updatable) The shared secret used for Spark authentication. Applicable when authenticationType is SHARED_SECRET.
Deprecated: This field is deprecated and replaced by "authSecretSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- auth
Secret StringSecret Id - (Updatable) The OCID of the Secret that stores the Spark authentication shared secret. Applicable when authenticationType is SHARED_SECRET. Note: When provided, 'authSecret' field must not be provided.
- auth
Token String - (Updatable) Personal access token used to connect to the Databricks Engine REST API. Only applicable for authenticationType == PERSONAL_ACCESS_TOKEN. Deprecated: This field is deprecated and replaced by "authTokenSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- auth
Token StringSecret Id - (Updatable) The OCID of the Secret where the personal access token is stored. Only applicable for authenticationType == PERSONAL_ACCESS_TOKEN. Note: When provided, 'authToken' field must not be provided.
- 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 mechanism; supported values depend on
connectionType.- DATABRICKS: Use PERSONAL_ACCESS_TOKEN or OAUTH_M2M.
- DATABRICKS_ENGINE: Use PERSONAL_ACCESS_TOKEN or OAUTH_M2M for the Databricks Engine REST API.
- JAVA_MESSAGE_SERVICE: Authentication type for Java Message Service. The default is NONE.
- SPARK: Use SHARED_SECRET only when the target cluster has
spark.authenticate=true. AES_RPC and SASL_ENCRYPTED require SHARED_SECRET. - AZURE_DATA_LAKE_STORAGE, ELASTICSEARCH, KAFKA_SCHEMA_REGISTRY, REDIS, SNOWFLAKE: Use the authentication type supported by the target service.
- String
- (Updatable) The endpoint used for authentication with Microsoft Entra ID (formerly Azure Active Directory). Default value: https://login.microsoftonline.com When connecting to a non-public Azure Cloud, the endpoint must be provided, eg:
- Azure China: https://login.chinacloudapi.cn/
- Azure US Government: https://login.microsoftonline.us/
- 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" - catalog Property Map
- (Updatable) The information about a new catalog of given type used in an Iceberg connection.
- client
Id String - (Updatable)
- AZURE_DATA_LAKE_STORAGE: Azure application client ID, required for AZURE_ACTIVE_DIRECTORY authentication.
- DATABRICKS, DATABRICKS_ENGINE: OAuth client ID, applicable to OAUTH_M2M authentication.
- MICROSOFT_FABRIC: Azure application client ID.
- client
Secret String - (Updatable) Plaintext client secret for the selected connection type. For DATABRICKS and DATABRICKS_ENGINE it applies to OAUTH_M2M authentication. Deprecated: use
clientSecretSecretId. - client
Secret StringSecret Id - (Updatable) Secret OCID containing the client secret. For DATABRICKS and DATABRICKS_ENGINE it applies to OAUTH_M2M authentication. When provided,
clientSecretmust not be provided. - cluster
Endpoint String - (Updatable) Spark master URL used for job submission. Required for both submitMode SUBMIT and REST. e.g.: 'spark://spark-master.example.com:7077' High availability can be configured with a comma-separated list, for example: 'spark://h1.example.com:7077,h2.example.com:7077'
- cluster
Id String - (Updatable) The OCID of the Kafka cluster being referenced from Oracle Cloud Infrastructure Streaming with Apache Kafka.
- cluster
Placement StringGroup Id - The OCID(https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cluster placement group for the resource. Only applicable for multicloud subscriptions. The cluster placement group id must be provided when a multicloud subscription id is provided. Otherwise the cluster placement group 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) JDBC connection string. e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'
- connection
Url String - (Updatable)
- AMAZON_REDSHIFT: JDBC connection URL. e.g.:
jdbc:redshift://aws-redshift-instance.aaaaaaaaaaaa.us-east-2.redshift.amazonaws.com:5439/mydb - DATABRICKS: JDBC 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 - JAVA_MESSAGE_SERVICE: Connection URL specifying the protocol, host, and port. e.g.:
mq://myjms.host.domain:7676 - ORACLE_AI_DATA_PLATFORM: Connection URL beginning with
jdbc:spark://. - SNOWFLAKE: JDBC connection URL. e.g.:
jdbc:snowflake://<account_name>.snowflakecomputing.com/?warehouse=<warehouse-name>&db=<db-name>
- AMAZON_REDSHIFT: JDBC connection URL. e.g.:
- 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). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - 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.
Deprecated: This field is deprecated. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example,
passwordSecretId) instead of plain-text attributes. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGateWhen set to
true, all sensitive information must be provided as Oracle Cloud Infrastructure Vault secrets using the corresponding*SecretIdattributes of the connection (for example,passwordSecretId). Plain-text sensitive attributes (for example,password) must not be used. This ensures that sensitive information remains stored and managed in the customer's Oracle Cloud Infrastructure Vault rather than by the GoldenGate service.When set to false, sensitive information must be provided in the corresponding plain-text attributes (for example,
password) rather than in secret OCID attributes. In this mode, the sensitive information is stored by the GoldenGate service. IfvaultIdandkeyIdare not specified, the GoldenGate service uses Oracle-managed encryption keys to encrypt the stored data.If
vaultIdandkeyIdare provided, the specified customer-managed key is used.- endpoint String
- (Updatable)
- AMAZON_KINESIS: The endpoint URL of the Amazon Kinesis service. e.g.: 'https://kinesis.us-east-1.amazonaws.com' If not provided, GoldenGate will default to 'https://kinesis..amazonaws.com'.
- AMAZON_S3: The Amazon Endpoint for S3. e.g.: 'https://my-bucket.s3.us-east-1.amazonaws.com' If not provided, GoldenGate will default to 'https://s3..amazonaws.com'.
- AZURE_DATA_LAKE_STORAGE: Azure Storage service endpoint. e.g: https://test.blob.core.windows.net
- GOOGLE_BIGQUERY: A legal URL to connect to BigQuery including scheme, server name and port, if not the default port. Default: https://bigquery.googleapis.com
- GOOGLE_CLOUD_STORAGE: A legal URL to connect to Google Cloud Storage including scheme, server name and port, if not the default port. Default: https://storage.googleapis.com
- MICROSOFT_FABRIC: 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) 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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) References the Oracle Cloud Infrastructure Vault key in the Oracle Cloud Infrastructure Vault identified by
vaultId.Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example,
passwordSecretId) instead of plain-text attributes encrypted withvaultIdandkeyId. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGateThe GoldenGate service uses this key to encrypt sensitive information (for example,
password) that is provided in plain-text connection attributes through the API. This field is applicable only whendoesUseSecretIdsis set tofalse. If bothvaultIdandkeyIdare provided, the GoldenGate service uses the specified customer-managed key to encrypt the sensitive data. If neithervaultIdnorkeyIdis provided, the GoldenGate service uses Oracle-managed encryption keys.- key
Store String (Updatable) Base64-encoded key store content.
- SPARK: Client key store used for mutual TLS when
securityProtocolis TLS. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY, REDIS: KeyStore file used by the target connection.
Deprecated: This field is deprecated and replaced by "keyStoreSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- SPARK: Client key store used for mutual TLS when
- key
Store StringPassword (Updatable) Password for
keyStore. For SPARK, it is required when a client key store is supplied.Deprecated: This field is deprecated and replaced by "keyStorePasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- key
Store StringPassword Secret Id - (Updatable) Secret OCID containing the key store password. For SPARK, it is required when
keyStoreSecretIdis supplied. When provided,keyStorePasswordmust not be provided. - key
Store StringSecret Id - (Updatable) Secret OCID containing the key store content. For SPARK, it applies when
securityProtocolis TLS. When provided,keyStoremust not be provided. - key
Store StringType - (Updatable) Client key store format used for mutual TLS. Applicable when securityProtocol is TLS and a client key store is provided. Defaults to JKS when not provided. Provide this only when a client key store is provided.
- locks List<Property Map>
- Locks associated with this resource.
- max
Input NumberChars - (Updatable) Maximum number of input characters supported by this AI model connection.
- model
Key String - (Updatable) AI model identifier.
- 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 to Snowflake platform. Deprecated: This field is deprecated and replaced by "passwordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate Snowflake is phasing out password authentication for legacy service users. Oracle GoldenGate Snowflake connections will support only key-pair authentication. See the Snowflake documentation for details: https://docs.snowflake.com/en/user-guide/security-mfa-rollout
- 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
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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- provider
Id String - Optional identifier of the AI Provider Connection backing this AI Model Connection. When provided, it must reference an existing Active connection of type
AI_PROVIDER. WhenproviderIdis set,providerTypeandauthDetailsmust not be provided on the AI Model Connection, because provider metadata is resolved from the referenced AI Provider Connection. WhenproviderIdis not set, the AI Model Connection must provide inline provider metadata usingproviderTypeandauthDetails. - provider
Type String - AI Provider type used by the AI Model Connection.
- 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 AWS region where the bucket is created. If not provided, GoldenGate will default to 'us-west-2'. Note: this property will become mandatory after May 20, 2026.
- rest
Auth StringSecret Key (Updatable) The BASE64URL-encoded HMAC secret key used to sign REST submission requests when the Spark master's REST endpoint is protected by the JWS filter. Applicable only when submitMode is REST and the cluster enforces REST request signing. This setting is independent of authenticationType.
Deprecated: This field is deprecated and replaced by "restAuthSecretKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- rest
Auth StringSecret Key Secret Id - (Updatable) The OCID of the Secret that stores the REST submission signing key. Applicable only when submitMode is REST and the cluster enforces REST request signing. This setting is independent of authenticationType. Note: When provided, 'restAuthSecretKey' field must not be provided.
- rest
Endpoint String - (Updatable) Spark standalone REST submission base URL. e.g.: 'https://spark-master.example.com:6066' Applicable only and required when submitMode is REST.
- routing
Method String (Updatable) Controls the network traffic direction to the target: 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. SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
Deprecated: SHARED_SERVICE_ENDPOINT is deprecated. Use another supported routingMethod value, or update existing connections to use a supported routing method. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- rpc
Cipher String - (Updatable) Cipher transform used for Spark RPC encryption. Applicable when securityProtocol is AES_RPC. Defaults to AES_CTR_NOPADDING when not provided.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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
Attributes Map<String> - (Updatable) Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}} - security
Protocol String - (Updatable) Security protocol; supported values depend on
connectionType.- SPARK: PLAINTEXT, TLS, AES_RPC, or SASL_ENCRYPTED. AES_RPC and SASL_ENCRYPTED require SHARED_SECRET authentication.
- DB2, ELASTICSEARCH, JAVA_MESSAGE_SERVICE, KAFKA, MICROSOFT_SQLSERVER, MONGODB, MYSQL, POSTGRESQL, REDIS: Use the protocol supported by the target service.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- service
Account StringKey File Secret Id - (Updatable) The OCID of the Secret where the content of the service account key file is stored, which contains the credentials required to use Google Cloud Storage. Note: When provided, 'serviceAccountKeyFile' field must not be provided.
- session
Mode String (Updatable) Specifies the session mode for the database connection. Use REDIRECT only for RAC databases with SCAN listeners that return IP addresses. For RAC databases with SCAN listeners that return FQDNs, and for all other Oracle database technologies, use DIRECT. In RAC deployments, SCAN listeners redirects a connection to a specific database node, identified by either IP address or FQDN. It is recommended to configure RAC with FQDN-based SCAN listeners.
The default is DIRECT, except when databaseId is provided and the discovered database relies on the SCAN listener. In this case, the default is REDIRECT.
Deprecated: Defaulting to the REDIRECT session mode will be removed after April 21, 2027.
- should
Use BooleanJndi - (Updatable) If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.
- should
Use BooleanResource Principal - (Updatable)
- KAFKA: Specifies that the user intends to authenticate to the instance using a resource principal. Applicable only for Oracle Cloud Infrastructure Streaming connections. Only available from 23.9.0.0.0 GoldenGate versions. Note: When specified, 'username'/'password'/'passwordSecretId' fields must not be provided. Default: false
- OCI_OBJECT_STORAGE, ORACLE_AI_DATA_PLATFORM, ORACLE_NOSQL: Specifies that the user intends to authenticate to the instance using a resource principal. Default: false
- 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)
- MICROSOFT_SQLSERVER: Database Certificate - The base64 encoded content of a .pem or .crt file containing the server public key (for 1-way SSL).
- MYSQL: Database Certificate - The base64 encoded content of a .pem or .crt file containing the server public key (for 1 and 2-way SSL). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - POSTGRESQL: The base64 encoded certificate of the trusted certificate authorities (Trusted CA) for PostgreSQL. The supported file formats are .pem and .crt. It is not included in GET responses if the
view=COMPACTquery parameter is specified.
- ssl
Cert String - (Updatable)
- MYSQL: Client Certificate - The base64 encoded content of a .pem or .crt file containing the client public key (for 2-way SSL). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - POSTGRESQL: The base64 encoded certificate of the PostgreSQL server. The supported file formats are .pem and .crt. It is not included in GET responses if the
view=COMPACTquery parameter is specified.
- MYSQL: Client Certificate - The base64 encoded content of a .pem or .crt file containing the client public key (for 2-way SSL). It is not included in GET responses if the
- ssl
Client StringKeystash (Updatable) The base64 encoded keystash file which contains the encrypted password to the key database file. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
Deprecated: This field is deprecated and replaced by "sslClientKeystashSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
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. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
Deprecated: This field is deprecated and replaced by "sslClientKeystoredbSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
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. It is not included in GET responses if the
view=COMPACTquery parameter is specified. - 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- ssl
Key StringPassword (Updatable) Password for the certificate private key inside the client key store.
- SPARK: Applicable when
securityProtocolis TLS and a client key store is provided. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY: Provide it when the private-key password differs from the key store password.
Deprecated: This field is deprecated and replaced by "sslKeyPasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- SPARK: Applicable when
- ssl
Key StringPassword Secret Id (Updatable) Secret OCID containing the certificate private-key password inside the client key store.
- SPARK: Applicable when
securityProtocolis TLS and a client key store is provided. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY: Provide it when the private-key password differs from the key store password.
When provided,
sslKeyPasswordmust not be provided.- SPARK: Applicable when
- 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. It is not included in GET responses if the
view=COMPACTquery parameter is specified. - storage Property Map
- (Updatable) The information about a new storage of given type used in an Iceberg 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.
- submit
Mode String - (Updatable) Selects the submission channel. SUBMIT uses the Spark master RPC endpoint. REST uses the Spark standalone REST submission gateway.
- subnet
Id String - (Updatable) The OCID of the target subnet of the dedicated connection.
- subscription
Id String - The OCID of the subscription with which resource needs to be associated with.
- 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). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- tls
Certificate StringKey File Password - (Updatable) Client Certificate key file password. Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFilePasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- tls
Protocol String - (Updatable) TLS protocol negotiated by the Spark client. Applicable when securityProtocol is TLS. Defaults to TLS_V1_3 when not provided. Must be supported by the target cluster.
- trigger
Refresh Boolean - trust
Store String (Updatable) Base64-encoded trust store content.
- SPARK: Trust store used to validate the Spark server certificate when
securityProtocolis TLS. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY, REDIS: TrustStore file used by the target connection.
Deprecated: This field is deprecated and replaced by "trustStoreSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- SPARK: Trust store used to validate the Spark server certificate when
- trust
Store StringPassword (Updatable) Password for
trustStore. For SPARK, it is required when a trust store is supplied.Deprecated: This field is deprecated and replaced by "trustStorePasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- trust
Store StringPassword Secret Id - (Updatable) Secret OCID containing the trust store password. For SPARK, it is required when
trustStoreSecretIdis supplied. When provided,trustStorePasswordmust not be provided. - trust
Store StringSecret Id - (Updatable) Secret OCID containing the trust store content. For SPARK, it applies when
securityProtocolis TLS. When provided,trustStoremust not be provided. - trust
Store StringType - (Updatable) Trust store format used by the Spark client. Applicable when securityProtocol is TLS and a trust store is provided. Defaults to JKS when not provided. Provide this only when a trust store is provided.
- url String
- (Updatable) Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'
- user
Id String - (Updatable)
- OCI_OBJECT_STORAGE, ORACLE_AI_DATA_PLATFORM: The OCID of the Oracle Cloud Infrastructure user who accesses Object Storage. The user must have write access to the bucket. If omitted, the service defaults to the user calling the API.
- ORACLE_NOSQL: The OCID of the Oracle Cloud Infrastructure user who accesses the Oracle NoSQL database. The user must have write access to the table. If omitted, the service defaults to the user calling the API.
- 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) References the Oracle Cloud Infrastructure Vault that contains the customer-managed encryption key identified by
keyId.Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example,
passwordSecretId) instead of plain-text attributes encrypted withvaultIdandkeyId. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGateThis field is applicable only when
doesUseSecretIdsis set tofalse. IfvaultIdis provided,keyIdmust also be provided.- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- workspace
Url String (Updatable)
- DATABRICKS_ENGINE: Databricks workspace base URL for the REST API, for example
https://<workspace>.cloud.databricks.com/api/2.0/. - ORACLE_AI_DATA_PLATFORM_ENGINE: Oracle AI Data Platform workspace URL.
** 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
- DATABRICKS_ENGINE: Databricks workspace base URL for the REST API, for example
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.
- Private
Ip string - This property is not available when creating connections. For existing deprecated connections having this value set, the value cannot be updated; set it to empty.
- 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.
- Private
Ip string - This property is not available when creating connections. For existing deprecated connections having this value set, the value cannot be updated; set it to empty.
- 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(object) - 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.
- private_
ip string - This property is not available when creating connections. For existing deprecated connections having this value set, the value cannot be updated; set it to empty.
- 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.
- 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.
- private
Ip String - This property is not available when creating connections. For existing deprecated connections having this value set, the value cannot be updated; set it to empty.
- 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.
- private
Ip string - This property is not available when creating connections. For existing deprecated connections having this value set, the value cannot be updated; set it to empty.
- 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.
- private_
ip str - This property is not available when creating connections. For existing deprecated connections having this value set, the value cannot be updated; set it to empty.
- 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.
- private
Ip String - This property is not available when creating connections. For existing deprecated connections having this value set, the value cannot be updated; set it to empty.
- 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,
artifact_location: Optional[ConnectionArtifactLocationArgs] = None,
auth_details: Optional[ConnectionAuthDetailsArgs] = None,
auth_secret: Optional[str] = None,
auth_secret_secret_id: Optional[str] = None,
auth_token: Optional[str] = None,
auth_token_secret_id: Optional[str] = None,
authentication_mode: Optional[str] = None,
authentication_type: Optional[str] = None,
azure_authority_host: Optional[str] = None,
azure_tenant_id: Optional[str] = None,
bootstrap_servers: Optional[Sequence[ConnectionBootstrapServerArgs]] = None,
catalog: Optional[ConnectionCatalogArgs] = None,
client_id: Optional[str] = None,
client_secret: Optional[str] = None,
client_secret_secret_id: Optional[str] = None,
cluster_endpoint: Optional[str] = None,
cluster_id: Optional[str] = None,
cluster_placement_group_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,
key_store_type: Optional[str] = None,
lifecycle_details: Optional[str] = None,
locks: Optional[Sequence[ConnectionLockArgs]] = None,
max_input_chars: Optional[int] = None,
model_key: Optional[str] = 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,
provider_id: Optional[str] = None,
provider_type: Optional[str] = None,
public_key_fingerprint: Optional[str] = None,
redis_cluster_id: Optional[str] = None,
region: Optional[str] = None,
rest_auth_secret_key: Optional[str] = None,
rest_auth_secret_key_secret_id: Optional[str] = None,
rest_endpoint: Optional[str] = None,
routing_method: Optional[str] = None,
rpc_cipher: 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_attributes: Optional[Mapping[str, 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: Optional[ConnectionStorageArgs] = None,
storage_credential_name: Optional[str] = None,
stream_pool_id: Optional[str] = None,
submit_mode: Optional[str] = None,
subnet_id: Optional[str] = None,
subscription_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,
tls_protocol: 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,
trust_store_type: 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,
workspace_url: 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: existingConnection: type: oci:GoldenGate:Connection get: id: ${id}import {
to = oci_golden_gate_connection.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- state ConnectionState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- 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 resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state ConnectionState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- state ConnectionState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- state ConnectionState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
- Access
Key stringId (Updatable)
- AMAZON_KINESIS: Access key ID used to access Amazon Kinesis.
- AMAZON_S3: Access key ID used to access the Amazon S3 bucket.
Note: Despite the "Id" suffix, this value is not an Oracle Cloud Infrastructure OCID.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- Artifact
Location ConnectionArtifact Location - (Updatable) Location used to share engine application artifacts.
- DATABRICKS_ENGINE: Location used to share Databricks application artifacts.
- SPARK: Location used to share Spark application artifacts with a remote cluster.
- Auth
Details ConnectionAuth Details - (Updatable) Authentication details for an AI Model or AI Provider connection.
- Auth
Secret string (Updatable) The shared secret used for Spark authentication. Applicable when authenticationType is SHARED_SECRET.
Deprecated: This field is deprecated and replaced by "authSecretSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Auth
Secret stringSecret Id - (Updatable) The OCID of the Secret that stores the Spark authentication shared secret. Applicable when authenticationType is SHARED_SECRET. Note: When provided, 'authSecret' field must not be provided.
- Auth
Token string - (Updatable) Personal access token used to connect to the Databricks Engine REST API. Only applicable for authenticationType == PERSONAL_ACCESS_TOKEN. Deprecated: This field is deprecated and replaced by "authTokenSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Auth
Token stringSecret Id - (Updatable) The OCID of the Secret where the personal access token is stored. Only applicable for authenticationType == PERSONAL_ACCESS_TOKEN. Note: When provided, 'authToken' field must not be provided.
- 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 mechanism; supported values depend on
connectionType.- DATABRICKS: Use PERSONAL_ACCESS_TOKEN or OAUTH_M2M.
- DATABRICKS_ENGINE: Use PERSONAL_ACCESS_TOKEN or OAUTH_M2M for the Databricks Engine REST API.
- JAVA_MESSAGE_SERVICE: Authentication type for Java Message Service. The default is NONE.
- SPARK: Use SHARED_SECRET only when the target cluster has
spark.authenticate=true. AES_RPC and SASL_ENCRYPTED require SHARED_SECRET. - AZURE_DATA_LAKE_STORAGE, ELASTICSEARCH, KAFKA_SCHEMA_REGISTRY, REDIS, SNOWFLAKE: Use the authentication type supported by the target service.
- string
- (Updatable) The endpoint used for authentication with Microsoft Entra ID (formerly Azure Active Directory). Default value: https://login.microsoftonline.com When connecting to a non-public Azure Cloud, the endpoint must be provided, eg:
- Azure China: https://login.chinacloudapi.cn/
- Azure US Government: https://login.microsoftonline.us/
- 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" - Catalog
Connection
Catalog - (Updatable) The information about a new catalog of given type used in an Iceberg connection.
- Client
Id string - (Updatable)
- AZURE_DATA_LAKE_STORAGE: Azure application client ID, required for AZURE_ACTIVE_DIRECTORY authentication.
- DATABRICKS, DATABRICKS_ENGINE: OAuth client ID, applicable to OAUTH_M2M authentication.
- MICROSOFT_FABRIC: Azure application client ID.
- Client
Secret string - (Updatable) Plaintext client secret for the selected connection type. For DATABRICKS and DATABRICKS_ENGINE it applies to OAUTH_M2M authentication. Deprecated: use
clientSecretSecretId. - Client
Secret stringSecret Id - (Updatable) Secret OCID containing the client secret. For DATABRICKS and DATABRICKS_ENGINE it applies to OAUTH_M2M authentication. When provided,
clientSecretmust not be provided. - Cluster
Endpoint string - (Updatable) Spark master URL used for job submission. Required for both submitMode SUBMIT and REST. e.g.: 'spark://spark-master.example.com:7077' High availability can be configured with a comma-separated list, for example: 'spark://h1.example.com:7077,h2.example.com:7077'
- Cluster
Id string - (Updatable) The OCID of the Kafka cluster being referenced from Oracle Cloud Infrastructure Streaming with Apache Kafka.
- Cluster
Placement stringGroup Id - The OCID(https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cluster placement group for the resource. Only applicable for multicloud subscriptions. The cluster placement group id must be provided when a multicloud subscription id is provided. Otherwise the cluster placement group 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) JDBC connection string. e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'
- Connection
Type string - (Updatable) The connection type.
- Connection
Url string - (Updatable)
- AMAZON_REDSHIFT: JDBC connection URL. e.g.:
jdbc:redshift://aws-redshift-instance.aaaaaaaaaaaa.us-east-2.redshift.amazonaws.com:5439/mydb - DATABRICKS: JDBC 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 - JAVA_MESSAGE_SERVICE: Connection URL specifying the protocol, host, and port. e.g.:
mq://myjms.host.domain:7676 - ORACLE_AI_DATA_PLATFORM: Connection URL beginning with
jdbc:spark://. - SNOWFLAKE: JDBC connection URL. e.g.:
jdbc:snowflake://<account_name>.snowflakecomputing.com/?warehouse=<warehouse-name>&db=<db-name>
- AMAZON_REDSHIFT: JDBC connection URL. e.g.:
- 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). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - 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.
Deprecated: This field is deprecated. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example,
passwordSecretId) instead of plain-text attributes. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGateWhen set to
true, all sensitive information must be provided as Oracle Cloud Infrastructure Vault secrets using the corresponding*SecretIdattributes of the connection (for example,passwordSecretId). Plain-text sensitive attributes (for example,password) must not be used. This ensures that sensitive information remains stored and managed in the customer's Oracle Cloud Infrastructure Vault rather than by the GoldenGate service.When set to false, sensitive information must be provided in the corresponding plain-text attributes (for example,
password) rather than in secret OCID attributes. In this mode, the sensitive information is stored by the GoldenGate service. IfvaultIdandkeyIdare not specified, the GoldenGate service uses Oracle-managed encryption keys to encrypt the stored data.If
vaultIdandkeyIdare provided, the specified customer-managed key is used.- Endpoint string
- (Updatable)
- AMAZON_KINESIS: The endpoint URL of the Amazon Kinesis service. e.g.: 'https://kinesis.us-east-1.amazonaws.com' If not provided, GoldenGate will default to 'https://kinesis..amazonaws.com'.
- AMAZON_S3: The Amazon Endpoint for S3. e.g.: 'https://my-bucket.s3.us-east-1.amazonaws.com' If not provided, GoldenGate will default to 'https://s3..amazonaws.com'.
- AZURE_DATA_LAKE_STORAGE: Azure Storage service endpoint. e.g: https://test.blob.core.windows.net
- GOOGLE_BIGQUERY: A legal URL to connect to BigQuery including scheme, server name and port, if not the default port. Default: https://bigquery.googleapis.com
- GOOGLE_CLOUD_STORAGE: A legal URL to connect to Google Cloud Storage including scheme, server name and port, if not the default port. Default: https://storage.googleapis.com
- MICROSOFT_FABRIC: 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) 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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) References the Oracle Cloud Infrastructure Vault key in the Oracle Cloud Infrastructure Vault identified by
vaultId.Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example,
passwordSecretId) instead of plain-text attributes encrypted withvaultIdandkeyId. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGateThe GoldenGate service uses this key to encrypt sensitive information (for example,
password) that is provided in plain-text connection attributes through the API. This field is applicable only whendoesUseSecretIdsis set tofalse. If bothvaultIdandkeyIdare provided, the GoldenGate service uses the specified customer-managed key to encrypt the sensitive data. If neithervaultIdnorkeyIdis provided, the GoldenGate service uses Oracle-managed encryption keys.- Key
Store string (Updatable) Base64-encoded key store content.
- SPARK: Client key store used for mutual TLS when
securityProtocolis TLS. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY, REDIS: KeyStore file used by the target connection.
Deprecated: This field is deprecated and replaced by "keyStoreSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- SPARK: Client key store used for mutual TLS when
- Key
Store stringPassword (Updatable) Password for
keyStore. For SPARK, it is required when a client key store is supplied.Deprecated: This field is deprecated and replaced by "keyStorePasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Key
Store stringPassword Secret Id - (Updatable) Secret OCID containing the key store password. For SPARK, it is required when
keyStoreSecretIdis supplied. When provided,keyStorePasswordmust not be provided. - Key
Store stringSecret Id - (Updatable) Secret OCID containing the key store content. For SPARK, it applies when
securityProtocolis TLS. When provided,keyStoremust not be provided. - Key
Store stringType - (Updatable) Client key store format used for mutual TLS. Applicable when securityProtocol is TLS and a client key store is provided. Defaults to JKS when not provided. Provide this only when a client key store is 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.
- Max
Input intChars - (Updatable) Maximum number of input characters supported by this AI model connection.
- Model
Key string - (Updatable) AI model identifier.
- 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 to Snowflake platform. Deprecated: This field is deprecated and replaced by "passwordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate Snowflake is phasing out password authentication for legacy service users. Oracle GoldenGate Snowflake connections will support only key-pair authentication. See the Snowflake documentation for details: https://docs.snowflake.com/en/user-guide/security-mfa-rollout
- 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 - This property is not available when creating connections. For existing deprecated connections having this value set, the value cannot be updated; set it to empty.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- Provider
Id string - Optional identifier of the AI Provider Connection backing this AI Model Connection. When provided, it must reference an existing Active connection of type
AI_PROVIDER. WhenproviderIdis set,providerTypeandauthDetailsmust not be provided on the AI Model Connection, because provider metadata is resolved from the referenced AI Provider Connection. WhenproviderIdis not set, the AI Model Connection must provide inline provider metadata usingproviderTypeandauthDetails. - Provider
Type string - AI Provider type used by the AI Model Connection.
- 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 AWS region where the bucket is created. If not provided, GoldenGate will default to 'us-west-2'. Note: this property will become mandatory after May 20, 2026.
- Rest
Auth stringSecret Key (Updatable) The BASE64URL-encoded HMAC secret key used to sign REST submission requests when the Spark master's REST endpoint is protected by the JWS filter. Applicable only when submitMode is REST and the cluster enforces REST request signing. This setting is independent of authenticationType.
Deprecated: This field is deprecated and replaced by "restAuthSecretKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Rest
Auth stringSecret Key Secret Id - (Updatable) The OCID of the Secret that stores the REST submission signing key. Applicable only when submitMode is REST and the cluster enforces REST request signing. This setting is independent of authenticationType. Note: When provided, 'restAuthSecretKey' field must not be provided.
- Rest
Endpoint string - (Updatable) Spark standalone REST submission base URL. e.g.: 'https://spark-master.example.com:6066' Applicable only and required when submitMode is REST.
- Routing
Method string (Updatable) Controls the network traffic direction to the target: 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. SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
Deprecated: SHARED_SERVICE_ENDPOINT is deprecated. Use another supported routingMethod value, or update existing connections to use a supported routing method. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Rpc
Cipher string - (Updatable) Cipher transform used for Spark RPC encryption. Applicable when securityProtocol is AES_RPC. Defaults to AES_CTR_NOPADDING when not provided.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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
Attributes Dictionary<string, string> - (Updatable) Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}} - Security
Protocol string - (Updatable) Security protocol; supported values depend on
connectionType.- SPARK: PLAINTEXT, TLS, AES_RPC, or SASL_ENCRYPTED. AES_RPC and SASL_ENCRYPTED require SHARED_SECRET authentication.
- DB2, ELASTICSEARCH, JAVA_MESSAGE_SERVICE, KAFKA, MICROSOFT_SQLSERVER, MONGODB, MYSQL, POSTGRESQL, REDIS: Use the protocol supported by the target service.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Service
Account stringKey File Secret Id - (Updatable) The OCID of the Secret where the content of the service account key file is stored, which contains the credentials required to use Google Cloud Storage. Note: When provided, 'serviceAccountKeyFile' field must not be provided.
- Session
Mode string (Updatable) Specifies the session mode for the database connection. Use REDIRECT only for RAC databases with SCAN listeners that return IP addresses. For RAC databases with SCAN listeners that return FQDNs, and for all other Oracle database technologies, use DIRECT. In RAC deployments, SCAN listeners redirects a connection to a specific database node, identified by either IP address or FQDN. It is recommended to configure RAC with FQDN-based SCAN listeners.
The default is DIRECT, except when databaseId is provided and the discovered database relies on the SCAN listener. In this case, the default is REDIRECT.
Deprecated: Defaulting to the REDIRECT session mode will be removed after April 21, 2027.
- Should
Use boolJndi - (Updatable) If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.
- Should
Use boolResource Principal - (Updatable)
- KAFKA: Specifies that the user intends to authenticate to the instance using a resource principal. Applicable only for Oracle Cloud Infrastructure Streaming connections. Only available from 23.9.0.0.0 GoldenGate versions. Note: When specified, 'username'/'password'/'passwordSecretId' fields must not be provided. Default: false
- OCI_OBJECT_STORAGE, ORACLE_AI_DATA_PLATFORM, ORACLE_NOSQL: Specifies that the user intends to authenticate to the instance using a resource principal. Default: false
- 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)
- MICROSOFT_SQLSERVER: Database Certificate - The base64 encoded content of a .pem or .crt file containing the server public key (for 1-way SSL).
- MYSQL: Database Certificate - The base64 encoded content of a .pem or .crt file containing the server public key (for 1 and 2-way SSL). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - POSTGRESQL: The base64 encoded certificate of the trusted certificate authorities (Trusted CA) for PostgreSQL. The supported file formats are .pem and .crt. It is not included in GET responses if the
view=COMPACTquery parameter is specified.
- Ssl
Cert string - (Updatable)
- MYSQL: Client Certificate - The base64 encoded content of a .pem or .crt file containing the client public key (for 2-way SSL). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - POSTGRESQL: The base64 encoded certificate of the PostgreSQL server. The supported file formats are .pem and .crt. It is not included in GET responses if the
view=COMPACTquery parameter is specified.
- MYSQL: Client Certificate - The base64 encoded content of a .pem or .crt file containing the client public key (for 2-way SSL). It is not included in GET responses if the
- Ssl
Client stringKeystash (Updatable) The base64 encoded keystash file which contains the encrypted password to the key database file. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
Deprecated: This field is deprecated and replaced by "sslClientKeystashSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
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. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
Deprecated: This field is deprecated and replaced by "sslClientKeystoredbSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
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. It is not included in GET responses if the
view=COMPACTquery parameter is specified. - 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Ssl
Key stringPassword (Updatable) Password for the certificate private key inside the client key store.
- SPARK: Applicable when
securityProtocolis TLS and a client key store is provided. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY: Provide it when the private-key password differs from the key store password.
Deprecated: This field is deprecated and replaced by "sslKeyPasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- SPARK: Applicable when
- Ssl
Key stringPassword Secret Id (Updatable) Secret OCID containing the certificate private-key password inside the client key store.
- SPARK: Applicable when
securityProtocolis TLS and a client key store is provided. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY: Provide it when the private-key password differs from the key store password.
When provided,
sslKeyPasswordmust not be provided.- SPARK: Applicable when
- 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. It is not included in GET responses if the
view=COMPACTquery parameter is specified. - State string
- Possible lifecycle states for connection.
- Storage
Connection
Storage - (Updatable) The information about a new storage of given type used in an Iceberg 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.
- Submit
Mode string - (Updatable) Selects the submission channel. SUBMIT uses the Spark master RPC endpoint. REST uses the Spark standalone REST submission gateway.
- Subnet
Id string - (Updatable) The OCID of the target subnet of the dedicated connection.
- Subscription
Id string - The OCID of the subscription with which resource needs to be associated with.
- 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 - Technology type selected for the connection.
- AI_MODEL: AI Model technology type.
- AI_PROVIDER: AI Provider technology type.
- DATABRICKS_ENGINE: Databricks Engine technology type.
- ICEBERG: Iceberg technology type. APACHE_ICEBERG supports all catalog types; AMAZON_S3_TABLES supports only REST catalog and S3 storage.
- KAFKA_SCHEMA_REGISTRY: Kafka Schema Registry technology type.
- ORACLE_AI_DATA_PLATFORM_ENGINE: Oracle AI Data Platform Engine technology type.
- SPARK: Spark 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). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Tls
Certificate stringKey File Password - (Updatable) Client Certificate key file password. Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFilePasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- Tls
Protocol string - (Updatable) TLS protocol negotiated by the Spark client. Applicable when securityProtocol is TLS. Defaults to TLS_V1_3 when not provided. Must be supported by the target cluster.
- Trigger
Refresh bool - Trust
Store string (Updatable) Base64-encoded trust store content.
- SPARK: Trust store used to validate the Spark server certificate when
securityProtocolis TLS. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY, REDIS: TrustStore file used by the target connection.
Deprecated: This field is deprecated and replaced by "trustStoreSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- SPARK: Trust store used to validate the Spark server certificate when
- Trust
Store stringPassword (Updatable) Password for
trustStore. For SPARK, it is required when a trust store is supplied.Deprecated: This field is deprecated and replaced by "trustStorePasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Trust
Store stringPassword Secret Id - (Updatable) Secret OCID containing the trust store password. For SPARK, it is required when
trustStoreSecretIdis supplied. When provided,trustStorePasswordmust not be provided. - Trust
Store stringSecret Id - (Updatable) Secret OCID containing the trust store content. For SPARK, it applies when
securityProtocolis TLS. When provided,trustStoremust not be provided. - Trust
Store stringType - (Updatable) Trust store format used by the Spark client. Applicable when securityProtocol is TLS and a trust store is provided. Defaults to JKS when not provided. Provide this only when a trust store is provided.
- Url string
- (Updatable) Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'
- User
Id string - (Updatable)
- OCI_OBJECT_STORAGE, ORACLE_AI_DATA_PLATFORM: The OCID of the Oracle Cloud Infrastructure user who accesses Object Storage. The user must have write access to the bucket. If omitted, the service defaults to the user calling the API.
- ORACLE_NOSQL: The OCID of the Oracle Cloud Infrastructure user who accesses the Oracle NoSQL database. The user must have write access to the table. If omitted, the service defaults to the user calling the API.
- 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) References the Oracle Cloud Infrastructure Vault that contains the customer-managed encryption key identified by
keyId.Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example,
passwordSecretId) instead of plain-text attributes encrypted withvaultIdandkeyId. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGateThis field is applicable only when
doesUseSecretIdsis set tofalse. IfvaultIdis provided,keyIdmust also be provided.- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- Workspace
Url string (Updatable)
- DATABRICKS_ENGINE: Databricks workspace base URL for the REST API, for example
https://<workspace>.cloud.databricks.com/api/2.0/. - ORACLE_AI_DATA_PLATFORM_ENGINE: Oracle AI Data Platform workspace URL.
** 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
- DATABRICKS_ENGINE: Databricks workspace base URL for the REST API, for example
- Access
Key stringId (Updatable)
- AMAZON_KINESIS: Access key ID used to access Amazon Kinesis.
- AMAZON_S3: Access key ID used to access the Amazon S3 bucket.
Note: Despite the "Id" suffix, this value is not an Oracle Cloud Infrastructure OCID.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- Artifact
Location ConnectionArtifact Location Args - (Updatable) Location used to share engine application artifacts.
- DATABRICKS_ENGINE: Location used to share Databricks application artifacts.
- SPARK: Location used to share Spark application artifacts with a remote cluster.
- Auth
Details ConnectionAuth Details Args - (Updatable) Authentication details for an AI Model or AI Provider connection.
- Auth
Secret string (Updatable) The shared secret used for Spark authentication. Applicable when authenticationType is SHARED_SECRET.
Deprecated: This field is deprecated and replaced by "authSecretSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Auth
Secret stringSecret Id - (Updatable) The OCID of the Secret that stores the Spark authentication shared secret. Applicable when authenticationType is SHARED_SECRET. Note: When provided, 'authSecret' field must not be provided.
- Auth
Token string - (Updatable) Personal access token used to connect to the Databricks Engine REST API. Only applicable for authenticationType == PERSONAL_ACCESS_TOKEN. Deprecated: This field is deprecated and replaced by "authTokenSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Auth
Token stringSecret Id - (Updatable) The OCID of the Secret where the personal access token is stored. Only applicable for authenticationType == PERSONAL_ACCESS_TOKEN. Note: When provided, 'authToken' field must not be provided.
- 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 mechanism; supported values depend on
connectionType.- DATABRICKS: Use PERSONAL_ACCESS_TOKEN or OAUTH_M2M.
- DATABRICKS_ENGINE: Use PERSONAL_ACCESS_TOKEN or OAUTH_M2M for the Databricks Engine REST API.
- JAVA_MESSAGE_SERVICE: Authentication type for Java Message Service. The default is NONE.
- SPARK: Use SHARED_SECRET only when the target cluster has
spark.authenticate=true. AES_RPC and SASL_ENCRYPTED require SHARED_SECRET. - AZURE_DATA_LAKE_STORAGE, ELASTICSEARCH, KAFKA_SCHEMA_REGISTRY, REDIS, SNOWFLAKE: Use the authentication type supported by the target service.
- string
- (Updatable) The endpoint used for authentication with Microsoft Entra ID (formerly Azure Active Directory). Default value: https://login.microsoftonline.com When connecting to a non-public Azure Cloud, the endpoint must be provided, eg:
- Azure China: https://login.chinacloudapi.cn/
- Azure US Government: https://login.microsoftonline.us/
- 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" - Catalog
Connection
Catalog Args - (Updatable) The information about a new catalog of given type used in an Iceberg connection.
- Client
Id string - (Updatable)
- AZURE_DATA_LAKE_STORAGE: Azure application client ID, required for AZURE_ACTIVE_DIRECTORY authentication.
- DATABRICKS, DATABRICKS_ENGINE: OAuth client ID, applicable to OAUTH_M2M authentication.
- MICROSOFT_FABRIC: Azure application client ID.
- Client
Secret string - (Updatable) Plaintext client secret for the selected connection type. For DATABRICKS and DATABRICKS_ENGINE it applies to OAUTH_M2M authentication. Deprecated: use
clientSecretSecretId. - Client
Secret stringSecret Id - (Updatable) Secret OCID containing the client secret. For DATABRICKS and DATABRICKS_ENGINE it applies to OAUTH_M2M authentication. When provided,
clientSecretmust not be provided. - Cluster
Endpoint string - (Updatable) Spark master URL used for job submission. Required for both submitMode SUBMIT and REST. e.g.: 'spark://spark-master.example.com:7077' High availability can be configured with a comma-separated list, for example: 'spark://h1.example.com:7077,h2.example.com:7077'
- Cluster
Id string - (Updatable) The OCID of the Kafka cluster being referenced from Oracle Cloud Infrastructure Streaming with Apache Kafka.
- Cluster
Placement stringGroup Id - The OCID(https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cluster placement group for the resource. Only applicable for multicloud subscriptions. The cluster placement group id must be provided when a multicloud subscription id is provided. Otherwise the cluster placement group 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) JDBC connection string. e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'
- Connection
Type string - (Updatable) The connection type.
- Connection
Url string - (Updatable)
- AMAZON_REDSHIFT: JDBC connection URL. e.g.:
jdbc:redshift://aws-redshift-instance.aaaaaaaaaaaa.us-east-2.redshift.amazonaws.com:5439/mydb - DATABRICKS: JDBC 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 - JAVA_MESSAGE_SERVICE: Connection URL specifying the protocol, host, and port. e.g.:
mq://myjms.host.domain:7676 - ORACLE_AI_DATA_PLATFORM: Connection URL beginning with
jdbc:spark://. - SNOWFLAKE: JDBC connection URL. e.g.:
jdbc:snowflake://<account_name>.snowflakecomputing.com/?warehouse=<warehouse-name>&db=<db-name>
- AMAZON_REDSHIFT: JDBC connection URL. e.g.:
- 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). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - 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.
Deprecated: This field is deprecated. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example,
passwordSecretId) instead of plain-text attributes. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGateWhen set to
true, all sensitive information must be provided as Oracle Cloud Infrastructure Vault secrets using the corresponding*SecretIdattributes of the connection (for example,passwordSecretId). Plain-text sensitive attributes (for example,password) must not be used. This ensures that sensitive information remains stored and managed in the customer's Oracle Cloud Infrastructure Vault rather than by the GoldenGate service.When set to false, sensitive information must be provided in the corresponding plain-text attributes (for example,
password) rather than in secret OCID attributes. In this mode, the sensitive information is stored by the GoldenGate service. IfvaultIdandkeyIdare not specified, the GoldenGate service uses Oracle-managed encryption keys to encrypt the stored data.If
vaultIdandkeyIdare provided, the specified customer-managed key is used.- Endpoint string
- (Updatable)
- AMAZON_KINESIS: The endpoint URL of the Amazon Kinesis service. e.g.: 'https://kinesis.us-east-1.amazonaws.com' If not provided, GoldenGate will default to 'https://kinesis..amazonaws.com'.
- AMAZON_S3: The Amazon Endpoint for S3. e.g.: 'https://my-bucket.s3.us-east-1.amazonaws.com' If not provided, GoldenGate will default to 'https://s3..amazonaws.com'.
- AZURE_DATA_LAKE_STORAGE: Azure Storage service endpoint. e.g: https://test.blob.core.windows.net
- GOOGLE_BIGQUERY: A legal URL to connect to BigQuery including scheme, server name and port, if not the default port. Default: https://bigquery.googleapis.com
- GOOGLE_CLOUD_STORAGE: A legal URL to connect to Google Cloud Storage including scheme, server name and port, if not the default port. Default: https://storage.googleapis.com
- MICROSOFT_FABRIC: 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) 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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) References the Oracle Cloud Infrastructure Vault key in the Oracle Cloud Infrastructure Vault identified by
vaultId.Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example,
passwordSecretId) instead of plain-text attributes encrypted withvaultIdandkeyId. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGateThe GoldenGate service uses this key to encrypt sensitive information (for example,
password) that is provided in plain-text connection attributes through the API. This field is applicable only whendoesUseSecretIdsis set tofalse. If bothvaultIdandkeyIdare provided, the GoldenGate service uses the specified customer-managed key to encrypt the sensitive data. If neithervaultIdnorkeyIdis provided, the GoldenGate service uses Oracle-managed encryption keys.- Key
Store string (Updatable) Base64-encoded key store content.
- SPARK: Client key store used for mutual TLS when
securityProtocolis TLS. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY, REDIS: KeyStore file used by the target connection.
Deprecated: This field is deprecated and replaced by "keyStoreSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- SPARK: Client key store used for mutual TLS when
- Key
Store stringPassword (Updatable) Password for
keyStore. For SPARK, it is required when a client key store is supplied.Deprecated: This field is deprecated and replaced by "keyStorePasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Key
Store stringPassword Secret Id - (Updatable) Secret OCID containing the key store password. For SPARK, it is required when
keyStoreSecretIdis supplied. When provided,keyStorePasswordmust not be provided. - Key
Store stringSecret Id - (Updatable) Secret OCID containing the key store content. For SPARK, it applies when
securityProtocolis TLS. When provided,keyStoremust not be provided. - Key
Store stringType - (Updatable) Client key store format used for mutual TLS. Applicable when securityProtocol is TLS and a client key store is provided. Defaults to JKS when not provided. Provide this only when a client key store is 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.
- Max
Input intChars - (Updatable) Maximum number of input characters supported by this AI model connection.
- Model
Key string - (Updatable) AI model identifier.
- 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 to Snowflake platform. Deprecated: This field is deprecated and replaced by "passwordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate Snowflake is phasing out password authentication for legacy service users. Oracle GoldenGate Snowflake connections will support only key-pair authentication. See the Snowflake documentation for details: https://docs.snowflake.com/en/user-guide/security-mfa-rollout
- 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 - This property is not available when creating connections. For existing deprecated connections having this value set, the value cannot be updated; set it to empty.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- Provider
Id string - Optional identifier of the AI Provider Connection backing this AI Model Connection. When provided, it must reference an existing Active connection of type
AI_PROVIDER. WhenproviderIdis set,providerTypeandauthDetailsmust not be provided on the AI Model Connection, because provider metadata is resolved from the referenced AI Provider Connection. WhenproviderIdis not set, the AI Model Connection must provide inline provider metadata usingproviderTypeandauthDetails. - Provider
Type string - AI Provider type used by the AI Model Connection.
- 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 AWS region where the bucket is created. If not provided, GoldenGate will default to 'us-west-2'. Note: this property will become mandatory after May 20, 2026.
- Rest
Auth stringSecret Key (Updatable) The BASE64URL-encoded HMAC secret key used to sign REST submission requests when the Spark master's REST endpoint is protected by the JWS filter. Applicable only when submitMode is REST and the cluster enforces REST request signing. This setting is independent of authenticationType.
Deprecated: This field is deprecated and replaced by "restAuthSecretKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Rest
Auth stringSecret Key Secret Id - (Updatable) The OCID of the Secret that stores the REST submission signing key. Applicable only when submitMode is REST and the cluster enforces REST request signing. This setting is independent of authenticationType. Note: When provided, 'restAuthSecretKey' field must not be provided.
- Rest
Endpoint string - (Updatable) Spark standalone REST submission base URL. e.g.: 'https://spark-master.example.com:6066' Applicable only and required when submitMode is REST.
- Routing
Method string (Updatable) Controls the network traffic direction to the target: 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. SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
Deprecated: SHARED_SERVICE_ENDPOINT is deprecated. Use another supported routingMethod value, or update existing connections to use a supported routing method. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Rpc
Cipher string - (Updatable) Cipher transform used for Spark RPC encryption. Applicable when securityProtocol is AES_RPC. Defaults to AES_CTR_NOPADDING when not provided.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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
Attributes map[string]string - (Updatable) Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}} - Security
Protocol string - (Updatable) Security protocol; supported values depend on
connectionType.- SPARK: PLAINTEXT, TLS, AES_RPC, or SASL_ENCRYPTED. AES_RPC and SASL_ENCRYPTED require SHARED_SECRET authentication.
- DB2, ELASTICSEARCH, JAVA_MESSAGE_SERVICE, KAFKA, MICROSOFT_SQLSERVER, MONGODB, MYSQL, POSTGRESQL, REDIS: Use the protocol supported by the target service.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Service
Account stringKey File Secret Id - (Updatable) The OCID of the Secret where the content of the service account key file is stored, which contains the credentials required to use Google Cloud Storage. Note: When provided, 'serviceAccountKeyFile' field must not be provided.
- Session
Mode string (Updatable) Specifies the session mode for the database connection. Use REDIRECT only for RAC databases with SCAN listeners that return IP addresses. For RAC databases with SCAN listeners that return FQDNs, and for all other Oracle database technologies, use DIRECT. In RAC deployments, SCAN listeners redirects a connection to a specific database node, identified by either IP address or FQDN. It is recommended to configure RAC with FQDN-based SCAN listeners.
The default is DIRECT, except when databaseId is provided and the discovered database relies on the SCAN listener. In this case, the default is REDIRECT.
Deprecated: Defaulting to the REDIRECT session mode will be removed after April 21, 2027.
- Should
Use boolJndi - (Updatable) If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.
- Should
Use boolResource Principal - (Updatable)
- KAFKA: Specifies that the user intends to authenticate to the instance using a resource principal. Applicable only for Oracle Cloud Infrastructure Streaming connections. Only available from 23.9.0.0.0 GoldenGate versions. Note: When specified, 'username'/'password'/'passwordSecretId' fields must not be provided. Default: false
- OCI_OBJECT_STORAGE, ORACLE_AI_DATA_PLATFORM, ORACLE_NOSQL: Specifies that the user intends to authenticate to the instance using a resource principal. Default: false
- 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)
- MICROSOFT_SQLSERVER: Database Certificate - The base64 encoded content of a .pem or .crt file containing the server public key (for 1-way SSL).
- MYSQL: Database Certificate - The base64 encoded content of a .pem or .crt file containing the server public key (for 1 and 2-way SSL). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - POSTGRESQL: The base64 encoded certificate of the trusted certificate authorities (Trusted CA) for PostgreSQL. The supported file formats are .pem and .crt. It is not included in GET responses if the
view=COMPACTquery parameter is specified.
- Ssl
Cert string - (Updatable)
- MYSQL: Client Certificate - The base64 encoded content of a .pem or .crt file containing the client public key (for 2-way SSL). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - POSTGRESQL: The base64 encoded certificate of the PostgreSQL server. The supported file formats are .pem and .crt. It is not included in GET responses if the
view=COMPACTquery parameter is specified.
- MYSQL: Client Certificate - The base64 encoded content of a .pem or .crt file containing the client public key (for 2-way SSL). It is not included in GET responses if the
- Ssl
Client stringKeystash (Updatable) The base64 encoded keystash file which contains the encrypted password to the key database file. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
Deprecated: This field is deprecated and replaced by "sslClientKeystashSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
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. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
Deprecated: This field is deprecated and replaced by "sslClientKeystoredbSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
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. It is not included in GET responses if the
view=COMPACTquery parameter is specified. - 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Ssl
Key stringPassword (Updatable) Password for the certificate private key inside the client key store.
- SPARK: Applicable when
securityProtocolis TLS and a client key store is provided. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY: Provide it when the private-key password differs from the key store password.
Deprecated: This field is deprecated and replaced by "sslKeyPasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- SPARK: Applicable when
- Ssl
Key stringPassword Secret Id (Updatable) Secret OCID containing the certificate private-key password inside the client key store.
- SPARK: Applicable when
securityProtocolis TLS and a client key store is provided. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY: Provide it when the private-key password differs from the key store password.
When provided,
sslKeyPasswordmust not be provided.- SPARK: Applicable when
- 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. It is not included in GET responses if the
view=COMPACTquery parameter is specified. - State string
- Possible lifecycle states for connection.
- Storage
Connection
Storage Args - (Updatable) The information about a new storage of given type used in an Iceberg 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.
- Submit
Mode string - (Updatable) Selects the submission channel. SUBMIT uses the Spark master RPC endpoint. REST uses the Spark standalone REST submission gateway.
- Subnet
Id string - (Updatable) The OCID of the target subnet of the dedicated connection.
- Subscription
Id string - The OCID of the subscription with which resource needs to be associated with.
- 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 - Technology type selected for the connection.
- AI_MODEL: AI Model technology type.
- AI_PROVIDER: AI Provider technology type.
- DATABRICKS_ENGINE: Databricks Engine technology type.
- ICEBERG: Iceberg technology type. APACHE_ICEBERG supports all catalog types; AMAZON_S3_TABLES supports only REST catalog and S3 storage.
- KAFKA_SCHEMA_REGISTRY: Kafka Schema Registry technology type.
- ORACLE_AI_DATA_PLATFORM_ENGINE: Oracle AI Data Platform Engine technology type.
- SPARK: Spark 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). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Tls
Certificate stringKey File Password - (Updatable) Client Certificate key file password. Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFilePasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- Tls
Protocol string - (Updatable) TLS protocol negotiated by the Spark client. Applicable when securityProtocol is TLS. Defaults to TLS_V1_3 when not provided. Must be supported by the target cluster.
- Trigger
Refresh bool - Trust
Store string (Updatable) Base64-encoded trust store content.
- SPARK: Trust store used to validate the Spark server certificate when
securityProtocolis TLS. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY, REDIS: TrustStore file used by the target connection.
Deprecated: This field is deprecated and replaced by "trustStoreSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- SPARK: Trust store used to validate the Spark server certificate when
- Trust
Store stringPassword (Updatable) Password for
trustStore. For SPARK, it is required when a trust store is supplied.Deprecated: This field is deprecated and replaced by "trustStorePasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Trust
Store stringPassword Secret Id - (Updatable) Secret OCID containing the trust store password. For SPARK, it is required when
trustStoreSecretIdis supplied. When provided,trustStorePasswordmust not be provided. - Trust
Store stringSecret Id - (Updatable) Secret OCID containing the trust store content. For SPARK, it applies when
securityProtocolis TLS. When provided,trustStoremust not be provided. - Trust
Store stringType - (Updatable) Trust store format used by the Spark client. Applicable when securityProtocol is TLS and a trust store is provided. Defaults to JKS when not provided. Provide this only when a trust store is provided.
- Url string
- (Updatable) Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'
- User
Id string - (Updatable)
- OCI_OBJECT_STORAGE, ORACLE_AI_DATA_PLATFORM: The OCID of the Oracle Cloud Infrastructure user who accesses Object Storage. The user must have write access to the bucket. If omitted, the service defaults to the user calling the API.
- ORACLE_NOSQL: The OCID of the Oracle Cloud Infrastructure user who accesses the Oracle NoSQL database. The user must have write access to the table. If omitted, the service defaults to the user calling the API.
- 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) References the Oracle Cloud Infrastructure Vault that contains the customer-managed encryption key identified by
keyId.Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example,
passwordSecretId) instead of plain-text attributes encrypted withvaultIdandkeyId. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGateThis field is applicable only when
doesUseSecretIdsis set tofalse. IfvaultIdis provided,keyIdmust also be provided.- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- Workspace
Url string (Updatable)
- DATABRICKS_ENGINE: Databricks workspace base URL for the REST API, for example
https://<workspace>.cloud.databricks.com/api/2.0/. - ORACLE_AI_DATA_PLATFORM_ENGINE: Oracle AI Data Platform workspace URL.
** 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
- DATABRICKS_ENGINE: Databricks workspace base URL for the REST API, for example
- access_
key_ stringid (Updatable)
- AMAZON_KINESIS: Access key ID used to access Amazon Kinesis.
- AMAZON_S3: Access key ID used to access the Amazon S3 bucket.
Note: Despite the "Id" suffix, this value is not an Oracle Cloud Infrastructure OCID.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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(object) - (Updatable) An array of name-value pair attribute entries. Used as additional parameters in connection string.
- artifact_
location object - (Updatable) Location used to share engine application artifacts.
- DATABRICKS_ENGINE: Location used to share Databricks application artifacts.
- SPARK: Location used to share Spark application artifacts with a remote cluster.
- auth_
details object - (Updatable) Authentication details for an AI Model or AI Provider connection.
- auth_
secret string (Updatable) The shared secret used for Spark authentication. Applicable when authenticationType is SHARED_SECRET.
Deprecated: This field is deprecated and replaced by "authSecretSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- auth_
secret_ stringsecret_ id - (Updatable) The OCID of the Secret that stores the Spark authentication shared secret. Applicable when authenticationType is SHARED_SECRET. Note: When provided, 'authSecret' field must not be provided.
- auth_
token string - (Updatable) Personal access token used to connect to the Databricks Engine REST API. Only applicable for authenticationType == PERSONAL_ACCESS_TOKEN. Deprecated: This field is deprecated and replaced by "authTokenSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- auth_
token_ stringsecret_ id - (Updatable) The OCID of the Secret where the personal access token is stored. Only applicable for authenticationType == PERSONAL_ACCESS_TOKEN. Note: When provided, 'authToken' field must not be provided.
- 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 mechanism; supported values depend on
connectionType.- DATABRICKS: Use PERSONAL_ACCESS_TOKEN or OAUTH_M2M.
- DATABRICKS_ENGINE: Use PERSONAL_ACCESS_TOKEN or OAUTH_M2M for the Databricks Engine REST API.
- JAVA_MESSAGE_SERVICE: Authentication type for Java Message Service. The default is NONE.
- SPARK: Use SHARED_SECRET only when the target cluster has
spark.authenticate=true. AES_RPC and SASL_ENCRYPTED require SHARED_SECRET. - AZURE_DATA_LAKE_STORAGE, ELASTICSEARCH, KAFKA_SCHEMA_REGISTRY, REDIS, SNOWFLAKE: Use the authentication type supported by the target service.
- string
- (Updatable) The endpoint used for authentication with Microsoft Entra ID (formerly Azure Active Directory). Default value: https://login.microsoftonline.com When connecting to a non-public Azure Cloud, the endpoint must be provided, eg:
- Azure China: https://login.chinacloudapi.cn/
- Azure US Government: https://login.microsoftonline.us/
- 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(object) - (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" - catalog object
- (Updatable) The information about a new catalog of given type used in an Iceberg connection.
- client_
id string - (Updatable)
- AZURE_DATA_LAKE_STORAGE: Azure application client ID, required for AZURE_ACTIVE_DIRECTORY authentication.
- DATABRICKS, DATABRICKS_ENGINE: OAuth client ID, applicable to OAUTH_M2M authentication.
- MICROSOFT_FABRIC: Azure application client ID.
- client_
secret string - (Updatable) Plaintext client secret for the selected connection type. For DATABRICKS and DATABRICKS_ENGINE it applies to OAUTH_M2M authentication. Deprecated: use
clientSecretSecretId. - client_
secret_ stringsecret_ id - (Updatable) Secret OCID containing the client secret. For DATABRICKS and DATABRICKS_ENGINE it applies to OAUTH_M2M authentication. When provided,
clientSecretmust not be provided. - cluster_
endpoint string - (Updatable) Spark master URL used for job submission. Required for both submitMode SUBMIT and REST. e.g.: 'spark://spark-master.example.com:7077' High availability can be configured with a comma-separated list, for example: 'spark://h1.example.com:7077,h2.example.com:7077'
- cluster_
id string - (Updatable) The OCID of the Kafka cluster being referenced from Oracle Cloud Infrastructure Streaming with Apache Kafka.
- cluster_
placement_ stringgroup_ id - The OCID(https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cluster placement group for the resource. Only applicable for multicloud subscriptions. The cluster placement group id must be provided when a multicloud subscription id is provided. Otherwise the cluster placement group 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) JDBC connection string. e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'
- connection_
type string - (Updatable) The connection type.
- connection_
url string - (Updatable)
- AMAZON_REDSHIFT: JDBC connection URL. e.g.:
jdbc:redshift://aws-redshift-instance.aaaaaaaaaaaa.us-east-2.redshift.amazonaws.com:5439/mydb - DATABRICKS: JDBC 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 - JAVA_MESSAGE_SERVICE: Connection URL specifying the protocol, host, and port. e.g.:
mq://myjms.host.domain:7676 - ORACLE_AI_DATA_PLATFORM: Connection URL beginning with
jdbc:spark://. - SNOWFLAKE: JDBC connection URL. e.g.:
jdbc:snowflake://<account_name>.snowflakecomputing.com/?warehouse=<warehouse-name>&db=<db-name>
- AMAZON_REDSHIFT: JDBC connection URL. e.g.:
- 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). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - 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_ boolsecret_ ids (Updatable) Indicates that sensitive attributes are provided via Secrets.
Deprecated: This field is deprecated. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example,
passwordSecretId) instead of plain-text attributes. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGateWhen set to
true, all sensitive information must be provided as Oracle Cloud Infrastructure Vault secrets using the corresponding*SecretIdattributes of the connection (for example,passwordSecretId). Plain-text sensitive attributes (for example,password) must not be used. This ensures that sensitive information remains stored and managed in the customer's Oracle Cloud Infrastructure Vault rather than by the GoldenGate service.When set to false, sensitive information must be provided in the corresponding plain-text attributes (for example,
password) rather than in secret OCID attributes. In this mode, the sensitive information is stored by the GoldenGate service. IfvaultIdandkeyIdare not specified, the GoldenGate service uses Oracle-managed encryption keys to encrypt the stored data.If
vaultIdandkeyIdare provided, the specified customer-managed key is used.- endpoint string
- (Updatable)
- AMAZON_KINESIS: The endpoint URL of the Amazon Kinesis service. e.g.: 'https://kinesis.us-east-1.amazonaws.com' If not provided, GoldenGate will default to 'https://kinesis..amazonaws.com'.
- AMAZON_S3: The Amazon Endpoint for S3. e.g.: 'https://my-bucket.s3.us-east-1.amazonaws.com' If not provided, GoldenGate will default to 'https://s3..amazonaws.com'.
- AZURE_DATA_LAKE_STORAGE: Azure Storage service endpoint. e.g: https://test.blob.core.windows.net
- GOOGLE_BIGQUERY: A legal URL to connect to BigQuery including scheme, server name and port, if not the default port. Default: https://bigquery.googleapis.com
- GOOGLE_CLOUD_STORAGE: A legal URL to connect to Google Cloud Storage including scheme, server name and port, if not the default port. Default: https://storage.googleapis.com
- MICROSOFT_FABRIC: 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) 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(object) - 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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) References the Oracle Cloud Infrastructure Vault key in the Oracle Cloud Infrastructure Vault identified by
vaultId.Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example,
passwordSecretId) instead of plain-text attributes encrypted withvaultIdandkeyId. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGateThe GoldenGate service uses this key to encrypt sensitive information (for example,
password) that is provided in plain-text connection attributes through the API. This field is applicable only whendoesUseSecretIdsis set tofalse. If bothvaultIdandkeyIdare provided, the GoldenGate service uses the specified customer-managed key to encrypt the sensitive data. If neithervaultIdnorkeyIdis provided, the GoldenGate service uses Oracle-managed encryption keys.- key_
store string (Updatable) Base64-encoded key store content.
- SPARK: Client key store used for mutual TLS when
securityProtocolis TLS. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY, REDIS: KeyStore file used by the target connection.
Deprecated: This field is deprecated and replaced by "keyStoreSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- SPARK: Client key store used for mutual TLS when
- key_
store_ stringpassword (Updatable) Password for
keyStore. For SPARK, it is required when a client key store is supplied.Deprecated: This field is deprecated and replaced by "keyStorePasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- key_
store_ stringpassword_ secret_ id - (Updatable) Secret OCID containing the key store password. For SPARK, it is required when
keyStoreSecretIdis supplied. When provided,keyStorePasswordmust not be provided. - key_
store_ stringsecret_ id - (Updatable) Secret OCID containing the key store content. For SPARK, it applies when
securityProtocolis TLS. When provided,keyStoremust not be provided. - key_
store_ stringtype - (Updatable) Client key store format used for mutual TLS. Applicable when securityProtocol is TLS and a client key store is provided. Defaults to JKS when not provided. Provide this only when a client key store is 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(object)
- Locks associated with this resource.
- max_
input_ numberchars - (Updatable) Maximum number of input characters supported by this AI model connection.
- model_
key string - (Updatable) AI model identifier.
- 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 to Snowflake platform. Deprecated: This field is deprecated and replaced by "passwordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate Snowflake is phasing out password authentication for legacy service users. Oracle GoldenGate Snowflake connections will support only key-pair authentication. See the Snowflake documentation for details: https://docs.snowflake.com/en/user-guide/security-mfa-rollout
- 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 - This property is not available when creating connections. For existing deprecated connections having this value set, the value cannot be updated; set it to empty.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- provider_
id string - Optional identifier of the AI Provider Connection backing this AI Model Connection. When provided, it must reference an existing Active connection of type
AI_PROVIDER. WhenproviderIdis set,providerTypeandauthDetailsmust not be provided on the AI Model Connection, because provider metadata is resolved from the referenced AI Provider Connection. WhenproviderIdis not set, the AI Model Connection must provide inline provider metadata usingproviderTypeandauthDetails. - provider_
type string - AI Provider type used by the AI Model Connection.
- 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 AWS region where the bucket is created. If not provided, GoldenGate will default to 'us-west-2'. Note: this property will become mandatory after May 20, 2026.
- rest_
auth_ stringsecret_ key (Updatable) The BASE64URL-encoded HMAC secret key used to sign REST submission requests when the Spark master's REST endpoint is protected by the JWS filter. Applicable only when submitMode is REST and the cluster enforces REST request signing. This setting is independent of authenticationType.
Deprecated: This field is deprecated and replaced by "restAuthSecretKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- rest_
auth_ stringsecret_ key_ secret_ id - (Updatable) The OCID of the Secret that stores the REST submission signing key. Applicable only when submitMode is REST and the cluster enforces REST request signing. This setting is independent of authenticationType. Note: When provided, 'restAuthSecretKey' field must not be provided.
- rest_
endpoint string - (Updatable) Spark standalone REST submission base URL. e.g.: 'https://spark-master.example.com:6066' Applicable only and required when submitMode is REST.
- routing_
method string (Updatable) Controls the network traffic direction to the target: 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. SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
Deprecated: SHARED_SERVICE_ENDPOINT is deprecated. Use another supported routingMethod value, or update existing connections to use a supported routing method. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- rpc_
cipher string - (Updatable) Cipher transform used for Spark RPC encryption. Applicable when securityProtocol is AES_RPC. Defaults to AES_CTR_NOPADDING when not provided.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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_
attributes map(string) - (Updatable) Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}} - security_
protocol string - (Updatable) Security protocol; supported values depend on
connectionType.- SPARK: PLAINTEXT, TLS, AES_RPC, or SASL_ENCRYPTED. AES_RPC and SASL_ENCRYPTED require SHARED_SECRET authentication.
- DB2, ELASTICSEARCH, JAVA_MESSAGE_SERVICE, KAFKA, MICROSOFT_SQLSERVER, MONGODB, MYSQL, POSTGRESQL, REDIS: Use the protocol supported by the target service.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- service_
account_ stringkey_ file_ secret_ id - (Updatable) The OCID of the Secret where the content of the service account key file is stored, which contains the credentials required to use Google Cloud Storage. Note: When provided, 'serviceAccountKeyFile' field must not be provided.
- session_
mode string (Updatable) Specifies the session mode for the database connection. Use REDIRECT only for RAC databases with SCAN listeners that return IP addresses. For RAC databases with SCAN listeners that return FQDNs, and for all other Oracle database technologies, use DIRECT. In RAC deployments, SCAN listeners redirects a connection to a specific database node, identified by either IP address or FQDN. It is recommended to configure RAC with FQDN-based SCAN listeners.
The default is DIRECT, except when databaseId is provided and the discovered database relies on the SCAN listener. In this case, the default is REDIRECT.
Deprecated: Defaulting to the REDIRECT session mode will be removed after April 21, 2027.
- should_
use_ booljndi - (Updatable) If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.
- should_
use_ boolresource_ principal - (Updatable)
- KAFKA: Specifies that the user intends to authenticate to the instance using a resource principal. Applicable only for Oracle Cloud Infrastructure Streaming connections. Only available from 23.9.0.0.0 GoldenGate versions. Note: When specified, 'username'/'password'/'passwordSecretId' fields must not be provided. Default: false
- OCI_OBJECT_STORAGE, ORACLE_AI_DATA_PLATFORM, ORACLE_NOSQL: Specifies that the user intends to authenticate to the instance using a resource principal. Default: false
- 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)
- MICROSOFT_SQLSERVER: Database Certificate - The base64 encoded content of a .pem or .crt file containing the server public key (for 1-way SSL).
- MYSQL: Database Certificate - The base64 encoded content of a .pem or .crt file containing the server public key (for 1 and 2-way SSL). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - POSTGRESQL: The base64 encoded certificate of the trusted certificate authorities (Trusted CA) for PostgreSQL. The supported file formats are .pem and .crt. It is not included in GET responses if the
view=COMPACTquery parameter is specified.
- ssl_
cert string - (Updatable)
- MYSQL: Client Certificate - The base64 encoded content of a .pem or .crt file containing the client public key (for 2-way SSL). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - POSTGRESQL: The base64 encoded certificate of the PostgreSQL server. The supported file formats are .pem and .crt. It is not included in GET responses if the
view=COMPACTquery parameter is specified.
- MYSQL: Client Certificate - The base64 encoded content of a .pem or .crt file containing the client public key (for 2-way SSL). It is not included in GET responses if the
- ssl_
client_ stringkeystash (Updatable) The base64 encoded keystash file which contains the encrypted password to the key database file. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
Deprecated: This field is deprecated and replaced by "sslClientKeystashSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
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. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
Deprecated: This field is deprecated and replaced by "sslClientKeystoredbSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
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. It is not included in GET responses if the
view=COMPACTquery parameter is specified. - 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- ssl_
key_ stringpassword (Updatable) Password for the certificate private key inside the client key store.
- SPARK: Applicable when
securityProtocolis TLS and a client key store is provided. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY: Provide it when the private-key password differs from the key store password.
Deprecated: This field is deprecated and replaced by "sslKeyPasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- SPARK: Applicable when
- ssl_
key_ stringpassword_ secret_ id (Updatable) Secret OCID containing the certificate private-key password inside the client key store.
- SPARK: Applicable when
securityProtocolis TLS and a client key store is provided. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY: Provide it when the private-key password differs from the key store password.
When provided,
sslKeyPasswordmust not be provided.- SPARK: Applicable when
- 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. It is not included in GET responses if the
view=COMPACTquery parameter is specified. - state string
- Possible lifecycle states for connection.
- storage object
- (Updatable) The information about a new storage of given type used in an Iceberg 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.
- submit_
mode string - (Updatable) Selects the submission channel. SUBMIT uses the Spark master RPC endpoint. REST uses the Spark standalone REST submission gateway.
- subnet_
id string - (Updatable) The OCID of the target subnet of the dedicated connection.
- subscription_
id string - The OCID of the subscription with which resource needs to be associated with.
- 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 - Technology type selected for the connection.
- AI_MODEL: AI Model technology type.
- AI_PROVIDER: AI Provider technology type.
- DATABRICKS_ENGINE: Databricks Engine technology type.
- ICEBERG: Iceberg technology type. APACHE_ICEBERG supports all catalog types; AMAZON_S3_TABLES supports only REST catalog and S3 storage.
- KAFKA_SCHEMA_REGISTRY: Kafka Schema Registry technology type.
- ORACLE_AI_DATA_PLATFORM_ENGINE: Oracle AI Data Platform Engine technology type.
- SPARK: Spark 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). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- tls_
certificate_ stringkey_ file_ password - (Updatable) Client Certificate key file password. Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFilePasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- tls_
protocol string - (Updatable) TLS protocol negotiated by the Spark client. Applicable when securityProtocol is TLS. Defaults to TLS_V1_3 when not provided. Must be supported by the target cluster.
- trigger_
refresh bool - trust_
store string (Updatable) Base64-encoded trust store content.
- SPARK: Trust store used to validate the Spark server certificate when
securityProtocolis TLS. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY, REDIS: TrustStore file used by the target connection.
Deprecated: This field is deprecated and replaced by "trustStoreSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- SPARK: Trust store used to validate the Spark server certificate when
- trust_
store_ stringpassword (Updatable) Password for
trustStore. For SPARK, it is required when a trust store is supplied.Deprecated: This field is deprecated and replaced by "trustStorePasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- trust_
store_ stringpassword_ secret_ id - (Updatable) Secret OCID containing the trust store password. For SPARK, it is required when
trustStoreSecretIdis supplied. When provided,trustStorePasswordmust not be provided. - trust_
store_ stringsecret_ id - (Updatable) Secret OCID containing the trust store content. For SPARK, it applies when
securityProtocolis TLS. When provided,trustStoremust not be provided. - trust_
store_ stringtype - (Updatable) Trust store format used by the Spark client. Applicable when securityProtocol is TLS and a trust store is provided. Defaults to JKS when not provided. Provide this only when a trust store is provided.
- url string
- (Updatable) Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'
- user_
id string - (Updatable)
- OCI_OBJECT_STORAGE, ORACLE_AI_DATA_PLATFORM: The OCID of the Oracle Cloud Infrastructure user who accesses Object Storage. The user must have write access to the bucket. If omitted, the service defaults to the user calling the API.
- ORACLE_NOSQL: The OCID of the Oracle Cloud Infrastructure user who accesses the Oracle NoSQL database. The user must have write access to the table. If omitted, the service defaults to the user calling the API.
- 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) References the Oracle Cloud Infrastructure Vault that contains the customer-managed encryption key identified by
keyId.Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example,
passwordSecretId) instead of plain-text attributes encrypted withvaultIdandkeyId. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGateThis field is applicable only when
doesUseSecretIdsis set tofalse. IfvaultIdis provided,keyIdmust also be provided.- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- workspace_
url string (Updatable)
- DATABRICKS_ENGINE: Databricks workspace base URL for the REST API, for example
https://<workspace>.cloud.databricks.com/api/2.0/. - ORACLE_AI_DATA_PLATFORM_ENGINE: Oracle AI Data Platform workspace URL.
** 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
- DATABRICKS_ENGINE: Databricks workspace base URL for the REST API, for example
- access
Key StringId (Updatable)
- AMAZON_KINESIS: Access key ID used to access Amazon Kinesis.
- AMAZON_S3: Access key ID used to access the Amazon S3 bucket.
Note: Despite the "Id" suffix, this value is not an Oracle Cloud Infrastructure OCID.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- artifact
Location ConnectionArtifact Location - (Updatable) Location used to share engine application artifacts.
- DATABRICKS_ENGINE: Location used to share Databricks application artifacts.
- SPARK: Location used to share Spark application artifacts with a remote cluster.
- auth
Details ConnectionAuth Details - (Updatable) Authentication details for an AI Model or AI Provider connection.
- auth
Secret String (Updatable) The shared secret used for Spark authentication. Applicable when authenticationType is SHARED_SECRET.
Deprecated: This field is deprecated and replaced by "authSecretSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- auth
Secret StringSecret Id - (Updatable) The OCID of the Secret that stores the Spark authentication shared secret. Applicable when authenticationType is SHARED_SECRET. Note: When provided, 'authSecret' field must not be provided.
- auth
Token String - (Updatable) Personal access token used to connect to the Databricks Engine REST API. Only applicable for authenticationType == PERSONAL_ACCESS_TOKEN. Deprecated: This field is deprecated and replaced by "authTokenSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- auth
Token StringSecret Id - (Updatable) The OCID of the Secret where the personal access token is stored. Only applicable for authenticationType == PERSONAL_ACCESS_TOKEN. Note: When provided, 'authToken' field must not be provided.
- 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 mechanism; supported values depend on
connectionType.- DATABRICKS: Use PERSONAL_ACCESS_TOKEN or OAUTH_M2M.
- DATABRICKS_ENGINE: Use PERSONAL_ACCESS_TOKEN or OAUTH_M2M for the Databricks Engine REST API.
- JAVA_MESSAGE_SERVICE: Authentication type for Java Message Service. The default is NONE.
- SPARK: Use SHARED_SECRET only when the target cluster has
spark.authenticate=true. AES_RPC and SASL_ENCRYPTED require SHARED_SECRET. - AZURE_DATA_LAKE_STORAGE, ELASTICSEARCH, KAFKA_SCHEMA_REGISTRY, REDIS, SNOWFLAKE: Use the authentication type supported by the target service.
- String
- (Updatable) The endpoint used for authentication with Microsoft Entra ID (formerly Azure Active Directory). Default value: https://login.microsoftonline.com When connecting to a non-public Azure Cloud, the endpoint must be provided, eg:
- Azure China: https://login.chinacloudapi.cn/
- Azure US Government: https://login.microsoftonline.us/
- 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" - catalog
Connection
Catalog - (Updatable) The information about a new catalog of given type used in an Iceberg connection.
- client
Id String - (Updatable)
- AZURE_DATA_LAKE_STORAGE: Azure application client ID, required for AZURE_ACTIVE_DIRECTORY authentication.
- DATABRICKS, DATABRICKS_ENGINE: OAuth client ID, applicable to OAUTH_M2M authentication.
- MICROSOFT_FABRIC: Azure application client ID.
- client
Secret String - (Updatable) Plaintext client secret for the selected connection type. For DATABRICKS and DATABRICKS_ENGINE it applies to OAUTH_M2M authentication. Deprecated: use
clientSecretSecretId. - client
Secret StringSecret Id - (Updatable) Secret OCID containing the client secret. For DATABRICKS and DATABRICKS_ENGINE it applies to OAUTH_M2M authentication. When provided,
clientSecretmust not be provided. - cluster
Endpoint String - (Updatable) Spark master URL used for job submission. Required for both submitMode SUBMIT and REST. e.g.: 'spark://spark-master.example.com:7077' High availability can be configured with a comma-separated list, for example: 'spark://h1.example.com:7077,h2.example.com:7077'
- cluster
Id String - (Updatable) The OCID of the Kafka cluster being referenced from Oracle Cloud Infrastructure Streaming with Apache Kafka.
- cluster
Placement StringGroup Id - The OCID(https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cluster placement group for the resource. Only applicable for multicloud subscriptions. The cluster placement group id must be provided when a multicloud subscription id is provided. Otherwise the cluster placement group 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) JDBC connection string. e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'
- connection
Type String - (Updatable) The connection type.
- connection
Url String - (Updatable)
- AMAZON_REDSHIFT: JDBC connection URL. e.g.:
jdbc:redshift://aws-redshift-instance.aaaaaaaaaaaa.us-east-2.redshift.amazonaws.com:5439/mydb - DATABRICKS: JDBC 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 - JAVA_MESSAGE_SERVICE: Connection URL specifying the protocol, host, and port. e.g.:
mq://myjms.host.domain:7676 - ORACLE_AI_DATA_PLATFORM: Connection URL beginning with
jdbc:spark://. - SNOWFLAKE: JDBC connection URL. e.g.:
jdbc:snowflake://<account_name>.snowflakecomputing.com/?warehouse=<warehouse-name>&db=<db-name>
- AMAZON_REDSHIFT: JDBC connection URL. e.g.:
- 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). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - 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.
Deprecated: This field is deprecated. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example,
passwordSecretId) instead of plain-text attributes. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGateWhen set to
true, all sensitive information must be provided as Oracle Cloud Infrastructure Vault secrets using the corresponding*SecretIdattributes of the connection (for example,passwordSecretId). Plain-text sensitive attributes (for example,password) must not be used. This ensures that sensitive information remains stored and managed in the customer's Oracle Cloud Infrastructure Vault rather than by the GoldenGate service.When set to false, sensitive information must be provided in the corresponding plain-text attributes (for example,
password) rather than in secret OCID attributes. In this mode, the sensitive information is stored by the GoldenGate service. IfvaultIdandkeyIdare not specified, the GoldenGate service uses Oracle-managed encryption keys to encrypt the stored data.If
vaultIdandkeyIdare provided, the specified customer-managed key is used.- endpoint String
- (Updatable)
- AMAZON_KINESIS: The endpoint URL of the Amazon Kinesis service. e.g.: 'https://kinesis.us-east-1.amazonaws.com' If not provided, GoldenGate will default to 'https://kinesis..amazonaws.com'.
- AMAZON_S3: The Amazon Endpoint for S3. e.g.: 'https://my-bucket.s3.us-east-1.amazonaws.com' If not provided, GoldenGate will default to 'https://s3..amazonaws.com'.
- AZURE_DATA_LAKE_STORAGE: Azure Storage service endpoint. e.g: https://test.blob.core.windows.net
- GOOGLE_BIGQUERY: A legal URL to connect to BigQuery including scheme, server name and port, if not the default port. Default: https://bigquery.googleapis.com
- GOOGLE_CLOUD_STORAGE: A legal URL to connect to Google Cloud Storage including scheme, server name and port, if not the default port. Default: https://storage.googleapis.com
- MICROSOFT_FABRIC: 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) 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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) References the Oracle Cloud Infrastructure Vault key in the Oracle Cloud Infrastructure Vault identified by
vaultId.Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example,
passwordSecretId) instead of plain-text attributes encrypted withvaultIdandkeyId. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGateThe GoldenGate service uses this key to encrypt sensitive information (for example,
password) that is provided in plain-text connection attributes through the API. This field is applicable only whendoesUseSecretIdsis set tofalse. If bothvaultIdandkeyIdare provided, the GoldenGate service uses the specified customer-managed key to encrypt the sensitive data. If neithervaultIdnorkeyIdis provided, the GoldenGate service uses Oracle-managed encryption keys.- key
Store String (Updatable) Base64-encoded key store content.
- SPARK: Client key store used for mutual TLS when
securityProtocolis TLS. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY, REDIS: KeyStore file used by the target connection.
Deprecated: This field is deprecated and replaced by "keyStoreSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- SPARK: Client key store used for mutual TLS when
- key
Store StringPassword (Updatable) Password for
keyStore. For SPARK, it is required when a client key store is supplied.Deprecated: This field is deprecated and replaced by "keyStorePasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- key
Store StringPassword Secret Id - (Updatable) Secret OCID containing the key store password. For SPARK, it is required when
keyStoreSecretIdis supplied. When provided,keyStorePasswordmust not be provided. - key
Store StringSecret Id - (Updatable) Secret OCID containing the key store content. For SPARK, it applies when
securityProtocolis TLS. When provided,keyStoremust not be provided. - key
Store StringType - (Updatable) Client key store format used for mutual TLS. Applicable when securityProtocol is TLS and a client key store is provided. Defaults to JKS when not provided. Provide this only when a client key store is 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.
- max
Input IntegerChars - (Updatable) Maximum number of input characters supported by this AI model connection.
- model
Key String - (Updatable) AI model identifier.
- 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 to Snowflake platform. Deprecated: This field is deprecated and replaced by "passwordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate Snowflake is phasing out password authentication for legacy service users. Oracle GoldenGate Snowflake connections will support only key-pair authentication. See the Snowflake documentation for details: https://docs.snowflake.com/en/user-guide/security-mfa-rollout
- 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 - This property is not available when creating connections. For existing deprecated connections having this value set, the value cannot be updated; set it to empty.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- provider
Id String - Optional identifier of the AI Provider Connection backing this AI Model Connection. When provided, it must reference an existing Active connection of type
AI_PROVIDER. WhenproviderIdis set,providerTypeandauthDetailsmust not be provided on the AI Model Connection, because provider metadata is resolved from the referenced AI Provider Connection. WhenproviderIdis not set, the AI Model Connection must provide inline provider metadata usingproviderTypeandauthDetails. - provider
Type String - AI Provider type used by the AI Model Connection.
- 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 AWS region where the bucket is created. If not provided, GoldenGate will default to 'us-west-2'. Note: this property will become mandatory after May 20, 2026.
- rest
Auth StringSecret Key (Updatable) The BASE64URL-encoded HMAC secret key used to sign REST submission requests when the Spark master's REST endpoint is protected by the JWS filter. Applicable only when submitMode is REST and the cluster enforces REST request signing. This setting is independent of authenticationType.
Deprecated: This field is deprecated and replaced by "restAuthSecretKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- rest
Auth StringSecret Key Secret Id - (Updatable) The OCID of the Secret that stores the REST submission signing key. Applicable only when submitMode is REST and the cluster enforces REST request signing. This setting is independent of authenticationType. Note: When provided, 'restAuthSecretKey' field must not be provided.
- rest
Endpoint String - (Updatable) Spark standalone REST submission base URL. e.g.: 'https://spark-master.example.com:6066' Applicable only and required when submitMode is REST.
- routing
Method String (Updatable) Controls the network traffic direction to the target: 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. SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
Deprecated: SHARED_SERVICE_ENDPOINT is deprecated. Use another supported routingMethod value, or update existing connections to use a supported routing method. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- rpc
Cipher String - (Updatable) Cipher transform used for Spark RPC encryption. Applicable when securityProtocol is AES_RPC. Defaults to AES_CTR_NOPADDING when not provided.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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
Attributes Map<String,String> - (Updatable) Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}} - security
Protocol String - (Updatable) Security protocol; supported values depend on
connectionType.- SPARK: PLAINTEXT, TLS, AES_RPC, or SASL_ENCRYPTED. AES_RPC and SASL_ENCRYPTED require SHARED_SECRET authentication.
- DB2, ELASTICSEARCH, JAVA_MESSAGE_SERVICE, KAFKA, MICROSOFT_SQLSERVER, MONGODB, MYSQL, POSTGRESQL, REDIS: Use the protocol supported by the target service.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- service
Account StringKey File Secret Id - (Updatable) The OCID of the Secret where the content of the service account key file is stored, which contains the credentials required to use Google Cloud Storage. Note: When provided, 'serviceAccountKeyFile' field must not be provided.
- session
Mode String (Updatable) Specifies the session mode for the database connection. Use REDIRECT only for RAC databases with SCAN listeners that return IP addresses. For RAC databases with SCAN listeners that return FQDNs, and for all other Oracle database technologies, use DIRECT. In RAC deployments, SCAN listeners redirects a connection to a specific database node, identified by either IP address or FQDN. It is recommended to configure RAC with FQDN-based SCAN listeners.
The default is DIRECT, except when databaseId is provided and the discovered database relies on the SCAN listener. In this case, the default is REDIRECT.
Deprecated: Defaulting to the REDIRECT session mode will be removed after April 21, 2027.
- should
Use BooleanJndi - (Updatable) If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.
- should
Use BooleanResource Principal - (Updatable)
- KAFKA: Specifies that the user intends to authenticate to the instance using a resource principal. Applicable only for Oracle Cloud Infrastructure Streaming connections. Only available from 23.9.0.0.0 GoldenGate versions. Note: When specified, 'username'/'password'/'passwordSecretId' fields must not be provided. Default: false
- OCI_OBJECT_STORAGE, ORACLE_AI_DATA_PLATFORM, ORACLE_NOSQL: Specifies that the user intends to authenticate to the instance using a resource principal. Default: false
- 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)
- MICROSOFT_SQLSERVER: Database Certificate - The base64 encoded content of a .pem or .crt file containing the server public key (for 1-way SSL).
- MYSQL: Database Certificate - The base64 encoded content of a .pem or .crt file containing the server public key (for 1 and 2-way SSL). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - POSTGRESQL: The base64 encoded certificate of the trusted certificate authorities (Trusted CA) for PostgreSQL. The supported file formats are .pem and .crt. It is not included in GET responses if the
view=COMPACTquery parameter is specified.
- ssl
Cert String - (Updatable)
- MYSQL: Client Certificate - The base64 encoded content of a .pem or .crt file containing the client public key (for 2-way SSL). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - POSTGRESQL: The base64 encoded certificate of the PostgreSQL server. The supported file formats are .pem and .crt. It is not included in GET responses if the
view=COMPACTquery parameter is specified.
- MYSQL: Client Certificate - The base64 encoded content of a .pem or .crt file containing the client public key (for 2-way SSL). It is not included in GET responses if the
- ssl
Client StringKeystash (Updatable) The base64 encoded keystash file which contains the encrypted password to the key database file. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
Deprecated: This field is deprecated and replaced by "sslClientKeystashSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
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. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
Deprecated: This field is deprecated and replaced by "sslClientKeystoredbSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
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. It is not included in GET responses if the
view=COMPACTquery parameter is specified. - 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- ssl
Key StringPassword (Updatable) Password for the certificate private key inside the client key store.
- SPARK: Applicable when
securityProtocolis TLS and a client key store is provided. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY: Provide it when the private-key password differs from the key store password.
Deprecated: This field is deprecated and replaced by "sslKeyPasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- SPARK: Applicable when
- ssl
Key StringPassword Secret Id (Updatable) Secret OCID containing the certificate private-key password inside the client key store.
- SPARK: Applicable when
securityProtocolis TLS and a client key store is provided. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY: Provide it when the private-key password differs from the key store password.
When provided,
sslKeyPasswordmust not be provided.- SPARK: Applicable when
- 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. It is not included in GET responses if the
view=COMPACTquery parameter is specified. - state String
- Possible lifecycle states for connection.
- storage
Connection
Storage - (Updatable) The information about a new storage of given type used in an Iceberg 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.
- submit
Mode String - (Updatable) Selects the submission channel. SUBMIT uses the Spark master RPC endpoint. REST uses the Spark standalone REST submission gateway.
- subnet
Id String - (Updatable) The OCID of the target subnet of the dedicated connection.
- subscription
Id String - The OCID of the subscription with which resource needs to be associated with.
- 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 - Technology type selected for the connection.
- AI_MODEL: AI Model technology type.
- AI_PROVIDER: AI Provider technology type.
- DATABRICKS_ENGINE: Databricks Engine technology type.
- ICEBERG: Iceberg technology type. APACHE_ICEBERG supports all catalog types; AMAZON_S3_TABLES supports only REST catalog and S3 storage.
- KAFKA_SCHEMA_REGISTRY: Kafka Schema Registry technology type.
- ORACLE_AI_DATA_PLATFORM_ENGINE: Oracle AI Data Platform Engine technology type.
- SPARK: Spark 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). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- tls
Certificate StringKey File Password - (Updatable) Client Certificate key file password. Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFilePasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- tls
Protocol String - (Updatable) TLS protocol negotiated by the Spark client. Applicable when securityProtocol is TLS. Defaults to TLS_V1_3 when not provided. Must be supported by the target cluster.
- trigger
Refresh Boolean - trust
Store String (Updatable) Base64-encoded trust store content.
- SPARK: Trust store used to validate the Spark server certificate when
securityProtocolis TLS. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY, REDIS: TrustStore file used by the target connection.
Deprecated: This field is deprecated and replaced by "trustStoreSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- SPARK: Trust store used to validate the Spark server certificate when
- trust
Store StringPassword (Updatable) Password for
trustStore. For SPARK, it is required when a trust store is supplied.Deprecated: This field is deprecated and replaced by "trustStorePasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- trust
Store StringPassword Secret Id - (Updatable) Secret OCID containing the trust store password. For SPARK, it is required when
trustStoreSecretIdis supplied. When provided,trustStorePasswordmust not be provided. - trust
Store StringSecret Id - (Updatable) Secret OCID containing the trust store content. For SPARK, it applies when
securityProtocolis TLS. When provided,trustStoremust not be provided. - trust
Store StringType - (Updatable) Trust store format used by the Spark client. Applicable when securityProtocol is TLS and a trust store is provided. Defaults to JKS when not provided. Provide this only when a trust store is provided.
- url String
- (Updatable) Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'
- user
Id String - (Updatable)
- OCI_OBJECT_STORAGE, ORACLE_AI_DATA_PLATFORM: The OCID of the Oracle Cloud Infrastructure user who accesses Object Storage. The user must have write access to the bucket. If omitted, the service defaults to the user calling the API.
- ORACLE_NOSQL: The OCID of the Oracle Cloud Infrastructure user who accesses the Oracle NoSQL database. The user must have write access to the table. If omitted, the service defaults to the user calling the API.
- 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) References the Oracle Cloud Infrastructure Vault that contains the customer-managed encryption key identified by
keyId.Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example,
passwordSecretId) instead of plain-text attributes encrypted withvaultIdandkeyId. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGateThis field is applicable only when
doesUseSecretIdsis set tofalse. IfvaultIdis provided,keyIdmust also be provided.- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- workspace
Url String (Updatable)
- DATABRICKS_ENGINE: Databricks workspace base URL for the REST API, for example
https://<workspace>.cloud.databricks.com/api/2.0/. - ORACLE_AI_DATA_PLATFORM_ENGINE: Oracle AI Data Platform workspace URL.
** 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
- DATABRICKS_ENGINE: Databricks workspace base URL for the REST API, for example
- access
Key stringId (Updatable)
- AMAZON_KINESIS: Access key ID used to access Amazon Kinesis.
- AMAZON_S3: Access key ID used to access the Amazon S3 bucket.
Note: Despite the "Id" suffix, this value is not an Oracle Cloud Infrastructure OCID.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- artifact
Location ConnectionArtifact Location - (Updatable) Location used to share engine application artifacts.
- DATABRICKS_ENGINE: Location used to share Databricks application artifacts.
- SPARK: Location used to share Spark application artifacts with a remote cluster.
- auth
Details ConnectionAuth Details - (Updatable) Authentication details for an AI Model or AI Provider connection.
- auth
Secret string (Updatable) The shared secret used for Spark authentication. Applicable when authenticationType is SHARED_SECRET.
Deprecated: This field is deprecated and replaced by "authSecretSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- auth
Secret stringSecret Id - (Updatable) The OCID of the Secret that stores the Spark authentication shared secret. Applicable when authenticationType is SHARED_SECRET. Note: When provided, 'authSecret' field must not be provided.
- auth
Token string - (Updatable) Personal access token used to connect to the Databricks Engine REST API. Only applicable for authenticationType == PERSONAL_ACCESS_TOKEN. Deprecated: This field is deprecated and replaced by "authTokenSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- auth
Token stringSecret Id - (Updatable) The OCID of the Secret where the personal access token is stored. Only applicable for authenticationType == PERSONAL_ACCESS_TOKEN. Note: When provided, 'authToken' field must not be provided.
- 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 mechanism; supported values depend on
connectionType.- DATABRICKS: Use PERSONAL_ACCESS_TOKEN or OAUTH_M2M.
- DATABRICKS_ENGINE: Use PERSONAL_ACCESS_TOKEN or OAUTH_M2M for the Databricks Engine REST API.
- JAVA_MESSAGE_SERVICE: Authentication type for Java Message Service. The default is NONE.
- SPARK: Use SHARED_SECRET only when the target cluster has
spark.authenticate=true. AES_RPC and SASL_ENCRYPTED require SHARED_SECRET. - AZURE_DATA_LAKE_STORAGE, ELASTICSEARCH, KAFKA_SCHEMA_REGISTRY, REDIS, SNOWFLAKE: Use the authentication type supported by the target service.
- string
- (Updatable) The endpoint used for authentication with Microsoft Entra ID (formerly Azure Active Directory). Default value: https://login.microsoftonline.com When connecting to a non-public Azure Cloud, the endpoint must be provided, eg:
- Azure China: https://login.chinacloudapi.cn/
- Azure US Government: https://login.microsoftonline.us/
- 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" - catalog
Connection
Catalog - (Updatable) The information about a new catalog of given type used in an Iceberg connection.
- client
Id string - (Updatable)
- AZURE_DATA_LAKE_STORAGE: Azure application client ID, required for AZURE_ACTIVE_DIRECTORY authentication.
- DATABRICKS, DATABRICKS_ENGINE: OAuth client ID, applicable to OAUTH_M2M authentication.
- MICROSOFT_FABRIC: Azure application client ID.
- client
Secret string - (Updatable) Plaintext client secret for the selected connection type. For DATABRICKS and DATABRICKS_ENGINE it applies to OAUTH_M2M authentication. Deprecated: use
clientSecretSecretId. - client
Secret stringSecret Id - (Updatable) Secret OCID containing the client secret. For DATABRICKS and DATABRICKS_ENGINE it applies to OAUTH_M2M authentication. When provided,
clientSecretmust not be provided. - cluster
Endpoint string - (Updatable) Spark master URL used for job submission. Required for both submitMode SUBMIT and REST. e.g.: 'spark://spark-master.example.com:7077' High availability can be configured with a comma-separated list, for example: 'spark://h1.example.com:7077,h2.example.com:7077'
- cluster
Id string - (Updatable) The OCID of the Kafka cluster being referenced from Oracle Cloud Infrastructure Streaming with Apache Kafka.
- cluster
Placement stringGroup Id - The OCID(https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cluster placement group for the resource. Only applicable for multicloud subscriptions. The cluster placement group id must be provided when a multicloud subscription id is provided. Otherwise the cluster placement group 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) JDBC connection string. e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'
- connection
Type string - (Updatable) The connection type.
- connection
Url string - (Updatable)
- AMAZON_REDSHIFT: JDBC connection URL. e.g.:
jdbc:redshift://aws-redshift-instance.aaaaaaaaaaaa.us-east-2.redshift.amazonaws.com:5439/mydb - DATABRICKS: JDBC 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 - JAVA_MESSAGE_SERVICE: Connection URL specifying the protocol, host, and port. e.g.:
mq://myjms.host.domain:7676 - ORACLE_AI_DATA_PLATFORM: Connection URL beginning with
jdbc:spark://. - SNOWFLAKE: JDBC connection URL. e.g.:
jdbc:snowflake://<account_name>.snowflakecomputing.com/?warehouse=<warehouse-name>&db=<db-name>
- AMAZON_REDSHIFT: JDBC connection URL. e.g.:
- 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). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - 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.
Deprecated: This field is deprecated. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example,
passwordSecretId) instead of plain-text attributes. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGateWhen set to
true, all sensitive information must be provided as Oracle Cloud Infrastructure Vault secrets using the corresponding*SecretIdattributes of the connection (for example,passwordSecretId). Plain-text sensitive attributes (for example,password) must not be used. This ensures that sensitive information remains stored and managed in the customer's Oracle Cloud Infrastructure Vault rather than by the GoldenGate service.When set to false, sensitive information must be provided in the corresponding plain-text attributes (for example,
password) rather than in secret OCID attributes. In this mode, the sensitive information is stored by the GoldenGate service. IfvaultIdandkeyIdare not specified, the GoldenGate service uses Oracle-managed encryption keys to encrypt the stored data.If
vaultIdandkeyIdare provided, the specified customer-managed key is used.- endpoint string
- (Updatable)
- AMAZON_KINESIS: The endpoint URL of the Amazon Kinesis service. e.g.: 'https://kinesis.us-east-1.amazonaws.com' If not provided, GoldenGate will default to 'https://kinesis..amazonaws.com'.
- AMAZON_S3: The Amazon Endpoint for S3. e.g.: 'https://my-bucket.s3.us-east-1.amazonaws.com' If not provided, GoldenGate will default to 'https://s3..amazonaws.com'.
- AZURE_DATA_LAKE_STORAGE: Azure Storage service endpoint. e.g: https://test.blob.core.windows.net
- GOOGLE_BIGQUERY: A legal URL to connect to BigQuery including scheme, server name and port, if not the default port. Default: https://bigquery.googleapis.com
- GOOGLE_CLOUD_STORAGE: A legal URL to connect to Google Cloud Storage including scheme, server name and port, if not the default port. Default: https://storage.googleapis.com
- MICROSOFT_FABRIC: 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) 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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) References the Oracle Cloud Infrastructure Vault key in the Oracle Cloud Infrastructure Vault identified by
vaultId.Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example,
passwordSecretId) instead of plain-text attributes encrypted withvaultIdandkeyId. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGateThe GoldenGate service uses this key to encrypt sensitive information (for example,
password) that is provided in plain-text connection attributes through the API. This field is applicable only whendoesUseSecretIdsis set tofalse. If bothvaultIdandkeyIdare provided, the GoldenGate service uses the specified customer-managed key to encrypt the sensitive data. If neithervaultIdnorkeyIdis provided, the GoldenGate service uses Oracle-managed encryption keys.- key
Store string (Updatable) Base64-encoded key store content.
- SPARK: Client key store used for mutual TLS when
securityProtocolis TLS. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY, REDIS: KeyStore file used by the target connection.
Deprecated: This field is deprecated and replaced by "keyStoreSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- SPARK: Client key store used for mutual TLS when
- key
Store stringPassword (Updatable) Password for
keyStore. For SPARK, it is required when a client key store is supplied.Deprecated: This field is deprecated and replaced by "keyStorePasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- key
Store stringPassword Secret Id - (Updatable) Secret OCID containing the key store password. For SPARK, it is required when
keyStoreSecretIdis supplied. When provided,keyStorePasswordmust not be provided. - key
Store stringSecret Id - (Updatable) Secret OCID containing the key store content. For SPARK, it applies when
securityProtocolis TLS. When provided,keyStoremust not be provided. - key
Store stringType - (Updatable) Client key store format used for mutual TLS. Applicable when securityProtocol is TLS and a client key store is provided. Defaults to JKS when not provided. Provide this only when a client key store is 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.
- max
Input numberChars - (Updatable) Maximum number of input characters supported by this AI model connection.
- model
Key string - (Updatable) AI model identifier.
- 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 to Snowflake platform. Deprecated: This field is deprecated and replaced by "passwordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate Snowflake is phasing out password authentication for legacy service users. Oracle GoldenGate Snowflake connections will support only key-pair authentication. See the Snowflake documentation for details: https://docs.snowflake.com/en/user-guide/security-mfa-rollout
- 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 - This property is not available when creating connections. For existing deprecated connections having this value set, the value cannot be updated; set it to empty.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- provider
Id string - Optional identifier of the AI Provider Connection backing this AI Model Connection. When provided, it must reference an existing Active connection of type
AI_PROVIDER. WhenproviderIdis set,providerTypeandauthDetailsmust not be provided on the AI Model Connection, because provider metadata is resolved from the referenced AI Provider Connection. WhenproviderIdis not set, the AI Model Connection must provide inline provider metadata usingproviderTypeandauthDetails. - provider
Type string - AI Provider type used by the AI Model Connection.
- 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 AWS region where the bucket is created. If not provided, GoldenGate will default to 'us-west-2'. Note: this property will become mandatory after May 20, 2026.
- rest
Auth stringSecret Key (Updatable) The BASE64URL-encoded HMAC secret key used to sign REST submission requests when the Spark master's REST endpoint is protected by the JWS filter. Applicable only when submitMode is REST and the cluster enforces REST request signing. This setting is independent of authenticationType.
Deprecated: This field is deprecated and replaced by "restAuthSecretKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- rest
Auth stringSecret Key Secret Id - (Updatable) The OCID of the Secret that stores the REST submission signing key. Applicable only when submitMode is REST and the cluster enforces REST request signing. This setting is independent of authenticationType. Note: When provided, 'restAuthSecretKey' field must not be provided.
- rest
Endpoint string - (Updatable) Spark standalone REST submission base URL. e.g.: 'https://spark-master.example.com:6066' Applicable only and required when submitMode is REST.
- routing
Method string (Updatable) Controls the network traffic direction to the target: 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. SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
Deprecated: SHARED_SERVICE_ENDPOINT is deprecated. Use another supported routingMethod value, or update existing connections to use a supported routing method. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- rpc
Cipher string - (Updatable) Cipher transform used for Spark RPC encryption. Applicable when securityProtocol is AES_RPC. Defaults to AES_CTR_NOPADDING when not provided.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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
Attributes {[key: string]: string} - (Updatable) Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}} - security
Protocol string - (Updatable) Security protocol; supported values depend on
connectionType.- SPARK: PLAINTEXT, TLS, AES_RPC, or SASL_ENCRYPTED. AES_RPC and SASL_ENCRYPTED require SHARED_SECRET authentication.
- DB2, ELASTICSEARCH, JAVA_MESSAGE_SERVICE, KAFKA, MICROSOFT_SQLSERVER, MONGODB, MYSQL, POSTGRESQL, REDIS: Use the protocol supported by the target service.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- service
Account stringKey File Secret Id - (Updatable) The OCID of the Secret where the content of the service account key file is stored, which contains the credentials required to use Google Cloud Storage. Note: When provided, 'serviceAccountKeyFile' field must not be provided.
- session
Mode string (Updatable) Specifies the session mode for the database connection. Use REDIRECT only for RAC databases with SCAN listeners that return IP addresses. For RAC databases with SCAN listeners that return FQDNs, and for all other Oracle database technologies, use DIRECT. In RAC deployments, SCAN listeners redirects a connection to a specific database node, identified by either IP address or FQDN. It is recommended to configure RAC with FQDN-based SCAN listeners.
The default is DIRECT, except when databaseId is provided and the discovered database relies on the SCAN listener. In this case, the default is REDIRECT.
Deprecated: Defaulting to the REDIRECT session mode will be removed after April 21, 2027.
- should
Use booleanJndi - (Updatable) If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.
- should
Use booleanResource Principal - (Updatable)
- KAFKA: Specifies that the user intends to authenticate to the instance using a resource principal. Applicable only for Oracle Cloud Infrastructure Streaming connections. Only available from 23.9.0.0.0 GoldenGate versions. Note: When specified, 'username'/'password'/'passwordSecretId' fields must not be provided. Default: false
- OCI_OBJECT_STORAGE, ORACLE_AI_DATA_PLATFORM, ORACLE_NOSQL: Specifies that the user intends to authenticate to the instance using a resource principal. Default: false
- 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)
- MICROSOFT_SQLSERVER: Database Certificate - The base64 encoded content of a .pem or .crt file containing the server public key (for 1-way SSL).
- MYSQL: Database Certificate - The base64 encoded content of a .pem or .crt file containing the server public key (for 1 and 2-way SSL). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - POSTGRESQL: The base64 encoded certificate of the trusted certificate authorities (Trusted CA) for PostgreSQL. The supported file formats are .pem and .crt. It is not included in GET responses if the
view=COMPACTquery parameter is specified.
- ssl
Cert string - (Updatable)
- MYSQL: Client Certificate - The base64 encoded content of a .pem or .crt file containing the client public key (for 2-way SSL). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - POSTGRESQL: The base64 encoded certificate of the PostgreSQL server. The supported file formats are .pem and .crt. It is not included in GET responses if the
view=COMPACTquery parameter is specified.
- MYSQL: Client Certificate - The base64 encoded content of a .pem or .crt file containing the client public key (for 2-way SSL). It is not included in GET responses if the
- ssl
Client stringKeystash (Updatable) The base64 encoded keystash file which contains the encrypted password to the key database file. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
Deprecated: This field is deprecated and replaced by "sslClientKeystashSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
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. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
Deprecated: This field is deprecated and replaced by "sslClientKeystoredbSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
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. It is not included in GET responses if the
view=COMPACTquery parameter is specified. - 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- ssl
Key stringPassword (Updatable) Password for the certificate private key inside the client key store.
- SPARK: Applicable when
securityProtocolis TLS and a client key store is provided. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY: Provide it when the private-key password differs from the key store password.
Deprecated: This field is deprecated and replaced by "sslKeyPasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- SPARK: Applicable when
- ssl
Key stringPassword Secret Id (Updatable) Secret OCID containing the certificate private-key password inside the client key store.
- SPARK: Applicable when
securityProtocolis TLS and a client key store is provided. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY: Provide it when the private-key password differs from the key store password.
When provided,
sslKeyPasswordmust not be provided.- SPARK: Applicable when
- 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. It is not included in GET responses if the
view=COMPACTquery parameter is specified. - state string
- Possible lifecycle states for connection.
- storage
Connection
Storage - (Updatable) The information about a new storage of given type used in an Iceberg 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.
- submit
Mode string - (Updatable) Selects the submission channel. SUBMIT uses the Spark master RPC endpoint. REST uses the Spark standalone REST submission gateway.
- subnet
Id string - (Updatable) The OCID of the target subnet of the dedicated connection.
- subscription
Id string - The OCID of the subscription with which resource needs to be associated with.
- {[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 - Technology type selected for the connection.
- AI_MODEL: AI Model technology type.
- AI_PROVIDER: AI Provider technology type.
- DATABRICKS_ENGINE: Databricks Engine technology type.
- ICEBERG: Iceberg technology type. APACHE_ICEBERG supports all catalog types; AMAZON_S3_TABLES supports only REST catalog and S3 storage.
- KAFKA_SCHEMA_REGISTRY: Kafka Schema Registry technology type.
- ORACLE_AI_DATA_PLATFORM_ENGINE: Oracle AI Data Platform Engine technology type.
- SPARK: Spark 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). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- tls
Certificate stringKey File Password - (Updatable) Client Certificate key file password. Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFilePasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- tls
Protocol string - (Updatable) TLS protocol negotiated by the Spark client. Applicable when securityProtocol is TLS. Defaults to TLS_V1_3 when not provided. Must be supported by the target cluster.
- trigger
Refresh boolean - trust
Store string (Updatable) Base64-encoded trust store content.
- SPARK: Trust store used to validate the Spark server certificate when
securityProtocolis TLS. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY, REDIS: TrustStore file used by the target connection.
Deprecated: This field is deprecated and replaced by "trustStoreSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- SPARK: Trust store used to validate the Spark server certificate when
- trust
Store stringPassword (Updatable) Password for
trustStore. For SPARK, it is required when a trust store is supplied.Deprecated: This field is deprecated and replaced by "trustStorePasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- trust
Store stringPassword Secret Id - (Updatable) Secret OCID containing the trust store password. For SPARK, it is required when
trustStoreSecretIdis supplied. When provided,trustStorePasswordmust not be provided. - trust
Store stringSecret Id - (Updatable) Secret OCID containing the trust store content. For SPARK, it applies when
securityProtocolis TLS. When provided,trustStoremust not be provided. - trust
Store stringType - (Updatable) Trust store format used by the Spark client. Applicable when securityProtocol is TLS and a trust store is provided. Defaults to JKS when not provided. Provide this only when a trust store is provided.
- url string
- (Updatable) Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'
- user
Id string - (Updatable)
- OCI_OBJECT_STORAGE, ORACLE_AI_DATA_PLATFORM: The OCID of the Oracle Cloud Infrastructure user who accesses Object Storage. The user must have write access to the bucket. If omitted, the service defaults to the user calling the API.
- ORACLE_NOSQL: The OCID of the Oracle Cloud Infrastructure user who accesses the Oracle NoSQL database. The user must have write access to the table. If omitted, the service defaults to the user calling the API.
- 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) References the Oracle Cloud Infrastructure Vault that contains the customer-managed encryption key identified by
keyId.Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example,
passwordSecretId) instead of plain-text attributes encrypted withvaultIdandkeyId. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGateThis field is applicable only when
doesUseSecretIdsis set tofalse. IfvaultIdis provided,keyIdmust also be provided.- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- workspace
Url string (Updatable)
- DATABRICKS_ENGINE: Databricks workspace base URL for the REST API, for example
https://<workspace>.cloud.databricks.com/api/2.0/. - ORACLE_AI_DATA_PLATFORM_ENGINE: Oracle AI Data Platform workspace URL.
** 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
- DATABRICKS_ENGINE: Databricks workspace base URL for the REST API, for example
- access_
key_ strid (Updatable)
- AMAZON_KINESIS: Access key ID used to access Amazon Kinesis.
- AMAZON_S3: Access key ID used to access the Amazon S3 bucket.
Note: Despite the "Id" suffix, this value is not an Oracle Cloud Infrastructure OCID.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- artifact_
location ConnectionArtifact Location Args - (Updatable) Location used to share engine application artifacts.
- DATABRICKS_ENGINE: Location used to share Databricks application artifacts.
- SPARK: Location used to share Spark application artifacts with a remote cluster.
- auth_
details ConnectionAuth Details Args - (Updatable) Authentication details for an AI Model or AI Provider connection.
- auth_
secret str (Updatable) The shared secret used for Spark authentication. Applicable when authenticationType is SHARED_SECRET.
Deprecated: This field is deprecated and replaced by "authSecretSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- auth_
secret_ strsecret_ id - (Updatable) The OCID of the Secret that stores the Spark authentication shared secret. Applicable when authenticationType is SHARED_SECRET. Note: When provided, 'authSecret' field must not be provided.
- auth_
token str - (Updatable) Personal access token used to connect to the Databricks Engine REST API. Only applicable for authenticationType == PERSONAL_ACCESS_TOKEN. Deprecated: This field is deprecated and replaced by "authTokenSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- auth_
token_ strsecret_ id - (Updatable) The OCID of the Secret where the personal access token is stored. Only applicable for authenticationType == PERSONAL_ACCESS_TOKEN. Note: When provided, 'authToken' field must not be provided.
- 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 mechanism; supported values depend on
connectionType.- DATABRICKS: Use PERSONAL_ACCESS_TOKEN or OAUTH_M2M.
- DATABRICKS_ENGINE: Use PERSONAL_ACCESS_TOKEN or OAUTH_M2M for the Databricks Engine REST API.
- JAVA_MESSAGE_SERVICE: Authentication type for Java Message Service. The default is NONE.
- SPARK: Use SHARED_SECRET only when the target cluster has
spark.authenticate=true. AES_RPC and SASL_ENCRYPTED require SHARED_SECRET. - AZURE_DATA_LAKE_STORAGE, ELASTICSEARCH, KAFKA_SCHEMA_REGISTRY, REDIS, SNOWFLAKE: Use the authentication type supported by the target service.
- str
- (Updatable) The endpoint used for authentication with Microsoft Entra ID (formerly Azure Active Directory). Default value: https://login.microsoftonline.com When connecting to a non-public Azure Cloud, the endpoint must be provided, eg:
- Azure China: https://login.chinacloudapi.cn/
- Azure US Government: https://login.microsoftonline.us/
- 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" - catalog
Connection
Catalog Args - (Updatable) The information about a new catalog of given type used in an Iceberg connection.
- client_
id str - (Updatable)
- AZURE_DATA_LAKE_STORAGE: Azure application client ID, required for AZURE_ACTIVE_DIRECTORY authentication.
- DATABRICKS, DATABRICKS_ENGINE: OAuth client ID, applicable to OAUTH_M2M authentication.
- MICROSOFT_FABRIC: Azure application client ID.
- client_
secret str - (Updatable) Plaintext client secret for the selected connection type. For DATABRICKS and DATABRICKS_ENGINE it applies to OAUTH_M2M authentication. Deprecated: use
clientSecretSecretId. - client_
secret_ strsecret_ id - (Updatable) Secret OCID containing the client secret. For DATABRICKS and DATABRICKS_ENGINE it applies to OAUTH_M2M authentication. When provided,
clientSecretmust not be provided. - cluster_
endpoint str - (Updatable) Spark master URL used for job submission. Required for both submitMode SUBMIT and REST. e.g.: 'spark://spark-master.example.com:7077' High availability can be configured with a comma-separated list, for example: 'spark://h1.example.com:7077,h2.example.com:7077'
- cluster_
id str - (Updatable) The OCID of the Kafka cluster being referenced from Oracle Cloud Infrastructure Streaming with Apache Kafka.
- cluster_
placement_ strgroup_ id - The OCID(https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cluster placement group for the resource. Only applicable for multicloud subscriptions. The cluster placement group id must be provided when a multicloud subscription id is provided. Otherwise the cluster placement group 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) JDBC connection string. e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'
- connection_
type str - (Updatable) The connection type.
- connection_
url str - (Updatable)
- AMAZON_REDSHIFT: JDBC connection URL. e.g.:
jdbc:redshift://aws-redshift-instance.aaaaaaaaaaaa.us-east-2.redshift.amazonaws.com:5439/mydb - DATABRICKS: JDBC 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 - JAVA_MESSAGE_SERVICE: Connection URL specifying the protocol, host, and port. e.g.:
mq://myjms.host.domain:7676 - ORACLE_AI_DATA_PLATFORM: Connection URL beginning with
jdbc:spark://. - SNOWFLAKE: JDBC connection URL. e.g.:
jdbc:snowflake://<account_name>.snowflakecomputing.com/?warehouse=<warehouse-name>&db=<db-name>
- AMAZON_REDSHIFT: JDBC connection URL. e.g.:
- 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). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - 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.
Deprecated: This field is deprecated. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example,
passwordSecretId) instead of plain-text attributes. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGateWhen set to
true, all sensitive information must be provided as Oracle Cloud Infrastructure Vault secrets using the corresponding*SecretIdattributes of the connection (for example,passwordSecretId). Plain-text sensitive attributes (for example,password) must not be used. This ensures that sensitive information remains stored and managed in the customer's Oracle Cloud Infrastructure Vault rather than by the GoldenGate service.When set to false, sensitive information must be provided in the corresponding plain-text attributes (for example,
password) rather than in secret OCID attributes. In this mode, the sensitive information is stored by the GoldenGate service. IfvaultIdandkeyIdare not specified, the GoldenGate service uses Oracle-managed encryption keys to encrypt the stored data.If
vaultIdandkeyIdare provided, the specified customer-managed key is used.- endpoint str
- (Updatable)
- AMAZON_KINESIS: The endpoint URL of the Amazon Kinesis service. e.g.: 'https://kinesis.us-east-1.amazonaws.com' If not provided, GoldenGate will default to 'https://kinesis..amazonaws.com'.
- AMAZON_S3: The Amazon Endpoint for S3. e.g.: 'https://my-bucket.s3.us-east-1.amazonaws.com' If not provided, GoldenGate will default to 'https://s3..amazonaws.com'.
- AZURE_DATA_LAKE_STORAGE: Azure Storage service endpoint. e.g: https://test.blob.core.windows.net
- GOOGLE_BIGQUERY: A legal URL to connect to BigQuery including scheme, server name and port, if not the default port. Default: https://bigquery.googleapis.com
- GOOGLE_CLOUD_STORAGE: A legal URL to connect to Google Cloud Storage including scheme, server name and port, if not the default port. Default: https://storage.googleapis.com
- MICROSOFT_FABRIC: 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) 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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) References the Oracle Cloud Infrastructure Vault key in the Oracle Cloud Infrastructure Vault identified by
vaultId.Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example,
passwordSecretId) instead of plain-text attributes encrypted withvaultIdandkeyId. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGateThe GoldenGate service uses this key to encrypt sensitive information (for example,
password) that is provided in plain-text connection attributes through the API. This field is applicable only whendoesUseSecretIdsis set tofalse. If bothvaultIdandkeyIdare provided, the GoldenGate service uses the specified customer-managed key to encrypt the sensitive data. If neithervaultIdnorkeyIdis provided, the GoldenGate service uses Oracle-managed encryption keys.- key_
store str (Updatable) Base64-encoded key store content.
- SPARK: Client key store used for mutual TLS when
securityProtocolis TLS. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY, REDIS: KeyStore file used by the target connection.
Deprecated: This field is deprecated and replaced by "keyStoreSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- SPARK: Client key store used for mutual TLS when
- key_
store_ strpassword (Updatable) Password for
keyStore. For SPARK, it is required when a client key store is supplied.Deprecated: This field is deprecated and replaced by "keyStorePasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- key_
store_ strpassword_ secret_ id - (Updatable) Secret OCID containing the key store password. For SPARK, it is required when
keyStoreSecretIdis supplied. When provided,keyStorePasswordmust not be provided. - key_
store_ strsecret_ id - (Updatable) Secret OCID containing the key store content. For SPARK, it applies when
securityProtocolis TLS. When provided,keyStoremust not be provided. - key_
store_ strtype - (Updatable) Client key store format used for mutual TLS. Applicable when securityProtocol is TLS and a client key store is provided. Defaults to JKS when not provided. Provide this only when a client key store is 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.
- max_
input_ intchars - (Updatable) Maximum number of input characters supported by this AI model connection.
- model_
key str - (Updatable) AI model identifier.
- 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 to Snowflake platform. Deprecated: This field is deprecated and replaced by "passwordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate Snowflake is phasing out password authentication for legacy service users. Oracle GoldenGate Snowflake connections will support only key-pair authentication. See the Snowflake documentation for details: https://docs.snowflake.com/en/user-guide/security-mfa-rollout
- 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 - This property is not available when creating connections. For existing deprecated connections having this value set, the value cannot be updated; set it to empty.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- provider_
id str - Optional identifier of the AI Provider Connection backing this AI Model Connection. When provided, it must reference an existing Active connection of type
AI_PROVIDER. WhenproviderIdis set,providerTypeandauthDetailsmust not be provided on the AI Model Connection, because provider metadata is resolved from the referenced AI Provider Connection. WhenproviderIdis not set, the AI Model Connection must provide inline provider metadata usingproviderTypeandauthDetails. - provider_
type str - AI Provider type used by the AI Model Connection.
- 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 AWS region where the bucket is created. If not provided, GoldenGate will default to 'us-west-2'. Note: this property will become mandatory after May 20, 2026.
- rest_
auth_ strsecret_ key (Updatable) The BASE64URL-encoded HMAC secret key used to sign REST submission requests when the Spark master's REST endpoint is protected by the JWS filter. Applicable only when submitMode is REST and the cluster enforces REST request signing. This setting is independent of authenticationType.
Deprecated: This field is deprecated and replaced by "restAuthSecretKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- rest_
auth_ strsecret_ key_ secret_ id - (Updatable) The OCID of the Secret that stores the REST submission signing key. Applicable only when submitMode is REST and the cluster enforces REST request signing. This setting is independent of authenticationType. Note: When provided, 'restAuthSecretKey' field must not be provided.
- rest_
endpoint str - (Updatable) Spark standalone REST submission base URL. e.g.: 'https://spark-master.example.com:6066' Applicable only and required when submitMode is REST.
- routing_
method str (Updatable) Controls the network traffic direction to the target: 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. SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
Deprecated: SHARED_SERVICE_ENDPOINT is deprecated. Use another supported routingMethod value, or update existing connections to use a supported routing method. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- rpc_
cipher str - (Updatable) Cipher transform used for Spark RPC encryption. Applicable when securityProtocol is AES_RPC. Defaults to AES_CTR_NOPADDING when not provided.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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_
attributes Mapping[str, str] - (Updatable) Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}} - security_
protocol str - (Updatable) Security protocol; supported values depend on
connectionType.- SPARK: PLAINTEXT, TLS, AES_RPC, or SASL_ENCRYPTED. AES_RPC and SASL_ENCRYPTED require SHARED_SECRET authentication.
- DB2, ELASTICSEARCH, JAVA_MESSAGE_SERVICE, KAFKA, MICROSOFT_SQLSERVER, MONGODB, MYSQL, POSTGRESQL, REDIS: Use the protocol supported by the target service.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- service_
account_ strkey_ file_ secret_ id - (Updatable) The OCID of the Secret where the content of the service account key file is stored, which contains the credentials required to use Google Cloud Storage. Note: When provided, 'serviceAccountKeyFile' field must not be provided.
- session_
mode str (Updatable) Specifies the session mode for the database connection. Use REDIRECT only for RAC databases with SCAN listeners that return IP addresses. For RAC databases with SCAN listeners that return FQDNs, and for all other Oracle database technologies, use DIRECT. In RAC deployments, SCAN listeners redirects a connection to a specific database node, identified by either IP address or FQDN. It is recommended to configure RAC with FQDN-based SCAN listeners.
The default is DIRECT, except when databaseId is provided and the discovered database relies on the SCAN listener. In this case, the default is REDIRECT.
Deprecated: Defaulting to the REDIRECT session mode will be removed after April 21, 2027.
- should_
use_ booljndi - (Updatable) If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.
- should_
use_ boolresource_ principal - (Updatable)
- KAFKA: Specifies that the user intends to authenticate to the instance using a resource principal. Applicable only for Oracle Cloud Infrastructure Streaming connections. Only available from 23.9.0.0.0 GoldenGate versions. Note: When specified, 'username'/'password'/'passwordSecretId' fields must not be provided. Default: false
- OCI_OBJECT_STORAGE, ORACLE_AI_DATA_PLATFORM, ORACLE_NOSQL: Specifies that the user intends to authenticate to the instance using a resource principal. Default: false
- 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)
- MICROSOFT_SQLSERVER: Database Certificate - The base64 encoded content of a .pem or .crt file containing the server public key (for 1-way SSL).
- MYSQL: Database Certificate - The base64 encoded content of a .pem or .crt file containing the server public key (for 1 and 2-way SSL). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - POSTGRESQL: The base64 encoded certificate of the trusted certificate authorities (Trusted CA) for PostgreSQL. The supported file formats are .pem and .crt. It is not included in GET responses if the
view=COMPACTquery parameter is specified.
- ssl_
cert str - (Updatable)
- MYSQL: Client Certificate - The base64 encoded content of a .pem or .crt file containing the client public key (for 2-way SSL). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - POSTGRESQL: The base64 encoded certificate of the PostgreSQL server. The supported file formats are .pem and .crt. It is not included in GET responses if the
view=COMPACTquery parameter is specified.
- MYSQL: Client Certificate - The base64 encoded content of a .pem or .crt file containing the client public key (for 2-way SSL). It is not included in GET responses if the
- ssl_
client_ strkeystash (Updatable) The base64 encoded keystash file which contains the encrypted password to the key database file. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
Deprecated: This field is deprecated and replaced by "sslClientKeystashSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
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. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
Deprecated: This field is deprecated and replaced by "sslClientKeystoredbSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
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. It is not included in GET responses if the
view=COMPACTquery parameter is specified. - 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- ssl_
key_ strpassword (Updatable) Password for the certificate private key inside the client key store.
- SPARK: Applicable when
securityProtocolis TLS and a client key store is provided. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY: Provide it when the private-key password differs from the key store password.
Deprecated: This field is deprecated and replaced by "sslKeyPasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- SPARK: Applicable when
- ssl_
key_ strpassword_ secret_ id (Updatable) Secret OCID containing the certificate private-key password inside the client key store.
- SPARK: Applicable when
securityProtocolis TLS and a client key store is provided. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY: Provide it when the private-key password differs from the key store password.
When provided,
sslKeyPasswordmust not be provided.- SPARK: Applicable when
- 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. It is not included in GET responses if the
view=COMPACTquery parameter is specified. - state str
- Possible lifecycle states for connection.
- storage
Connection
Storage Args - (Updatable) The information about a new storage of given type used in an Iceberg 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.
- submit_
mode str - (Updatable) Selects the submission channel. SUBMIT uses the Spark master RPC endpoint. REST uses the Spark standalone REST submission gateway.
- subnet_
id str - (Updatable) The OCID of the target subnet of the dedicated connection.
- subscription_
id str - The OCID of the subscription with which resource needs to be associated with.
- 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 - Technology type selected for the connection.
- AI_MODEL: AI Model technology type.
- AI_PROVIDER: AI Provider technology type.
- DATABRICKS_ENGINE: Databricks Engine technology type.
- ICEBERG: Iceberg technology type. APACHE_ICEBERG supports all catalog types; AMAZON_S3_TABLES supports only REST catalog and S3 storage.
- KAFKA_SCHEMA_REGISTRY: Kafka Schema Registry technology type.
- ORACLE_AI_DATA_PLATFORM_ENGINE: Oracle AI Data Platform Engine technology type.
- SPARK: Spark 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). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- tls_
certificate_ strkey_ file_ password - (Updatable) Client Certificate key file password. Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFilePasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- tls_
protocol str - (Updatable) TLS protocol negotiated by the Spark client. Applicable when securityProtocol is TLS. Defaults to TLS_V1_3 when not provided. Must be supported by the target cluster.
- trigger_
refresh bool - trust_
store str (Updatable) Base64-encoded trust store content.
- SPARK: Trust store used to validate the Spark server certificate when
securityProtocolis TLS. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY, REDIS: TrustStore file used by the target connection.
Deprecated: This field is deprecated and replaced by "trustStoreSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- SPARK: Trust store used to validate the Spark server certificate when
- trust_
store_ strpassword (Updatable) Password for
trustStore. For SPARK, it is required when a trust store is supplied.Deprecated: This field is deprecated and replaced by "trustStorePasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- trust_
store_ strpassword_ secret_ id - (Updatable) Secret OCID containing the trust store password. For SPARK, it is required when
trustStoreSecretIdis supplied. When provided,trustStorePasswordmust not be provided. - trust_
store_ strsecret_ id - (Updatable) Secret OCID containing the trust store content. For SPARK, it applies when
securityProtocolis TLS. When provided,trustStoremust not be provided. - trust_
store_ strtype - (Updatable) Trust store format used by the Spark client. Applicable when securityProtocol is TLS and a trust store is provided. Defaults to JKS when not provided. Provide this only when a trust store is provided.
- url str
- (Updatable) Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'
- user_
id str - (Updatable)
- OCI_OBJECT_STORAGE, ORACLE_AI_DATA_PLATFORM: The OCID of the Oracle Cloud Infrastructure user who accesses Object Storage. The user must have write access to the bucket. If omitted, the service defaults to the user calling the API.
- ORACLE_NOSQL: The OCID of the Oracle Cloud Infrastructure user who accesses the Oracle NoSQL database. The user must have write access to the table. If omitted, the service defaults to the user calling the API.
- 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) References the Oracle Cloud Infrastructure Vault that contains the customer-managed encryption key identified by
keyId.Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example,
passwordSecretId) instead of plain-text attributes encrypted withvaultIdandkeyId. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGateThis field is applicable only when
doesUseSecretIdsis set tofalse. IfvaultIdis provided,keyIdmust also be provided.- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- workspace_
url str (Updatable)
- DATABRICKS_ENGINE: Databricks workspace base URL for the REST API, for example
https://<workspace>.cloud.databricks.com/api/2.0/. - ORACLE_AI_DATA_PLATFORM_ENGINE: Oracle AI Data Platform workspace URL.
** 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
- DATABRICKS_ENGINE: Databricks workspace base URL for the REST API, for example
- access
Key StringId (Updatable)
- AMAZON_KINESIS: Access key ID used to access Amazon Kinesis.
- AMAZON_S3: Access key ID used to access the Amazon S3 bucket.
Note: Despite the "Id" suffix, this value is not an Oracle Cloud Infrastructure OCID.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- artifact
Location Property Map - (Updatable) Location used to share engine application artifacts.
- DATABRICKS_ENGINE: Location used to share Databricks application artifacts.
- SPARK: Location used to share Spark application artifacts with a remote cluster.
- auth
Details Property Map - (Updatable) Authentication details for an AI Model or AI Provider connection.
- auth
Secret String (Updatable) The shared secret used for Spark authentication. Applicable when authenticationType is SHARED_SECRET.
Deprecated: This field is deprecated and replaced by "authSecretSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- auth
Secret StringSecret Id - (Updatable) The OCID of the Secret that stores the Spark authentication shared secret. Applicable when authenticationType is SHARED_SECRET. Note: When provided, 'authSecret' field must not be provided.
- auth
Token String - (Updatable) Personal access token used to connect to the Databricks Engine REST API. Only applicable for authenticationType == PERSONAL_ACCESS_TOKEN. Deprecated: This field is deprecated and replaced by "authTokenSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- auth
Token StringSecret Id - (Updatable) The OCID of the Secret where the personal access token is stored. Only applicable for authenticationType == PERSONAL_ACCESS_TOKEN. Note: When provided, 'authToken' field must not be provided.
- 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 mechanism; supported values depend on
connectionType.- DATABRICKS: Use PERSONAL_ACCESS_TOKEN or OAUTH_M2M.
- DATABRICKS_ENGINE: Use PERSONAL_ACCESS_TOKEN or OAUTH_M2M for the Databricks Engine REST API.
- JAVA_MESSAGE_SERVICE: Authentication type for Java Message Service. The default is NONE.
- SPARK: Use SHARED_SECRET only when the target cluster has
spark.authenticate=true. AES_RPC and SASL_ENCRYPTED require SHARED_SECRET. - AZURE_DATA_LAKE_STORAGE, ELASTICSEARCH, KAFKA_SCHEMA_REGISTRY, REDIS, SNOWFLAKE: Use the authentication type supported by the target service.
- String
- (Updatable) The endpoint used for authentication with Microsoft Entra ID (formerly Azure Active Directory). Default value: https://login.microsoftonline.com When connecting to a non-public Azure Cloud, the endpoint must be provided, eg:
- Azure China: https://login.chinacloudapi.cn/
- Azure US Government: https://login.microsoftonline.us/
- 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" - catalog Property Map
- (Updatable) The information about a new catalog of given type used in an Iceberg connection.
- client
Id String - (Updatable)
- AZURE_DATA_LAKE_STORAGE: Azure application client ID, required for AZURE_ACTIVE_DIRECTORY authentication.
- DATABRICKS, DATABRICKS_ENGINE: OAuth client ID, applicable to OAUTH_M2M authentication.
- MICROSOFT_FABRIC: Azure application client ID.
- client
Secret String - (Updatable) Plaintext client secret for the selected connection type. For DATABRICKS and DATABRICKS_ENGINE it applies to OAUTH_M2M authentication. Deprecated: use
clientSecretSecretId. - client
Secret StringSecret Id - (Updatable) Secret OCID containing the client secret. For DATABRICKS and DATABRICKS_ENGINE it applies to OAUTH_M2M authentication. When provided,
clientSecretmust not be provided. - cluster
Endpoint String - (Updatable) Spark master URL used for job submission. Required for both submitMode SUBMIT and REST. e.g.: 'spark://spark-master.example.com:7077' High availability can be configured with a comma-separated list, for example: 'spark://h1.example.com:7077,h2.example.com:7077'
- cluster
Id String - (Updatable) The OCID of the Kafka cluster being referenced from Oracle Cloud Infrastructure Streaming with Apache Kafka.
- cluster
Placement StringGroup Id - The OCID(https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cluster placement group for the resource. Only applicable for multicloud subscriptions. The cluster placement group id must be provided when a multicloud subscription id is provided. Otherwise the cluster placement group 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) JDBC connection string. e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'
- connection
Type String - (Updatable) The connection type.
- connection
Url String - (Updatable)
- AMAZON_REDSHIFT: JDBC connection URL. e.g.:
jdbc:redshift://aws-redshift-instance.aaaaaaaaaaaa.us-east-2.redshift.amazonaws.com:5439/mydb - DATABRICKS: JDBC 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 - JAVA_MESSAGE_SERVICE: Connection URL specifying the protocol, host, and port. e.g.:
mq://myjms.host.domain:7676 - ORACLE_AI_DATA_PLATFORM: Connection URL beginning with
jdbc:spark://. - SNOWFLAKE: JDBC connection URL. e.g.:
jdbc:snowflake://<account_name>.snowflakecomputing.com/?warehouse=<warehouse-name>&db=<db-name>
- AMAZON_REDSHIFT: JDBC connection URL. e.g.:
- 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). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - 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.
Deprecated: This field is deprecated. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example,
passwordSecretId) instead of plain-text attributes. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGateWhen set to
true, all sensitive information must be provided as Oracle Cloud Infrastructure Vault secrets using the corresponding*SecretIdattributes of the connection (for example,passwordSecretId). Plain-text sensitive attributes (for example,password) must not be used. This ensures that sensitive information remains stored and managed in the customer's Oracle Cloud Infrastructure Vault rather than by the GoldenGate service.When set to false, sensitive information must be provided in the corresponding plain-text attributes (for example,
password) rather than in secret OCID attributes. In this mode, the sensitive information is stored by the GoldenGate service. IfvaultIdandkeyIdare not specified, the GoldenGate service uses Oracle-managed encryption keys to encrypt the stored data.If
vaultIdandkeyIdare provided, the specified customer-managed key is used.- endpoint String
- (Updatable)
- AMAZON_KINESIS: The endpoint URL of the Amazon Kinesis service. e.g.: 'https://kinesis.us-east-1.amazonaws.com' If not provided, GoldenGate will default to 'https://kinesis..amazonaws.com'.
- AMAZON_S3: The Amazon Endpoint for S3. e.g.: 'https://my-bucket.s3.us-east-1.amazonaws.com' If not provided, GoldenGate will default to 'https://s3..amazonaws.com'.
- AZURE_DATA_LAKE_STORAGE: Azure Storage service endpoint. e.g: https://test.blob.core.windows.net
- GOOGLE_BIGQUERY: A legal URL to connect to BigQuery including scheme, server name and port, if not the default port. Default: https://bigquery.googleapis.com
- GOOGLE_CLOUD_STORAGE: A legal URL to connect to Google Cloud Storage including scheme, server name and port, if not the default port. Default: https://storage.googleapis.com
- MICROSOFT_FABRIC: 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) 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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) References the Oracle Cloud Infrastructure Vault key in the Oracle Cloud Infrastructure Vault identified by
vaultId.Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example,
passwordSecretId) instead of plain-text attributes encrypted withvaultIdandkeyId. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGateThe GoldenGate service uses this key to encrypt sensitive information (for example,
password) that is provided in plain-text connection attributes through the API. This field is applicable only whendoesUseSecretIdsis set tofalse. If bothvaultIdandkeyIdare provided, the GoldenGate service uses the specified customer-managed key to encrypt the sensitive data. If neithervaultIdnorkeyIdis provided, the GoldenGate service uses Oracle-managed encryption keys.- key
Store String (Updatable) Base64-encoded key store content.
- SPARK: Client key store used for mutual TLS when
securityProtocolis TLS. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY, REDIS: KeyStore file used by the target connection.
Deprecated: This field is deprecated and replaced by "keyStoreSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- SPARK: Client key store used for mutual TLS when
- key
Store StringPassword (Updatable) Password for
keyStore. For SPARK, it is required when a client key store is supplied.Deprecated: This field is deprecated and replaced by "keyStorePasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- key
Store StringPassword Secret Id - (Updatable) Secret OCID containing the key store password. For SPARK, it is required when
keyStoreSecretIdis supplied. When provided,keyStorePasswordmust not be provided. - key
Store StringSecret Id - (Updatable) Secret OCID containing the key store content. For SPARK, it applies when
securityProtocolis TLS. When provided,keyStoremust not be provided. - key
Store StringType - (Updatable) Client key store format used for mutual TLS. Applicable when securityProtocol is TLS and a client key store is provided. Defaults to JKS when not provided. Provide this only when a client key store is 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.
- max
Input NumberChars - (Updatable) Maximum number of input characters supported by this AI model connection.
- model
Key String - (Updatable) AI model identifier.
- 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 to Snowflake platform. Deprecated: This field is deprecated and replaced by "passwordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate Snowflake is phasing out password authentication for legacy service users. Oracle GoldenGate Snowflake connections will support only key-pair authentication. See the Snowflake documentation for details: https://docs.snowflake.com/en/user-guide/security-mfa-rollout
- 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 - This property is not available when creating connections. For existing deprecated connections having this value set, the value cannot be updated; set it to empty.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- provider
Id String - Optional identifier of the AI Provider Connection backing this AI Model Connection. When provided, it must reference an existing Active connection of type
AI_PROVIDER. WhenproviderIdis set,providerTypeandauthDetailsmust not be provided on the AI Model Connection, because provider metadata is resolved from the referenced AI Provider Connection. WhenproviderIdis not set, the AI Model Connection must provide inline provider metadata usingproviderTypeandauthDetails. - provider
Type String - AI Provider type used by the AI Model Connection.
- 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 AWS region where the bucket is created. If not provided, GoldenGate will default to 'us-west-2'. Note: this property will become mandatory after May 20, 2026.
- rest
Auth StringSecret Key (Updatable) The BASE64URL-encoded HMAC secret key used to sign REST submission requests when the Spark master's REST endpoint is protected by the JWS filter. Applicable only when submitMode is REST and the cluster enforces REST request signing. This setting is independent of authenticationType.
Deprecated: This field is deprecated and replaced by "restAuthSecretKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- rest
Auth StringSecret Key Secret Id - (Updatable) The OCID of the Secret that stores the REST submission signing key. Applicable only when submitMode is REST and the cluster enforces REST request signing. This setting is independent of authenticationType. Note: When provided, 'restAuthSecretKey' field must not be provided.
- rest
Endpoint String - (Updatable) Spark standalone REST submission base URL. e.g.: 'https://spark-master.example.com:6066' Applicable only and required when submitMode is REST.
- routing
Method String (Updatable) Controls the network traffic direction to the target: 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. SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets.
Deprecated: SHARED_SERVICE_ENDPOINT is deprecated. Use another supported routingMethod value, or update existing connections to use a supported routing method. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- rpc
Cipher String - (Updatable) Cipher transform used for Spark RPC encryption. Applicable when securityProtocol is AES_RPC. Defaults to AES_CTR_NOPADDING when not provided.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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
Attributes Map<String> - (Updatable) Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}} - security
Protocol String - (Updatable) Security protocol; supported values depend on
connectionType.- SPARK: PLAINTEXT, TLS, AES_RPC, or SASL_ENCRYPTED. AES_RPC and SASL_ENCRYPTED require SHARED_SECRET authentication.
- DB2, ELASTICSEARCH, JAVA_MESSAGE_SERVICE, KAFKA, MICROSOFT_SQLSERVER, MONGODB, MYSQL, POSTGRESQL, REDIS: Use the protocol supported by the target service.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- service
Account StringKey File Secret Id - (Updatable) The OCID of the Secret where the content of the service account key file is stored, which contains the credentials required to use Google Cloud Storage. Note: When provided, 'serviceAccountKeyFile' field must not be provided.
- session
Mode String (Updatable) Specifies the session mode for the database connection. Use REDIRECT only for RAC databases with SCAN listeners that return IP addresses. For RAC databases with SCAN listeners that return FQDNs, and for all other Oracle database technologies, use DIRECT. In RAC deployments, SCAN listeners redirects a connection to a specific database node, identified by either IP address or FQDN. It is recommended to configure RAC with FQDN-based SCAN listeners.
The default is DIRECT, except when databaseId is provided and the discovered database relies on the SCAN listener. In this case, the default is REDIRECT.
Deprecated: Defaulting to the REDIRECT session mode will be removed after April 21, 2027.
- should
Use BooleanJndi - (Updatable) If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.
- should
Use BooleanResource Principal - (Updatable)
- KAFKA: Specifies that the user intends to authenticate to the instance using a resource principal. Applicable only for Oracle Cloud Infrastructure Streaming connections. Only available from 23.9.0.0.0 GoldenGate versions. Note: When specified, 'username'/'password'/'passwordSecretId' fields must not be provided. Default: false
- OCI_OBJECT_STORAGE, ORACLE_AI_DATA_PLATFORM, ORACLE_NOSQL: Specifies that the user intends to authenticate to the instance using a resource principal. Default: false
- 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)
- MICROSOFT_SQLSERVER: Database Certificate - The base64 encoded content of a .pem or .crt file containing the server public key (for 1-way SSL).
- MYSQL: Database Certificate - The base64 encoded content of a .pem or .crt file containing the server public key (for 1 and 2-way SSL). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - POSTGRESQL: The base64 encoded certificate of the trusted certificate authorities (Trusted CA) for PostgreSQL. The supported file formats are .pem and .crt. It is not included in GET responses if the
view=COMPACTquery parameter is specified.
- ssl
Cert String - (Updatable)
- MYSQL: Client Certificate - The base64 encoded content of a .pem or .crt file containing the client public key (for 2-way SSL). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - POSTGRESQL: The base64 encoded certificate of the PostgreSQL server. The supported file formats are .pem and .crt. It is not included in GET responses if the
view=COMPACTquery parameter is specified.
- MYSQL: Client Certificate - The base64 encoded content of a .pem or .crt file containing the client public key (for 2-way SSL). It is not included in GET responses if the
- ssl
Client StringKeystash (Updatable) The base64 encoded keystash file which contains the encrypted password to the key database file. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
Deprecated: This field is deprecated and replaced by "sslClientKeystashSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
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. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
Deprecated: This field is deprecated and replaced by "sslClientKeystoredbSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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. This property is not supported for IBM Db2 for i, as client TLS mode is not available.
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. It is not included in GET responses if the
view=COMPACTquery parameter is specified. - 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- ssl
Key StringPassword (Updatable) Password for the certificate private key inside the client key store.
- SPARK: Applicable when
securityProtocolis TLS and a client key store is provided. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY: Provide it when the private-key password differs from the key store password.
Deprecated: This field is deprecated and replaced by "sslKeyPasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- SPARK: Applicable when
- ssl
Key StringPassword Secret Id (Updatable) Secret OCID containing the certificate private-key password inside the client key store.
- SPARK: Applicable when
securityProtocolis TLS and a client key store is provided. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY: Provide it when the private-key password differs from the key store password.
When provided,
sslKeyPasswordmust not be provided.- SPARK: Applicable when
- 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. It is not included in GET responses if the
view=COMPACTquery parameter is specified. - state String
- Possible lifecycle states for connection.
- storage Property Map
- (Updatable) The information about a new storage of given type used in an Iceberg 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.
- submit
Mode String - (Updatable) Selects the submission channel. SUBMIT uses the Spark master RPC endpoint. REST uses the Spark standalone REST submission gateway.
- subnet
Id String - (Updatable) The OCID of the target subnet of the dedicated connection.
- subscription
Id String - The OCID of the subscription with which resource needs to be associated with.
- 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 - Technology type selected for the connection.
- AI_MODEL: AI Model technology type.
- AI_PROVIDER: AI Provider technology type.
- DATABRICKS_ENGINE: Databricks Engine technology type.
- ICEBERG: Iceberg technology type. APACHE_ICEBERG supports all catalog types; AMAZON_S3_TABLES supports only REST catalog and S3 storage.
- KAFKA_SCHEMA_REGISTRY: Kafka Schema Registry technology type.
- ORACLE_AI_DATA_PLATFORM_ENGINE: Oracle AI Data Platform Engine technology type.
- SPARK: Spark 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). It is not included in GET responses if the
view=COMPACTquery parameter is specified. - 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- tls
Certificate StringKey File Password - (Updatable) Client Certificate key file password. Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFilePasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- tls
Protocol String - (Updatable) TLS protocol negotiated by the Spark client. Applicable when securityProtocol is TLS. Defaults to TLS_V1_3 when not provided. Must be supported by the target cluster.
- trigger
Refresh Boolean - trust
Store String (Updatable) Base64-encoded trust store content.
- SPARK: Trust store used to validate the Spark server certificate when
securityProtocolis TLS. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY, REDIS: TrustStore file used by the target connection.
Deprecated: This field is deprecated and replaced by "trustStoreSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- SPARK: Trust store used to validate the Spark server certificate when
- trust
Store StringPassword (Updatable) Password for
trustStore. For SPARK, it is required when a trust store is supplied.Deprecated: This field is deprecated and replaced by "trustStorePasswordSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- trust
Store StringPassword Secret Id - (Updatable) Secret OCID containing the trust store password. For SPARK, it is required when
trustStoreSecretIdis supplied. When provided,trustStorePasswordmust not be provided. - trust
Store StringSecret Id - (Updatable) Secret OCID containing the trust store content. For SPARK, it applies when
securityProtocolis TLS. When provided,trustStoremust not be provided. - trust
Store StringType - (Updatable) Trust store format used by the Spark client. Applicable when securityProtocol is TLS and a trust store is provided. Defaults to JKS when not provided. Provide this only when a trust store is provided.
- url String
- (Updatable) Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'
- user
Id String - (Updatable)
- OCI_OBJECT_STORAGE, ORACLE_AI_DATA_PLATFORM: The OCID of the Oracle Cloud Infrastructure user who accesses Object Storage. The user must have write access to the bucket. If omitted, the service defaults to the user calling the API.
- ORACLE_NOSQL: The OCID of the Oracle Cloud Infrastructure user who accesses the Oracle NoSQL database. The user must have write access to the table. If omitted, the service defaults to the user calling the API.
- 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) References the Oracle Cloud Infrastructure Vault that contains the customer-managed encryption key identified by
keyId.Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example,
passwordSecretId) instead of plain-text attributes encrypted withvaultIdandkeyId. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGateThis field is applicable only when
doesUseSecretIdsis set tofalse. IfvaultIdis provided,keyIdmust also be provided.- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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.
- workspace
Url String (Updatable)
- DATABRICKS_ENGINE: Databricks workspace base URL for the REST API, for example
https://<workspace>.cloud.databricks.com/api/2.0/. - ORACLE_AI_DATA_PLATFORM_ENGINE: Oracle AI Data Platform workspace URL.
** 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
- DATABRICKS_ENGINE: Databricks workspace base URL for the REST API, for example
Supporting Types
ConnectionAdditionalAttribute, ConnectionAdditionalAttributeArgs
ConnectionArtifactLocation, ConnectionArtifactLocationArgs
- Location
Type string - (Updatable) The type of location used to share Databricks application artifacts.
- Account
Key string - (Updatable) Storage account access key. Deprecated: This field is deprecated and replaced by "accountKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Account
Key stringSecret Id - (Updatable) The OCID of the Secret that stores the storage account access key. Note: When provided, 'accountKey' field must not be provided.
- Configuration
Connection
Artifact Location Configuration - (Updatable) Oracle Cloud Infrastructure Object Storage configuration for the artifact location.
- Endpoint
Suffix string - (Updatable) Endpoint suffix. Defaults to dfs.core.windows.net.
- Filesystem string
- (Updatable) Azure Data Lake Storage Gen2 filesystem containing the application artifacts. Example: "ggs-artifacts"
- Path string
- (Updatable)
- AZURE_DATE_LAKE_STORAGE: Artifact path within the Azure Data Lake Storage filesystem.
- UC_VOLUME: Unity Catalog volume artifact path.
- Should
Overwrite boolExisting (Updatable) Controls whether a staged Spark application artifact replaces an existing file or object with the same name at the configured destination. The artifact is typically a GGFAB pipeline package or one of its dependency files.
When set to
true, the existing file or object is replaced with the newly staged version. When set tofalse, staging fails or skips the upload rather than replacing it. This setting does not replace the entire target directory or prefix. It allows an updated pipeline or dependency to be deployed when artifact names remain the same across versions.- Storage
Account string - (Updatable) Azure Data Lake Storage Gen2 storage-account name.
- Location
Type string - (Updatable) The type of location used to share Databricks application artifacts.
- Account
Key string - (Updatable) Storage account access key. Deprecated: This field is deprecated and replaced by "accountKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Account
Key stringSecret Id - (Updatable) The OCID of the Secret that stores the storage account access key. Note: When provided, 'accountKey' field must not be provided.
- Configuration
Connection
Artifact Location Configuration - (Updatable) Oracle Cloud Infrastructure Object Storage configuration for the artifact location.
- Endpoint
Suffix string - (Updatable) Endpoint suffix. Defaults to dfs.core.windows.net.
- Filesystem string
- (Updatable) Azure Data Lake Storage Gen2 filesystem containing the application artifacts. Example: "ggs-artifacts"
- Path string
- (Updatable)
- AZURE_DATE_LAKE_STORAGE: Artifact path within the Azure Data Lake Storage filesystem.
- UC_VOLUME: Unity Catalog volume artifact path.
- Should
Overwrite boolExisting (Updatable) Controls whether a staged Spark application artifact replaces an existing file or object with the same name at the configured destination. The artifact is typically a GGFAB pipeline package or one of its dependency files.
When set to
true, the existing file or object is replaced with the newly staged version. When set tofalse, staging fails or skips the upload rather than replacing it. This setting does not replace the entire target directory or prefix. It allows an updated pipeline or dependency to be deployed when artifact names remain the same across versions.- Storage
Account string - (Updatable) Azure Data Lake Storage Gen2 storage-account name.
- location_
type string - (Updatable) The type of location used to share Databricks application artifacts.
- account_
key string - (Updatable) Storage account access key. Deprecated: This field is deprecated and replaced by "accountKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- account_
key_ stringsecret_ id - (Updatable) The OCID of the Secret that stores the storage account access key. Note: When provided, 'accountKey' field must not be provided.
- configuration object
- (Updatable) Oracle Cloud Infrastructure Object Storage configuration for the artifact location.
- endpoint_
suffix string - (Updatable) Endpoint suffix. Defaults to dfs.core.windows.net.
- filesystem string
- (Updatable) Azure Data Lake Storage Gen2 filesystem containing the application artifacts. Example: "ggs-artifacts"
- path string
- (Updatable)
- AZURE_DATE_LAKE_STORAGE: Artifact path within the Azure Data Lake Storage filesystem.
- UC_VOLUME: Unity Catalog volume artifact path.
- should_
overwrite_ boolexisting (Updatable) Controls whether a staged Spark application artifact replaces an existing file or object with the same name at the configured destination. The artifact is typically a GGFAB pipeline package or one of its dependency files.
When set to
true, the existing file or object is replaced with the newly staged version. When set tofalse, staging fails or skips the upload rather than replacing it. This setting does not replace the entire target directory or prefix. It allows an updated pipeline or dependency to be deployed when artifact names remain the same across versions.- storage_
account string - (Updatable) Azure Data Lake Storage Gen2 storage-account name.
- location
Type String - (Updatable) The type of location used to share Databricks application artifacts.
- account
Key String - (Updatable) Storage account access key. Deprecated: This field is deprecated and replaced by "accountKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- account
Key StringSecret Id - (Updatable) The OCID of the Secret that stores the storage account access key. Note: When provided, 'accountKey' field must not be provided.
- configuration
Connection
Artifact Location Configuration - (Updatable) Oracle Cloud Infrastructure Object Storage configuration for the artifact location.
- endpoint
Suffix String - (Updatable) Endpoint suffix. Defaults to dfs.core.windows.net.
- filesystem String
- (Updatable) Azure Data Lake Storage Gen2 filesystem containing the application artifacts. Example: "ggs-artifacts"
- path String
- (Updatable)
- AZURE_DATE_LAKE_STORAGE: Artifact path within the Azure Data Lake Storage filesystem.
- UC_VOLUME: Unity Catalog volume artifact path.
- should
Overwrite BooleanExisting (Updatable) Controls whether a staged Spark application artifact replaces an existing file or object with the same name at the configured destination. The artifact is typically a GGFAB pipeline package or one of its dependency files.
When set to
true, the existing file or object is replaced with the newly staged version. When set tofalse, staging fails or skips the upload rather than replacing it. This setting does not replace the entire target directory or prefix. It allows an updated pipeline or dependency to be deployed when artifact names remain the same across versions.- storage
Account String - (Updatable) Azure Data Lake Storage Gen2 storage-account name.
- location
Type string - (Updatable) The type of location used to share Databricks application artifacts.
- account
Key string - (Updatable) Storage account access key. Deprecated: This field is deprecated and replaced by "accountKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- account
Key stringSecret Id - (Updatable) The OCID of the Secret that stores the storage account access key. Note: When provided, 'accountKey' field must not be provided.
- configuration
Connection
Artifact Location Configuration - (Updatable) Oracle Cloud Infrastructure Object Storage configuration for the artifact location.
- endpoint
Suffix string - (Updatable) Endpoint suffix. Defaults to dfs.core.windows.net.
- filesystem string
- (Updatable) Azure Data Lake Storage Gen2 filesystem containing the application artifacts. Example: "ggs-artifacts"
- path string
- (Updatable)
- AZURE_DATE_LAKE_STORAGE: Artifact path within the Azure Data Lake Storage filesystem.
- UC_VOLUME: Unity Catalog volume artifact path.
- should
Overwrite booleanExisting (Updatable) Controls whether a staged Spark application artifact replaces an existing file or object with the same name at the configured destination. The artifact is typically a GGFAB pipeline package or one of its dependency files.
When set to
true, the existing file or object is replaced with the newly staged version. When set tofalse, staging fails or skips the upload rather than replacing it. This setting does not replace the entire target directory or prefix. It allows an updated pipeline or dependency to be deployed when artifact names remain the same across versions.- storage
Account string - (Updatable) Azure Data Lake Storage Gen2 storage-account name.
- location_
type str - (Updatable) The type of location used to share Databricks application artifacts.
- account_
key str - (Updatable) Storage account access key. Deprecated: This field is deprecated and replaced by "accountKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- account_
key_ strsecret_ id - (Updatable) The OCID of the Secret that stores the storage account access key. Note: When provided, 'accountKey' field must not be provided.
- configuration
Connection
Artifact Location Configuration - (Updatable) Oracle Cloud Infrastructure Object Storage configuration for the artifact location.
- endpoint_
suffix str - (Updatable) Endpoint suffix. Defaults to dfs.core.windows.net.
- filesystem str
- (Updatable) Azure Data Lake Storage Gen2 filesystem containing the application artifacts. Example: "ggs-artifacts"
- path str
- (Updatable)
- AZURE_DATE_LAKE_STORAGE: Artifact path within the Azure Data Lake Storage filesystem.
- UC_VOLUME: Unity Catalog volume artifact path.
- should_
overwrite_ boolexisting (Updatable) Controls whether a staged Spark application artifact replaces an existing file or object with the same name at the configured destination. The artifact is typically a GGFAB pipeline package or one of its dependency files.
When set to
true, the existing file or object is replaced with the newly staged version. When set tofalse, staging fails or skips the upload rather than replacing it. This setting does not replace the entire target directory or prefix. It allows an updated pipeline or dependency to be deployed when artifact names remain the same across versions.- storage_
account str - (Updatable) Azure Data Lake Storage Gen2 storage-account name.
- location
Type String - (Updatable) The type of location used to share Databricks application artifacts.
- account
Key String - (Updatable) Storage account access key. Deprecated: This field is deprecated and replaced by "accountKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- account
Key StringSecret Id - (Updatable) The OCID of the Secret that stores the storage account access key. Note: When provided, 'accountKey' field must not be provided.
- configuration Property Map
- (Updatable) Oracle Cloud Infrastructure Object Storage configuration for the artifact location.
- endpoint
Suffix String - (Updatable) Endpoint suffix. Defaults to dfs.core.windows.net.
- filesystem String
- (Updatable) Azure Data Lake Storage Gen2 filesystem containing the application artifacts. Example: "ggs-artifacts"
- path String
- (Updatable)
- AZURE_DATE_LAKE_STORAGE: Artifact path within the Azure Data Lake Storage filesystem.
- UC_VOLUME: Unity Catalog volume artifact path.
- should
Overwrite BooleanExisting (Updatable) Controls whether a staged Spark application artifact replaces an existing file or object with the same name at the configured destination. The artifact is typically a GGFAB pipeline package or one of its dependency files.
When set to
true, the existing file or object is replaced with the newly staged version. When set tofalse, staging fails or skips the upload rather than replacing it. This setting does not replace the entire target directory or prefix. It allows an updated pipeline or dependency to be deployed when artifact names remain the same across versions.- storage
Account String - (Updatable) Azure Data Lake Storage Gen2 storage-account name.
ConnectionArtifactLocationConfiguration, ConnectionArtifactLocationConfigurationArgs
- Authentication
Type string (Updatable) Authentication method used to access Oracle Cloud Infrastructure Object Storage.
When
authenticationTypeisUSER_PRINCIPAL,region,namespace,bucket,path,userId, andpublicKeyFingerprintare required. Provide exactly one ofprivateKeyFileorprivateKeyFileSecretIdas the private-key credential.tenancyIdand the private-key passphrase are optional. When a passphrase is used, provide at most one ofprivateKeyPassphraseorprivateKeyPassphraseSecretId.When
authenticationTypeisRESOURCE_PRINCIPAL,region,namespace,bucket, andpathare required.When
authenticationTypeisCUSTOMER_SECRET_KEY,region,namespace,bucket,path, andaccessKeyIdare required. Provide exactly one ofsecretAccessKeyorsecretAccessKeySecretIdas the secret-key credential. The S3 Compatibility API endpoint is inferred fromregionandnamespace.When
authenticationTypeisPRE_AUTHENTICATED_REQUEST, provide exactly one ofparUrlorparUrlSecretId.- Access
Key stringId - (Updatable) Access key identifier used for Oracle Cloud Infrastructure Object Storage secret-key authentication. Note: Despite the "Id" suffix, this value is not an Oracle Cloud Infrastructure OCID.
- Bucket string
- (Updatable) Oracle Cloud Infrastructure Object Storage bucket containing application artifacts.
- Namespace string
- (Updatable) The Oracle Cloud Infrastructure Object Storage namespace containing the bucket. Example: "mynamespace"
- Par
Url string - (Updatable) A pre-authenticated request (PAR) URL that provides access to the artifact location. Deprecated: This field is deprecated and replaced by "parUrlSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Par
Url stringSecret Id - (Updatable) The OCID of the Secret that stores the pre-authenticated request (PAR) URL. Note: When provided,
parUrlmust not be provided. - Path string
- (Updatable) Object path used for application artifacts.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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) The passphrase of the private key. Deprecated: This field is deprecated and replaced by "privateKeyPassphraseSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Private
Key stringPassphrase Secret Id - (Updatable) The OCID of the Secret that stores the passphrase of the private key. Note: When provided, 'privateKeyPassphrase' field must not be provided.
- 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
- 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.
- Secret
Access stringKey - (Updatable) Secret access key used for Oracle Cloud Infrastructure Object Storage secret-key authentication. Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Secret
Access stringKey Secret Id - (Updatable) The OCID of the Secret that stores the secret access key. Note: When provided,
secretAccessKeymust not be provided. - Tenancy
Id string - (Updatable) The OCID of the related Oracle Cloud Infrastructure tenancy.
- User
Id string - (Updatable) The OCID of the Oracle Cloud Infrastructure user whose API key is used to access the artifact location. If not provided it will default to the current user.
- Authentication
Type string (Updatable) Authentication method used to access Oracle Cloud Infrastructure Object Storage.
When
authenticationTypeisUSER_PRINCIPAL,region,namespace,bucket,path,userId, andpublicKeyFingerprintare required. Provide exactly one ofprivateKeyFileorprivateKeyFileSecretIdas the private-key credential.tenancyIdand the private-key passphrase are optional. When a passphrase is used, provide at most one ofprivateKeyPassphraseorprivateKeyPassphraseSecretId.When
authenticationTypeisRESOURCE_PRINCIPAL,region,namespace,bucket, andpathare required.When
authenticationTypeisCUSTOMER_SECRET_KEY,region,namespace,bucket,path, andaccessKeyIdare required. Provide exactly one ofsecretAccessKeyorsecretAccessKeySecretIdas the secret-key credential. The S3 Compatibility API endpoint is inferred fromregionandnamespace.When
authenticationTypeisPRE_AUTHENTICATED_REQUEST, provide exactly one ofparUrlorparUrlSecretId.- Access
Key stringId - (Updatable) Access key identifier used for Oracle Cloud Infrastructure Object Storage secret-key authentication. Note: Despite the "Id" suffix, this value is not an Oracle Cloud Infrastructure OCID.
- Bucket string
- (Updatable) Oracle Cloud Infrastructure Object Storage bucket containing application artifacts.
- Namespace string
- (Updatable) The Oracle Cloud Infrastructure Object Storage namespace containing the bucket. Example: "mynamespace"
- Par
Url string - (Updatable) A pre-authenticated request (PAR) URL that provides access to the artifact location. Deprecated: This field is deprecated and replaced by "parUrlSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Par
Url stringSecret Id - (Updatable) The OCID of the Secret that stores the pre-authenticated request (PAR) URL. Note: When provided,
parUrlmust not be provided. - Path string
- (Updatable) Object path used for application artifacts.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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) The passphrase of the private key. Deprecated: This field is deprecated and replaced by "privateKeyPassphraseSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Private
Key stringPassphrase Secret Id - (Updatable) The OCID of the Secret that stores the passphrase of the private key. Note: When provided, 'privateKeyPassphrase' field must not be provided.
- 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
- 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.
- Secret
Access stringKey - (Updatable) Secret access key used for Oracle Cloud Infrastructure Object Storage secret-key authentication. Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Secret
Access stringKey Secret Id - (Updatable) The OCID of the Secret that stores the secret access key. Note: When provided,
secretAccessKeymust not be provided. - Tenancy
Id string - (Updatable) The OCID of the related Oracle Cloud Infrastructure tenancy.
- User
Id string - (Updatable) The OCID of the Oracle Cloud Infrastructure user whose API key is used to access the artifact location. If not provided it will default to the current user.
- authentication_
type string (Updatable) Authentication method used to access Oracle Cloud Infrastructure Object Storage.
When
authenticationTypeisUSER_PRINCIPAL,region,namespace,bucket,path,userId, andpublicKeyFingerprintare required. Provide exactly one ofprivateKeyFileorprivateKeyFileSecretIdas the private-key credential.tenancyIdand the private-key passphrase are optional. When a passphrase is used, provide at most one ofprivateKeyPassphraseorprivateKeyPassphraseSecretId.When
authenticationTypeisRESOURCE_PRINCIPAL,region,namespace,bucket, andpathare required.When
authenticationTypeisCUSTOMER_SECRET_KEY,region,namespace,bucket,path, andaccessKeyIdare required. Provide exactly one ofsecretAccessKeyorsecretAccessKeySecretIdas the secret-key credential. The S3 Compatibility API endpoint is inferred fromregionandnamespace.When
authenticationTypeisPRE_AUTHENTICATED_REQUEST, provide exactly one ofparUrlorparUrlSecretId.- access_
key_ stringid - (Updatable) Access key identifier used for Oracle Cloud Infrastructure Object Storage secret-key authentication. Note: Despite the "Id" suffix, this value is not an Oracle Cloud Infrastructure OCID.
- bucket string
- (Updatable) Oracle Cloud Infrastructure Object Storage bucket containing application artifacts.
- namespace string
- (Updatable) The Oracle Cloud Infrastructure Object Storage namespace containing the bucket. Example: "mynamespace"
- par_
url string - (Updatable) A pre-authenticated request (PAR) URL that provides access to the artifact location. Deprecated: This field is deprecated and replaced by "parUrlSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- par_
url_ stringsecret_ id - (Updatable) The OCID of the Secret that stores the pre-authenticated request (PAR) URL. Note: When provided,
parUrlmust not be provided. - path string
- (Updatable) Object path used for application artifacts.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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) The passphrase of the private key. Deprecated: This field is deprecated and replaced by "privateKeyPassphraseSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- private_
key_ stringpassphrase_ secret_ id - (Updatable) The OCID of the Secret that stores the passphrase of the private key. Note: When provided, 'privateKeyPassphrase' field must not be provided.
- 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
- 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.
- secret_
access_ stringkey - (Updatable) Secret access key used for Oracle Cloud Infrastructure Object Storage secret-key authentication. Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- secret_
access_ stringkey_ secret_ id - (Updatable) The OCID of the Secret that stores the secret access key. Note: When provided,
secretAccessKeymust not be provided. - tenancy_
id string - (Updatable) The OCID of the related Oracle Cloud Infrastructure tenancy.
- user_
id string - (Updatable) The OCID of the Oracle Cloud Infrastructure user whose API key is used to access the artifact location. If not provided it will default to the current user.
- authentication
Type String (Updatable) Authentication method used to access Oracle Cloud Infrastructure Object Storage.
When
authenticationTypeisUSER_PRINCIPAL,region,namespace,bucket,path,userId, andpublicKeyFingerprintare required. Provide exactly one ofprivateKeyFileorprivateKeyFileSecretIdas the private-key credential.tenancyIdand the private-key passphrase are optional. When a passphrase is used, provide at most one ofprivateKeyPassphraseorprivateKeyPassphraseSecretId.When
authenticationTypeisRESOURCE_PRINCIPAL,region,namespace,bucket, andpathare required.When
authenticationTypeisCUSTOMER_SECRET_KEY,region,namespace,bucket,path, andaccessKeyIdare required. Provide exactly one ofsecretAccessKeyorsecretAccessKeySecretIdas the secret-key credential. The S3 Compatibility API endpoint is inferred fromregionandnamespace.When
authenticationTypeisPRE_AUTHENTICATED_REQUEST, provide exactly one ofparUrlorparUrlSecretId.- access
Key StringId - (Updatable) Access key identifier used for Oracle Cloud Infrastructure Object Storage secret-key authentication. Note: Despite the "Id" suffix, this value is not an Oracle Cloud Infrastructure OCID.
- bucket String
- (Updatable) Oracle Cloud Infrastructure Object Storage bucket containing application artifacts.
- namespace String
- (Updatable) The Oracle Cloud Infrastructure Object Storage namespace containing the bucket. Example: "mynamespace"
- par
Url String - (Updatable) A pre-authenticated request (PAR) URL that provides access to the artifact location. Deprecated: This field is deprecated and replaced by "parUrlSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- par
Url StringSecret Id - (Updatable) The OCID of the Secret that stores the pre-authenticated request (PAR) URL. Note: When provided,
parUrlmust not be provided. - path String
- (Updatable) Object path used for application artifacts.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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) The passphrase of the private key. Deprecated: This field is deprecated and replaced by "privateKeyPassphraseSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- private
Key StringPassphrase Secret Id - (Updatable) The OCID of the Secret that stores the passphrase of the private key. Note: When provided, 'privateKeyPassphrase' field must not be provided.
- 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
- 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.
- secret
Access StringKey - (Updatable) Secret access key used for Oracle Cloud Infrastructure Object Storage secret-key authentication. Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- secret
Access StringKey Secret Id - (Updatable) The OCID of the Secret that stores the secret access key. Note: When provided,
secretAccessKeymust not be provided. - tenancy
Id String - (Updatable) The OCID of the related Oracle Cloud Infrastructure tenancy.
- user
Id String - (Updatable) The OCID of the Oracle Cloud Infrastructure user whose API key is used to access the artifact location. If not provided it will default to the current user.
- authentication
Type string (Updatable) Authentication method used to access Oracle Cloud Infrastructure Object Storage.
When
authenticationTypeisUSER_PRINCIPAL,region,namespace,bucket,path,userId, andpublicKeyFingerprintare required. Provide exactly one ofprivateKeyFileorprivateKeyFileSecretIdas the private-key credential.tenancyIdand the private-key passphrase are optional. When a passphrase is used, provide at most one ofprivateKeyPassphraseorprivateKeyPassphraseSecretId.When
authenticationTypeisRESOURCE_PRINCIPAL,region,namespace,bucket, andpathare required.When
authenticationTypeisCUSTOMER_SECRET_KEY,region,namespace,bucket,path, andaccessKeyIdare required. Provide exactly one ofsecretAccessKeyorsecretAccessKeySecretIdas the secret-key credential. The S3 Compatibility API endpoint is inferred fromregionandnamespace.When
authenticationTypeisPRE_AUTHENTICATED_REQUEST, provide exactly one ofparUrlorparUrlSecretId.- access
Key stringId - (Updatable) Access key identifier used for Oracle Cloud Infrastructure Object Storage secret-key authentication. Note: Despite the "Id" suffix, this value is not an Oracle Cloud Infrastructure OCID.
- bucket string
- (Updatable) Oracle Cloud Infrastructure Object Storage bucket containing application artifacts.
- namespace string
- (Updatable) The Oracle Cloud Infrastructure Object Storage namespace containing the bucket. Example: "mynamespace"
- par
Url string - (Updatable) A pre-authenticated request (PAR) URL that provides access to the artifact location. Deprecated: This field is deprecated and replaced by "parUrlSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- par
Url stringSecret Id - (Updatable) The OCID of the Secret that stores the pre-authenticated request (PAR) URL. Note: When provided,
parUrlmust not be provided. - path string
- (Updatable) Object path used for application artifacts.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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) The passphrase of the private key. Deprecated: This field is deprecated and replaced by "privateKeyPassphraseSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- private
Key stringPassphrase Secret Id - (Updatable) The OCID of the Secret that stores the passphrase of the private key. Note: When provided, 'privateKeyPassphrase' field must not be provided.
- 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
- 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.
- secret
Access stringKey - (Updatable) Secret access key used for Oracle Cloud Infrastructure Object Storage secret-key authentication. Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- secret
Access stringKey Secret Id - (Updatable) The OCID of the Secret that stores the secret access key. Note: When provided,
secretAccessKeymust not be provided. - tenancy
Id string - (Updatable) The OCID of the related Oracle Cloud Infrastructure tenancy.
- user
Id string - (Updatable) The OCID of the Oracle Cloud Infrastructure user whose API key is used to access the artifact location. If not provided it will default to the current user.
- authentication_
type str (Updatable) Authentication method used to access Oracle Cloud Infrastructure Object Storage.
When
authenticationTypeisUSER_PRINCIPAL,region,namespace,bucket,path,userId, andpublicKeyFingerprintare required. Provide exactly one ofprivateKeyFileorprivateKeyFileSecretIdas the private-key credential.tenancyIdand the private-key passphrase are optional. When a passphrase is used, provide at most one ofprivateKeyPassphraseorprivateKeyPassphraseSecretId.When
authenticationTypeisRESOURCE_PRINCIPAL,region,namespace,bucket, andpathare required.When
authenticationTypeisCUSTOMER_SECRET_KEY,region,namespace,bucket,path, andaccessKeyIdare required. Provide exactly one ofsecretAccessKeyorsecretAccessKeySecretIdas the secret-key credential. The S3 Compatibility API endpoint is inferred fromregionandnamespace.When
authenticationTypeisPRE_AUTHENTICATED_REQUEST, provide exactly one ofparUrlorparUrlSecretId.- access_
key_ strid - (Updatable) Access key identifier used for Oracle Cloud Infrastructure Object Storage secret-key authentication. Note: Despite the "Id" suffix, this value is not an Oracle Cloud Infrastructure OCID.
- bucket str
- (Updatable) Oracle Cloud Infrastructure Object Storage bucket containing application artifacts.
- namespace str
- (Updatable) The Oracle Cloud Infrastructure Object Storage namespace containing the bucket. Example: "mynamespace"
- par_
url str - (Updatable) A pre-authenticated request (PAR) URL that provides access to the artifact location. Deprecated: This field is deprecated and replaced by "parUrlSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- par_
url_ strsecret_ id - (Updatable) The OCID of the Secret that stores the pre-authenticated request (PAR) URL. Note: When provided,
parUrlmust not be provided. - path str
- (Updatable) Object path used for application artifacts.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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) The passphrase of the private key. Deprecated: This field is deprecated and replaced by "privateKeyPassphraseSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- private_
key_ strpassphrase_ secret_ id - (Updatable) The OCID of the Secret that stores the passphrase of the private key. Note: When provided, 'privateKeyPassphrase' field must not be provided.
- 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
- 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.
- secret_
access_ strkey - (Updatable) Secret access key used for Oracle Cloud Infrastructure Object Storage secret-key authentication. Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- secret_
access_ strkey_ secret_ id - (Updatable) The OCID of the Secret that stores the secret access key. Note: When provided,
secretAccessKeymust not be provided. - tenancy_
id str - (Updatable) The OCID of the related Oracle Cloud Infrastructure tenancy.
- user_
id str - (Updatable) The OCID of the Oracle Cloud Infrastructure user whose API key is used to access the artifact location. If not provided it will default to the current user.
- authentication
Type String (Updatable) Authentication method used to access Oracle Cloud Infrastructure Object Storage.
When
authenticationTypeisUSER_PRINCIPAL,region,namespace,bucket,path,userId, andpublicKeyFingerprintare required. Provide exactly one ofprivateKeyFileorprivateKeyFileSecretIdas the private-key credential.tenancyIdand the private-key passphrase are optional. When a passphrase is used, provide at most one ofprivateKeyPassphraseorprivateKeyPassphraseSecretId.When
authenticationTypeisRESOURCE_PRINCIPAL,region,namespace,bucket, andpathare required.When
authenticationTypeisCUSTOMER_SECRET_KEY,region,namespace,bucket,path, andaccessKeyIdare required. Provide exactly one ofsecretAccessKeyorsecretAccessKeySecretIdas the secret-key credential. The S3 Compatibility API endpoint is inferred fromregionandnamespace.When
authenticationTypeisPRE_AUTHENTICATED_REQUEST, provide exactly one ofparUrlorparUrlSecretId.- access
Key StringId - (Updatable) Access key identifier used for Oracle Cloud Infrastructure Object Storage secret-key authentication. Note: Despite the "Id" suffix, this value is not an Oracle Cloud Infrastructure OCID.
- bucket String
- (Updatable) Oracle Cloud Infrastructure Object Storage bucket containing application artifacts.
- namespace String
- (Updatable) The Oracle Cloud Infrastructure Object Storage namespace containing the bucket. Example: "mynamespace"
- par
Url String - (Updatable) A pre-authenticated request (PAR) URL that provides access to the artifact location. Deprecated: This field is deprecated and replaced by "parUrlSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- par
Url StringSecret Id - (Updatable) The OCID of the Secret that stores the pre-authenticated request (PAR) URL. Note: When provided,
parUrlmust not be provided. - path String
- (Updatable) Object path used for application artifacts.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- 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) The passphrase of the private key. Deprecated: This field is deprecated and replaced by "privateKeyPassphraseSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- private
Key StringPassphrase Secret Id - (Updatable) The OCID of the Secret that stores the passphrase of the private key. Note: When provided, 'privateKeyPassphrase' field must not be provided.
- 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
- 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.
- secret
Access StringKey - (Updatable) Secret access key used for Oracle Cloud Infrastructure Object Storage secret-key authentication. Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- secret
Access StringKey Secret Id - (Updatable) The OCID of the Secret that stores the secret access key. Note: When provided,
secretAccessKeymust not be provided. - tenancy
Id String - (Updatable) The OCID of the related Oracle Cloud Infrastructure tenancy.
- user
Id String - (Updatable) The OCID of the Oracle Cloud Infrastructure user whose API key is used to access the artifact location. If not provided it will default to the current user.
ConnectionAuthDetails, ConnectionAuthDetailsArgs
- Auth
Type string - (Updatable) Authentication type used by the AI model connection.
- Api
Key string - (Updatable) API key for the AI model connection. Deprecated: This field is deprecated and replaced by "apiKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Api
Key stringSecret Id - (Updatable) API key secret OCID for the AI model connection.
- Base
Url string - (Updatable) Base URL of the AI model endpoint. If not specified, the default base URL for the selected AI provider will be used.
- Key
Fingerprint string - (Updatable) Oracle Cloud Infrastructure Generative AI key fingerprint.
- 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.
- Tenancy
Id string - (Updatable) Oracle Cloud Infrastructure Generative AI tenancy OCID. If this value is not provided, or is updated to an empty value, it defaults to the tenancy OCID of the user who is executing the operation.
- User
Id string - (Updatable) Oracle Cloud Infrastructure Generative AI user OCID. If this value is not provided, or is updated to an empty value, it defaults to the OCID of the user who is executing the operation.
- Auth
Type string - (Updatable) Authentication type used by the AI model connection.
- Api
Key string - (Updatable) API key for the AI model connection. Deprecated: This field is deprecated and replaced by "apiKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Api
Key stringSecret Id - (Updatable) API key secret OCID for the AI model connection.
- Base
Url string - (Updatable) Base URL of the AI model endpoint. If not specified, the default base URL for the selected AI provider will be used.
- Key
Fingerprint string - (Updatable) Oracle Cloud Infrastructure Generative AI key fingerprint.
- 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.
- Tenancy
Id string - (Updatable) Oracle Cloud Infrastructure Generative AI tenancy OCID. If this value is not provided, or is updated to an empty value, it defaults to the tenancy OCID of the user who is executing the operation.
- User
Id string - (Updatable) Oracle Cloud Infrastructure Generative AI user OCID. If this value is not provided, or is updated to an empty value, it defaults to the OCID of the user who is executing the operation.
- auth_
type string - (Updatable) Authentication type used by the AI model connection.
- api_
key string - (Updatable) API key for the AI model connection. Deprecated: This field is deprecated and replaced by "apiKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- api_
key_ stringsecret_ id - (Updatable) API key secret OCID for the AI model connection.
- base_
url string - (Updatable) Base URL of the AI model endpoint. If not specified, the default base URL for the selected AI provider will be used.
- key_
fingerprint string - (Updatable) Oracle Cloud Infrastructure Generative AI key fingerprint.
- 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.
- tenancy_
id string - (Updatable) Oracle Cloud Infrastructure Generative AI tenancy OCID. If this value is not provided, or is updated to an empty value, it defaults to the tenancy OCID of the user who is executing the operation.
- user_
id string - (Updatable) Oracle Cloud Infrastructure Generative AI user OCID. If this value is not provided, or is updated to an empty value, it defaults to the OCID of the user who is executing the operation.
- auth
Type String - (Updatable) Authentication type used by the AI model connection.
- api
Key String - (Updatable) API key for the AI model connection. Deprecated: This field is deprecated and replaced by "apiKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- api
Key StringSecret Id - (Updatable) API key secret OCID for the AI model connection.
- base
Url String - (Updatable) Base URL of the AI model endpoint. If not specified, the default base URL for the selected AI provider will be used.
- key
Fingerprint String - (Updatable) Oracle Cloud Infrastructure Generative AI key fingerprint.
- 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.
- tenancy
Id String - (Updatable) Oracle Cloud Infrastructure Generative AI tenancy OCID. If this value is not provided, or is updated to an empty value, it defaults to the tenancy OCID of the user who is executing the operation.
- user
Id String - (Updatable) Oracle Cloud Infrastructure Generative AI user OCID. If this value is not provided, or is updated to an empty value, it defaults to the OCID of the user who is executing the operation.
- auth
Type string - (Updatable) Authentication type used by the AI model connection.
- api
Key string - (Updatable) API key for the AI model connection. Deprecated: This field is deprecated and replaced by "apiKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- api
Key stringSecret Id - (Updatable) API key secret OCID for the AI model connection.
- base
Url string - (Updatable) Base URL of the AI model endpoint. If not specified, the default base URL for the selected AI provider will be used.
- key
Fingerprint string - (Updatable) Oracle Cloud Infrastructure Generative AI key fingerprint.
- 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.
- tenancy
Id string - (Updatable) Oracle Cloud Infrastructure Generative AI tenancy OCID. If this value is not provided, or is updated to an empty value, it defaults to the tenancy OCID of the user who is executing the operation.
- user
Id string - (Updatable) Oracle Cloud Infrastructure Generative AI user OCID. If this value is not provided, or is updated to an empty value, it defaults to the OCID of the user who is executing the operation.
- auth_
type str - (Updatable) Authentication type used by the AI model connection.
- api_
key str - (Updatable) API key for the AI model connection. Deprecated: This field is deprecated and replaced by "apiKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- api_
key_ strsecret_ id - (Updatable) API key secret OCID for the AI model connection.
- base_
url str - (Updatable) Base URL of the AI model endpoint. If not specified, the default base URL for the selected AI provider will be used.
- key_
fingerprint str - (Updatable) Oracle Cloud Infrastructure Generative AI key fingerprint.
- 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.
- tenancy_
id str - (Updatable) Oracle Cloud Infrastructure Generative AI tenancy OCID. If this value is not provided, or is updated to an empty value, it defaults to the tenancy OCID of the user who is executing the operation.
- user_
id str - (Updatable) Oracle Cloud Infrastructure Generative AI user OCID. If this value is not provided, or is updated to an empty value, it defaults to the OCID of the user who is executing the operation.
- auth
Type String - (Updatable) Authentication type used by the AI model connection.
- api
Key String - (Updatable) API key for the AI model connection. Deprecated: This field is deprecated and replaced by "apiKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- api
Key StringSecret Id - (Updatable) API key secret OCID for the AI model connection.
- base
Url String - (Updatable) Base URL of the AI model endpoint. If not specified, the default base URL for the selected AI provider will be used.
- key
Fingerprint String - (Updatable) Oracle Cloud Infrastructure Generative AI key fingerprint.
- 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.
- tenancy
Id String - (Updatable) Oracle Cloud Infrastructure Generative AI tenancy OCID. If this value is not provided, or is updated to an empty value, it defaults to the tenancy OCID of the user who is executing the operation.
- user
Id String - (Updatable) Oracle Cloud Infrastructure Generative AI user OCID. If this value is not provided, or is updated to an empty value, it defaults to the OCID of the user who is executing the operation.
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 - This property is not available when creating connections. For existing deprecated connections having this value set, the value cannot be updated; set it to empty.
- 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 - This property is not available when creating connections. For existing deprecated connections having this value set, the value cannot be updated; set it to empty.
- 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 - This property is not available when creating connections. For existing deprecated connections having this value set, the value cannot be updated; set it to empty.
- 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 - This property is not available when creating connections. For existing deprecated connections having this value set, the value cannot be updated; set it to empty.
- 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 - This property is not available when creating connections. For existing deprecated connections having this value set, the value cannot be updated; set it to empty.
- 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 - This property is not available when creating connections. For existing deprecated connections having this value set, the value cannot be updated; set it to empty.
- 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 - This property is not available when creating connections. For existing deprecated connections having this value set, the value cannot be updated; set it to empty.
ConnectionCatalog, ConnectionCatalogArgs
- Catalog
Type string - (Updatable) The catalog type.
- Branch string
- (Updatable) The active branch of the Nessie catalog from which Iceberg reads and writes table metadata.
- Client
Id string - (Updatable) The OAuth client ID used for authentication.
- Client
Secret string - (Updatable) Client secret required to connect to Polaris.
- Client
Secret stringSecret Id - (Updatable) The OCID of the Secret that stores the password Oracle GoldenGate uses to connect to Polaris.
- Glue
Id string - (Updatable) The AWS Glue Catalog ID where Iceberg tables are registered.
- Name string
- (Updatable) The catalog name within Polaris where Iceberg tables are registered.
- Principal
Role string - (Updatable) The Snowflake role used to access Polaris.
- Properties string
- (Updatable) The base64 encoded content of the configuration file containing additional properties for the REST catalog.
- Properties
Secret stringId - (Updatable) The OCID of the Secret that stores the content of the configuration file containing additional properties for the REST catalog. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm
- Uri string
- (Updatable) The URL endpoint for the Polaris API. e.g.: 'https://.snowflakecomputing.com/polaris/api/catalog'
- Catalog
Type string - (Updatable) The catalog type.
- Branch string
- (Updatable) The active branch of the Nessie catalog from which Iceberg reads and writes table metadata.
- Client
Id string - (Updatable) The OAuth client ID used for authentication.
- Client
Secret string - (Updatable) Client secret required to connect to Polaris.
- Client
Secret stringSecret Id - (Updatable) The OCID of the Secret that stores the password Oracle GoldenGate uses to connect to Polaris.
- Glue
Id string - (Updatable) The AWS Glue Catalog ID where Iceberg tables are registered.
- Name string
- (Updatable) The catalog name within Polaris where Iceberg tables are registered.
- Principal
Role string - (Updatable) The Snowflake role used to access Polaris.
- Properties string
- (Updatable) The base64 encoded content of the configuration file containing additional properties for the REST catalog.
- Properties
Secret stringId - (Updatable) The OCID of the Secret that stores the content of the configuration file containing additional properties for the REST catalog. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm
- Uri string
- (Updatable) The URL endpoint for the Polaris API. e.g.: 'https://.snowflakecomputing.com/polaris/api/catalog'
- catalog_
type string - (Updatable) The catalog type.
- branch string
- (Updatable) The active branch of the Nessie catalog from which Iceberg reads and writes table metadata.
- client_
id string - (Updatable) The OAuth client ID used for authentication.
- client_
secret string - (Updatable) Client secret required to connect to Polaris.
- client_
secret_ stringsecret_ id - (Updatable) The OCID of the Secret that stores the password Oracle GoldenGate uses to connect to Polaris.
- glue_
id string - (Updatable) The AWS Glue Catalog ID where Iceberg tables are registered.
- name string
- (Updatable) The catalog name within Polaris where Iceberg tables are registered.
- principal_
role string - (Updatable) The Snowflake role used to access Polaris.
- properties string
- (Updatable) The base64 encoded content of the configuration file containing additional properties for the REST catalog.
- properties_
secret_ stringid - (Updatable) The OCID of the Secret that stores the content of the configuration file containing additional properties for the REST catalog. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm
- uri string
- (Updatable) The URL endpoint for the Polaris API. e.g.: 'https://.snowflakecomputing.com/polaris/api/catalog'
- catalog
Type String - (Updatable) The catalog type.
- branch String
- (Updatable) The active branch of the Nessie catalog from which Iceberg reads and writes table metadata.
- client
Id String - (Updatable) The OAuth client ID used for authentication.
- client
Secret String - (Updatable) Client secret required to connect to Polaris.
- client
Secret StringSecret Id - (Updatable) The OCID of the Secret that stores the password Oracle GoldenGate uses to connect to Polaris.
- glue
Id String - (Updatable) The AWS Glue Catalog ID where Iceberg tables are registered.
- name String
- (Updatable) The catalog name within Polaris where Iceberg tables are registered.
- principal
Role String - (Updatable) The Snowflake role used to access Polaris.
- properties String
- (Updatable) The base64 encoded content of the configuration file containing additional properties for the REST catalog.
- properties
Secret StringId - (Updatable) The OCID of the Secret that stores the content of the configuration file containing additional properties for the REST catalog. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm
- uri String
- (Updatable) The URL endpoint for the Polaris API. e.g.: 'https://.snowflakecomputing.com/polaris/api/catalog'
- catalog
Type string - (Updatable) The catalog type.
- branch string
- (Updatable) The active branch of the Nessie catalog from which Iceberg reads and writes table metadata.
- client
Id string - (Updatable) The OAuth client ID used for authentication.
- client
Secret string - (Updatable) Client secret required to connect to Polaris.
- client
Secret stringSecret Id - (Updatable) The OCID of the Secret that stores the password Oracle GoldenGate uses to connect to Polaris.
- glue
Id string - (Updatable) The AWS Glue Catalog ID where Iceberg tables are registered.
- name string
- (Updatable) The catalog name within Polaris where Iceberg tables are registered.
- principal
Role string - (Updatable) The Snowflake role used to access Polaris.
- properties string
- (Updatable) The base64 encoded content of the configuration file containing additional properties for the REST catalog.
- properties
Secret stringId - (Updatable) The OCID of the Secret that stores the content of the configuration file containing additional properties for the REST catalog. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm
- uri string
- (Updatable) The URL endpoint for the Polaris API. e.g.: 'https://.snowflakecomputing.com/polaris/api/catalog'
- catalog_
type str - (Updatable) The catalog type.
- branch str
- (Updatable) The active branch of the Nessie catalog from which Iceberg reads and writes table metadata.
- client_
id str - (Updatable) The OAuth client ID used for authentication.
- client_
secret str - (Updatable) Client secret required to connect to Polaris.
- client_
secret_ strsecret_ id - (Updatable) The OCID of the Secret that stores the password Oracle GoldenGate uses to connect to Polaris.
- glue_
id str - (Updatable) The AWS Glue Catalog ID where Iceberg tables are registered.
- name str
- (Updatable) The catalog name within Polaris where Iceberg tables are registered.
- principal_
role str - (Updatable) The Snowflake role used to access Polaris.
- properties str
- (Updatable) The base64 encoded content of the configuration file containing additional properties for the REST catalog.
- properties_
secret_ strid - (Updatable) The OCID of the Secret that stores the content of the configuration file containing additional properties for the REST catalog. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm
- uri str
- (Updatable) The URL endpoint for the Polaris API. e.g.: 'https://.snowflakecomputing.com/polaris/api/catalog'
- catalog
Type String - (Updatable) The catalog type.
- branch String
- (Updatable) The active branch of the Nessie catalog from which Iceberg reads and writes table metadata.
- client
Id String - (Updatable) The OAuth client ID used for authentication.
- client
Secret String - (Updatable) Client secret required to connect to Polaris.
- client
Secret StringSecret Id - (Updatable) The OCID of the Secret that stores the password Oracle GoldenGate uses to connect to Polaris.
- glue
Id String - (Updatable) The AWS Glue Catalog ID where Iceberg tables are registered.
- name String
- (Updatable) The catalog name within Polaris where Iceberg tables are registered.
- principal
Role String - (Updatable) The Snowflake role used to access Polaris.
- properties String
- (Updatable) The base64 encoded content of the configuration file containing additional properties for the REST catalog.
- properties
Secret StringId - (Updatable) The OCID of the Secret that stores the content of the configuration file containing additional properties for the REST catalog. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm
- uri String
- (Updatable) The URL endpoint for the Polaris API. e.g.: 'https://.snowflakecomputing.com/polaris/api/catalog'
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 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 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.
ConnectionStorage, ConnectionStorageArgs
- Storage
Type string - (Updatable) The storage type used in the Iceberg connection. Supported storage types by catalog type:
- GLUE: AMAZON_S3.
- HADOOP: AMAZON_S3, GOOGLE_CLOUD_STORAGE, AZURE_DATA_LAKE_STORAGE, or OCI_OBJECT_STORAGE_S3_API.
- NESSIE: AMAZON_S3, GOOGLE_CLOUD_STORAGE, or AZURE_DATA_LAKE_STORAGE.
- POLARIS: AMAZON_S3, GOOGLE_CLOUD_STORAGE, or AZURE_DATA_LAKE_STORAGE.
- REST: AMAZON_S3, GOOGLE_CLOUD_STORAGE, AZURE_DATA_LAKE_STORAGE, or NONE.
- Access
Key stringId (Updatable) Access Key ID from the Oracle Cloud Infrastructure IAM user's Customer Secret Key pair used to authenticate to Oracle Cloud Infrastructure Object Storage via the S3 Compatibility API.
Note: Despite the "Id" suffix, this value is not an Oracle Cloud Infrastructure OCID.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Account
Key stringSecret Id - (Updatable) The OCID of the Secret where the account key is stored.
- Account
Name string - (Updatable) Sets the Azure storage account name.
- Bucket string
- (Updatable) Target Oracle Cloud Infrastructure Object Storage bucket name where Iceberg stores table metadata and data files.
- Container string
- (Updatable) The Azure Blob Storage container where Iceberg tables are stored.
- Endpoint string
- (Updatable) Oracle Cloud Infrastructure Object Storage S3 Compatibility API endpoint URL. Format: "https://.compat.objectstorage.." Example: "https://mynamespace.compat.objectstorage.us-ashburn-1.oraclecloud.com"
- Project
Id string - (Updatable) The Google Cloud Project where the bucket exists.
- Region string
- (Updatable) The AMAZON region where the S3 bucket is hosted. e.g.: 'us-east-2'
- Scheme
Type string - (Updatable) The scheme of the storage.
- Secret
Access stringKey - (Updatable) Secret Access Key from the Oracle Cloud Infrastructure IAM user's Customer Secret Key pair used to authenticate to Oracle Cloud Infrastructure Object Storage via the S3 Compatibility API. Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Secret
Access stringKey Secret Id - (Updatable) The OCID of the Secret where the Secret Access Key used for Oracle Cloud Infrastructure Object Storage S3 Compatibility authentication.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Service
Account stringKey File Secret Id - (Updatable) The OCID of the Secret where the content of the service account key file is stored, which contains the credentials required to use Google Cloud Storage.
- Storage
Type string - (Updatable) The storage type used in the Iceberg connection. Supported storage types by catalog type:
- GLUE: AMAZON_S3.
- HADOOP: AMAZON_S3, GOOGLE_CLOUD_STORAGE, AZURE_DATA_LAKE_STORAGE, or OCI_OBJECT_STORAGE_S3_API.
- NESSIE: AMAZON_S3, GOOGLE_CLOUD_STORAGE, or AZURE_DATA_LAKE_STORAGE.
- POLARIS: AMAZON_S3, GOOGLE_CLOUD_STORAGE, or AZURE_DATA_LAKE_STORAGE.
- REST: AMAZON_S3, GOOGLE_CLOUD_STORAGE, AZURE_DATA_LAKE_STORAGE, or NONE.
- Access
Key stringId (Updatable) Access Key ID from the Oracle Cloud Infrastructure IAM user's Customer Secret Key pair used to authenticate to Oracle Cloud Infrastructure Object Storage via the S3 Compatibility API.
Note: Despite the "Id" suffix, this value is not an Oracle Cloud Infrastructure OCID.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Account
Key stringSecret Id - (Updatable) The OCID of the Secret where the account key is stored.
- Account
Name string - (Updatable) Sets the Azure storage account name.
- Bucket string
- (Updatable) Target Oracle Cloud Infrastructure Object Storage bucket name where Iceberg stores table metadata and data files.
- Container string
- (Updatable) The Azure Blob Storage container where Iceberg tables are stored.
- Endpoint string
- (Updatable) Oracle Cloud Infrastructure Object Storage S3 Compatibility API endpoint URL. Format: "https://.compat.objectstorage.." Example: "https://mynamespace.compat.objectstorage.us-ashburn-1.oraclecloud.com"
- Project
Id string - (Updatable) The Google Cloud Project where the bucket exists.
- Region string
- (Updatable) The AMAZON region where the S3 bucket is hosted. e.g.: 'us-east-2'
- Scheme
Type string - (Updatable) The scheme of the storage.
- Secret
Access stringKey - (Updatable) Secret Access Key from the Oracle Cloud Infrastructure IAM user's Customer Secret Key pair used to authenticate to Oracle Cloud Infrastructure Object Storage via the S3 Compatibility API. Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Secret
Access stringKey Secret Id - (Updatable) The OCID of the Secret where the Secret Access Key used for Oracle Cloud Infrastructure Object Storage S3 Compatibility authentication.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Service
Account stringKey File Secret Id - (Updatable) The OCID of the Secret where the content of the service account key file is stored, which contains the credentials required to use Google Cloud Storage.
- storage_
type string - (Updatable) The storage type used in the Iceberg connection. Supported storage types by catalog type:
- GLUE: AMAZON_S3.
- HADOOP: AMAZON_S3, GOOGLE_CLOUD_STORAGE, AZURE_DATA_LAKE_STORAGE, or OCI_OBJECT_STORAGE_S3_API.
- NESSIE: AMAZON_S3, GOOGLE_CLOUD_STORAGE, or AZURE_DATA_LAKE_STORAGE.
- POLARIS: AMAZON_S3, GOOGLE_CLOUD_STORAGE, or AZURE_DATA_LAKE_STORAGE.
- REST: AMAZON_S3, GOOGLE_CLOUD_STORAGE, AZURE_DATA_LAKE_STORAGE, or NONE.
- access_
key_ stringid (Updatable) Access Key ID from the Oracle Cloud Infrastructure IAM user's Customer Secret Key pair used to authenticate to Oracle Cloud Infrastructure Object Storage via the S3 Compatibility API.
Note: Despite the "Id" suffix, this value is not an Oracle Cloud Infrastructure OCID.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- account_
key_ stringsecret_ id - (Updatable) The OCID of the Secret where the account key is stored.
- account_
name string - (Updatable) Sets the Azure storage account name.
- bucket string
- (Updatable) Target Oracle Cloud Infrastructure Object Storage bucket name where Iceberg stores table metadata and data files.
- container string
- (Updatable) The Azure Blob Storage container where Iceberg tables are stored.
- endpoint string
- (Updatable) Oracle Cloud Infrastructure Object Storage S3 Compatibility API endpoint URL. Format: "https://.compat.objectstorage.." Example: "https://mynamespace.compat.objectstorage.us-ashburn-1.oraclecloud.com"
- project_
id string - (Updatable) The Google Cloud Project where the bucket exists.
- region string
- (Updatable) The AMAZON region where the S3 bucket is hosted. e.g.: 'us-east-2'
- scheme_
type string - (Updatable) The scheme of the storage.
- secret_
access_ stringkey - (Updatable) Secret Access Key from the Oracle Cloud Infrastructure IAM user's Customer Secret Key pair used to authenticate to Oracle Cloud Infrastructure Object Storage via the S3 Compatibility API. Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- secret_
access_ stringkey_ secret_ id - (Updatable) The OCID of the Secret where the Secret Access Key used for Oracle Cloud Infrastructure Object Storage S3 Compatibility authentication.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- service_
account_ stringkey_ file_ secret_ id - (Updatable) The OCID of the Secret where the content of the service account key file is stored, which contains the credentials required to use Google Cloud Storage.
- storage
Type String - (Updatable) The storage type used in the Iceberg connection. Supported storage types by catalog type:
- GLUE: AMAZON_S3.
- HADOOP: AMAZON_S3, GOOGLE_CLOUD_STORAGE, AZURE_DATA_LAKE_STORAGE, or OCI_OBJECT_STORAGE_S3_API.
- NESSIE: AMAZON_S3, GOOGLE_CLOUD_STORAGE, or AZURE_DATA_LAKE_STORAGE.
- POLARIS: AMAZON_S3, GOOGLE_CLOUD_STORAGE, or AZURE_DATA_LAKE_STORAGE.
- REST: AMAZON_S3, GOOGLE_CLOUD_STORAGE, AZURE_DATA_LAKE_STORAGE, or NONE.
- access
Key StringId (Updatable) Access Key ID from the Oracle Cloud Infrastructure IAM user's Customer Secret Key pair used to authenticate to Oracle Cloud Infrastructure Object Storage via the S3 Compatibility API.
Note: Despite the "Id" suffix, this value is not an Oracle Cloud Infrastructure OCID.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- account
Key StringSecret Id - (Updatable) The OCID of the Secret where the account key is stored.
- account
Name String - (Updatable) Sets the Azure storage account name.
- bucket String
- (Updatable) Target Oracle Cloud Infrastructure Object Storage bucket name where Iceberg stores table metadata and data files.
- container String
- (Updatable) The Azure Blob Storage container where Iceberg tables are stored.
- endpoint String
- (Updatable) Oracle Cloud Infrastructure Object Storage S3 Compatibility API endpoint URL. Format: "https://.compat.objectstorage.." Example: "https://mynamespace.compat.objectstorage.us-ashburn-1.oraclecloud.com"
- project
Id String - (Updatable) The Google Cloud Project where the bucket exists.
- region String
- (Updatable) The AMAZON region where the S3 bucket is hosted. e.g.: 'us-east-2'
- scheme
Type String - (Updatable) The scheme of the storage.
- secret
Access StringKey - (Updatable) Secret Access Key from the Oracle Cloud Infrastructure IAM user's Customer Secret Key pair used to authenticate to Oracle Cloud Infrastructure Object Storage via the S3 Compatibility API. Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- secret
Access StringKey Secret Id - (Updatable) The OCID of the Secret where the Secret Access Key used for Oracle Cloud Infrastructure Object Storage S3 Compatibility authentication.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- service
Account StringKey File Secret Id - (Updatable) The OCID of the Secret where the content of the service account key file is stored, which contains the credentials required to use Google Cloud Storage.
- storage
Type string - (Updatable) The storage type used in the Iceberg connection. Supported storage types by catalog type:
- GLUE: AMAZON_S3.
- HADOOP: AMAZON_S3, GOOGLE_CLOUD_STORAGE, AZURE_DATA_LAKE_STORAGE, or OCI_OBJECT_STORAGE_S3_API.
- NESSIE: AMAZON_S3, GOOGLE_CLOUD_STORAGE, or AZURE_DATA_LAKE_STORAGE.
- POLARIS: AMAZON_S3, GOOGLE_CLOUD_STORAGE, or AZURE_DATA_LAKE_STORAGE.
- REST: AMAZON_S3, GOOGLE_CLOUD_STORAGE, AZURE_DATA_LAKE_STORAGE, or NONE.
- access
Key stringId (Updatable) Access Key ID from the Oracle Cloud Infrastructure IAM user's Customer Secret Key pair used to authenticate to Oracle Cloud Infrastructure Object Storage via the S3 Compatibility API.
Note: Despite the "Id" suffix, this value is not an Oracle Cloud Infrastructure OCID.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- account
Key stringSecret Id - (Updatable) The OCID of the Secret where the account key is stored.
- account
Name string - (Updatable) Sets the Azure storage account name.
- bucket string
- (Updatable) Target Oracle Cloud Infrastructure Object Storage bucket name where Iceberg stores table metadata and data files.
- container string
- (Updatable) The Azure Blob Storage container where Iceberg tables are stored.
- endpoint string
- (Updatable) Oracle Cloud Infrastructure Object Storage S3 Compatibility API endpoint URL. Format: "https://.compat.objectstorage.." Example: "https://mynamespace.compat.objectstorage.us-ashburn-1.oraclecloud.com"
- project
Id string - (Updatable) The Google Cloud Project where the bucket exists.
- region string
- (Updatable) The AMAZON region where the S3 bucket is hosted. e.g.: 'us-east-2'
- scheme
Type string - (Updatable) The scheme of the storage.
- secret
Access stringKey - (Updatable) Secret Access Key from the Oracle Cloud Infrastructure IAM user's Customer Secret Key pair used to authenticate to Oracle Cloud Infrastructure Object Storage via the S3 Compatibility API. Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- secret
Access stringKey Secret Id - (Updatable) The OCID of the Secret where the Secret Access Key used for Oracle Cloud Infrastructure Object Storage S3 Compatibility authentication.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- service
Account stringKey File Secret Id - (Updatable) The OCID of the Secret where the content of the service account key file is stored, which contains the credentials required to use Google Cloud Storage.
- storage_
type str - (Updatable) The storage type used in the Iceberg connection. Supported storage types by catalog type:
- GLUE: AMAZON_S3.
- HADOOP: AMAZON_S3, GOOGLE_CLOUD_STORAGE, AZURE_DATA_LAKE_STORAGE, or OCI_OBJECT_STORAGE_S3_API.
- NESSIE: AMAZON_S3, GOOGLE_CLOUD_STORAGE, or AZURE_DATA_LAKE_STORAGE.
- POLARIS: AMAZON_S3, GOOGLE_CLOUD_STORAGE, or AZURE_DATA_LAKE_STORAGE.
- REST: AMAZON_S3, GOOGLE_CLOUD_STORAGE, AZURE_DATA_LAKE_STORAGE, or NONE.
- access_
key_ strid (Updatable) Access Key ID from the Oracle Cloud Infrastructure IAM user's Customer Secret Key pair used to authenticate to Oracle Cloud Infrastructure Object Storage via the S3 Compatibility API.
Note: Despite the "Id" suffix, this value is not an Oracle Cloud Infrastructure OCID.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- account_
key_ strsecret_ id - (Updatable) The OCID of the Secret where the account key is stored.
- account_
name str - (Updatable) Sets the Azure storage account name.
- bucket str
- (Updatable) Target Oracle Cloud Infrastructure Object Storage bucket name where Iceberg stores table metadata and data files.
- container str
- (Updatable) The Azure Blob Storage container where Iceberg tables are stored.
- endpoint str
- (Updatable) Oracle Cloud Infrastructure Object Storage S3 Compatibility API endpoint URL. Format: "https://.compat.objectstorage.." Example: "https://mynamespace.compat.objectstorage.us-ashburn-1.oraclecloud.com"
- project_
id str - (Updatable) The Google Cloud Project where the bucket exists.
- region str
- (Updatable) The AMAZON region where the S3 bucket is hosted. e.g.: 'us-east-2'
- scheme_
type str - (Updatable) The scheme of the storage.
- secret_
access_ strkey - (Updatable) Secret Access Key from the Oracle Cloud Infrastructure IAM user's Customer Secret Key pair used to authenticate to Oracle Cloud Infrastructure Object Storage via the S3 Compatibility API. Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- secret_
access_ strkey_ secret_ id - (Updatable) The OCID of the Secret where the Secret Access Key used for Oracle Cloud Infrastructure Object Storage S3 Compatibility authentication.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- service_
account_ strkey_ file_ secret_ id - (Updatable) The OCID of the Secret where the content of the service account key file is stored, which contains the credentials required to use Google Cloud Storage.
- storage
Type String - (Updatable) The storage type used in the Iceberg connection. Supported storage types by catalog type:
- GLUE: AMAZON_S3.
- HADOOP: AMAZON_S3, GOOGLE_CLOUD_STORAGE, AZURE_DATA_LAKE_STORAGE, or OCI_OBJECT_STORAGE_S3_API.
- NESSIE: AMAZON_S3, GOOGLE_CLOUD_STORAGE, or AZURE_DATA_LAKE_STORAGE.
- POLARIS: AMAZON_S3, GOOGLE_CLOUD_STORAGE, or AZURE_DATA_LAKE_STORAGE.
- REST: AMAZON_S3, GOOGLE_CLOUD_STORAGE, AZURE_DATA_LAKE_STORAGE, or NONE.
- access
Key StringId (Updatable) Access Key ID from the Oracle Cloud Infrastructure IAM user's Customer Secret Key pair used to authenticate to Oracle Cloud Infrastructure Object Storage via the S3 Compatibility API.
Note: Despite the "Id" suffix, this value is not an Oracle Cloud Infrastructure OCID.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- account
Key StringSecret Id - (Updatable) The OCID of the Secret where the account key is stored.
- account
Name String - (Updatable) Sets the Azure storage account name.
- bucket String
- (Updatable) Target Oracle Cloud Infrastructure Object Storage bucket name where Iceberg stores table metadata and data files.
- container String
- (Updatable) The Azure Blob Storage container where Iceberg tables are stored.
- endpoint String
- (Updatable) Oracle Cloud Infrastructure Object Storage S3 Compatibility API endpoint URL. Format: "https://.compat.objectstorage.." Example: "https://mynamespace.compat.objectstorage.us-ashburn-1.oraclecloud.com"
- project
Id String - (Updatable) The Google Cloud Project where the bucket exists.
- region String
- (Updatable) The AMAZON region where the S3 bucket is hosted. e.g.: 'us-east-2'
- scheme
Type String - (Updatable) The scheme of the storage.
- secret
Access StringKey - (Updatable) Secret Access Key from the Oracle Cloud Infrastructure IAM user's Customer Secret Key pair used to authenticate to Oracle Cloud Infrastructure Object Storage via the S3 Compatibility API. Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- secret
Access StringKey Secret Id - (Updatable) The OCID of the Secret where the Secret Access Key used for Oracle Cloud Infrastructure Object Storage S3 Compatibility authentication.
- 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 change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- service
Account StringKey File Secret Id - (Updatable) The OCID of the Secret where the content of the service account key file is stored, which contains the credentials required to use Google Cloud Storage.
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.
published on Thursday, Nov 19, 2026 by Pulumi