oci logo
Oracle Cloud Infrastructure v0.6.0, Jan 23 23

oci.GoldenGate.Connection

This resource provides the Connection resource in Oracle Cloud Infrastructure Golden Gate service.

Creates a new Connection.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var testConnection = new Oci.GoldenGate.Connection("testConnection", new()
    {
        CompartmentId = @var.Compartment_id,
        ConnectionType = @var.Connection_connection_type,
        DisplayName = @var.Connection_display_name,
        TechnologyType = @var.Connection_technology_type,
        AccountKey = @var.Connection_account_key,
        AccountName = @var.Connection_account_name,
        AdditionalAttributes = new[]
        {
            new Oci.GoldenGate.Inputs.ConnectionAdditionalAttributeArgs
            {
                Name = @var.Connection_additional_attributes_name,
                Value = @var.Connection_additional_attributes_value,
            },
        },
        AuthenticationType = @var.Connection_authentication_type,
        AzureTenantId = oci_golden_gate_azure_tenant.Test_azure_tenant.Id,
        BootstrapServers = new[]
        {
            new Oci.GoldenGate.Inputs.ConnectionBootstrapServerArgs
            {
                Host = @var.Connection_bootstrap_servers_host,
                Port = @var.Connection_bootstrap_servers_port,
                PrivateIp = @var.Connection_bootstrap_servers_private_ip,
            },
        },
        ClientId = oci_golden_gate_client.Test_client.Id,
        ClientSecret = @var.Connection_client_secret,
        ConnectionString = @var.Connection_connection_string,
        ConsumerProperties = @var.Connection_consumer_properties,
        DatabaseId = oci_database_database.Test_database.Id,
        DatabaseName = oci_database_database.Test_database.Name,
        DbSystemId = oci_database_db_system.Test_db_system.Id,
        DefinedTags = 
        {
            { "foo-namespace.bar-key", "value" },
        },
        DeploymentId = oci_golden_gate_deployment.Test_deployment.Id,
        Description = @var.Connection_description,
        Endpoint = @var.Connection_endpoint,
        FreeformTags = 
        {
            { "bar-key", "value" },
        },
        Host = @var.Connection_host,
        KeyId = oci_kms_key.Test_key.Id,
        KeyStore = @var.Connection_key_store,
        KeyStorePassword = @var.Connection_key_store_password,
        NsgIds = @var.Connection_nsg_ids,
        Password = @var.Connection_password,
        Port = @var.Connection_port,
        PrivateIp = @var.Connection_private_ip,
        PrivateKeyFile = @var.Connection_private_key_file,
        PrivateKeyPassphrase = @var.Connection_private_key_passphrase,
        ProducerProperties = @var.Connection_producer_properties,
        PublicKeyFingerprint = @var.Connection_public_key_fingerprint,
        Region = @var.Connection_region,
        SasToken = @var.Connection_sas_token,
        SecurityProtocol = @var.Connection_security_protocol,
        SessionMode = @var.Connection_session_mode,
        SslCa = @var.Connection_ssl_ca,
        SslCert = @var.Connection_ssl_cert,
        SslCrl = @var.Connection_ssl_crl,
        SslKey = @var.Connection_ssl_key,
        SslKeyPassword = @var.Connection_ssl_key_password,
        SslMode = @var.Connection_ssl_mode,
        StreamPoolId = oci_streaming_stream_pool.Test_stream_pool.Id,
        SubnetId = oci_core_subnet.Test_subnet.Id,
        TenancyId = oci_identity_tenancy.Test_tenancy.Id,
        TrustStore = @var.Connection_trust_store,
        TrustStorePassword = @var.Connection_trust_store_password,
        Url = @var.Connection_url,
        UserId = oci_identity_user.Test_user.Id,
        Username = @var.Connection_username,
        VaultId = oci_kms_vault.Test_vault.Id,
        Wallet = @var.Connection_wallet,
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := GoldenGate.NewConnection(ctx, "testConnection", &GoldenGate.ConnectionArgs{
			CompartmentId:  pulumi.Any(_var.Compartment_id),
			ConnectionType: pulumi.Any(_var.Connection_connection_type),
			DisplayName:    pulumi.Any(_var.Connection_display_name),
			TechnologyType: pulumi.Any(_var.Connection_technology_type),
			AccountKey:     pulumi.Any(_var.Connection_account_key),
			AccountName:    pulumi.Any(_var.Connection_account_name),
			AdditionalAttributes: goldengate.ConnectionAdditionalAttributeArray{
				&goldengate.ConnectionAdditionalAttributeArgs{
					Name:  pulumi.Any(_var.Connection_additional_attributes_name),
					Value: pulumi.Any(_var.Connection_additional_attributes_value),
				},
			},
			AuthenticationType: pulumi.Any(_var.Connection_authentication_type),
			AzureTenantId:      pulumi.Any(oci_golden_gate_azure_tenant.Test_azure_tenant.Id),
			BootstrapServers: goldengate.ConnectionBootstrapServerArray{
				&goldengate.ConnectionBootstrapServerArgs{
					Host:      pulumi.Any(_var.Connection_bootstrap_servers_host),
					Port:      pulumi.Any(_var.Connection_bootstrap_servers_port),
					PrivateIp: pulumi.Any(_var.Connection_bootstrap_servers_private_ip),
				},
			},
			ClientId:           pulumi.Any(oci_golden_gate_client.Test_client.Id),
			ClientSecret:       pulumi.Any(_var.Connection_client_secret),
			ConnectionString:   pulumi.Any(_var.Connection_connection_string),
			ConsumerProperties: pulumi.Any(_var.Connection_consumer_properties),
			DatabaseId:         pulumi.Any(oci_database_database.Test_database.Id),
			DatabaseName:       pulumi.Any(oci_database_database.Test_database.Name),
			DbSystemId:         pulumi.Any(oci_database_db_system.Test_db_system.Id),
			DefinedTags: pulumi.AnyMap{
				"foo-namespace.bar-key": pulumi.Any("value"),
			},
			DeploymentId: pulumi.Any(oci_golden_gate_deployment.Test_deployment.Id),
			Description:  pulumi.Any(_var.Connection_description),
			Endpoint:     pulumi.Any(_var.Connection_endpoint),
			FreeformTags: pulumi.AnyMap{
				"bar-key": pulumi.Any("value"),
			},
			Host:                 pulumi.Any(_var.Connection_host),
			KeyId:                pulumi.Any(oci_kms_key.Test_key.Id),
			KeyStore:             pulumi.Any(_var.Connection_key_store),
			KeyStorePassword:     pulumi.Any(_var.Connection_key_store_password),
			NsgIds:               pulumi.Any(_var.Connection_nsg_ids),
			Password:             pulumi.Any(_var.Connection_password),
			Port:                 pulumi.Any(_var.Connection_port),
			PrivateIp:            pulumi.Any(_var.Connection_private_ip),
			PrivateKeyFile:       pulumi.Any(_var.Connection_private_key_file),
			PrivateKeyPassphrase: pulumi.Any(_var.Connection_private_key_passphrase),
			ProducerProperties:   pulumi.Any(_var.Connection_producer_properties),
			PublicKeyFingerprint: pulumi.Any(_var.Connection_public_key_fingerprint),
			Region:               pulumi.Any(_var.Connection_region),
			SasToken:             pulumi.Any(_var.Connection_sas_token),
			SecurityProtocol:     pulumi.Any(_var.Connection_security_protocol),
			SessionMode:          pulumi.Any(_var.Connection_session_mode),
			SslCa:                pulumi.Any(_var.Connection_ssl_ca),
			SslCert:              pulumi.Any(_var.Connection_ssl_cert),
			SslCrl:               pulumi.Any(_var.Connection_ssl_crl),
			SslKey:               pulumi.Any(_var.Connection_ssl_key),
			SslKeyPassword:       pulumi.Any(_var.Connection_ssl_key_password),
			SslMode:              pulumi.Any(_var.Connection_ssl_mode),
			StreamPoolId:         pulumi.Any(oci_streaming_stream_pool.Test_stream_pool.Id),
			SubnetId:             pulumi.Any(oci_core_subnet.Test_subnet.Id),
			TenancyId:            pulumi.Any(oci_identity_tenancy.Test_tenancy.Id),
			TrustStore:           pulumi.Any(_var.Connection_trust_store),
			TrustStorePassword:   pulumi.Any(_var.Connection_trust_store_password),
			Url:                  pulumi.Any(_var.Connection_url),
			UserId:               pulumi.Any(oci_identity_user.Test_user.Id),
			Username:             pulumi.Any(_var.Connection_username),
			VaultId:              pulumi.Any(oci_kms_vault.Test_vault.Id),
			Wallet:               pulumi.Any(_var.Connection_wallet),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.GoldenGate.Connection;
import com.pulumi.oci.GoldenGate.ConnectionArgs;
import com.pulumi.oci.GoldenGate.inputs.ConnectionAdditionalAttributeArgs;
import com.pulumi.oci.GoldenGate.inputs.ConnectionBootstrapServerArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var testConnection = new Connection("testConnection", ConnectionArgs.builder()        
            .compartmentId(var_.compartment_id())
            .connectionType(var_.connection_connection_type())
            .displayName(var_.connection_display_name())
            .technologyType(var_.connection_technology_type())
            .accountKey(var_.connection_account_key())
            .accountName(var_.connection_account_name())
            .additionalAttributes(ConnectionAdditionalAttributeArgs.builder()
                .name(var_.connection_additional_attributes_name())
                .value(var_.connection_additional_attributes_value())
                .build())
            .authenticationType(var_.connection_authentication_type())
            .azureTenantId(oci_golden_gate_azure_tenant.test_azure_tenant().id())
            .bootstrapServers(ConnectionBootstrapServerArgs.builder()
                .host(var_.connection_bootstrap_servers_host())
                .port(var_.connection_bootstrap_servers_port())
                .privateIp(var_.connection_bootstrap_servers_private_ip())
                .build())
            .clientId(oci_golden_gate_client.test_client().id())
            .clientSecret(var_.connection_client_secret())
            .connectionString(var_.connection_connection_string())
            .consumerProperties(var_.connection_consumer_properties())
            .databaseId(oci_database_database.test_database().id())
            .databaseName(oci_database_database.test_database().name())
            .dbSystemId(oci_database_db_system.test_db_system().id())
            .definedTags(Map.of("foo-namespace.bar-key", "value"))
            .deploymentId(oci_golden_gate_deployment.test_deployment().id())
            .description(var_.connection_description())
            .endpoint(var_.connection_endpoint())
            .freeformTags(Map.of("bar-key", "value"))
            .host(var_.connection_host())
            .keyId(oci_kms_key.test_key().id())
            .keyStore(var_.connection_key_store())
            .keyStorePassword(var_.connection_key_store_password())
            .nsgIds(var_.connection_nsg_ids())
            .password(var_.connection_password())
            .port(var_.connection_port())
            .privateIp(var_.connection_private_ip())
            .privateKeyFile(var_.connection_private_key_file())
            .privateKeyPassphrase(var_.connection_private_key_passphrase())
            .producerProperties(var_.connection_producer_properties())
            .publicKeyFingerprint(var_.connection_public_key_fingerprint())
            .region(var_.connection_region())
            .sasToken(var_.connection_sas_token())
            .securityProtocol(var_.connection_security_protocol())
            .sessionMode(var_.connection_session_mode())
            .sslCa(var_.connection_ssl_ca())
            .sslCert(var_.connection_ssl_cert())
            .sslCrl(var_.connection_ssl_crl())
            .sslKey(var_.connection_ssl_key())
            .sslKeyPassword(var_.connection_ssl_key_password())
            .sslMode(var_.connection_ssl_mode())
            .streamPoolId(oci_streaming_stream_pool.test_stream_pool().id())
            .subnetId(oci_core_subnet.test_subnet().id())
            .tenancyId(oci_identity_tenancy.test_tenancy().id())
            .trustStore(var_.connection_trust_store())
            .trustStorePassword(var_.connection_trust_store_password())
            .url(var_.connection_url())
            .userId(oci_identity_user.test_user().id())
            .username(var_.connection_username())
            .vaultId(oci_kms_vault.test_vault().id())
            .wallet(var_.connection_wallet())
            .build());

    }
}
import pulumi
import pulumi_oci as oci

test_connection = oci.golden_gate.Connection("testConnection",
    compartment_id=var["compartment_id"],
    connection_type=var["connection_connection_type"],
    display_name=var["connection_display_name"],
    technology_type=var["connection_technology_type"],
    account_key=var["connection_account_key"],
    account_name=var["connection_account_name"],
    additional_attributes=[oci.golden_gate.ConnectionAdditionalAttributeArgs(
        name=var["connection_additional_attributes_name"],
        value=var["connection_additional_attributes_value"],
    )],
    authentication_type=var["connection_authentication_type"],
    azure_tenant_id=oci_golden_gate_azure_tenant["test_azure_tenant"]["id"],
    bootstrap_servers=[oci.golden_gate.ConnectionBootstrapServerArgs(
        host=var["connection_bootstrap_servers_host"],
        port=var["connection_bootstrap_servers_port"],
        private_ip=var["connection_bootstrap_servers_private_ip"],
    )],
    client_id=oci_golden_gate_client["test_client"]["id"],
    client_secret=var["connection_client_secret"],
    connection_string=var["connection_connection_string"],
    consumer_properties=var["connection_consumer_properties"],
    database_id=oci_database_database["test_database"]["id"],
    database_name=oci_database_database["test_database"]["name"],
    db_system_id=oci_database_db_system["test_db_system"]["id"],
    defined_tags={
        "foo-namespace.bar-key": "value",
    },
    deployment_id=oci_golden_gate_deployment["test_deployment"]["id"],
    description=var["connection_description"],
    endpoint=var["connection_endpoint"],
    freeform_tags={
        "bar-key": "value",
    },
    host=var["connection_host"],
    key_id=oci_kms_key["test_key"]["id"],
    key_store=var["connection_key_store"],
    key_store_password=var["connection_key_store_password"],
    nsg_ids=var["connection_nsg_ids"],
    password=var["connection_password"],
    port=var["connection_port"],
    private_ip=var["connection_private_ip"],
    private_key_file=var["connection_private_key_file"],
    private_key_passphrase=var["connection_private_key_passphrase"],
    producer_properties=var["connection_producer_properties"],
    public_key_fingerprint=var["connection_public_key_fingerprint"],
    region=var["connection_region"],
    sas_token=var["connection_sas_token"],
    security_protocol=var["connection_security_protocol"],
    session_mode=var["connection_session_mode"],
    ssl_ca=var["connection_ssl_ca"],
    ssl_cert=var["connection_ssl_cert"],
    ssl_crl=var["connection_ssl_crl"],
    ssl_key=var["connection_ssl_key"],
    ssl_key_password=var["connection_ssl_key_password"],
    ssl_mode=var["connection_ssl_mode"],
    stream_pool_id=oci_streaming_stream_pool["test_stream_pool"]["id"],
    subnet_id=oci_core_subnet["test_subnet"]["id"],
    tenancy_id=oci_identity_tenancy["test_tenancy"]["id"],
    trust_store=var["connection_trust_store"],
    trust_store_password=var["connection_trust_store_password"],
    url=var["connection_url"],
    user_id=oci_identity_user["test_user"]["id"],
    username=var["connection_username"],
    vault_id=oci_kms_vault["test_vault"]["id"],
    wallet=var["connection_wallet"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testConnection = new oci.goldengate.Connection("testConnection", {
    compartmentId: _var.compartment_id,
    connectionType: _var.connection_connection_type,
    displayName: _var.connection_display_name,
    technologyType: _var.connection_technology_type,
    accountKey: _var.connection_account_key,
    accountName: _var.connection_account_name,
    additionalAttributes: [{
        name: _var.connection_additional_attributes_name,
        value: _var.connection_additional_attributes_value,
    }],
    authenticationType: _var.connection_authentication_type,
    azureTenantId: oci_golden_gate_azure_tenant.test_azure_tenant.id,
    bootstrapServers: [{
        host: _var.connection_bootstrap_servers_host,
        port: _var.connection_bootstrap_servers_port,
        privateIp: _var.connection_bootstrap_servers_private_ip,
    }],
    clientId: oci_golden_gate_client.test_client.id,
    clientSecret: _var.connection_client_secret,
    connectionString: _var.connection_connection_string,
    consumerProperties: _var.connection_consumer_properties,
    databaseId: oci_database_database.test_database.id,
    databaseName: oci_database_database.test_database.name,
    dbSystemId: oci_database_db_system.test_db_system.id,
    definedTags: {
        "foo-namespace.bar-key": "value",
    },
    deploymentId: oci_golden_gate_deployment.test_deployment.id,
    description: _var.connection_description,
    endpoint: _var.connection_endpoint,
    freeformTags: {
        "bar-key": "value",
    },
    host: _var.connection_host,
    keyId: oci_kms_key.test_key.id,
    keyStore: _var.connection_key_store,
    keyStorePassword: _var.connection_key_store_password,
    nsgIds: _var.connection_nsg_ids,
    password: _var.connection_password,
    port: _var.connection_port,
    privateIp: _var.connection_private_ip,
    privateKeyFile: _var.connection_private_key_file,
    privateKeyPassphrase: _var.connection_private_key_passphrase,
    producerProperties: _var.connection_producer_properties,
    publicKeyFingerprint: _var.connection_public_key_fingerprint,
    region: _var.connection_region,
    sasToken: _var.connection_sas_token,
    securityProtocol: _var.connection_security_protocol,
    sessionMode: _var.connection_session_mode,
    sslCa: _var.connection_ssl_ca,
    sslCert: _var.connection_ssl_cert,
    sslCrl: _var.connection_ssl_crl,
    sslKey: _var.connection_ssl_key,
    sslKeyPassword: _var.connection_ssl_key_password,
    sslMode: _var.connection_ssl_mode,
    streamPoolId: oci_streaming_stream_pool.test_stream_pool.id,
    subnetId: oci_core_subnet.test_subnet.id,
    tenancyId: oci_identity_tenancy.test_tenancy.id,
    trustStore: _var.connection_trust_store,
    trustStorePassword: _var.connection_trust_store_password,
    url: _var.connection_url,
    userId: oci_identity_user.test_user.id,
    username: _var.connection_username,
    vaultId: oci_kms_vault.test_vault.id,
    wallet: _var.connection_wallet,
});
resources:
  testConnection:
    type: oci:GoldenGate:Connection
    properties:
      #Required
      compartmentId: ${var.compartment_id}
      connectionType: ${var.connection_connection_type}
      displayName: ${var.connection_display_name}
      technologyType: ${var.connection_technology_type}
      #Optional
      accountKey: ${var.connection_account_key}
      accountName: ${var.connection_account_name}
      additionalAttributes:
        - name: ${var.connection_additional_attributes_name}
          value: ${var.connection_additional_attributes_value}
      authenticationType: ${var.connection_authentication_type}
      azureTenantId: ${oci_golden_gate_azure_tenant.test_azure_tenant.id}
      bootstrapServers:
        - host: ${var.connection_bootstrap_servers_host}
          port: ${var.connection_bootstrap_servers_port}
          privateIp: ${var.connection_bootstrap_servers_private_ip}
      clientId: ${oci_golden_gate_client.test_client.id}
      clientSecret: ${var.connection_client_secret}
      connectionString: ${var.connection_connection_string}
      consumerProperties: ${var.connection_consumer_properties}
      databaseId: ${oci_database_database.test_database.id}
      databaseName: ${oci_database_database.test_database.name}
      dbSystemId: ${oci_database_db_system.test_db_system.id}
      definedTags:
        foo-namespace.bar-key: value
      deploymentId: ${oci_golden_gate_deployment.test_deployment.id}
      description: ${var.connection_description}
      endpoint: ${var.connection_endpoint}
      freeformTags:
        bar-key: value
      host: ${var.connection_host}
      keyId: ${oci_kms_key.test_key.id}
      keyStore: ${var.connection_key_store}
      keyStorePassword: ${var.connection_key_store_password}
      nsgIds: ${var.connection_nsg_ids}
      password: ${var.connection_password}
      port: ${var.connection_port}
      privateIp: ${var.connection_private_ip}
      privateKeyFile: ${var.connection_private_key_file}
      privateKeyPassphrase: ${var.connection_private_key_passphrase}
      producerProperties: ${var.connection_producer_properties}
      publicKeyFingerprint: ${var.connection_public_key_fingerprint}
      region: ${var.connection_region}
      sasToken: ${var.connection_sas_token}
      securityProtocol: ${var.connection_security_protocol}
      sessionMode: ${var.connection_session_mode}
      sslCa: ${var.connection_ssl_ca}
      sslCert: ${var.connection_ssl_cert}
      sslCrl: ${var.connection_ssl_crl}
      sslKey: ${var.connection_ssl_key}
      sslKeyPassword: ${var.connection_ssl_key_password}
      sslMode: ${var.connection_ssl_mode}
      streamPoolId: ${oci_streaming_stream_pool.test_stream_pool.id}
      subnetId: ${oci_core_subnet.test_subnet.id}
      tenancyId: ${oci_identity_tenancy.test_tenancy.id}
      trustStore: ${var.connection_trust_store}
      trustStorePassword: ${var.connection_trust_store_password}
      url: ${var.connection_url}
      userId: ${oci_identity_user.test_user.id}
      username: ${var.connection_username}
      vaultId: ${oci_kms_vault.test_vault.id}
      wallet: ${var.connection_wallet}

Create Connection Resource

new Connection(name: string, args: ConnectionArgs, opts?: CustomResourceOptions);
@overload
def Connection(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               account_key: Optional[str] = None,
               account_name: Optional[str] = None,
               additional_attributes: Optional[Sequence[_goldengate.ConnectionAdditionalAttributeArgs]] = None,
               authentication_type: Optional[str] = None,
               azure_tenant_id: Optional[str] = None,
               bootstrap_servers: Optional[Sequence[_goldengate.ConnectionBootstrapServerArgs]] = None,
               client_id: Optional[str] = None,
               client_secret: Optional[str] = None,
               compartment_id: Optional[str] = None,
               connection_string: Optional[str] = None,
               connection_type: Optional[str] = None,
               consumer_properties: Optional[str] = None,
               database_id: Optional[str] = None,
               database_name: Optional[str] = None,
               db_system_id: Optional[str] = None,
               defined_tags: Optional[Mapping[str, Any]] = None,
               deployment_id: Optional[str] = None,
               description: Optional[str] = None,
               display_name: Optional[str] = None,
               endpoint: Optional[str] = None,
               freeform_tags: Optional[Mapping[str, Any]] = None,
               host: Optional[str] = None,
               key_id: Optional[str] = None,
               key_store: Optional[str] = None,
               key_store_password: Optional[str] = None,
               nsg_ids: Optional[Sequence[str]] = None,
               password: Optional[str] = None,
               port: Optional[int] = None,
               private_ip: Optional[str] = None,
               private_key_file: Optional[str] = None,
               private_key_passphrase: Optional[str] = None,
               producer_properties: Optional[str] = None,
               public_key_fingerprint: Optional[str] = None,
               region: Optional[str] = None,
               sas_token: Optional[str] = None,
               security_protocol: Optional[str] = None,
               session_mode: Optional[str] = None,
               ssl_ca: Optional[str] = None,
               ssl_cert: Optional[str] = None,
               ssl_crl: Optional[str] = None,
               ssl_key: Optional[str] = None,
               ssl_key_password: Optional[str] = None,
               ssl_mode: Optional[str] = None,
               stream_pool_id: Optional[str] = None,
               subnet_id: Optional[str] = None,
               technology_type: Optional[str] = None,
               tenancy_id: Optional[str] = None,
               trust_store: Optional[str] = None,
               trust_store_password: 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)
@overload
def Connection(resource_name: str,
               args: ConnectionArgs,
               opts: Optional[ResourceOptions] = 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.

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.

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

The Connection resource accepts the following input properties:

CompartmentId string

(Updatable) The OCID of the compartment being referenced.

ConnectionType string

(Updatable) The connection type.

DisplayName string

(Updatable) An object's Display Name.

TechnologyType string

The Kafka (e.g. Confluent) Schema Registry technology type.

AccountKey string

(Updatable) Azure storage account key. This property is required when 'authenticationType' is set to 'SHARED_KEY'. e.g.: pa3WbhVATzj56xD4DH1VjOUhApRGEGHvOo58eQJVWIzX+j8j4CUVFcTjpIqDSRaSa1Wo2LbWY5at+AStEgLOIQ==

AccountName string

(Updatable) Sets the Azure storage account name.

AdditionalAttributes List<ConnectionAdditionalAttributeArgs>

(Updatable) An array of name-value pair attribute entries. Used as additional parameters in connection string.

AuthenticationType string

(Updatable) Used authentication mechanism to access Azure Data Lake Storage.

AzureTenantId string

(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

BootstrapServers List<ConnectionBootstrapServerArgs>

(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"

ClientId string

(Updatable) Azure client ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 06ecaabf-8b80-4ec8-a0ec-20cbf463703d

ClientSecret string

(Updatable) Azure client secret (aka application password) for authentication. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: dO29Q~F5-VwnA.lZdd11xFF_t5NAXCaGwDl9NbT1

ConnectionString string

(Updatable) JDBC connection string. e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'

ConsumerProperties string

(Updatable) The base64 encoded content of the consumer.properties file.

DatabaseId string

(Updatable) The OCID of the database being referenced.

DatabaseName string

(Updatable) The name of the database.

DbSystemId string

(Updatable) The OCID of the database system being referenced.

DefinedTags Dictionary<string, object>

(Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

DeploymentId string

(Updatable) The OCID of the deployment being referenced.

Description string

(Updatable) Metadata about this specific object.

Endpoint string

(Updatable) Azure Storage service endpoint. e.g: https://test.blob.core.windows.net

FreeformTags Dictionary<string, object>

(Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

Host string

(Updatable) The name or address of a host.

KeyId string

(Updatable) The OCID of the customer "Master" key being referenced. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this key to manage secrets.

KeyStore string

(Updatable) The base64 encoded content of the KeyStore file.

KeyStorePassword string

(Updatable) The KeyStore password.

NsgIds List<string>

(Updatable) An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.

Password string

(Updatable) The password Oracle GoldenGate uses to connect the associated RDBMS. It must conform to the specific security requirements implemented by the database including length, case sensitivity, and so on.

Port int

(Updatable) The port of an endpoint usually specified for a connection.

PrivateIp string

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

PrivateKeyFile string

(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

PrivateKeyPassphrase string

(Updatable) The passphrase of the private key.

ProducerProperties string

(Updatable) The base64 encoded content of the producer.properties file.

PublicKeyFingerprint string

(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

SasToken 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

SecurityProtocol string

(Updatable) Security protocol for PostgreSQL.

SessionMode string

(Updatable) The mode of the database connection session to be established by the data client. 'REDIRECT' - for a RAC database, 'DIRECT' - for a non-RAC database. Connection to a RAC database involves a redirection received from the SCAN listeners to the database node to connect to. By default the mode would be DIRECT.

SslCa string

(Updatable) Database Certificate - The base64 encoded content of mysql.pem file containing the server public key (for 1 and 2-way SSL).

SslCert string

(Updatable) Client Certificate - The base64 encoded content of client-cert.pem file containing the client public key (for 2-way SSL).

SslCrl string

(Updatable) Certificates revoked by certificate authorities (CA). Server certificate must not be on this list (for 1 and 2-way SSL). Note: This is an optional and that too only applicable if TLS/MTLS option is selected.

SslKey string

(Updatable) Client Key - The client-key.pem containing the client private key (for 2-way SSL).

SslKeyPassword string

(Updatable) The password for the cert inside of the KeyStore. In case it differs from the KeyStore password, it should be provided.

SslMode string

(Updatable) SSL modes for PostgreSQL.

StreamPoolId string

(Updatable) The OCID of the stream pool being referenced.

SubnetId string

The OCID of the subnet being referenced.

TenancyId string

(Updatable) The OCID of the related Oracle Cloud Infrastructure tenancy.

TrustStore string

(Updatable) The base64 encoded content of the TrustStore file.

TrustStorePassword string

(Updatable) The TrustStore password.

Url string

(Updatable) Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'

UserId string

(Updatable) The OCID of the Oracle Cloud Infrastructure user who will access the Object Storage. The user must have write access to the bucket they want to connect to.

Username string

(Updatable) The username Oracle GoldenGate uses to connect the associated RDBMS. This username must already exist and be available for use by the database. It must conform to the security requirements implemented by the database including length, case sensitivity, and so on.

VaultId string

(Updatable) The OCID of the customer vault being referenced. If provided, this will reference a vault which the customer will be required to ensure the policies are established to permit the GoldenGate Service to manage secrets contained within this vault.

Wallet string

(Updatable) The wallet contents Oracle GoldenGate uses to make connections to a database. This attribute is expected to be base64 encoded.

CompartmentId string

(Updatable) The OCID of the compartment being referenced.

ConnectionType string

(Updatable) The connection type.

DisplayName string

(Updatable) An object's Display Name.

TechnologyType string

The Kafka (e.g. Confluent) Schema Registry technology type.

AccountKey string

(Updatable) Azure storage account key. This property is required when 'authenticationType' is set to 'SHARED_KEY'. e.g.: pa3WbhVATzj56xD4DH1VjOUhApRGEGHvOo58eQJVWIzX+j8j4CUVFcTjpIqDSRaSa1Wo2LbWY5at+AStEgLOIQ==

AccountName string

(Updatable) Sets the Azure storage account name.

AdditionalAttributes []ConnectionAdditionalAttributeArgs

(Updatable) An array of name-value pair attribute entries. Used as additional parameters in connection string.

AuthenticationType string

(Updatable) Used authentication mechanism to access Azure Data Lake Storage.

AzureTenantId string

(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

BootstrapServers []ConnectionBootstrapServerArgs

(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"

ClientId string

(Updatable) Azure client ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 06ecaabf-8b80-4ec8-a0ec-20cbf463703d

ClientSecret string

(Updatable) Azure client secret (aka application password) for authentication. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: dO29Q~F5-VwnA.lZdd11xFF_t5NAXCaGwDl9NbT1

ConnectionString string

(Updatable) JDBC connection string. e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'

ConsumerProperties string

(Updatable) The base64 encoded content of the consumer.properties file.

DatabaseId string

(Updatable) The OCID of the database being referenced.

DatabaseName string

(Updatable) The name of the database.

DbSystemId string

(Updatable) The OCID of the database system being referenced.

DefinedTags map[string]interface{}

(Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

DeploymentId string

(Updatable) The OCID of the deployment being referenced.

Description string

(Updatable) Metadata about this specific object.

Endpoint string

(Updatable) Azure Storage service endpoint. e.g: https://test.blob.core.windows.net

FreeformTags map[string]interface{}

(Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

Host string

(Updatable) The name or address of a host.

KeyId string

(Updatable) The OCID of the customer "Master" key being referenced. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this key to manage secrets.

KeyStore string

(Updatable) The base64 encoded content of the KeyStore file.

KeyStorePassword string

(Updatable) The KeyStore password.

NsgIds []string

(Updatable) An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.

Password string

(Updatable) The password Oracle GoldenGate uses to connect the associated RDBMS. It must conform to the specific security requirements implemented by the database including length, case sensitivity, and so on.

Port int

(Updatable) The port of an endpoint usually specified for a connection.

PrivateIp string

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

PrivateKeyFile string

(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

PrivateKeyPassphrase string

(Updatable) The passphrase of the private key.

ProducerProperties string

(Updatable) The base64 encoded content of the producer.properties file.

PublicKeyFingerprint string

(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

SasToken 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

SecurityProtocol string

(Updatable) Security protocol for PostgreSQL.

SessionMode string

(Updatable) The mode of the database connection session to be established by the data client. 'REDIRECT' - for a RAC database, 'DIRECT' - for a non-RAC database. Connection to a RAC database involves a redirection received from the SCAN listeners to the database node to connect to. By default the mode would be DIRECT.

SslCa string

(Updatable) Database Certificate - The base64 encoded content of mysql.pem file containing the server public key (for 1 and 2-way SSL).

SslCert string

(Updatable) Client Certificate - The base64 encoded content of client-cert.pem file containing the client public key (for 2-way SSL).

SslCrl string

(Updatable) Certificates revoked by certificate authorities (CA). Server certificate must not be on this list (for 1 and 2-way SSL). Note: This is an optional and that too only applicable if TLS/MTLS option is selected.

SslKey string

(Updatable) Client Key - The client-key.pem containing the client private key (for 2-way SSL).

SslKeyPassword string

(Updatable) The password for the cert inside of the KeyStore. In case it differs from the KeyStore password, it should be provided.

SslMode string

(Updatable) SSL modes for PostgreSQL.

StreamPoolId string

(Updatable) The OCID of the stream pool being referenced.

SubnetId string

The OCID of the subnet being referenced.

TenancyId string

(Updatable) The OCID of the related Oracle Cloud Infrastructure tenancy.

TrustStore string

(Updatable) The base64 encoded content of the TrustStore file.

TrustStorePassword string

(Updatable) The TrustStore password.

Url string

(Updatable) Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'

UserId string

(Updatable) The OCID of the Oracle Cloud Infrastructure user who will access the Object Storage. The user must have write access to the bucket they want to connect to.

Username string

(Updatable) The username Oracle GoldenGate uses to connect the associated RDBMS. This username must already exist and be available for use by the database. It must conform to the security requirements implemented by the database including length, case sensitivity, and so on.

VaultId string

(Updatable) The OCID of the customer vault being referenced. If provided, this will reference a vault which the customer will be required to ensure the policies are established to permit the GoldenGate Service to manage secrets contained within this vault.

Wallet string

(Updatable) The wallet contents Oracle GoldenGate uses to make connections to a database. This attribute is expected to be base64 encoded.

compartmentId String

(Updatable) The OCID of the compartment being referenced.

connectionType String

(Updatable) The connection type.

displayName String

(Updatable) An object's Display Name.

technologyType String

The Kafka (e.g. Confluent) Schema Registry technology type.

accountKey String

(Updatable) Azure storage account key. This property is required when 'authenticationType' is set to 'SHARED_KEY'. e.g.: pa3WbhVATzj56xD4DH1VjOUhApRGEGHvOo58eQJVWIzX+j8j4CUVFcTjpIqDSRaSa1Wo2LbWY5at+AStEgLOIQ==

accountName String

(Updatable) Sets the Azure storage account name.

additionalAttributes List<ConnectionAdditionalAttributeArgs>

(Updatable) An array of name-value pair attribute entries. Used as additional parameters in connection string.

authenticationType String

(Updatable) Used authentication mechanism to access Azure Data Lake Storage.

azureTenantId String

(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

bootstrapServers List<ConnectionBootstrapServerArgs>

(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"

clientId String

(Updatable) Azure client ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 06ecaabf-8b80-4ec8-a0ec-20cbf463703d

clientSecret String

(Updatable) Azure client secret (aka application password) for authentication. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: dO29Q~F5-VwnA.lZdd11xFF_t5NAXCaGwDl9NbT1

connectionString String

(Updatable) JDBC connection string. e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'

consumerProperties String

(Updatable) The base64 encoded content of the consumer.properties file.

databaseId String

(Updatable) The OCID of the database being referenced.

databaseName String

(Updatable) The name of the database.

dbSystemId String

(Updatable) The OCID of the database system being referenced.

definedTags Map<String,Object>

(Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

deploymentId String

(Updatable) The OCID of the deployment being referenced.

description String

(Updatable) Metadata about this specific object.

endpoint String

(Updatable) Azure Storage service endpoint. e.g: https://test.blob.core.windows.net

freeformTags Map<String,Object>

(Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

host String

(Updatable) The name or address of a host.

keyId String

(Updatable) The OCID of the customer "Master" key being referenced. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this key to manage secrets.

keyStore String

(Updatable) The base64 encoded content of the KeyStore file.

keyStorePassword String

(Updatable) The KeyStore password.

nsgIds List<String>

(Updatable) An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.

password String

(Updatable) The password Oracle GoldenGate uses to connect the associated RDBMS. It must conform to the specific security requirements implemented by the database including length, case sensitivity, and so on.

port Integer

(Updatable) The port of an endpoint usually specified for a connection.

privateIp String

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

privateKeyFile String

(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

privateKeyPassphrase String

(Updatable) The passphrase of the private key.

producerProperties String

(Updatable) The base64 encoded content of the producer.properties file.

publicKeyFingerprint String

(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

sasToken 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

securityProtocol String

(Updatable) Security protocol for PostgreSQL.

sessionMode String

(Updatable) The mode of the database connection session to be established by the data client. 'REDIRECT' - for a RAC database, 'DIRECT' - for a non-RAC database. Connection to a RAC database involves a redirection received from the SCAN listeners to the database node to connect to. By default the mode would be DIRECT.

sslCa String

(Updatable) Database Certificate - The base64 encoded content of mysql.pem file containing the server public key (for 1 and 2-way SSL).

sslCert String

(Updatable) Client Certificate - The base64 encoded content of client-cert.pem file containing the client public key (for 2-way SSL).

sslCrl String

(Updatable) Certificates revoked by certificate authorities (CA). Server certificate must not be on this list (for 1 and 2-way SSL). Note: This is an optional and that too only applicable if TLS/MTLS option is selected.

sslKey String

(Updatable) Client Key - The client-key.pem containing the client private key (for 2-way SSL).

sslKeyPassword String

(Updatable) The password for the cert inside of the KeyStore. In case it differs from the KeyStore password, it should be provided.

sslMode String

(Updatable) SSL modes for PostgreSQL.

streamPoolId String

(Updatable) The OCID of the stream pool being referenced.

subnetId String

The OCID of the subnet being referenced.

tenancyId String

(Updatable) The OCID of the related Oracle Cloud Infrastructure tenancy.

trustStore String

(Updatable) The base64 encoded content of the TrustStore file.

trustStorePassword String

(Updatable) The TrustStore password.

url String

(Updatable) Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'

userId String

(Updatable) The OCID of the Oracle Cloud Infrastructure user who will access the Object Storage. The user must have write access to the bucket they want to connect to.

username String

(Updatable) The username Oracle GoldenGate uses to connect the associated RDBMS. This username must already exist and be available for use by the database. It must conform to the security requirements implemented by the database including length, case sensitivity, and so on.

vaultId String

(Updatable) The OCID of the customer vault being referenced. If provided, this will reference a vault which the customer will be required to ensure the policies are established to permit the GoldenGate Service to manage secrets contained within this vault.

wallet String

(Updatable) The wallet contents Oracle GoldenGate uses to make connections to a database. This attribute is expected to be base64 encoded.

compartmentId string

(Updatable) The OCID of the compartment being referenced.

connectionType string

(Updatable) The connection type.

displayName string

(Updatable) An object's Display Name.

technologyType string

The Kafka (e.g. Confluent) Schema Registry technology type.

accountKey string

(Updatable) Azure storage account key. This property is required when 'authenticationType' is set to 'SHARED_KEY'. e.g.: pa3WbhVATzj56xD4DH1VjOUhApRGEGHvOo58eQJVWIzX+j8j4CUVFcTjpIqDSRaSa1Wo2LbWY5at+AStEgLOIQ==

accountName string

(Updatable) Sets the Azure storage account name.

additionalAttributes ConnectionAdditionalAttributeArgs[]

(Updatable) An array of name-value pair attribute entries. Used as additional parameters in connection string.

authenticationType string

(Updatable) Used authentication mechanism to access Azure Data Lake Storage.

azureTenantId string

(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

bootstrapServers ConnectionBootstrapServerArgs[]

(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"

clientId string

(Updatable) Azure client ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 06ecaabf-8b80-4ec8-a0ec-20cbf463703d

clientSecret string

(Updatable) Azure client secret (aka application password) for authentication. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: dO29Q~F5-VwnA.lZdd11xFF_t5NAXCaGwDl9NbT1

connectionString string

(Updatable) JDBC connection string. e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'

consumerProperties string

(Updatable) The base64 encoded content of the consumer.properties file.

databaseId string

(Updatable) The OCID of the database being referenced.

databaseName string

(Updatable) The name of the database.

dbSystemId string

(Updatable) The OCID of the database system being referenced.

definedTags {[key: string]: any}

(Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

deploymentId string

(Updatable) The OCID of the deployment being referenced.

description string

(Updatable) Metadata about this specific object.

endpoint string

(Updatable) Azure Storage service endpoint. e.g: https://test.blob.core.windows.net

freeformTags {[key: string]: any}

(Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

host string

(Updatable) The name or address of a host.

keyId string

(Updatable) The OCID of the customer "Master" key being referenced. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this key to manage secrets.

keyStore string

(Updatable) The base64 encoded content of the KeyStore file.

keyStorePassword string

(Updatable) The KeyStore password.

nsgIds string[]

(Updatable) An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.

password string

(Updatable) The password Oracle GoldenGate uses to connect the associated RDBMS. It must conform to the specific security requirements implemented by the database including length, case sensitivity, and so on.

port number

(Updatable) The port of an endpoint usually specified for a connection.

privateIp string

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

privateKeyFile string

(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

privateKeyPassphrase string

(Updatable) The passphrase of the private key.

producerProperties string

(Updatable) The base64 encoded content of the producer.properties file.

publicKeyFingerprint string

(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

sasToken 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

securityProtocol string

(Updatable) Security protocol for PostgreSQL.

sessionMode string

(Updatable) The mode of the database connection session to be established by the data client. 'REDIRECT' - for a RAC database, 'DIRECT' - for a non-RAC database. Connection to a RAC database involves a redirection received from the SCAN listeners to the database node to connect to. By default the mode would be DIRECT.

sslCa string

(Updatable) Database Certificate - The base64 encoded content of mysql.pem file containing the server public key (for 1 and 2-way SSL).

sslCert string

(Updatable) Client Certificate - The base64 encoded content of client-cert.pem file containing the client public key (for 2-way SSL).

sslCrl string

(Updatable) Certificates revoked by certificate authorities (CA). Server certificate must not be on this list (for 1 and 2-way SSL). Note: This is an optional and that too only applicable if TLS/MTLS option is selected.

sslKey string

(Updatable) Client Key - The client-key.pem containing the client private key (for 2-way SSL).

sslKeyPassword string

(Updatable) The password for the cert inside of the KeyStore. In case it differs from the KeyStore password, it should be provided.

sslMode string

(Updatable) SSL modes for PostgreSQL.

streamPoolId string

(Updatable) The OCID of the stream pool being referenced.

subnetId string

The OCID of the subnet being referenced.

tenancyId string

(Updatable) The OCID of the related Oracle Cloud Infrastructure tenancy.

trustStore string

(Updatable) The base64 encoded content of the TrustStore file.

trustStorePassword string

(Updatable) The TrustStore password.

url string

(Updatable) Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'

userId string

(Updatable) The OCID of the Oracle Cloud Infrastructure user who will access the Object Storage. The user must have write access to the bucket they want to connect to.

username string

(Updatable) The username Oracle GoldenGate uses to connect the associated RDBMS. This username must already exist and be available for use by the database. It must conform to the security requirements implemented by the database including length, case sensitivity, and so on.

vaultId string

(Updatable) The OCID of the customer vault being referenced. If provided, this will reference a vault which the customer will be required to ensure the policies are established to permit the GoldenGate Service to manage secrets contained within this vault.

wallet string

(Updatable) The wallet contents Oracle GoldenGate uses to make connections to a database. This attribute is expected to be base64 encoded.

compartment_id str

(Updatable) The OCID of the compartment being referenced.

connection_type str

(Updatable) The connection type.

display_name str

(Updatable) An object's Display Name.

technology_type str

The Kafka (e.g. Confluent) Schema Registry technology type.

account_key str

(Updatable) Azure storage account key. This property is required when 'authenticationType' is set to 'SHARED_KEY'. e.g.: pa3WbhVATzj56xD4DH1VjOUhApRGEGHvOo58eQJVWIzX+j8j4CUVFcTjpIqDSRaSa1Wo2LbWY5at+AStEgLOIQ==

account_name str

(Updatable) Sets the Azure storage account name.

additional_attributes ConnectionAdditionalAttributeArgs]

(Updatable) An array of name-value pair attribute entries. Used as additional parameters in connection string.

authentication_type str

(Updatable) Used authentication mechanism to access Azure Data Lake Storage.

azure_tenant_id str

(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 ConnectionBootstrapServerArgs]

(Updatable) Kafka bootstrap. Equivalent of bootstrap.servers configuration property in Kafka: list of KafkaBootstrapServer objects specified by host/port. Used for establishing the initial connection to the Kafka cluster. Example: "server1.example.com:9092,server2.example.com:9092"

client_id str

(Updatable) Azure client ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 06ecaabf-8b80-4ec8-a0ec-20cbf463703d

client_secret str

(Updatable) Azure client secret (aka application password) for authentication. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: dO29Q~F5-VwnA.lZdd11xFF_t5NAXCaGwDl9NbT1

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;'

consumer_properties str

(Updatable) The base64 encoded content of the consumer.properties file.

database_id str

(Updatable) The OCID of the database being referenced.

database_name str

(Updatable) The name of the database.

db_system_id str

(Updatable) The OCID of the database system being referenced.

defined_tags Mapping[str, Any]

(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.

endpoint str

(Updatable) Azure Storage service endpoint. e.g: https://test.blob.core.windows.net

freeform_tags Mapping[str, Any]

(Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

host str

(Updatable) The name or address of a host.

key_id str

(Updatable) The OCID of the customer "Master" key being referenced. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this key to manage secrets.

key_store str

(Updatable) The base64 encoded content of the KeyStore file.

key_store_password str

(Updatable) The KeyStore password.

nsg_ids Sequence[str]

(Updatable) An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.

password str

(Updatable) The password Oracle GoldenGate uses to connect the associated RDBMS. It must conform to the specific security requirements implemented by the database including length, case sensitivity, and so on.

port int

(Updatable) The port of an endpoint usually specified for a connection.

private_ip str

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

private_key_file str

(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

private_key_passphrase str

(Updatable) The passphrase of the private key.

producer_properties str

(Updatable) The base64 encoded content of the producer.properties file.

public_key_fingerprint str

(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

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

security_protocol str

(Updatable) Security protocol for PostgreSQL.

session_mode str

(Updatable) The mode of the database connection session to be established by the data client. 'REDIRECT' - for a RAC database, 'DIRECT' - for a non-RAC database. Connection to a RAC database involves a redirection received from the SCAN listeners to the database node to connect to. By default the mode would be DIRECT.

ssl_ca str

(Updatable) Database Certificate - The base64 encoded content of mysql.pem file containing the server public key (for 1 and 2-way SSL).

ssl_cert str

(Updatable) Client Certificate - The base64 encoded content of client-cert.pem file containing the client public key (for 2-way SSL).

ssl_crl str

(Updatable) Certificates revoked by certificate authorities (CA). Server certificate must not be on this list (for 1 and 2-way SSL). Note: This is an optional and that too only applicable if TLS/MTLS option is selected.

ssl_key str

(Updatable) Client Key - The client-key.pem containing the client private key (for 2-way SSL).

ssl_key_password str

(Updatable) The password for the cert inside of the KeyStore. In case it differs from the KeyStore password, it should be provided.

ssl_mode str

(Updatable) SSL modes for PostgreSQL.

stream_pool_id str

(Updatable) The OCID of the stream pool being referenced.

subnet_id str

The OCID of the subnet being referenced.

tenancy_id str

(Updatable) The OCID of the related Oracle Cloud Infrastructure tenancy.

trust_store str

(Updatable) The base64 encoded content of the TrustStore file.

trust_store_password str

(Updatable) The TrustStore password.

url str

(Updatable) Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'

user_id str

(Updatable) The OCID of the Oracle Cloud Infrastructure user who will access the Object Storage. The user must have write access to the bucket they want to connect to.

username str

(Updatable) The username Oracle GoldenGate uses to connect the associated RDBMS. This username must already exist and be available for use by the database. It must conform to the security requirements implemented by the database including length, case sensitivity, and so on.

vault_id str

(Updatable) The OCID of the customer vault being referenced. If provided, this will reference a vault which the customer will be required to ensure the policies are established to permit the GoldenGate Service to manage secrets contained within this vault.

wallet str

(Updatable) The wallet contents Oracle GoldenGate uses to make connections to a database. This attribute is expected to be base64 encoded.

compartmentId String

(Updatable) The OCID of the compartment being referenced.

connectionType String

(Updatable) The connection type.

displayName String

(Updatable) An object's Display Name.

technologyType String

The Kafka (e.g. Confluent) Schema Registry technology type.

accountKey String

(Updatable) Azure storage account key. This property is required when 'authenticationType' is set to 'SHARED_KEY'. e.g.: pa3WbhVATzj56xD4DH1VjOUhApRGEGHvOo58eQJVWIzX+j8j4CUVFcTjpIqDSRaSa1Wo2LbWY5at+AStEgLOIQ==

accountName String

(Updatable) Sets the Azure storage account name.

additionalAttributes List<Property Map>

(Updatable) An array of name-value pair attribute entries. Used as additional parameters in connection string.

authenticationType String

(Updatable) Used authentication mechanism to access Azure Data Lake Storage.

azureTenantId String

(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

bootstrapServers 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"

clientId String

(Updatable) Azure client ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 06ecaabf-8b80-4ec8-a0ec-20cbf463703d

clientSecret String

(Updatable) Azure client secret (aka application password) for authentication. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: dO29Q~F5-VwnA.lZdd11xFF_t5NAXCaGwDl9NbT1

connectionString String

(Updatable) JDBC connection string. e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'

consumerProperties String

(Updatable) The base64 encoded content of the consumer.properties file.

databaseId String

(Updatable) The OCID of the database being referenced.

databaseName String

(Updatable) The name of the database.

dbSystemId String

(Updatable) The OCID of the database system being referenced.

definedTags Map<Any>

(Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

deploymentId String

(Updatable) The OCID of the deployment being referenced.

description String

(Updatable) Metadata about this specific object.

endpoint String

(Updatable) Azure Storage service endpoint. e.g: https://test.blob.core.windows.net

freeformTags Map<Any>

(Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

host String

(Updatable) The name or address of a host.

keyId String

(Updatable) The OCID of the customer "Master" key being referenced. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this key to manage secrets.

keyStore String

(Updatable) The base64 encoded content of the KeyStore file.

keyStorePassword String

(Updatable) The KeyStore password.

nsgIds List<String>

(Updatable) An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.

password String

(Updatable) The password Oracle GoldenGate uses to connect the associated RDBMS. It must conform to the specific security requirements implemented by the database including length, case sensitivity, and so on.

port Number

(Updatable) The port of an endpoint usually specified for a connection.

privateIp String

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

privateKeyFile String

(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

privateKeyPassphrase String

(Updatable) The passphrase of the private key.

producerProperties String

(Updatable) The base64 encoded content of the producer.properties file.

publicKeyFingerprint String

(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

sasToken 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

securityProtocol String

(Updatable) Security protocol for PostgreSQL.

sessionMode String

(Updatable) The mode of the database connection session to be established by the data client. 'REDIRECT' - for a RAC database, 'DIRECT' - for a non-RAC database. Connection to a RAC database involves a redirection received from the SCAN listeners to the database node to connect to. By default the mode would be DIRECT.

sslCa String

(Updatable) Database Certificate - The base64 encoded content of mysql.pem file containing the server public key (for 1 and 2-way SSL).

sslCert String

(Updatable) Client Certificate - The base64 encoded content of client-cert.pem file containing the client public key (for 2-way SSL).

sslCrl String

(Updatable) Certificates revoked by certificate authorities (CA). Server certificate must not be on this list (for 1 and 2-way SSL). Note: This is an optional and that too only applicable if TLS/MTLS option is selected.

sslKey String

(Updatable) Client Key - The client-key.pem containing the client private key (for 2-way SSL).

sslKeyPassword String

(Updatable) The password for the cert inside of the KeyStore. In case it differs from the KeyStore password, it should be provided.

sslMode String

(Updatable) SSL modes for PostgreSQL.

streamPoolId String

(Updatable) The OCID of the stream pool being referenced.

subnetId String

The OCID of the subnet being referenced.

tenancyId String

(Updatable) The OCID of the related Oracle Cloud Infrastructure tenancy.

trustStore String

(Updatable) The base64 encoded content of the TrustStore file.

trustStorePassword String

(Updatable) The TrustStore password.

url String

(Updatable) Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'

userId String

(Updatable) The OCID of the Oracle Cloud Infrastructure user who will access the Object Storage. The user must have write access to the bucket they want to connect to.

username String

(Updatable) The username Oracle GoldenGate uses to connect the associated RDBMS. This username must already exist and be available for use by the database. It must conform to the security requirements implemented by the database including length, case sensitivity, and so on.

vaultId String

(Updatable) The OCID of the customer vault being referenced. If provided, this will reference a vault which the customer will be required to ensure the policies are established to permit the GoldenGate Service to manage secrets contained within this vault.

wallet String

(Updatable) The wallet contents Oracle GoldenGate uses to make connections to a database. This attribute is expected to be base64 encoded.

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.

IngressIps List<ConnectionIngressIp>

List of ingress IP addresses, from where the GoldenGate deployment connects to this connection's privateIp.

LifecycleDetails string

Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.

State string

Possible lifecycle states for connection.

SystemTags Dictionary<string, object>

The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}

TimeCreated string

The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

TimeUpdated string

The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

Id string

The provider-assigned unique ID for this managed resource.

IngressIps []ConnectionIngressIp

List of ingress IP addresses, from where the GoldenGate deployment connects to this connection's privateIp.

LifecycleDetails string

Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.

State string

Possible lifecycle states for connection.

SystemTags map[string]interface{}

The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}

TimeCreated string

The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

TimeUpdated string

The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

id String

The provider-assigned unique ID for this managed resource.

ingressIps List<ConnectionIngressIp>

List of ingress IP addresses, from where the GoldenGate deployment connects to this connection's privateIp.

lifecycleDetails String

Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.

state String

Possible lifecycle states for connection.

systemTags Map<String,Object>

The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}

timeCreated String

The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

timeUpdated String

The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

id string

The provider-assigned unique ID for this managed resource.

ingressIps ConnectionIngressIp[]

List of ingress IP addresses, from where the GoldenGate deployment connects to this connection's privateIp.

lifecycleDetails string

Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.

state string

Possible lifecycle states for connection.

systemTags {[key: string]: any}

The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}

timeCreated string

The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

timeUpdated string

The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

id str

The provider-assigned unique ID for this managed resource.

ingress_ips ConnectionIngressIp]

List of ingress IP addresses, from where the GoldenGate deployment connects to this connection's privateIp.

lifecycle_details str

Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.

state str

Possible lifecycle states for connection.

system_tags Mapping[str, Any]

The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}

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.

ingressIps List<Property Map>

List of ingress IP addresses, from where the GoldenGate deployment connects to this connection's privateIp.

lifecycleDetails String

Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.

state String

Possible lifecycle states for connection.

systemTags Map<Any>

The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}

timeCreated String

The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

timeUpdated String

The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

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,
        account_key: Optional[str] = None,
        account_name: Optional[str] = None,
        additional_attributes: Optional[Sequence[_goldengate.ConnectionAdditionalAttributeArgs]] = None,
        authentication_type: Optional[str] = None,
        azure_tenant_id: Optional[str] = None,
        bootstrap_servers: Optional[Sequence[_goldengate.ConnectionBootstrapServerArgs]] = None,
        client_id: Optional[str] = None,
        client_secret: Optional[str] = None,
        compartment_id: Optional[str] = None,
        connection_string: Optional[str] = None,
        connection_type: Optional[str] = None,
        consumer_properties: Optional[str] = None,
        database_id: Optional[str] = None,
        database_name: Optional[str] = None,
        db_system_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, Any]] = None,
        deployment_id: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        endpoint: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, Any]] = None,
        host: Optional[str] = None,
        ingress_ips: Optional[Sequence[_goldengate.ConnectionIngressIpArgs]] = None,
        key_id: Optional[str] = None,
        key_store: Optional[str] = None,
        key_store_password: Optional[str] = None,
        lifecycle_details: Optional[str] = None,
        nsg_ids: Optional[Sequence[str]] = None,
        password: Optional[str] = None,
        port: Optional[int] = None,
        private_ip: Optional[str] = None,
        private_key_file: Optional[str] = None,
        private_key_passphrase: Optional[str] = None,
        producer_properties: Optional[str] = None,
        public_key_fingerprint: Optional[str] = None,
        region: Optional[str] = None,
        sas_token: Optional[str] = None,
        security_protocol: Optional[str] = None,
        session_mode: Optional[str] = None,
        ssl_ca: Optional[str] = None,
        ssl_cert: Optional[str] = None,
        ssl_crl: Optional[str] = None,
        ssl_key: Optional[str] = None,
        ssl_key_password: Optional[str] = None,
        ssl_mode: Optional[str] = None,
        state: Optional[str] = None,
        stream_pool_id: Optional[str] = None,
        subnet_id: Optional[str] = None,
        system_tags: Optional[Mapping[str, Any]] = None,
        technology_type: Optional[str] = None,
        tenancy_id: Optional[str] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None,
        trust_store: Optional[str] = None,
        trust_store_password: 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) -> Connection
func 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)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AccountKey string

(Updatable) Azure storage account key. This property is required when 'authenticationType' is set to 'SHARED_KEY'. e.g.: pa3WbhVATzj56xD4DH1VjOUhApRGEGHvOo58eQJVWIzX+j8j4CUVFcTjpIqDSRaSa1Wo2LbWY5at+AStEgLOIQ==

AccountName string

(Updatable) Sets the Azure storage account name.

AdditionalAttributes List<ConnectionAdditionalAttributeArgs>

(Updatable) An array of name-value pair attribute entries. Used as additional parameters in connection string.

AuthenticationType string

(Updatable) Used authentication mechanism to access Azure Data Lake Storage.

AzureTenantId string

(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

BootstrapServers List<ConnectionBootstrapServerArgs>

(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"

ClientId string

(Updatable) Azure client ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 06ecaabf-8b80-4ec8-a0ec-20cbf463703d

ClientSecret string

(Updatable) Azure client secret (aka application password) for authentication. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: dO29Q~F5-VwnA.lZdd11xFF_t5NAXCaGwDl9NbT1

CompartmentId string

(Updatable) The OCID of the compartment being referenced.

ConnectionString string

(Updatable) JDBC connection string. e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'

ConnectionType string

(Updatable) The connection type.

ConsumerProperties string

(Updatable) The base64 encoded content of the consumer.properties file.

DatabaseId string

(Updatable) The OCID of the database being referenced.

DatabaseName string

(Updatable) The name of the database.

DbSystemId string

(Updatable) The OCID of the database system being referenced.

DefinedTags Dictionary<string, object>

(Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

DeploymentId string

(Updatable) The OCID of the deployment being referenced.

Description string

(Updatable) Metadata about this specific object.

DisplayName string

(Updatable) An object's Display Name.

Endpoint string

(Updatable) Azure Storage service endpoint. e.g: https://test.blob.core.windows.net

FreeformTags Dictionary<string, object>

(Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

Host string

(Updatable) The name or address of a host.

IngressIps List<ConnectionIngressIpArgs>

List of ingress IP addresses, from where the GoldenGate deployment connects to this connection's privateIp.

KeyId string

(Updatable) The OCID of the customer "Master" key being referenced. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this key to manage secrets.

KeyStore string

(Updatable) The base64 encoded content of the KeyStore file.

KeyStorePassword string

(Updatable) The KeyStore password.

LifecycleDetails string

Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.

NsgIds List<string>

(Updatable) An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.

Password string

(Updatable) The password Oracle GoldenGate uses to connect the associated RDBMS. It must conform to the specific security requirements implemented by the database including length, case sensitivity, and so on.

Port int

(Updatable) The port of an endpoint usually specified for a connection.

PrivateIp string

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

PrivateKeyFile string

(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

PrivateKeyPassphrase string

(Updatable) The passphrase of the private key.

ProducerProperties string

(Updatable) The base64 encoded content of the producer.properties file.

PublicKeyFingerprint string

(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

SasToken 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

SecurityProtocol string

(Updatable) Security protocol for PostgreSQL.

SessionMode string

(Updatable) The mode of the database connection session to be established by the data client. 'REDIRECT' - for a RAC database, 'DIRECT' - for a non-RAC database. Connection to a RAC database involves a redirection received from the SCAN listeners to the database node to connect to. By default the mode would be DIRECT.

SslCa string

(Updatable) Database Certificate - The base64 encoded content of mysql.pem file containing the server public key (for 1 and 2-way SSL).

SslCert string

(Updatable) Client Certificate - The base64 encoded content of client-cert.pem file containing the client public key (for 2-way SSL).

SslCrl string

(Updatable) Certificates revoked by certificate authorities (CA). Server certificate must not be on this list (for 1 and 2-way SSL). Note: This is an optional and that too only applicable if TLS/MTLS option is selected.

SslKey string

(Updatable) Client Key - The client-key.pem containing the client private key (for 2-way SSL).

SslKeyPassword string

(Updatable) The password for the cert inside of the KeyStore. In case it differs from the KeyStore password, it should be provided.

SslMode string

(Updatable) SSL modes for PostgreSQL.

State string

Possible lifecycle states for connection.

StreamPoolId string

(Updatable) The OCID of the stream pool being referenced.

SubnetId string

The OCID of the subnet being referenced.

SystemTags Dictionary<string, object>

The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}

TechnologyType string

The Kafka (e.g. Confluent) Schema Registry technology type.

TenancyId string

(Updatable) The OCID of the related Oracle Cloud Infrastructure tenancy.

TimeCreated string

The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

TimeUpdated string

The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

TrustStore string

(Updatable) The base64 encoded content of the TrustStore file.

TrustStorePassword string

(Updatable) The TrustStore password.

Url string

(Updatable) Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'

UserId string

(Updatable) The OCID of the Oracle Cloud Infrastructure user who will access the Object Storage. The user must have write access to the bucket they want to connect to.

Username string

(Updatable) The username Oracle GoldenGate uses to connect the associated RDBMS. This username must already exist and be available for use by the database. It must conform to the security requirements implemented by the database including length, case sensitivity, and so on.

VaultId string

(Updatable) The OCID of the customer vault being referenced. If provided, this will reference a vault which the customer will be required to ensure the policies are established to permit the GoldenGate Service to manage secrets contained within this vault.

Wallet string

(Updatable) The wallet contents Oracle GoldenGate uses to make connections to a database. This attribute is expected to be base64 encoded.

AccountKey string

(Updatable) Azure storage account key. This property is required when 'authenticationType' is set to 'SHARED_KEY'. e.g.: pa3WbhVATzj56xD4DH1VjOUhApRGEGHvOo58eQJVWIzX+j8j4CUVFcTjpIqDSRaSa1Wo2LbWY5at+AStEgLOIQ==

AccountName string

(Updatable) Sets the Azure storage account name.

AdditionalAttributes []ConnectionAdditionalAttributeArgs

(Updatable) An array of name-value pair attribute entries. Used as additional parameters in connection string.

AuthenticationType string

(Updatable) Used authentication mechanism to access Azure Data Lake Storage.

AzureTenantId string

(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

BootstrapServers []ConnectionBootstrapServerArgs

(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"

ClientId string

(Updatable) Azure client ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 06ecaabf-8b80-4ec8-a0ec-20cbf463703d

ClientSecret string

(Updatable) Azure client secret (aka application password) for authentication. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: dO29Q~F5-VwnA.lZdd11xFF_t5NAXCaGwDl9NbT1

CompartmentId string

(Updatable) The OCID of the compartment being referenced.

ConnectionString string

(Updatable) JDBC connection string. e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'

ConnectionType string

(Updatable) The connection type.

ConsumerProperties string

(Updatable) The base64 encoded content of the consumer.properties file.

DatabaseId string

(Updatable) The OCID of the database being referenced.

DatabaseName string

(Updatable) The name of the database.

DbSystemId string

(Updatable) The OCID of the database system being referenced.

DefinedTags map[string]interface{}

(Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

DeploymentId string

(Updatable) The OCID of the deployment being referenced.

Description string

(Updatable) Metadata about this specific object.

DisplayName string

(Updatable) An object's Display Name.

Endpoint string

(Updatable) Azure Storage service endpoint. e.g: https://test.blob.core.windows.net

FreeformTags map[string]interface{}

(Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

Host string

(Updatable) The name or address of a host.

IngressIps []ConnectionIngressIpArgs

List of ingress IP addresses, from where the GoldenGate deployment connects to this connection's privateIp.

KeyId string

(Updatable) The OCID of the customer "Master" key being referenced. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this key to manage secrets.

KeyStore string

(Updatable) The base64 encoded content of the KeyStore file.

KeyStorePassword string

(Updatable) The KeyStore password.

LifecycleDetails string

Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.

NsgIds []string

(Updatable) An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.

Password string

(Updatable) The password Oracle GoldenGate uses to connect the associated RDBMS. It must conform to the specific security requirements implemented by the database including length, case sensitivity, and so on.

Port int

(Updatable) The port of an endpoint usually specified for a connection.

PrivateIp string

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

PrivateKeyFile string

(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

PrivateKeyPassphrase string

(Updatable) The passphrase of the private key.

ProducerProperties string

(Updatable) The base64 encoded content of the producer.properties file.

PublicKeyFingerprint string

(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

SasToken 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

SecurityProtocol string

(Updatable) Security protocol for PostgreSQL.

SessionMode string

(Updatable) The mode of the database connection session to be established by the data client. 'REDIRECT' - for a RAC database, 'DIRECT' - for a non-RAC database. Connection to a RAC database involves a redirection received from the SCAN listeners to the database node to connect to. By default the mode would be DIRECT.

SslCa string

(Updatable) Database Certificate - The base64 encoded content of mysql.pem file containing the server public key (for 1 and 2-way SSL).

SslCert string

(Updatable) Client Certificate - The base64 encoded content of client-cert.pem file containing the client public key (for 2-way SSL).

SslCrl string

(Updatable) Certificates revoked by certificate authorities (CA). Server certificate must not be on this list (for 1 and 2-way SSL). Note: This is an optional and that too only applicable if TLS/MTLS option is selected.

SslKey string

(Updatable) Client Key - The client-key.pem containing the client private key (for 2-way SSL).

SslKeyPassword string

(Updatable) The password for the cert inside of the KeyStore. In case it differs from the KeyStore password, it should be provided.

SslMode string

(Updatable) SSL modes for PostgreSQL.

State string

Possible lifecycle states for connection.

StreamPoolId string

(Updatable) The OCID of the stream pool being referenced.

SubnetId string

The OCID of the subnet being referenced.

SystemTags map[string]interface{}

The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}

TechnologyType string

The Kafka (e.g. Confluent) Schema Registry technology type.

TenancyId string

(Updatable) The OCID of the related Oracle Cloud Infrastructure tenancy.

TimeCreated string

The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

TimeUpdated string

The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

TrustStore string

(Updatable) The base64 encoded content of the TrustStore file.

TrustStorePassword string

(Updatable) The TrustStore password.

Url string

(Updatable) Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'

UserId string

(Updatable) The OCID of the Oracle Cloud Infrastructure user who will access the Object Storage. The user must have write access to the bucket they want to connect to.

Username string

(Updatable) The username Oracle GoldenGate uses to connect the associated RDBMS. This username must already exist and be available for use by the database. It must conform to the security requirements implemented by the database including length, case sensitivity, and so on.

VaultId string

(Updatable) The OCID of the customer vault being referenced. If provided, this will reference a vault which the customer will be required to ensure the policies are established to permit the GoldenGate Service to manage secrets contained within this vault.

Wallet string

(Updatable) The wallet contents Oracle GoldenGate uses to make connections to a database. This attribute is expected to be base64 encoded.

accountKey String

(Updatable) Azure storage account key. This property is required when 'authenticationType' is set to 'SHARED_KEY'. e.g.: pa3WbhVATzj56xD4DH1VjOUhApRGEGHvOo58eQJVWIzX+j8j4CUVFcTjpIqDSRaSa1Wo2LbWY5at+AStEgLOIQ==

accountName String

(Updatable) Sets the Azure storage account name.

additionalAttributes List<ConnectionAdditionalAttributeArgs>

(Updatable) An array of name-value pair attribute entries. Used as additional parameters in connection string.

authenticationType String

(Updatable) Used authentication mechanism to access Azure Data Lake Storage.

azureTenantId String

(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

bootstrapServers List<ConnectionBootstrapServerArgs>

(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"

clientId String

(Updatable) Azure client ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 06ecaabf-8b80-4ec8-a0ec-20cbf463703d

clientSecret String

(Updatable) Azure client secret (aka application password) for authentication. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: dO29Q~F5-VwnA.lZdd11xFF_t5NAXCaGwDl9NbT1

compartmentId String

(Updatable) The OCID of the compartment being referenced.

connectionString String

(Updatable) JDBC connection string. e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'

connectionType String

(Updatable) The connection type.

consumerProperties String

(Updatable) The base64 encoded content of the consumer.properties file.

databaseId String

(Updatable) The OCID of the database being referenced.

databaseName String

(Updatable) The name of the database.

dbSystemId String

(Updatable) The OCID of the database system being referenced.

definedTags Map<String,Object>

(Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

deploymentId String

(Updatable) The OCID of the deployment being referenced.

description String

(Updatable) Metadata about this specific object.

displayName String

(Updatable) An object's Display Name.

endpoint String

(Updatable) Azure Storage service endpoint. e.g: https://test.blob.core.windows.net

freeformTags Map<String,Object>

(Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

host String

(Updatable) The name or address of a host.

ingressIps List<ConnectionIngressIpArgs>

List of ingress IP addresses, from where the GoldenGate deployment connects to this connection's privateIp.

keyId String

(Updatable) The OCID of the customer "Master" key being referenced. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this key to manage secrets.

keyStore String

(Updatable) The base64 encoded content of the KeyStore file.

keyStorePassword String

(Updatable) The KeyStore password.

lifecycleDetails String

Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.

nsgIds List<String>

(Updatable) An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.

password String

(Updatable) The password Oracle GoldenGate uses to connect the associated RDBMS. It must conform to the specific security requirements implemented by the database including length, case sensitivity, and so on.

port Integer

(Updatable) The port of an endpoint usually specified for a connection.

privateIp String

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

privateKeyFile String

(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

privateKeyPassphrase String

(Updatable) The passphrase of the private key.

producerProperties String

(Updatable) The base64 encoded content of the producer.properties file.

publicKeyFingerprint String

(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

sasToken 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

securityProtocol String

(Updatable) Security protocol for PostgreSQL.

sessionMode String

(Updatable) The mode of the database connection session to be established by the data client. 'REDIRECT' - for a RAC database, 'DIRECT' - for a non-RAC database. Connection to a RAC database involves a redirection received from the SCAN listeners to the database node to connect to. By default the mode would be DIRECT.

sslCa String

(Updatable) Database Certificate - The base64 encoded content of mysql.pem file containing the server public key (for 1 and 2-way SSL).

sslCert String

(Updatable) Client Certificate - The base64 encoded content of client-cert.pem file containing the client public key (for 2-way SSL).

sslCrl String

(Updatable) Certificates revoked by certificate authorities (CA). Server certificate must not be on this list (for 1 and 2-way SSL). Note: This is an optional and that too only applicable if TLS/MTLS option is selected.

sslKey String

(Updatable) Client Key - The client-key.pem containing the client private key (for 2-way SSL).

sslKeyPassword String

(Updatable) The password for the cert inside of the KeyStore. In case it differs from the KeyStore password, it should be provided.

sslMode String

(Updatable) SSL modes for PostgreSQL.

state String

Possible lifecycle states for connection.

streamPoolId String

(Updatable) The OCID of the stream pool being referenced.

subnetId String

The OCID of the subnet being referenced.

systemTags Map<String,Object>

The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}

technologyType String

The Kafka (e.g. Confluent) Schema Registry technology type.

tenancyId String

(Updatable) The OCID of the related Oracle Cloud Infrastructure tenancy.

timeCreated String

The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

timeUpdated String

The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

trustStore String

(Updatable) The base64 encoded content of the TrustStore file.

trustStorePassword String

(Updatable) The TrustStore password.

url String

(Updatable) Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'

userId String

(Updatable) The OCID of the Oracle Cloud Infrastructure user who will access the Object Storage. The user must have write access to the bucket they want to connect to.

username String

(Updatable) The username Oracle GoldenGate uses to connect the associated RDBMS. This username must already exist and be available for use by the database. It must conform to the security requirements implemented by the database including length, case sensitivity, and so on.

vaultId String

(Updatable) The OCID of the customer vault being referenced. If provided, this will reference a vault which the customer will be required to ensure the policies are established to permit the GoldenGate Service to manage secrets contained within this vault.

wallet String

(Updatable) The wallet contents Oracle GoldenGate uses to make connections to a database. This attribute is expected to be base64 encoded.

accountKey string

(Updatable) Azure storage account key. This property is required when 'authenticationType' is set to 'SHARED_KEY'. e.g.: pa3WbhVATzj56xD4DH1VjOUhApRGEGHvOo58eQJVWIzX+j8j4CUVFcTjpIqDSRaSa1Wo2LbWY5at+AStEgLOIQ==

accountName string

(Updatable) Sets the Azure storage account name.

additionalAttributes ConnectionAdditionalAttributeArgs[]

(Updatable) An array of name-value pair attribute entries. Used as additional parameters in connection string.

authenticationType string

(Updatable) Used authentication mechanism to access Azure Data Lake Storage.

azureTenantId string

(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

bootstrapServers ConnectionBootstrapServerArgs[]

(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"

clientId string

(Updatable) Azure client ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 06ecaabf-8b80-4ec8-a0ec-20cbf463703d

clientSecret string

(Updatable) Azure client secret (aka application password) for authentication. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: dO29Q~F5-VwnA.lZdd11xFF_t5NAXCaGwDl9NbT1

compartmentId string

(Updatable) The OCID of the compartment being referenced.

connectionString string

(Updatable) JDBC connection string. e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'

connectionType string

(Updatable) The connection type.

consumerProperties string

(Updatable) The base64 encoded content of the consumer.properties file.

databaseId string

(Updatable) The OCID of the database being referenced.

databaseName string

(Updatable) The name of the database.

dbSystemId string

(Updatable) The OCID of the database system being referenced.

definedTags {[key: string]: any}

(Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

deploymentId string

(Updatable) The OCID of the deployment being referenced.

description string

(Updatable) Metadata about this specific object.

displayName string

(Updatable) An object's Display Name.

endpoint string

(Updatable) Azure Storage service endpoint. e.g: https://test.blob.core.windows.net

freeformTags {[key: string]: any}

(Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

host string

(Updatable) The name or address of a host.

ingressIps ConnectionIngressIpArgs[]

List of ingress IP addresses, from where the GoldenGate deployment connects to this connection's privateIp.

keyId string

(Updatable) The OCID of the customer "Master" key being referenced. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this key to manage secrets.

keyStore string

(Updatable) The base64 encoded content of the KeyStore file.

keyStorePassword string

(Updatable) The KeyStore password.

lifecycleDetails string

Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.

nsgIds string[]

(Updatable) An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.

password string

(Updatable) The password Oracle GoldenGate uses to connect the associated RDBMS. It must conform to the specific security requirements implemented by the database including length, case sensitivity, and so on.

port number

(Updatable) The port of an endpoint usually specified for a connection.

privateIp string

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

privateKeyFile string

(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

privateKeyPassphrase string

(Updatable) The passphrase of the private key.

producerProperties string

(Updatable) The base64 encoded content of the producer.properties file.

publicKeyFingerprint string

(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

sasToken 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

securityProtocol string

(Updatable) Security protocol for PostgreSQL.

sessionMode string

(Updatable) The mode of the database connection session to be established by the data client. 'REDIRECT' - for a RAC database, 'DIRECT' - for a non-RAC database. Connection to a RAC database involves a redirection received from the SCAN listeners to the database node to connect to. By default the mode would be DIRECT.

sslCa string

(Updatable) Database Certificate - The base64 encoded content of mysql.pem file containing the server public key (for 1 and 2-way SSL).

sslCert string

(Updatable) Client Certificate - The base64 encoded content of client-cert.pem file containing the client public key (for 2-way SSL).

sslCrl string

(Updatable) Certificates revoked by certificate authorities (CA). Server certificate must not be on this list (for 1 and 2-way SSL). Note: This is an optional and that too only applicable if TLS/MTLS option is selected.

sslKey string

(Updatable) Client Key - The client-key.pem containing the client private key (for 2-way SSL).

sslKeyPassword string

(Updatable) The password for the cert inside of the KeyStore. In case it differs from the KeyStore password, it should be provided.

sslMode string

(Updatable) SSL modes for PostgreSQL.

state string

Possible lifecycle states for connection.

streamPoolId string

(Updatable) The OCID of the stream pool being referenced.

subnetId string

The OCID of the subnet being referenced.

systemTags {[key: string]: any}

The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}

technologyType string

The Kafka (e.g. Confluent) Schema Registry technology type.

tenancyId string

(Updatable) The OCID of the related Oracle Cloud Infrastructure tenancy.

timeCreated string

The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

timeUpdated string

The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

trustStore string

(Updatable) The base64 encoded content of the TrustStore file.

trustStorePassword string

(Updatable) The TrustStore password.

url string

(Updatable) Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'

userId string

(Updatable) The OCID of the Oracle Cloud Infrastructure user who will access the Object Storage. The user must have write access to the bucket they want to connect to.

username string

(Updatable) The username Oracle GoldenGate uses to connect the associated RDBMS. This username must already exist and be available for use by the database. It must conform to the security requirements implemented by the database including length, case sensitivity, and so on.

vaultId string

(Updatable) The OCID of the customer vault being referenced. If provided, this will reference a vault which the customer will be required to ensure the policies are established to permit the GoldenGate Service to manage secrets contained within this vault.

wallet string

(Updatable) The wallet contents Oracle GoldenGate uses to make connections to a database. This attribute is expected to be base64 encoded.

account_key str

(Updatable) Azure storage account key. This property is required when 'authenticationType' is set to 'SHARED_KEY'. e.g.: pa3WbhVATzj56xD4DH1VjOUhApRGEGHvOo58eQJVWIzX+j8j4CUVFcTjpIqDSRaSa1Wo2LbWY5at+AStEgLOIQ==

account_name str

(Updatable) Sets the Azure storage account name.

additional_attributes ConnectionAdditionalAttributeArgs]

(Updatable) An array of name-value pair attribute entries. Used as additional parameters in connection string.

authentication_type str

(Updatable) Used authentication mechanism to access Azure Data Lake Storage.

azure_tenant_id str

(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 ConnectionBootstrapServerArgs]

(Updatable) Kafka bootstrap. Equivalent of bootstrap.servers configuration property in Kafka: list of KafkaBootstrapServer objects specified by host/port. Used for establishing the initial connection to the Kafka cluster. Example: "server1.example.com:9092,server2.example.com:9092"

client_id str

(Updatable) Azure client ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 06ecaabf-8b80-4ec8-a0ec-20cbf463703d

client_secret str

(Updatable) Azure client secret (aka application password) for authentication. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: dO29Q~F5-VwnA.lZdd11xFF_t5NAXCaGwDl9NbT1

compartment_id str

(Updatable) The OCID of the compartment being referenced.

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.

consumer_properties str

(Updatable) The base64 encoded content of the consumer.properties file.

database_id str

(Updatable) The OCID of the database being referenced.

database_name str

(Updatable) The name of the database.

db_system_id str

(Updatable) The OCID of the database system being referenced.

defined_tags Mapping[str, Any]

(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.

endpoint str

(Updatable) Azure Storage service endpoint. e.g: https://test.blob.core.windows.net

freeform_tags Mapping[str, Any]

(Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

host str

(Updatable) The name or address of a host.

ingress_ips ConnectionIngressIpArgs]

List of ingress IP addresses, from where the GoldenGate deployment connects to this connection's privateIp.

key_id str

(Updatable) The OCID of the customer "Master" key being referenced. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this key to manage secrets.

key_store str

(Updatable) The base64 encoded content of the KeyStore file.

key_store_password str

(Updatable) The KeyStore password.

lifecycle_details str

Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.

nsg_ids Sequence[str]

(Updatable) An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.

password str

(Updatable) The password Oracle GoldenGate uses to connect the associated RDBMS. It must conform to the specific security requirements implemented by the database including length, case sensitivity, and so on.

port int

(Updatable) The port of an endpoint usually specified for a connection.

private_ip str

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

private_key_file str

(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

private_key_passphrase str

(Updatable) The passphrase of the private key.

producer_properties str

(Updatable) The base64 encoded content of the producer.properties file.

public_key_fingerprint str

(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

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

security_protocol str

(Updatable) Security protocol for PostgreSQL.

session_mode str

(Updatable) The mode of the database connection session to be established by the data client. 'REDIRECT' - for a RAC database, 'DIRECT' - for a non-RAC database. Connection to a RAC database involves a redirection received from the SCAN listeners to the database node to connect to. By default the mode would be DIRECT.

ssl_ca str

(Updatable) Database Certificate - The base64 encoded content of mysql.pem file containing the server public key (for 1 and 2-way SSL).

ssl_cert str

(Updatable) Client Certificate - The base64 encoded content of client-cert.pem file containing the client public key (for 2-way SSL).

ssl_crl str

(Updatable) Certificates revoked by certificate authorities (CA). Server certificate must not be on this list (for 1 and 2-way SSL). Note: This is an optional and that too only applicable if TLS/MTLS option is selected.

ssl_key str

(Updatable) Client Key - The client-key.pem containing the client private key (for 2-way SSL).

ssl_key_password str

(Updatable) The password for the cert inside of the KeyStore. In case it differs from the KeyStore password, it should be provided.

ssl_mode str

(Updatable) SSL modes for PostgreSQL.

state str

Possible lifecycle states for connection.

stream_pool_id str

(Updatable) The OCID of the stream pool being referenced.

subnet_id str

The OCID of the subnet being referenced.

system_tags Mapping[str, Any]

The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}

technology_type str

The Kafka (e.g. Confluent) Schema Registry technology type.

tenancy_id str

(Updatable) The OCID of the related Oracle Cloud Infrastructure tenancy.

time_created str

The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

time_updated str

The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

trust_store str

(Updatable) The base64 encoded content of the TrustStore file.

trust_store_password str

(Updatable) The TrustStore password.

url str

(Updatable) Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'

user_id str

(Updatable) The OCID of the Oracle Cloud Infrastructure user who will access the Object Storage. The user must have write access to the bucket they want to connect to.

username str

(Updatable) The username Oracle GoldenGate uses to connect the associated RDBMS. This username must already exist and be available for use by the database. It must conform to the security requirements implemented by the database including length, case sensitivity, and so on.

vault_id str

(Updatable) The OCID of the customer vault being referenced. If provided, this will reference a vault which the customer will be required to ensure the policies are established to permit the GoldenGate Service to manage secrets contained within this vault.

wallet str

(Updatable) The wallet contents Oracle GoldenGate uses to make connections to a database. This attribute is expected to be base64 encoded.

accountKey String

(Updatable) Azure storage account key. This property is required when 'authenticationType' is set to 'SHARED_KEY'. e.g.: pa3WbhVATzj56xD4DH1VjOUhApRGEGHvOo58eQJVWIzX+j8j4CUVFcTjpIqDSRaSa1Wo2LbWY5at+AStEgLOIQ==

accountName String

(Updatable) Sets the Azure storage account name.

additionalAttributes List<Property Map>

(Updatable) An array of name-value pair attribute entries. Used as additional parameters in connection string.

authenticationType String

(Updatable) Used authentication mechanism to access Azure Data Lake Storage.

azureTenantId String

(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

bootstrapServers 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"

clientId String

(Updatable) Azure client ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 06ecaabf-8b80-4ec8-a0ec-20cbf463703d

clientSecret String

(Updatable) Azure client secret (aka application password) for authentication. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: dO29Q~F5-VwnA.lZdd11xFF_t5NAXCaGwDl9NbT1

compartmentId String

(Updatable) The OCID of the compartment being referenced.

connectionString String

(Updatable) JDBC connection string. e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'

connectionType String

(Updatable) The connection type.

consumerProperties String

(Updatable) The base64 encoded content of the consumer.properties file.

databaseId String

(Updatable) The OCID of the database being referenced.

databaseName String

(Updatable) The name of the database.

dbSystemId String

(Updatable) The OCID of the database system being referenced.

definedTags Map<Any>

(Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

deploymentId String

(Updatable) The OCID of the deployment being referenced.

description String

(Updatable) Metadata about this specific object.

displayName String

(Updatable) An object's Display Name.

endpoint String

(Updatable) Azure Storage service endpoint. e.g: https://test.blob.core.windows.net

freeformTags Map<Any>

(Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

host String

(Updatable) The name or address of a host.

ingressIps List<Property Map>

List of ingress IP addresses, from where the GoldenGate deployment connects to this connection's privateIp.

keyId String

(Updatable) The OCID of the customer "Master" key being referenced. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this key to manage secrets.

keyStore String

(Updatable) The base64 encoded content of the KeyStore file.

keyStorePassword String

(Updatable) The KeyStore password.

lifecycleDetails String

Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.

nsgIds List<String>

(Updatable) An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.

password String

(Updatable) The password Oracle GoldenGate uses to connect the associated RDBMS. It must conform to the specific security requirements implemented by the database including length, case sensitivity, and so on.

port Number

(Updatable) The port of an endpoint usually specified for a connection.

privateIp String

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

privateKeyFile String

(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

privateKeyPassphrase String

(Updatable) The passphrase of the private key.

producerProperties String

(Updatable) The base64 encoded content of the producer.properties file.

publicKeyFingerprint String

(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

sasToken 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

securityProtocol String

(Updatable) Security protocol for PostgreSQL.

sessionMode String

(Updatable) The mode of the database connection session to be established by the data client. 'REDIRECT' - for a RAC database, 'DIRECT' - for a non-RAC database. Connection to a RAC database involves a redirection received from the SCAN listeners to the database node to connect to. By default the mode would be DIRECT.

sslCa String

(Updatable) Database Certificate - The base64 encoded content of mysql.pem file containing the server public key (for 1 and 2-way SSL).

sslCert String

(Updatable) Client Certificate - The base64 encoded content of client-cert.pem file containing the client public key (for 2-way SSL).

sslCrl String

(Updatable) Certificates revoked by certificate authorities (CA). Server certificate must not be on this list (for 1 and 2-way SSL). Note: This is an optional and that too only applicable if TLS/MTLS option is selected.

sslKey String

(Updatable) Client Key - The client-key.pem containing the client private key (for 2-way SSL).

sslKeyPassword String

(Updatable) The password for the cert inside of the KeyStore. In case it differs from the KeyStore password, it should be provided.

sslMode String

(Updatable) SSL modes for PostgreSQL.

state String

Possible lifecycle states for connection.

streamPoolId String

(Updatable) The OCID of the stream pool being referenced.

subnetId String

The OCID of the subnet being referenced.

systemTags Map<Any>

The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}

technologyType String

The Kafka (e.g. Confluent) Schema Registry technology type.

tenancyId String

(Updatable) The OCID of the related Oracle Cloud Infrastructure tenancy.

timeCreated String

The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

timeUpdated String

The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

trustStore String

(Updatable) The base64 encoded content of the TrustStore file.

trustStorePassword String

(Updatable) The TrustStore password.

url String

(Updatable) Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'

userId String

(Updatable) The OCID of the Oracle Cloud Infrastructure user who will access the Object Storage. The user must have write access to the bucket they want to connect to.

username String

(Updatable) The username Oracle GoldenGate uses to connect the associated RDBMS. This username must already exist and be available for use by the database. It must conform to the security requirements implemented by the database including length, case sensitivity, and so on.

vaultId String

(Updatable) The OCID of the customer vault being referenced. If provided, this will reference a vault which the customer will be required to ensure the policies are established to permit the GoldenGate Service to manage secrets contained within this vault.

wallet String

(Updatable) The wallet contents Oracle GoldenGate uses to make connections to a database. This attribute is expected to be base64 encoded.

Supporting Types

ConnectionAdditionalAttribute

Name string

(Updatable) The name of the property entry.

Value string

(Updatable) The value of the property entry.

Name string

(Updatable) The name of the property entry.

Value string

(Updatable) The value of the property entry.

name String

(Updatable) The name of the property entry.

value String

(Updatable) The value of the property entry.

name string

(Updatable) The name of the property entry.

value string

(Updatable) The value of the property entry.

name str

(Updatable) The name of the property entry.

value str

(Updatable) The value of the property entry.

name String

(Updatable) The name of the property entry.

value String

(Updatable) The value of the property entry.

ConnectionBootstrapServer

Host string

(Updatable) The name or address of a host.

Port int

(Updatable) The port of an endpoint usually specified for a connection.

PrivateIp string

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

Host string

(Updatable) The name or address of a host.

Port int

(Updatable) The port of an endpoint usually specified for a connection.

PrivateIp string

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

host String

(Updatable) The name or address of a host.

port Integer

(Updatable) The port of an endpoint usually specified for a connection.

privateIp String

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

host string

(Updatable) The name or address of a host.

port number

(Updatable) The port of an endpoint usually specified for a connection.

privateIp string

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

host str

(Updatable) The name or address of a host.

port int

(Updatable) The port of an endpoint usually specified for a connection.

private_ip str

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

host String

(Updatable) The name or address of a host.

port Number

(Updatable) The port of an endpoint usually specified for a connection.

privateIp String

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

ConnectionIngressIp

IngressIp string

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

IngressIp string

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

ingressIp String

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

ingressIp string

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

ingress_ip str

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

ingressIp String

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

Import

Connections can be imported using the id, e.g.

 $ pulumi import oci:GoldenGate/connection:Connection test_connection "id"

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.