oci.GoldenGate.getConnection

func GetConnection(ctx *Context, args *GetConnectionArgs, opts ...InvokeOption) (*GetConnectionResult, error)
func GetConnectionOutput(ctx *Context, args *GetConnectionOutputArgs, opts ...InvokeOption) GetConnectionResultOutput

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

ConnectionId string

The OCID of a Connection.

ConnectionId string

The OCID of a Connection.

connectionId String

The OCID of a Connection.

connectionId string

The OCID of a Connection.

connection_id str

The OCID of a Connection.

connectionId String

The OCID of a Connection.

AccessKeyId string

Access key ID to access the Amazon S3 bucket. e.g.: "this-is-not-the-secret"

AccountKey string

AccountName string

Sets the Azure storage account name.

AdditionalAttributes List<GetConnectionAdditionalAttribute>

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

AuthenticationMode string

Authentication mode. It can be provided at creation of Oracle Autonomous Database Serverless connections, when a databaseId is provided. The default value is MTLS.

AuthenticationType string

Used authentication mechanism to be provided for the following connection types:

• AZURE_DATA_LAKE_STORAGE, ELASTICSEARCH, KAFKA_SCHEMA_REGISTRY, REDIS, SNOWFLAKE
• JAVA_MESSAGE_SERVICE - If not provided, default is NONE. Optional until 2024-06-27, in the release after it will be made required.

AzureTenantId string

Azure tenant ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 14593954-d337-4a61-a364-9f758c64f97f

BootstrapServers List<GetConnectionBootstrapServer>

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

ClientId string

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

ClientSecret string

CompartmentId string

The OCID of the compartment being referenced.

ConnectionFactory string

The of Java class implementing javax.jms.ConnectionFactory interface supplied by the Java Message Service provider. e.g.: 'com.stc.jmsjca.core.JConnectionFactoryXA'

ConnectionId string

ConnectionString string

• ORACLE: Connect descriptor or Easy Connect Naming method used to connect to a database.
• MONGODB: MongoDB connection string. e.g.: 'mongodb://mongodb0.example.com:27017/recordsrecords'
• AZURE_SYNAPSE_ANALYTICS: JDBC connection string. e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'

ConnectionType string

The connection type.

ConnectionUrl string

• JAVA_MESSAGE_SERVICE: Connection URL of the Java Message Service, specifying the protocol, host, and port. e.g.: 'mq://myjms.host.domain:7676'
• SNOWFLAKE: JDBC connection URL. e.g.: 'jdbc:snowflake://<account_name>.snowflakecomputing.com/?warehouse=&db='
• AMAZON_REDSHIFT: Connection URL. e.g.: 'jdbc:redshift://aws-redshift-instance.aaaaaaaaaaaa.us-east-2.redshift.amazonaws.com:5439/mydb'

ConsumerProperties string

CoreSiteXml string

DatabaseId string

The OCID of the database being referenced.

DatabaseName string

The name of the database.

DbSystemId string

The OCID of the database system being referenced.

DefinedTags Dictionary<string, object>

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

DeploymentId string

The OCID of the deployment being referenced.

Description string

Metadata about this specific object.

DisplayName string

An object's Display Name.

Endpoint string

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

Fingerprint string

FreeformTags Dictionary<string, object>

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

Host string

The name or address of a host. In case of Generic connection type it represents the Host and port separated by colon. Example: "server.example.com:1234" For multiple hosts, provide a comma separated list. Example: "server1.example.com:1000,server1.example.com:2000"

Id string

The OCID of the connection being referenced.

IngressIps List<GetConnectionIngressIp>

List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp. Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.

IsLockOverride bool

JndiConnectionFactory string

The Connection Factory can be looked up using this name. e.g.: 'ConnectionFactory'

JndiInitialContextFactory string

The implementation of javax.naming.spi.InitialContextFactory interface that the client uses to obtain initial naming context. e.g.: 'org.apache.activemq.jndi.ActiveMQInitialContextFactory'

JndiProviderUrl string

The URL that Java Message Service will use to contact the JNDI provider. e.g.: 'tcp://myjms.host.domain:61616?jms.prefetchPolicy.all=1000'

JndiSecurityCredentials string

JndiSecurityPrincipal string

Specifies the identity of the principal (user) to be authenticated. e.g.: 'admin2'

KeyId string

Refers to the customer's master key OCID. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.

KeyStore string

KeyStorePassword string

LifecycleDetails string

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

Locks List<GetConnectionLock>

Locks associated with this resource.

NsgIds List<string>

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

Password string

Port int

The port of an endpoint usually specified for a connection.

PrivateIp string

Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host field, or make sure the host name is resolvable in the target VCN. The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.

PrivateKeyFile string

PrivateKeyPassphrase string

ProducerProperties string

PublicKeyFingerprint string

RedisClusterId string

The OCID of the Redis cluster.

Region string

The name of the region. e.g.: us-ashburn-1

RoutingMethod string

Controls the network traffic direction to the target: SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets. SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet. DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.

SasToken string

SecretAccessKey string

SecurityProtocol string

Security Protocol to be provided for the following connection types:

• ELASTICSEARCH, KAFKA, MICROSOFT_SQLSERVER, MYSQL, POSTGRESQL, REDIS
• JAVA_MESSAGE_SERVICE - If not provided, default is NONE. Optional until 2024-06-27, in the release after it will be made required.

Servers string

Comma separated list of server addresses, specified as host:port entries, where :port is optional. Example: "server1.example.com:4000,server2.example.com:4000" If port is not specified, a default value is set, in case of ELASTICSEARCH: 9200, for REDIS 6379.

ServiceAccountKeyFile string

SessionMode string

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

ShouldUseJndi bool

If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.

ShouldValidateServerCertificate bool

If set to true, the driver validates the certificate that is sent by the database server.

SslCa string

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

SslCert string

SslClientKeystash string

SslClientKeystoredb string

SslCrl string

SslKey string

SslKeyPassword string

SslMode string

SSL mode to be provided for the following connection types: MYSQL, POSTGRESQL.

SslServerCertificate string

State string

Possible lifecycle states for connection.

StreamPoolId string

The OCID of the stream pool being referenced.

SubnetId string

The OCID of the target subnet of the dedicated 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}}

TechnologyType string

The technology type.

TenancyId string

The OCID of the related Oracle Cloud Infrastructure tenancy.

TimeCreated string

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

TimeUpdated string

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

TrustStore string

TrustStorePassword string

Url string

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

UserId string

The OCID of the Oracle Cloud Infrastructure user who will access the Oracle NoSQL database/Object Storage. The user must have write access to the table they want to connect to.

Username string

The username Oracle GoldenGate uses to connect the associated system of the given technology. This username must already exist and be available by the system/application to be connected to and must conform to the case sensitivity requirements defined in it.

VaultId string

Refers to the customer's vault OCID. If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate to manage secrets contained within this vault.

Wallet string

AccessKeyId string

Access key ID to access the Amazon S3 bucket. e.g.: "this-is-not-the-secret"

AccountKey string

AccountName string

Sets the Azure storage account name.

AdditionalAttributes []GetConnectionAdditionalAttribute

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

AuthenticationMode string

Authentication mode. It can be provided at creation of Oracle Autonomous Database Serverless connections, when a databaseId is provided. The default value is MTLS.

AuthenticationType string

Used authentication mechanism to be provided for the following connection types:

• AZURE_DATA_LAKE_STORAGE, ELASTICSEARCH, KAFKA_SCHEMA_REGISTRY, REDIS, SNOWFLAKE
• JAVA_MESSAGE_SERVICE - If not provided, default is NONE. Optional until 2024-06-27, in the release after it will be made required.

AzureTenantId string

Azure tenant ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 14593954-d337-4a61-a364-9f758c64f97f

BootstrapServers []GetConnectionBootstrapServer

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

ClientId string

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

ClientSecret string

CompartmentId string

The OCID of the compartment being referenced.

ConnectionFactory string

The of Java class implementing javax.jms.ConnectionFactory interface supplied by the Java Message Service provider. e.g.: 'com.stc.jmsjca.core.JConnectionFactoryXA'

ConnectionId string

ConnectionString string

• ORACLE: Connect descriptor or Easy Connect Naming method used to connect to a database.
• MONGODB: MongoDB connection string. e.g.: 'mongodb://mongodb0.example.com:27017/recordsrecords'
• AZURE_SYNAPSE_ANALYTICS: JDBC connection string. e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'

ConnectionType string

The connection type.

ConnectionUrl string

• JAVA_MESSAGE_SERVICE: Connection URL of the Java Message Service, specifying the protocol, host, and port. e.g.: 'mq://myjms.host.domain:7676'
• SNOWFLAKE: JDBC connection URL. e.g.: 'jdbc:snowflake://<account_name>.snowflakecomputing.com/?warehouse=&db='
• AMAZON_REDSHIFT: Connection URL. e.g.: 'jdbc:redshift://aws-redshift-instance.aaaaaaaaaaaa.us-east-2.redshift.amazonaws.com:5439/mydb'

ConsumerProperties string

CoreSiteXml string

DatabaseId string

The OCID of the database being referenced.

DatabaseName string

The name of the database.

DbSystemId string

The OCID of the database system being referenced.

DefinedTags map[string]interface{}

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

DeploymentId string

The OCID of the deployment being referenced.

Description string

Metadata about this specific object.

DisplayName string

An object's Display Name.

Endpoint string

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

Fingerprint string

FreeformTags map[string]interface{}

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

Host string

The name or address of a host. In case of Generic connection type it represents the Host and port separated by colon. Example: "server.example.com:1234" For multiple hosts, provide a comma separated list. Example: "server1.example.com:1000,server1.example.com:2000"

Id string

The OCID of the connection being referenced.

IngressIps []GetConnectionIngressIp

List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp. Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.

IsLockOverride bool

JndiConnectionFactory string

The Connection Factory can be looked up using this name. e.g.: 'ConnectionFactory'

JndiInitialContextFactory string

The implementation of javax.naming.spi.InitialContextFactory interface that the client uses to obtain initial naming context. e.g.: 'org.apache.activemq.jndi.ActiveMQInitialContextFactory'

JndiProviderUrl string

The URL that Java Message Service will use to contact the JNDI provider. e.g.: 'tcp://myjms.host.domain:61616?jms.prefetchPolicy.all=1000'

JndiSecurityCredentials string

JndiSecurityPrincipal string

Specifies the identity of the principal (user) to be authenticated. e.g.: 'admin2'

KeyId string

Refers to the customer's master key OCID. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.

KeyStore string

KeyStorePassword string

LifecycleDetails string

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

Locks []GetConnectionLock

Locks associated with this resource.

NsgIds []string

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

Password string

Port int

The port of an endpoint usually specified for a connection.

PrivateIp string

Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host field, or make sure the host name is resolvable in the target VCN. The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.

PrivateKeyFile string

PrivateKeyPassphrase string

ProducerProperties string

PublicKeyFingerprint string

RedisClusterId string

The OCID of the Redis cluster.

Region string

The name of the region. e.g.: us-ashburn-1

RoutingMethod string

Controls the network traffic direction to the target: SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets. SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet. DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.

SasToken string

SecretAccessKey string

SecurityProtocol string

Security Protocol to be provided for the following connection types:

• ELASTICSEARCH, KAFKA, MICROSOFT_SQLSERVER, MYSQL, POSTGRESQL, REDIS
• JAVA_MESSAGE_SERVICE - If not provided, default is NONE. Optional until 2024-06-27, in the release after it will be made required.

Servers string

Comma separated list of server addresses, specified as host:port entries, where :port is optional. Example: "server1.example.com:4000,server2.example.com:4000" If port is not specified, a default value is set, in case of ELASTICSEARCH: 9200, for REDIS 6379.

ServiceAccountKeyFile string

SessionMode string

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

ShouldUseJndi bool

If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.

ShouldValidateServerCertificate bool

If set to true, the driver validates the certificate that is sent by the database server.

SslCa string

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

SslCert string

SslClientKeystash string

SslClientKeystoredb string

SslCrl string

SslKey string

SslKeyPassword string

SslMode string

SSL mode to be provided for the following connection types: MYSQL, POSTGRESQL.

SslServerCertificate string

State string

Possible lifecycle states for connection.

StreamPoolId string

The OCID of the stream pool being referenced.

SubnetId string

The OCID of the target subnet of the dedicated 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}}

TechnologyType string

The technology type.

TenancyId string

The OCID of the related Oracle Cloud Infrastructure tenancy.

TimeCreated string

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

TimeUpdated string

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

TrustStore string

TrustStorePassword string

Url string

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

UserId string

The OCID of the Oracle Cloud Infrastructure user who will access the Oracle NoSQL database/Object Storage. The user must have write access to the table they want to connect to.

Username string

The username Oracle GoldenGate uses to connect the associated system of the given technology. This username must already exist and be available by the system/application to be connected to and must conform to the case sensitivity requirements defined in it.

VaultId string

Refers to the customer's vault OCID. If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate to manage secrets contained within this vault.

Wallet string

accessKeyId String

Access key ID to access the Amazon S3 bucket. e.g.: "this-is-not-the-secret"

accountKey String

accountName String

Sets the Azure storage account name.

additionalAttributes List<GetConnectionAdditionalAttribute>

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

authenticationMode String

Authentication mode. It can be provided at creation of Oracle Autonomous Database Serverless connections, when a databaseId is provided. The default value is MTLS.

authenticationType String

Used authentication mechanism to be provided for the following connection types:

• AZURE_DATA_LAKE_STORAGE, ELASTICSEARCH, KAFKA_SCHEMA_REGISTRY, REDIS, SNOWFLAKE
• JAVA_MESSAGE_SERVICE - If not provided, default is NONE. Optional until 2024-06-27, in the release after it will be made required.

azureTenantId String

Azure tenant ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 14593954-d337-4a61-a364-9f758c64f97f

bootstrapServers List<GetConnectionBootstrapServer>

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

clientId String

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

clientSecret String

compartmentId String

The OCID of the compartment being referenced.

connectionFactory String

The of Java class implementing javax.jms.ConnectionFactory interface supplied by the Java Message Service provider. e.g.: 'com.stc.jmsjca.core.JConnectionFactoryXA'

connectionId String

connectionString String

• ORACLE: Connect descriptor or Easy Connect Naming method used to connect to a database.
• MONGODB: MongoDB connection string. e.g.: 'mongodb://mongodb0.example.com:27017/recordsrecords'
• AZURE_SYNAPSE_ANALYTICS: JDBC connection string. e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'

connectionType String

The connection type.

connectionUrl String

• JAVA_MESSAGE_SERVICE: Connection URL of the Java Message Service, specifying the protocol, host, and port. e.g.: 'mq://myjms.host.domain:7676'
• SNOWFLAKE: JDBC connection URL. e.g.: 'jdbc:snowflake://<account_name>.snowflakecomputing.com/?warehouse=&db='
• AMAZON_REDSHIFT: Connection URL. e.g.: 'jdbc:redshift://aws-redshift-instance.aaaaaaaaaaaa.us-east-2.redshift.amazonaws.com:5439/mydb'

consumerProperties String

coreSiteXml String

databaseId String

The OCID of the database being referenced.

databaseName String

The name of the database.

dbSystemId String

The OCID of the database system being referenced.

definedTags Map<String,Object>

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

deploymentId String

The OCID of the deployment being referenced.

description String

Metadata about this specific object.

displayName String

An object's Display Name.

endpoint String

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

fingerprint String

freeformTags Map<String,Object>

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

host String

The name or address of a host. In case of Generic connection type it represents the Host and port separated by colon. Example: "server.example.com:1234" For multiple hosts, provide a comma separated list. Example: "server1.example.com:1000,server1.example.com:2000"

id String

The OCID of the connection being referenced.

ingressIps List<GetConnectionIngressIp>

List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp. Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.

isLockOverride Boolean

jndiConnectionFactory String

The Connection Factory can be looked up using this name. e.g.: 'ConnectionFactory'

jndiInitialContextFactory String

The implementation of javax.naming.spi.InitialContextFactory interface that the client uses to obtain initial naming context. e.g.: 'org.apache.activemq.jndi.ActiveMQInitialContextFactory'

jndiProviderUrl String

The URL that Java Message Service will use to contact the JNDI provider. e.g.: 'tcp://myjms.host.domain:61616?jms.prefetchPolicy.all=1000'

jndiSecurityCredentials String

jndiSecurityPrincipal String

Specifies the identity of the principal (user) to be authenticated. e.g.: 'admin2'

keyId String

Refers to the customer's master key OCID. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.

keyStore String

keyStorePassword String

lifecycleDetails String

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

locks List<GetConnectionLock>

Locks associated with this resource.

nsgIds List<String>

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

password String

port Integer

The port of an endpoint usually specified for a connection.

privateIp String

Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host field, or make sure the host name is resolvable in the target VCN. The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.

privateKeyFile String

privateKeyPassphrase String

producerProperties String

publicKeyFingerprint String

redisClusterId String

The OCID of the Redis cluster.

region String

The name of the region. e.g.: us-ashburn-1

routingMethod String

Controls the network traffic direction to the target: SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets. SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet. DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.

sasToken String

secretAccessKey String

securityProtocol String

Security Protocol to be provided for the following connection types:

• ELASTICSEARCH, KAFKA, MICROSOFT_SQLSERVER, MYSQL, POSTGRESQL, REDIS
• JAVA_MESSAGE_SERVICE - If not provided, default is NONE. Optional until 2024-06-27, in the release after it will be made required.

servers String

Comma separated list of server addresses, specified as host:port entries, where :port is optional. Example: "server1.example.com:4000,server2.example.com:4000" If port is not specified, a default value is set, in case of ELASTICSEARCH: 9200, for REDIS 6379.

serviceAccountKeyFile String

sessionMode String

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

shouldUseJndi Boolean

If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.

shouldValidateServerCertificate Boolean

If set to true, the driver validates the certificate that is sent by the database server.

sslCa String

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

sslCert String

sslClientKeystash String

sslClientKeystoredb String

sslCrl String

sslKey String

sslKeyPassword String

sslMode String

SSL mode to be provided for the following connection types: MYSQL, POSTGRESQL.

sslServerCertificate String

state String

Possible lifecycle states for connection.

streamPoolId String

The OCID of the stream pool being referenced.

subnetId String

The OCID of the target subnet of the dedicated 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}}

technologyType String

The technology type.

tenancyId String

The OCID of the related Oracle Cloud Infrastructure tenancy.

timeCreated String

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

timeUpdated String

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

trustStore String

trustStorePassword String

url String

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

userId String

The OCID of the Oracle Cloud Infrastructure user who will access the Oracle NoSQL database/Object Storage. The user must have write access to the table they want to connect to.

username String

The username Oracle GoldenGate uses to connect the associated system of the given technology. This username must already exist and be available by the system/application to be connected to and must conform to the case sensitivity requirements defined in it.

vaultId String

Refers to the customer's vault OCID. If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate to manage secrets contained within this vault.

wallet String

accessKeyId string

Access key ID to access the Amazon S3 bucket. e.g.: "this-is-not-the-secret"

accountKey string

accountName string

Sets the Azure storage account name.

additionalAttributes GetConnectionAdditionalAttribute[]

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

authenticationMode string

Authentication mode. It can be provided at creation of Oracle Autonomous Database Serverless connections, when a databaseId is provided. The default value is MTLS.

authenticationType string

Used authentication mechanism to be provided for the following connection types:

• AZURE_DATA_LAKE_STORAGE, ELASTICSEARCH, KAFKA_SCHEMA_REGISTRY, REDIS, SNOWFLAKE
• JAVA_MESSAGE_SERVICE - If not provided, default is NONE. Optional until 2024-06-27, in the release after it will be made required.

azureTenantId string

Azure tenant ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 14593954-d337-4a61-a364-9f758c64f97f

bootstrapServers GetConnectionBootstrapServer[]

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

clientId string

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

clientSecret string

compartmentId string

The OCID of the compartment being referenced.

connectionFactory string

The of Java class implementing javax.jms.ConnectionFactory interface supplied by the Java Message Service provider. e.g.: 'com.stc.jmsjca.core.JConnectionFactoryXA'

connectionId string

connectionString string

• ORACLE: Connect descriptor or Easy Connect Naming method used to connect to a database.
• MONGODB: MongoDB connection string. e.g.: 'mongodb://mongodb0.example.com:27017/recordsrecords'
• AZURE_SYNAPSE_ANALYTICS: JDBC connection string. e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'

connectionType string

The connection type.

connectionUrl string

• JAVA_MESSAGE_SERVICE: Connection URL of the Java Message Service, specifying the protocol, host, and port. e.g.: 'mq://myjms.host.domain:7676'
• SNOWFLAKE: JDBC connection URL. e.g.: 'jdbc:snowflake://<account_name>.snowflakecomputing.com/?warehouse=&db='
• AMAZON_REDSHIFT: Connection URL. e.g.: 'jdbc:redshift://aws-redshift-instance.aaaaaaaaaaaa.us-east-2.redshift.amazonaws.com:5439/mydb'

consumerProperties string

coreSiteXml string

databaseId string

The OCID of the database being referenced.

databaseName string

The name of the database.

dbSystemId string

The OCID of the database system being referenced.

definedTags {[key: string]: any}

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

deploymentId string

The OCID of the deployment being referenced.

description string

Metadata about this specific object.

displayName string

An object's Display Name.

endpoint string

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

fingerprint string

freeformTags {[key: string]: any}

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

host string

The name or address of a host. In case of Generic connection type it represents the Host and port separated by colon. Example: "server.example.com:1234" For multiple hosts, provide a comma separated list. Example: "server1.example.com:1000,server1.example.com:2000"

id string

The OCID of the connection being referenced.

ingressIps GetConnectionIngressIp[]

List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp. Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.

isLockOverride boolean

jndiConnectionFactory string

The Connection Factory can be looked up using this name. e.g.: 'ConnectionFactory'

jndiInitialContextFactory string

The implementation of javax.naming.spi.InitialContextFactory interface that the client uses to obtain initial naming context. e.g.: 'org.apache.activemq.jndi.ActiveMQInitialContextFactory'

jndiProviderUrl string

The URL that Java Message Service will use to contact the JNDI provider. e.g.: 'tcp://myjms.host.domain:61616?jms.prefetchPolicy.all=1000'

jndiSecurityCredentials string

jndiSecurityPrincipal string

Specifies the identity of the principal (user) to be authenticated. e.g.: 'admin2'

keyId string

Refers to the customer's master key OCID. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.

keyStore string

keyStorePassword string

lifecycleDetails string

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

locks GetConnectionLock[]

Locks associated with this resource.

nsgIds string[]

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

password string

port number

The port of an endpoint usually specified for a connection.

privateIp string

Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host field, or make sure the host name is resolvable in the target VCN. The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.

privateKeyFile string

privateKeyPassphrase string

producerProperties string

publicKeyFingerprint string

redisClusterId string

The OCID of the Redis cluster.

region string

The name of the region. e.g.: us-ashburn-1

routingMethod string

Controls the network traffic direction to the target: SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets. SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet. DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.

sasToken string

secretAccessKey string

securityProtocol string

Security Protocol to be provided for the following connection types:

• ELASTICSEARCH, KAFKA, MICROSOFT_SQLSERVER, MYSQL, POSTGRESQL, REDIS
• JAVA_MESSAGE_SERVICE - If not provided, default is NONE. Optional until 2024-06-27, in the release after it will be made required.

servers string

Comma separated list of server addresses, specified as host:port entries, where :port is optional. Example: "server1.example.com:4000,server2.example.com:4000" If port is not specified, a default value is set, in case of ELASTICSEARCH: 9200, for REDIS 6379.

serviceAccountKeyFile string

sessionMode string

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

shouldUseJndi boolean

If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.

shouldValidateServerCertificate boolean

If set to true, the driver validates the certificate that is sent by the database server.

sslCa string

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

sslCert string

sslClientKeystash string

sslClientKeystoredb string

sslCrl string

sslKey string

sslKeyPassword string

sslMode string

SSL mode to be provided for the following connection types: MYSQL, POSTGRESQL.

sslServerCertificate string

state string

Possible lifecycle states for connection.

streamPoolId string

The OCID of the stream pool being referenced.

subnetId string

The OCID of the target subnet of the dedicated 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}}

technologyType string

The technology type.

tenancyId string

The OCID of the related Oracle Cloud Infrastructure tenancy.

timeCreated string

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

timeUpdated string

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

trustStore string

trustStorePassword string

url string

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

userId string

The OCID of the Oracle Cloud Infrastructure user who will access the Oracle NoSQL database/Object Storage. The user must have write access to the table they want to connect to.

username string

The username Oracle GoldenGate uses to connect the associated system of the given technology. This username must already exist and be available by the system/application to be connected to and must conform to the case sensitivity requirements defined in it.

vaultId string

Refers to the customer's vault OCID. If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate to manage secrets contained within this vault.

wallet string

access_key_id str

Access key ID to access the Amazon S3 bucket. e.g.: "this-is-not-the-secret"

account_key str

account_name str

Sets the Azure storage account name.

additional_attributes Sequence[goldengate.GetConnectionAdditionalAttribute]

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

authentication_mode str

Authentication mode. It can be provided at creation of Oracle Autonomous Database Serverless connections, when a databaseId is provided. The default value is MTLS.

authentication_type str

Used authentication mechanism to be provided for the following connection types:

• AZURE_DATA_LAKE_STORAGE, ELASTICSEARCH, KAFKA_SCHEMA_REGISTRY, REDIS, SNOWFLAKE
• JAVA_MESSAGE_SERVICE - If not provided, default is NONE. Optional until 2024-06-27, in the release after it will be made required.

azure_tenant_id str

Azure tenant ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 14593954-d337-4a61-a364-9f758c64f97f

bootstrap_servers Sequence[goldengate.GetConnectionBootstrapServer]

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

client_id str

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

client_secret str

compartment_id str

The OCID of the compartment being referenced.

connection_factory str

The of Java class implementing javax.jms.ConnectionFactory interface supplied by the Java Message Service provider. e.g.: 'com.stc.jmsjca.core.JConnectionFactoryXA'

connection_id str

connection_string str

• ORACLE: Connect descriptor or Easy Connect Naming method used to connect to a database.
• MONGODB: MongoDB connection string. e.g.: 'mongodb://mongodb0.example.com:27017/recordsrecords'
• AZURE_SYNAPSE_ANALYTICS: JDBC connection string. e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'

connection_type str

The connection type.

connection_url str

• JAVA_MESSAGE_SERVICE: Connection URL of the Java Message Service, specifying the protocol, host, and port. e.g.: 'mq://myjms.host.domain:7676'
• SNOWFLAKE: JDBC connection URL. e.g.: 'jdbc:snowflake://<account_name>.snowflakecomputing.com/?warehouse=&db='
• AMAZON_REDSHIFT: Connection URL. e.g.: 'jdbc:redshift://aws-redshift-instance.aaaaaaaaaaaa.us-east-2.redshift.amazonaws.com:5439/mydb'

consumer_properties str

core_site_xml str

database_id str

The OCID of the database being referenced.

database_name str

The name of the database.

db_system_id str

The OCID of the database system being referenced.

defined_tags Mapping[str, Any]

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

deployment_id str

The OCID of the deployment being referenced.

description str

Metadata about this specific object.

display_name str

An object's Display Name.

endpoint str

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

fingerprint str

freeform_tags Mapping[str, Any]

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

host str

The name or address of a host. In case of Generic connection type it represents the Host and port separated by colon. Example: "server.example.com:1234" For multiple hosts, provide a comma separated list. Example: "server1.example.com:1000,server1.example.com:2000"

id str

The OCID of the connection being referenced.

ingress_ips Sequence[goldengate.GetConnectionIngressIp]

List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp. Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.

is_lock_override bool

jndi_connection_factory str

The Connection Factory can be looked up using this name. e.g.: 'ConnectionFactory'

jndi_initial_context_factory str

The implementation of javax.naming.spi.InitialContextFactory interface that the client uses to obtain initial naming context. e.g.: 'org.apache.activemq.jndi.ActiveMQInitialContextFactory'

jndi_provider_url str

The URL that Java Message Service will use to contact the JNDI provider. e.g.: 'tcp://myjms.host.domain:61616?jms.prefetchPolicy.all=1000'

jndi_security_credentials str

jndi_security_principal str

Specifies the identity of the principal (user) to be authenticated. e.g.: 'admin2'

key_id str

Refers to the customer's master key OCID. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.

key_store str

key_store_password str

lifecycle_details str

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

locks Sequence[goldengate.GetConnectionLock]

Locks associated with this resource.

nsg_ids Sequence[str]

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

password str

port int

The port of an endpoint usually specified for a connection.

private_ip str

Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host field, or make sure the host name is resolvable in the target VCN. The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.

private_key_file str

private_key_passphrase str

producer_properties str

public_key_fingerprint str

redis_cluster_id str

The OCID of the Redis cluster.

region str

The name of the region. e.g.: us-ashburn-1

routing_method str

Controls the network traffic direction to the target: SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets. SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet. DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.

sas_token str

secret_access_key str

security_protocol str

Security Protocol to be provided for the following connection types:

• ELASTICSEARCH, KAFKA, MICROSOFT_SQLSERVER, MYSQL, POSTGRESQL, REDIS
• JAVA_MESSAGE_SERVICE - If not provided, default is NONE. Optional until 2024-06-27, in the release after it will be made required.

servers str

Comma separated list of server addresses, specified as host:port entries, where :port is optional. Example: "server1.example.com:4000,server2.example.com:4000" If port is not specified, a default value is set, in case of ELASTICSEARCH: 9200, for REDIS 6379.

service_account_key_file str

session_mode str

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

should_use_jndi bool

If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.

should_validate_server_certificate bool

If set to true, the driver validates the certificate that is sent by the database server.

ssl_ca str

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

ssl_cert str

ssl_client_keystash str

ssl_client_keystoredb str

ssl_crl str

ssl_key str

ssl_key_password str

ssl_mode str

SSL mode to be provided for the following connection types: MYSQL, POSTGRESQL.

ssl_server_certificate str

state str

Possible lifecycle states for connection.

stream_pool_id str

The OCID of the stream pool being referenced.

subnet_id str

The OCID of the target subnet of the dedicated 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}}

technology_type str

The technology type.

tenancy_id str

The OCID of the related Oracle Cloud Infrastructure tenancy.

time_created str

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

time_updated str

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

trust_store str

trust_store_password str

url str

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

user_id str

The OCID of the Oracle Cloud Infrastructure user who will access the Oracle NoSQL database/Object Storage. The user must have write access to the table they want to connect to.

username str

The username Oracle GoldenGate uses to connect the associated system of the given technology. This username must already exist and be available by the system/application to be connected to and must conform to the case sensitivity requirements defined in it.

vault_id str

Refers to the customer's vault OCID. If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate to manage secrets contained within this vault.

wallet str

accessKeyId String

Access key ID to access the Amazon S3 bucket. e.g.: "this-is-not-the-secret"

accountKey String

accountName String

Sets the Azure storage account name.

additionalAttributes List<Property Map>

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

authenticationMode String

Authentication mode. It can be provided at creation of Oracle Autonomous Database Serverless connections, when a databaseId is provided. The default value is MTLS.

authenticationType String

Used authentication mechanism to be provided for the following connection types:

• AZURE_DATA_LAKE_STORAGE, ELASTICSEARCH, KAFKA_SCHEMA_REGISTRY, REDIS, SNOWFLAKE
• JAVA_MESSAGE_SERVICE - If not provided, default is NONE. Optional until 2024-06-27, in the release after it will be made required.

azureTenantId String

Azure tenant ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 14593954-d337-4a61-a364-9f758c64f97f

bootstrapServers List<Property Map>

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

clientId String

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

clientSecret String

compartmentId String

The OCID of the compartment being referenced.

connectionFactory String

The of Java class implementing javax.jms.ConnectionFactory interface supplied by the Java Message Service provider. e.g.: 'com.stc.jmsjca.core.JConnectionFactoryXA'

connectionId String

connectionString String

• ORACLE: Connect descriptor or Easy Connect Naming method used to connect to a database.
• MONGODB: MongoDB connection string. e.g.: 'mongodb://mongodb0.example.com:27017/recordsrecords'
• AZURE_SYNAPSE_ANALYTICS: JDBC connection string. e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'

connectionType String

The connection type.

connectionUrl String

• JAVA_MESSAGE_SERVICE: Connection URL of the Java Message Service, specifying the protocol, host, and port. e.g.: 'mq://myjms.host.domain:7676'
• SNOWFLAKE: JDBC connection URL. e.g.: 'jdbc:snowflake://<account_name>.snowflakecomputing.com/?warehouse=&db='
• AMAZON_REDSHIFT: Connection URL. e.g.: 'jdbc:redshift://aws-redshift-instance.aaaaaaaaaaaa.us-east-2.redshift.amazonaws.com:5439/mydb'

consumerProperties String

coreSiteXml String

databaseId String

The OCID of the database being referenced.

databaseName String

The name of the database.

dbSystemId String

The OCID of the database system being referenced.

definedTags Map<Any>

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

deploymentId String

The OCID of the deployment being referenced.

description String

Metadata about this specific object.

displayName String

An object's Display Name.

endpoint String

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

fingerprint String

freeformTags Map<Any>

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

host String

The name or address of a host. In case of Generic connection type it represents the Host and port separated by colon. Example: "server.example.com:1234" For multiple hosts, provide a comma separated list. Example: "server1.example.com:1000,server1.example.com:2000"

id String

The OCID of the connection being referenced.

ingressIps List<Property Map>

List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp. Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.

isLockOverride Boolean

jndiConnectionFactory String

The Connection Factory can be looked up using this name. e.g.: 'ConnectionFactory'

jndiInitialContextFactory String

The implementation of javax.naming.spi.InitialContextFactory interface that the client uses to obtain initial naming context. e.g.: 'org.apache.activemq.jndi.ActiveMQInitialContextFactory'

jndiProviderUrl String

The URL that Java Message Service will use to contact the JNDI provider. e.g.: 'tcp://myjms.host.domain:61616?jms.prefetchPolicy.all=1000'

jndiSecurityCredentials String

jndiSecurityPrincipal String

Specifies the identity of the principal (user) to be authenticated. e.g.: 'admin2'

keyId String

Refers to the customer's master key OCID. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.

keyStore String

keyStorePassword String

lifecycleDetails String

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

locks List<Property Map>

Locks associated with this resource.

nsgIds List<String>

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

password String

port Number

The port of an endpoint usually specified for a connection.

privateIp String

Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host field, or make sure the host name is resolvable in the target VCN. The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.

privateKeyFile String

privateKeyPassphrase String

producerProperties String

publicKeyFingerprint String

redisClusterId String

The OCID of the Redis cluster.

region String

The name of the region. e.g.: us-ashburn-1

routingMethod String

Controls the network traffic direction to the target: SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets. SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet. DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.

sasToken String

secretAccessKey String

securityProtocol String

Security Protocol to be provided for the following connection types:

• ELASTICSEARCH, KAFKA, MICROSOFT_SQLSERVER, MYSQL, POSTGRESQL, REDIS
• JAVA_MESSAGE_SERVICE - If not provided, default is NONE. Optional until 2024-06-27, in the release after it will be made required.

servers String

Comma separated list of server addresses, specified as host:port entries, where :port is optional. Example: "server1.example.com:4000,server2.example.com:4000" If port is not specified, a default value is set, in case of ELASTICSEARCH: 9200, for REDIS 6379.

serviceAccountKeyFile String

sessionMode String

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

shouldUseJndi Boolean

If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.

shouldValidateServerCertificate Boolean

If set to true, the driver validates the certificate that is sent by the database server.

sslCa String

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

sslCert String

sslClientKeystash String

sslClientKeystoredb String

sslCrl String

sslKey String

sslKeyPassword String

sslMode String

SSL mode to be provided for the following connection types: MYSQL, POSTGRESQL.

sslServerCertificate String

state String

Possible lifecycle states for connection.

streamPoolId String

The OCID of the stream pool being referenced.

subnetId String

The OCID of the target subnet of the dedicated 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}}

technologyType String

The technology type.

tenancyId String

The OCID of the related Oracle Cloud Infrastructure tenancy.

timeCreated String

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

timeUpdated String

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

trustStore String

trustStorePassword String

url String

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

userId String

The OCID of the Oracle Cloud Infrastructure user who will access the Oracle NoSQL database/Object Storage. The user must have write access to the table they want to connect to.

username String

The username Oracle GoldenGate uses to connect the associated system of the given technology. This username must already exist and be available by the system/application to be connected to and must conform to the case sensitivity requirements defined in it.

vaultId String

Refers to the customer's vault OCID. If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate to manage secrets contained within this vault.

wallet String

Name string

The name of the property entry.

Value string

The value of the property entry.

Name string

The name of the property entry.

Value string

The value of the property entry.

name String

The name of the property entry.

value String

The value of the property entry.

name string

The name of the property entry.

value string

The value of the property entry.

name str

The name of the property entry.

value str

The value of the property entry.

name String

The name of the property entry.

value String

The value of the property entry.

Host string

The name or address of a host. In case of Generic connection type it represents the Host and port separated by colon. Example: "server.example.com:1234" For multiple hosts, provide a comma separated list. Example: "server1.example.com:1000,server1.example.com:2000"

Port int

The port of an endpoint usually specified for a connection.

PrivateIp string

Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host field, or make sure the host name is resolvable in the target VCN. The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.

Host string

The name or address of a host. In case of Generic connection type it represents the Host and port separated by colon. Example: "server.example.com:1234" For multiple hosts, provide a comma separated list. Example: "server1.example.com:1000,server1.example.com:2000"

Port int

The port of an endpoint usually specified for a connection.

PrivateIp string

Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host field, or make sure the host name is resolvable in the target VCN. The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.

host String

The name or address of a host. In case of Generic connection type it represents the Host and port separated by colon. Example: "server.example.com:1234" For multiple hosts, provide a comma separated list. Example: "server1.example.com:1000,server1.example.com:2000"

port Integer

The port of an endpoint usually specified for a connection.

privateIp String

Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host field, or make sure the host name is resolvable in the target VCN. The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.

host string

The name or address of a host. In case of Generic connection type it represents the Host and port separated by colon. Example: "server.example.com:1234" For multiple hosts, provide a comma separated list. Example: "server1.example.com:1000,server1.example.com:2000"

port number

The port of an endpoint usually specified for a connection.

privateIp string

Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host field, or make sure the host name is resolvable in the target VCN. The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.

host str

The name or address of a host. In case of Generic connection type it represents the Host and port separated by colon. Example: "server.example.com:1234" For multiple hosts, provide a comma separated list. Example: "server1.example.com:1000,server1.example.com:2000"

port int

The port of an endpoint usually specified for a connection.

private_ip str

Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host field, or make sure the host name is resolvable in the target VCN. The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.

host String

The name or address of a host. In case of Generic connection type it represents the Host and port separated by colon. Example: "server.example.com:1234" For multiple hosts, provide a comma separated list. Example: "server1.example.com:1000,server1.example.com:2000"

port Number

The port of an endpoint usually specified for a connection.

privateIp String

Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host field, or make sure the host name is resolvable in the target VCN. The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.

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.

Message string

A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.

RelatedResourceId string

The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.

TimeCreated string

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

Type string

Type of the lock.

Message string

A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.

RelatedResourceId string

The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.

TimeCreated string

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

Type string

Type of the lock.

message String

A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.

relatedResourceId String

The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.

timeCreated String

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

type String

Type of the lock.

message string

A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.

relatedResourceId string

The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.

timeCreated string

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

type string

Type of the lock.

message str

A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.

related_resource_id str

The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.

time_created str

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

type str

Type of the lock.

message String

A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.

relatedResourceId String

The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.

timeCreated String

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

type String

Type of the lock.