Oracle Cloud Infrastructure v3.2.0, Jul 10 25

Oracle Cloud Infrastructure v3.2.0 published on Thursday, Jul 10, 2025 by Pulumi

oci.GoldenGate.getConnection

Explore with Pulumi AI

Oracle Cloud Infrastructure v3.2.0 published on Thursday, Jul 10, 2025 by Pulumi

Example Usage

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

variables:
  testConnection:
    fn::invoke:
      function: oci:GoldenGate:getConnection
      arguments:
        connectionId: ${testConnectionOciGoldenGateConnection.id}
        view: ${connectionView}

Using getConnection

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getConnection(args: GetConnectionArgs, opts?: InvokeOptions): Promise<GetConnectionResult>
function getConnectionOutput(args: GetConnectionOutputArgs, opts?: InvokeOptions): Output<GetConnectionResult>

def get_connection(connection_id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetConnectionResult
def get_connection_output(connection_id: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetConnectionResult]

func LookupConnection(ctx *Context, args *LookupConnectionArgs, opts ...InvokeOption) (*LookupConnectionResult, error)
func LookupConnectionOutput(ctx *Context, args *LookupConnectionOutputArgs, opts ...InvokeOption) LookupConnectionResultOutput

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

public static class GetConnection 
{
    public static Task<GetConnectionResult> InvokeAsync(GetConnectionArgs args, InvokeOptions? opts = null)
    public static Output<GetConnectionResult> Invoke(GetConnectionInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetConnectionResult> getConnection(GetConnectionArgs args, InvokeOptions options)
public static Output<GetConnectionResult> getConnection(GetConnectionArgs args, InvokeOptions options)

fn::invoke:
  function: oci:GoldenGate/getConnection:getConnection
  arguments:
    # arguments dictionary

The following arguments are supported:

ConnectionId string: The OCID of a Connection.

ConnectionId string: The OCID of a Connection.

connectionId String: The OCID of a Connection.

connectionId string: The OCID of a Connection.

connection_id str: The OCID of a Connection.

connectionId String: The OCID of a Connection.

getConnection Result

The following output properties are available:

AccessKeyId string

Access key ID to access the Amazon S3 bucket.

AccountKey string

AccountKeySecretId string

The OCID of the Secret where the account key is stored.

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.
DATABRICKS - Required fields by authentication types:
PERSONAL_ACCESS_TOKEN: username is always 'token', user must enter password
OAUTH_M2M: user must enter clientId and clientSecret

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"

Catalogs List<GetConnectionCatalog>

Represents the catalog of given type used in an Iceberg connection.

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

ClientSecretSecretId string

The OCID of the Secret where the client secret is stored. Note: When provided, 'clientSecret' field must not be provided.

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'
DATABRICKS: Connection URL. e.g.: 'jdbc:databricks://adb-33934.4.azuredatabricks.net:443/default;transportMode=http;ssl=1;httpPath=sql/protocolv1/o/3393########44/0##3-7-hlrb'

ConsumerProperties string

The base64 encoded content of the consumer.properties file.

CoreSiteXml string

The base64 encoded content of the Hadoop Distributed File System configuration file (core-site.xml). It is not included in GET responses if the view=COMPACT query parameter is specified.

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, string>

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.

DoesUseSecretIds bool

Indicates that sensitive attributes are provided via Secrets.

Endpoint string

The Azure Blob Storage endpoint where Iceberg data is stored. e.g.: 'https://my-azure-storage-account.blob.core.windows.net'

Fingerprint string

Fingerprint required by TLS security protocol. Eg.: '6152b2dfbff200f973c5074a5b91d06ab3b472c07c09a1ea57bb7fd406cdce9c'

FreeformTags Dictionary<string, string>

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

JndiSecurityCredentialsSecretId string

The OCID of the Secret where the security credentials are stored associated to the principal. Note: When provided, 'jndiSecurityCredentials' field must not be provided.

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

KeyStorePasswordSecretId string

The OCID of the Secret where the kafka Ssl KeyStore password is stored. Note: When provided, 'keyStorePassword' field must not be provided.

KeyStoreSecretId string

The OCID of the Secret where the content of the KeyStore file is stored. Note: When provided, 'keyStore' field must not be provided.

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

PasswordSecretId string

The OCID of the Secret where the password is stored. The password Oracle GoldenGate uses to connect the associated system of the given technology. It must conform to the specific security requirements including length, case sensitivity, and so on. Note: When provided, 'password' field must not be provided.

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

PrivateKeyFileSecretId string

The OCID of the Secret that stores the content of the private key file (PEM file) corresponding to the API key of the fingerprint. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm Note: When provided, 'privateKeyFile' field must not be provided.

PrivateKeyPassphrase string

PrivateKeyPassphraseSecretId string

The OCID of the Secret that stores the password for the private key file. Note: When provided, 'privateKeyPassphrase' field must not be provided.

ProducerProperties string

The base64 encoded content of the producer.properties file.

PublicKeyFingerprint string

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

RedisClusterId string

The OCID of the Redis cluster.

Region string

The AMAZON region where the S3 bucket is hosted. e.g.: 'us-east-2'

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

SasTokenSecretId string

The OCID of the Secret where the sas token is stored. Note: When provided, 'sasToken' field must not be provided.

SecretAccessKey string

SecretAccessKeySecretId string

The OCID of the Secret where the Secret Access Key is stored.

SecurityProtocol string

Security Protocol to be provided for the following connection types:

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

Servers string

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

ServiceAccountKeyFileSecretId string

The OCID of the Secret where the content of the service account key file is stored, which contains the credentials required to use Google Cloud Storage.

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.

ShouldUseResourcePrincipal bool

Indicates that the user intents to connect to the instance through resource principal.

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 a .pem or .crt file. containing the server public key (for 1-way SSL). The supported file formats are .pem and .crt. In case of MYSQL and POSTGRESQL connections it is not included in GET responses if the view=COMPACT query parameter is specified.

SslCert string

Client Certificate - The base64 encoded content of a .pem or .crt file containing the client public key (for 2-way SSL). It is not included in GET responses if the view=COMPACT query parameter is specified.

SslClientKeystash string

SslClientKeystashSecretId string

The OCID of the Secret where the keystash file is stored, which contains the encrypted password to the key database file. Note: When provided, 'sslClientKeystash' field must not be provided.

SslClientKeystoredb string

SslClientKeystoredbSecretId string

The OCID of the Secret where the keystore file stored, which created at the client containing the server certificate / CA root certificate. Note: When provided, 'sslClientKeystoredb' field must not be provided.

SslCrl string

The base64 encoded list of certificates revoked by the trusted certificate authorities (Trusted CA). Note: This is an optional property and only applicable if TLS/MTLS option is selected. It is not included in GET responses if the view=COMPACT query parameter is specified.

SslKey string

SslKeyPassword string

SslKeyPasswordSecretId string

The OCID of the Secret where the password is stored for the cert inside of the Keystore. In case it differs from the KeyStore password, it should be provided. Note: When provided, 'sslKeyPassword' field must not be provided.

SslKeySecretId string

The OCID of the Secret that stores the Client Key

The content of a .pem or .crt file containing the client private key (for 2-way SSL). Note: When provided, 'sslKey' field must not be provided.

SslMode string

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

SslServerCertificate string

The base64 encoded file which contains the self-signed server certificate / Certificate Authority (CA) certificate. It is not included in GET responses if the view=COMPACT query parameter is specified.

State string

Possible lifecycle states for connection.

StorageCredentialName string

Optional. External storage credential name to access files on object storage such as ADLS Gen2, S3 or GCS.

Storages List<GetConnectionStorage>

Represents the storage of given type used in an Iceberg 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, string>

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

TechnologyType string

The technology type.

TenancyId string

The OCID of the related Oracle Cloud Infrastructure tenancy.

TenantId string

Azure tenant ID of the application. e.g.: 14593954-d337-4a61-a364-9f758c64f97f

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.

TlsCaFile string

Database Certificate - The base64 encoded content of a .pem file, containing the server public key (for 1 and 2-way SSL). It is not included in GET responses if the view=COMPACT query parameter is specified.

TlsCertificateKeyFile string

TlsCertificateKeyFilePassword string

TlsCertificateKeyFilePasswordSecretId string

The OCID of the Secret that stores the password of the tls certificate key file. Note: When provided, 'tlsCertificateKeyFilePassword' field must not be provided.

TlsCertificateKeyFileSecretId string

The OCID of the Secret that stores the certificate key file of the mtls connection.

The content of a .pem file containing the client private key (for 2-way SSL). Note: When provided, 'tlsCertificateKeyFile' field must not be provided.

TriggerRefresh bool

TrustStore string

TrustStorePassword string

TrustStorePasswordSecretId string

The OCID of the Secret where the kafka Ssl TrustStore password is stored. Note: When provided, 'trustStorePassword' field must not be provided.

TrustStoreSecretId string

The OCID of the Secret where the content of the TrustStore file is stored. Note: When provided, 'trustStore' field must not be provided.

Url string

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. The user must have write access to the table they want to connect to. If the user is not provided, backend will default to the user who is calling the API endpoint.

Username string

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

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

WalletSecretId string

The OCID of the Secret where the wallet file is stored. The wallet contents Oracle GoldenGate uses to make connections to a database. Note: When provided, 'wallet' field must not be provided.

AccessKeyId string

Access key ID to access the Amazon S3 bucket.

AccountKey string

AccountKeySecretId string

The OCID of the Secret where the account key is stored.

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.
DATABRICKS - Required fields by authentication types:
PERSONAL_ACCESS_TOKEN: username is always 'token', user must enter password
OAUTH_M2M: user must enter clientId and clientSecret

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

Catalogs []GetConnectionCatalog

Represents the catalog of given type used in an Iceberg connection.

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

ClientSecretSecretId string

The OCID of the Secret where the client secret is stored. Note: When provided, 'clientSecret' field must not be provided.

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'
DATABRICKS: Connection URL. e.g.: 'jdbc:databricks://adb-33934.4.azuredatabricks.net:443/default;transportMode=http;ssl=1;httpPath=sql/protocolv1/o/3393########44/0##3-7-hlrb'

ConsumerProperties string

The base64 encoded content of the consumer.properties file.

CoreSiteXml string

The base64 encoded content of the Hadoop Distributed File System configuration file (core-site.xml). It is not included in GET responses if the view=COMPACT query parameter is specified.

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]string

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.

DoesUseSecretIds bool

Indicates that sensitive attributes are provided via Secrets.

Endpoint string

The Azure Blob Storage endpoint where Iceberg data is stored. e.g.: 'https://my-azure-storage-account.blob.core.windows.net'

Fingerprint string

Fingerprint required by TLS security protocol. Eg.: '6152b2dfbff200f973c5074a5b91d06ab3b472c07c09a1ea57bb7fd406cdce9c'

FreeformTags map[string]string

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

Id string

The OCID of the connection being referenced.

IngressIps []GetConnectionIngressIp

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

JndiSecurityCredentialsSecretId string

The OCID of the Secret where the security credentials are stored associated to the principal. Note: When provided, 'jndiSecurityCredentials' field must not be provided.

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

KeyStorePasswordSecretId string

The OCID of the Secret where the kafka Ssl KeyStore password is stored. Note: When provided, 'keyStorePassword' field must not be provided.

KeyStoreSecretId string

The OCID of the Secret where the content of the KeyStore file is stored. Note: When provided, 'keyStore' field must not be provided.

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

PasswordSecretId string

Port int

The port of an endpoint usually specified for a connection.

PrivateIp string

PrivateKeyFile string

PrivateKeyFileSecretId string

PrivateKeyPassphrase string

PrivateKeyPassphraseSecretId string

The OCID of the Secret that stores the password for the private key file. Note: When provided, 'privateKeyPassphrase' field must not be provided.

ProducerProperties string

The base64 encoded content of the producer.properties file.

PublicKeyFingerprint string

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

RedisClusterId string

The OCID of the Redis cluster.

Region string

The AMAZON region where the S3 bucket is hosted. e.g.: 'us-east-2'

RoutingMethod string

SasToken string

SasTokenSecretId string

The OCID of the Secret where the sas token is stored. Note: When provided, 'sasToken' field must not be provided.

SecretAccessKey string

SecretAccessKeySecretId string

The OCID of the Secret where the Secret Access Key is stored.

SecurityProtocol string

Security Protocol to be provided for the following connection types:

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

Servers string

ServiceAccountKeyFile string

ServiceAccountKeyFileSecretId string

The OCID of the Secret where the content of the service account key file is stored, which contains the credentials required to use Google Cloud Storage.

SessionMode string

ShouldUseJndi bool

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

ShouldUseResourcePrincipal bool

Indicates that the user intents to connect to the instance through resource principal.

ShouldValidateServerCertificate bool

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

SslCa string

SslCert string

SslClientKeystash string

SslClientKeystashSecretId string

The OCID of the Secret where the keystash file is stored, which contains the encrypted password to the key database file. Note: When provided, 'sslClientKeystash' field must not be provided.

SslClientKeystoredb string

SslClientKeystoredbSecretId string

SslCrl string

SslKey string

SslKeyPassword string

SslKeyPasswordSecretId string

SslKeySecretId string

The OCID of the Secret that stores the Client Key

The content of a .pem or .crt file containing the client private key (for 2-way SSL). Note: When provided, 'sslKey' field must not be provided.

SslMode string

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

SslServerCertificate string

State string

Possible lifecycle states for connection.

StorageCredentialName string

Optional. External storage credential name to access files on object storage such as ADLS Gen2, S3 or GCS.

Storages []GetConnectionStorage

Represents the storage of given type used in an Iceberg 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]string

TechnologyType string

The technology type.

TenancyId string

The OCID of the related Oracle Cloud Infrastructure tenancy.

TenantId string

Azure tenant ID of the application. e.g.: 14593954-d337-4a61-a364-9f758c64f97f

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.

TlsCaFile string

TlsCertificateKeyFile string

TlsCertificateKeyFilePassword string

TlsCertificateKeyFilePasswordSecretId string

The OCID of the Secret that stores the password of the tls certificate key file. Note: When provided, 'tlsCertificateKeyFilePassword' field must not be provided.

TlsCertificateKeyFileSecretId string

The OCID of the Secret that stores the certificate key file of the mtls connection.

The content of a .pem file containing the client private key (for 2-way SSL). Note: When provided, 'tlsCertificateKeyFile' field must not be provided.

TriggerRefresh bool

TrustStore string

TrustStorePassword string

TrustStorePasswordSecretId string

The OCID of the Secret where the kafka Ssl TrustStore password is stored. Note: When provided, 'trustStorePassword' field must not be provided.

TrustStoreSecretId string

The OCID of the Secret where the content of the TrustStore file is stored. Note: When provided, 'trustStore' field must not be provided.

Url string

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

UserId string

Username string

VaultId string

Wallet string

WalletSecretId string

The OCID of the Secret where the wallet file is stored. The wallet contents Oracle GoldenGate uses to make connections to a database. Note: When provided, 'wallet' field must not be provided.

accessKeyId String

Access key ID to access the Amazon S3 bucket.

accountKey String

accountKeySecretId String

The OCID of the Secret where the account key is stored.

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.
DATABRICKS - Required fields by authentication types:
PERSONAL_ACCESS_TOKEN: username is always 'token', user must enter password
OAUTH_M2M: user must enter clientId and clientSecret

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>

catalogs List<GetConnectionCatalog>

Represents the catalog of given type used in an Iceberg connection.

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

clientSecretSecretId String

The OCID of the Secret where the client secret is stored. Note: When provided, 'clientSecret' field must not be provided.

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'
DATABRICKS: Connection URL. e.g.: 'jdbc:databricks://adb-33934.4.azuredatabricks.net:443/default;transportMode=http;ssl=1;httpPath=sql/protocolv1/o/3393########44/0##3-7-hlrb'

consumerProperties String

The base64 encoded content of the consumer.properties file.

coreSiteXml String

The base64 encoded content of the Hadoop Distributed File System configuration file (core-site.xml). It is not included in GET responses if the view=COMPACT query parameter is specified.

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,String>

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.

doesUseSecretIds Boolean

Indicates that sensitive attributes are provided via Secrets.

endpoint String

The Azure Blob Storage endpoint where Iceberg data is stored. e.g.: 'https://my-azure-storage-account.blob.core.windows.net'

fingerprint String

Fingerprint required by TLS security protocol. Eg.: '6152b2dfbff200f973c5074a5b91d06ab3b472c07c09a1ea57bb7fd406cdce9c'

freeformTags Map<String,String>

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

id String

The OCID of the connection being referenced.

ingressIps List<GetConnectionIngressIp>

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

jndiSecurityCredentialsSecretId String

The OCID of the Secret where the security credentials are stored associated to the principal. Note: When provided, 'jndiSecurityCredentials' field must not be provided.

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

keyStorePasswordSecretId String

The OCID of the Secret where the kafka Ssl KeyStore password is stored. Note: When provided, 'keyStorePassword' field must not be provided.

keyStoreSecretId String

The OCID of the Secret where the content of the KeyStore file is stored. Note: When provided, 'keyStore' field must not be provided.

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

passwordSecretId String

port Integer

The port of an endpoint usually specified for a connection.

privateIp String

privateKeyFile String

privateKeyFileSecretId String

privateKeyPassphrase String

privateKeyPassphraseSecretId String

The OCID of the Secret that stores the password for the private key file. Note: When provided, 'privateKeyPassphrase' field must not be provided.

producerProperties String

The base64 encoded content of the producer.properties file.

publicKeyFingerprint String

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

redisClusterId String

The OCID of the Redis cluster.

region String

The AMAZON region where the S3 bucket is hosted. e.g.: 'us-east-2'

routingMethod String

sasToken String

sasTokenSecretId String

The OCID of the Secret where the sas token is stored. Note: When provided, 'sasToken' field must not be provided.

secretAccessKey String

secretAccessKeySecretId String

The OCID of the Secret where the Secret Access Key is stored.

securityProtocol String

Security Protocol to be provided for the following connection types:

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

servers String

serviceAccountKeyFile String

serviceAccountKeyFileSecretId String

The OCID of the Secret where the content of the service account key file is stored, which contains the credentials required to use Google Cloud Storage.

sessionMode String

shouldUseJndi Boolean

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

shouldUseResourcePrincipal Boolean

Indicates that the user intents to connect to the instance through resource principal.

shouldValidateServerCertificate Boolean

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

sslCa String

sslCert String

sslClientKeystash String

sslClientKeystashSecretId String

The OCID of the Secret where the keystash file is stored, which contains the encrypted password to the key database file. Note: When provided, 'sslClientKeystash' field must not be provided.

sslClientKeystoredb String

sslClientKeystoredbSecretId String

sslCrl String

sslKey String

sslKeyPassword String

sslKeyPasswordSecretId String

sslKeySecretId String

The OCID of the Secret that stores the Client Key

The content of a .pem or .crt file containing the client private key (for 2-way SSL). Note: When provided, 'sslKey' field must not be provided.

sslMode String

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

sslServerCertificate String

state String

Possible lifecycle states for connection.

storageCredentialName String

Optional. External storage credential name to access files on object storage such as ADLS Gen2, S3 or GCS.

storages List<GetConnectionStorage>

Represents the storage of given type used in an Iceberg 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,String>

technologyType String

The technology type.

tenancyId String

The OCID of the related Oracle Cloud Infrastructure tenancy.

tenantId String

Azure tenant ID of the application. e.g.: 14593954-d337-4a61-a364-9f758c64f97f

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.

tlsCaFile String

tlsCertificateKeyFile String

tlsCertificateKeyFilePassword String

tlsCertificateKeyFilePasswordSecretId String

The OCID of the Secret that stores the password of the tls certificate key file. Note: When provided, 'tlsCertificateKeyFilePassword' field must not be provided.

tlsCertificateKeyFileSecretId String

The OCID of the Secret that stores the certificate key file of the mtls connection.

The content of a .pem file containing the client private key (for 2-way SSL). Note: When provided, 'tlsCertificateKeyFile' field must not be provided.

triggerRefresh Boolean

trustStore String

trustStorePassword String

trustStorePasswordSecretId String

The OCID of the Secret where the kafka Ssl TrustStore password is stored. Note: When provided, 'trustStorePassword' field must not be provided.

trustStoreSecretId String

The OCID of the Secret where the content of the TrustStore file is stored. Note: When provided, 'trustStore' field must not be provided.

url String

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

userId String

username String

vaultId String

wallet String

walletSecretId String

The OCID of the Secret where the wallet file is stored. The wallet contents Oracle GoldenGate uses to make connections to a database. Note: When provided, 'wallet' field must not be provided.

accessKeyId string

Access key ID to access the Amazon S3 bucket.

accountKey string

accountKeySecretId string

The OCID of the Secret where the account key is stored.

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.
DATABRICKS - Required fields by authentication types:
PERSONAL_ACCESS_TOKEN: username is always 'token', user must enter password
OAUTH_M2M: user must enter clientId and clientSecret

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[]

catalogs GetConnectionCatalog[]

Represents the catalog of given type used in an Iceberg connection.

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

clientSecretSecretId string

The OCID of the Secret where the client secret is stored. Note: When provided, 'clientSecret' field must not be provided.

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'
DATABRICKS: Connection URL. e.g.: 'jdbc:databricks://adb-33934.4.azuredatabricks.net:443/default;transportMode=http;ssl=1;httpPath=sql/protocolv1/o/3393########44/0##3-7-hlrb'

consumerProperties string

The base64 encoded content of the consumer.properties file.

coreSiteXml string

The base64 encoded content of the Hadoop Distributed File System configuration file (core-site.xml). It is not included in GET responses if the view=COMPACT query parameter is specified.

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]: string}

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.

doesUseSecretIds boolean

Indicates that sensitive attributes are provided via Secrets.

endpoint string

The Azure Blob Storage endpoint where Iceberg data is stored. e.g.: 'https://my-azure-storage-account.blob.core.windows.net'

fingerprint string

Fingerprint required by TLS security protocol. Eg.: '6152b2dfbff200f973c5074a5b91d06ab3b472c07c09a1ea57bb7fd406cdce9c'

freeformTags {[key: string]: string}

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

id string

The OCID of the connection being referenced.

ingressIps GetConnectionIngressIp[]

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

jndiSecurityCredentialsSecretId string

The OCID of the Secret where the security credentials are stored associated to the principal. Note: When provided, 'jndiSecurityCredentials' field must not be provided.

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

keyStorePasswordSecretId string

The OCID of the Secret where the kafka Ssl KeyStore password is stored. Note: When provided, 'keyStorePassword' field must not be provided.

keyStoreSecretId string

The OCID of the Secret where the content of the KeyStore file is stored. Note: When provided, 'keyStore' field must not be provided.

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

passwordSecretId string

port number

The port of an endpoint usually specified for a connection.

privateIp string

privateKeyFile string

privateKeyFileSecretId string

privateKeyPassphrase string

privateKeyPassphraseSecretId string

The OCID of the Secret that stores the password for the private key file. Note: When provided, 'privateKeyPassphrase' field must not be provided.

producerProperties string

The base64 encoded content of the producer.properties file.

publicKeyFingerprint string

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

redisClusterId string

The OCID of the Redis cluster.

region string

The AMAZON region where the S3 bucket is hosted. e.g.: 'us-east-2'

routingMethod string

sasToken string

sasTokenSecretId string

The OCID of the Secret where the sas token is stored. Note: When provided, 'sasToken' field must not be provided.

secretAccessKey string

secretAccessKeySecretId string

The OCID of the Secret where the Secret Access Key is stored.

securityProtocol string

Security Protocol to be provided for the following connection types:

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

servers string

serviceAccountKeyFile string

serviceAccountKeyFileSecretId string

The OCID of the Secret where the content of the service account key file is stored, which contains the credentials required to use Google Cloud Storage.

sessionMode string

shouldUseJndi boolean

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

shouldUseResourcePrincipal boolean

Indicates that the user intents to connect to the instance through resource principal.

shouldValidateServerCertificate boolean

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

sslCa string

sslCert string

sslClientKeystash string

sslClientKeystashSecretId string

The OCID of the Secret where the keystash file is stored, which contains the encrypted password to the key database file. Note: When provided, 'sslClientKeystash' field must not be provided.

sslClientKeystoredb string

sslClientKeystoredbSecretId string

sslCrl string

sslKey string

sslKeyPassword string

sslKeyPasswordSecretId string

sslKeySecretId string

The OCID of the Secret that stores the Client Key

The content of a .pem or .crt file containing the client private key (for 2-way SSL). Note: When provided, 'sslKey' field must not be provided.

sslMode string

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

sslServerCertificate string

state string

Possible lifecycle states for connection.

storageCredentialName string

Optional. External storage credential name to access files on object storage such as ADLS Gen2, S3 or GCS.

storages GetConnectionStorage[]

Represents the storage of given type used in an Iceberg 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]: string}

technologyType string

The technology type.

tenancyId string

The OCID of the related Oracle Cloud Infrastructure tenancy.

tenantId string

Azure tenant ID of the application. e.g.: 14593954-d337-4a61-a364-9f758c64f97f

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.

tlsCaFile string

tlsCertificateKeyFile string

tlsCertificateKeyFilePassword string

tlsCertificateKeyFilePasswordSecretId string

The OCID of the Secret that stores the password of the tls certificate key file. Note: When provided, 'tlsCertificateKeyFilePassword' field must not be provided.

tlsCertificateKeyFileSecretId string

The OCID of the Secret that stores the certificate key file of the mtls connection.

The content of a .pem file containing the client private key (for 2-way SSL). Note: When provided, 'tlsCertificateKeyFile' field must not be provided.

triggerRefresh boolean

trustStore string

trustStorePassword string

trustStorePasswordSecretId string

The OCID of the Secret where the kafka Ssl TrustStore password is stored. Note: When provided, 'trustStorePassword' field must not be provided.

trustStoreSecretId string

The OCID of the Secret where the content of the TrustStore file is stored. Note: When provided, 'trustStore' field must not be provided.

url string

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

userId string

username string

vaultId string

wallet string

walletSecretId string

The OCID of the Secret where the wallet file is stored. The wallet contents Oracle GoldenGate uses to make connections to a database. Note: When provided, 'wallet' field must not be provided.

access_key_id str

Access key ID to access the Amazon S3 bucket.

account_key str

account_key_secret_id str

The OCID of the Secret where the account key is stored.

account_name str

Sets the Azure storage account name.

additional_attributes Sequence[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.
DATABRICKS - Required fields by authentication types:
PERSONAL_ACCESS_TOKEN: username is always 'token', user must enter password
OAUTH_M2M: user must enter clientId and clientSecret

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[GetConnectionBootstrapServer]

catalogs Sequence[GetConnectionCatalog]

Represents the catalog of given type used in an Iceberg connection.

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

client_secret_secret_id str

The OCID of the Secret where the client secret is stored. Note: When provided, 'clientSecret' field must not be provided.

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'
DATABRICKS: Connection URL. e.g.: 'jdbc:databricks://adb-33934.4.azuredatabricks.net:443/default;transportMode=http;ssl=1;httpPath=sql/protocolv1/o/3393########44/0##3-7-hlrb'

consumer_properties str

The base64 encoded content of the consumer.properties file.

core_site_xml str

The base64 encoded content of the Hadoop Distributed File System configuration file (core-site.xml). It is not included in GET responses if the view=COMPACT query parameter is specified.

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, str]

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.

does_use_secret_ids bool

Indicates that sensitive attributes are provided via Secrets.

endpoint str

The Azure Blob Storage endpoint where Iceberg data is stored. e.g.: 'https://my-azure-storage-account.blob.core.windows.net'

fingerprint str

Fingerprint required by TLS security protocol. Eg.: '6152b2dfbff200f973c5074a5b91d06ab3b472c07c09a1ea57bb7fd406cdce9c'

freeform_tags Mapping[str, str]

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

id str

The OCID of the connection being referenced.

ingress_ips Sequence[GetConnectionIngressIp]

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_credentials_secret_id str

The OCID of the Secret where the security credentials are stored associated to the principal. Note: When provided, 'jndiSecurityCredentials' field must not be provided.

jndi_security_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

key_store_password_secret_id str

The OCID of the Secret where the kafka Ssl KeyStore password is stored. Note: When provided, 'keyStorePassword' field must not be provided.

key_store_secret_id str

The OCID of the Secret where the content of the KeyStore file is stored. Note: When provided, 'keyStore' field must not be provided.

lifecycle_details str

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

locks Sequence[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

password_secret_id str

port int

The port of an endpoint usually specified for a connection.

private_ip str

private_key_file str

private_key_file_secret_id str

private_key_passphrase str

private_key_passphrase_secret_id str

The OCID of the Secret that stores the password for the private key file. Note: When provided, 'privateKeyPassphrase' field must not be provided.

producer_properties str

The base64 encoded content of the producer.properties file.

public_key_fingerprint str

The fingerprint of the API Key of the user specified by the userId. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm

redis_cluster_id str

The OCID of the Redis cluster.

region str

The AMAZON region where the S3 bucket is hosted. e.g.: 'us-east-2'

routing_method str

sas_token str

sas_token_secret_id str

The OCID of the Secret where the sas token is stored. Note: When provided, 'sasToken' field must not be provided.

secret_access_key str

secret_access_key_secret_id str

The OCID of the Secret where the Secret Access Key is stored.

security_protocol str

Security Protocol to be provided for the following connection types:

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

servers str

service_account_key_file str

service_account_key_file_secret_id str

The OCID of the Secret where the content of the service account key file is stored, which contains the credentials required to use Google Cloud Storage.

session_mode str

should_use_jndi bool

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

should_use_resource_principal bool

Indicates that the user intents to connect to the instance through resource principal.

should_validate_server_certificate bool

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

ssl_ca str

ssl_cert str

ssl_client_keystash str

ssl_client_keystash_secret_id str

The OCID of the Secret where the keystash file is stored, which contains the encrypted password to the key database file. Note: When provided, 'sslClientKeystash' field must not be provided.

ssl_client_keystoredb str

ssl_client_keystoredb_secret_id str

ssl_crl str

ssl_key str

ssl_key_password str

ssl_key_password_secret_id str

ssl_key_secret_id str

The OCID of the Secret that stores the Client Key

The content of a .pem or .crt file containing the client private key (for 2-way SSL). Note: When provided, 'sslKey' field must not be provided.

ssl_mode str

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

ssl_server_certificate str

state str

Possible lifecycle states for connection.

storage_credential_name str

Optional. External storage credential name to access files on object storage such as ADLS Gen2, S3 or GCS.

storages Sequence[GetConnectionStorage]

Represents the storage of given type used in an Iceberg 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, str]

technology_type str

The technology type.

tenancy_id str

The OCID of the related Oracle Cloud Infrastructure tenancy.

tenant_id str

Azure tenant ID of the application. e.g.: 14593954-d337-4a61-a364-9f758c64f97f

time_created str

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

time_updated str

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

tls_ca_file str

tls_certificate_key_file str

tls_certificate_key_file_password str

tls_certificate_key_file_password_secret_id str

The OCID of the Secret that stores the password of the tls certificate key file. Note: When provided, 'tlsCertificateKeyFilePassword' field must not be provided.

tls_certificate_key_file_secret_id str

The OCID of the Secret that stores the certificate key file of the mtls connection.

The content of a .pem file containing the client private key (for 2-way SSL). Note: When provided, 'tlsCertificateKeyFile' field must not be provided.

trigger_refresh bool

trust_store str

trust_store_password str

trust_store_password_secret_id str

The OCID of the Secret where the kafka Ssl TrustStore password is stored. Note: When provided, 'trustStorePassword' field must not be provided.

trust_store_secret_id str

The OCID of the Secret where the content of the TrustStore file is stored. Note: When provided, 'trustStore' field must not be provided.

url str

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

user_id str

username str

vault_id str

wallet str

wallet_secret_id str

The OCID of the Secret where the wallet file is stored. The wallet contents Oracle GoldenGate uses to make connections to a database. Note: When provided, 'wallet' field must not be provided.

accessKeyId String

Access key ID to access the Amazon S3 bucket.

accountKey String

accountKeySecretId String

The OCID of the Secret where the account key is stored.

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.
DATABRICKS - Required fields by authentication types:
PERSONAL_ACCESS_TOKEN: username is always 'token', user must enter password
OAUTH_M2M: user must enter clientId and clientSecret

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>

catalogs List<Property Map>

Represents the catalog of given type used in an Iceberg connection.

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

clientSecretSecretId String

The OCID of the Secret where the client secret is stored. Note: When provided, 'clientSecret' field must not be provided.

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'
DATABRICKS: Connection URL. e.g.: 'jdbc:databricks://adb-33934.4.azuredatabricks.net:443/default;transportMode=http;ssl=1;httpPath=sql/protocolv1/o/3393########44/0##3-7-hlrb'

consumerProperties String

The base64 encoded content of the consumer.properties file.

coreSiteXml String

The base64 encoded content of the Hadoop Distributed File System configuration file (core-site.xml). It is not included in GET responses if the view=COMPACT query parameter is specified.

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>

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.

doesUseSecretIds Boolean

Indicates that sensitive attributes are provided via Secrets.

endpoint String

The Azure Blob Storage endpoint where Iceberg data is stored. e.g.: 'https://my-azure-storage-account.blob.core.windows.net'

fingerprint String

Fingerprint required by TLS security protocol. Eg.: '6152b2dfbff200f973c5074a5b91d06ab3b472c07c09a1ea57bb7fd406cdce9c'

freeformTags Map<String>

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

id String

The OCID of the connection being referenced.

ingressIps List<Property Map>

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

jndiSecurityCredentialsSecretId String

The OCID of the Secret where the security credentials are stored associated to the principal. Note: When provided, 'jndiSecurityCredentials' field must not be provided.

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

keyStorePasswordSecretId String

The OCID of the Secret where the kafka Ssl KeyStore password is stored. Note: When provided, 'keyStorePassword' field must not be provided.

keyStoreSecretId String

The OCID of the Secret where the content of the KeyStore file is stored. Note: When provided, 'keyStore' field must not be provided.

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

passwordSecretId String

port Number

The port of an endpoint usually specified for a connection.

privateIp String

privateKeyFile String

privateKeyFileSecretId String

privateKeyPassphrase String

privateKeyPassphraseSecretId String

The OCID of the Secret that stores the password for the private key file. Note: When provided, 'privateKeyPassphrase' field must not be provided.

producerProperties String

The base64 encoded content of the producer.properties file.

publicKeyFingerprint String

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

redisClusterId String

The OCID of the Redis cluster.

region String

The AMAZON region where the S3 bucket is hosted. e.g.: 'us-east-2'

routingMethod String

sasToken String

sasTokenSecretId String

The OCID of the Secret where the sas token is stored. Note: When provided, 'sasToken' field must not be provided.

secretAccessKey String

secretAccessKeySecretId String

The OCID of the Secret where the Secret Access Key is stored.

securityProtocol String

Security Protocol to be provided for the following connection types:

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

servers String

serviceAccountKeyFile String

serviceAccountKeyFileSecretId String

The OCID of the Secret where the content of the service account key file is stored, which contains the credentials required to use Google Cloud Storage.

sessionMode String

shouldUseJndi Boolean

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

shouldUseResourcePrincipal Boolean

Indicates that the user intents to connect to the instance through resource principal.

shouldValidateServerCertificate Boolean

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

sslCa String

sslCert String

sslClientKeystash String

sslClientKeystashSecretId String

The OCID of the Secret where the keystash file is stored, which contains the encrypted password to the key database file. Note: When provided, 'sslClientKeystash' field must not be provided.

sslClientKeystoredb String

sslClientKeystoredbSecretId String

sslCrl String

sslKey String

sslKeyPassword String

sslKeyPasswordSecretId String

sslKeySecretId String

The OCID of the Secret that stores the Client Key

The content of a .pem or .crt file containing the client private key (for 2-way SSL). Note: When provided, 'sslKey' field must not be provided.

sslMode String

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

sslServerCertificate String

state String

Possible lifecycle states for connection.

storageCredentialName String

Optional. External storage credential name to access files on object storage such as ADLS Gen2, S3 or GCS.

storages List<Property Map>

Represents the storage of given type used in an Iceberg 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>

technologyType String

The technology type.

tenancyId String

The OCID of the related Oracle Cloud Infrastructure tenancy.

tenantId String

Azure tenant ID of the application. e.g.: 14593954-d337-4a61-a364-9f758c64f97f

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.

tlsCaFile String

tlsCertificateKeyFile String

tlsCertificateKeyFilePassword String

tlsCertificateKeyFilePasswordSecretId String

The OCID of the Secret that stores the password of the tls certificate key file. Note: When provided, 'tlsCertificateKeyFilePassword' field must not be provided.

tlsCertificateKeyFileSecretId String

The OCID of the Secret that stores the certificate key file of the mtls connection.

The content of a .pem file containing the client private key (for 2-way SSL). Note: When provided, 'tlsCertificateKeyFile' field must not be provided.

triggerRefresh Boolean

trustStore String

trustStorePassword String

trustStorePasswordSecretId String

The OCID of the Secret where the kafka Ssl TrustStore password is stored. Note: When provided, 'trustStorePassword' field must not be provided.

trustStoreSecretId String

The OCID of the Secret where the content of the TrustStore file is stored. Note: When provided, 'trustStore' field must not be provided.

url String

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

userId String

username String

vaultId String

wallet String

walletSecretId String

The OCID of the Secret where the wallet file is stored. The wallet contents Oracle GoldenGate uses to make connections to a database. Note: When provided, 'wallet' field must not be provided.

Supporting Types

GetConnectionAdditionalAttribute

Name string: The catalog name within Polaris where Iceberg tables are registered.
Value string: The value of the property entry.

Name string: The catalog name within Polaris where Iceberg tables are registered.
Value string: The value of the property entry.

name String: The catalog name within Polaris where Iceberg tables are registered.
value String: The value of the property entry.

name string: The catalog name within Polaris where Iceberg tables are registered.
value string: The value of the property entry.

name str: The catalog name within Polaris where Iceberg tables are registered.
value str: The value of the property entry.

name String: The catalog name within Polaris where Iceberg tables are registered.
value String: The value of the property entry.

GetConnectionBootstrapServer

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.

GetConnectionCatalog

Branch string: The active branch of the Nessie catalog from which Iceberg reads and writes table metadata.
CatalogType string: The catalog type.
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
ClientSecretSecretId string: The OCID of the Secret where the client secret is stored. Note: When provided, 'clientSecret' field must not be provided.
GlueId string: The AWS Glue Catalog ID where Iceberg tables are registered.
Name string: The catalog name within Polaris where Iceberg tables are registered.
PrincipalRole string: The Snowflake role used to access Polaris.
PropertiesSecretId string: The OCID of the Secret that stores the content of the configuration file containing additional properties for the REST catalog. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm
Uri string: The URL endpoint for the Polaris API. e.g.: 'https://.snowflakecomputing.com/polaris/api/catalog'

Branch string: The active branch of the Nessie catalog from which Iceberg reads and writes table metadata.
CatalogType string: The catalog type.
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
ClientSecretSecretId string: The OCID of the Secret where the client secret is stored. Note: When provided, 'clientSecret' field must not be provided.
GlueId string: The AWS Glue Catalog ID where Iceberg tables are registered.
Name string: The catalog name within Polaris where Iceberg tables are registered.
PrincipalRole string: The Snowflake role used to access Polaris.
PropertiesSecretId string: The OCID of the Secret that stores the content of the configuration file containing additional properties for the REST catalog. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm
Uri string: The URL endpoint for the Polaris API. e.g.: 'https://.snowflakecomputing.com/polaris/api/catalog'

branch String: The active branch of the Nessie catalog from which Iceberg reads and writes table metadata.
catalogType String: The catalog type.
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
clientSecretSecretId String: The OCID of the Secret where the client secret is stored. Note: When provided, 'clientSecret' field must not be provided.
glueId String: The AWS Glue Catalog ID where Iceberg tables are registered.
name String: The catalog name within Polaris where Iceberg tables are registered.
principalRole String: The Snowflake role used to access Polaris.
propertiesSecretId String: The OCID of the Secret that stores the content of the configuration file containing additional properties for the REST catalog. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm
uri String: The URL endpoint for the Polaris API. e.g.: 'https://.snowflakecomputing.com/polaris/api/catalog'

branch string: The active branch of the Nessie catalog from which Iceberg reads and writes table metadata.
catalogType string: The catalog type.
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
clientSecretSecretId string: The OCID of the Secret where the client secret is stored. Note: When provided, 'clientSecret' field must not be provided.
glueId string: The AWS Glue Catalog ID where Iceberg tables are registered.
name string: The catalog name within Polaris where Iceberg tables are registered.
principalRole string: The Snowflake role used to access Polaris.
propertiesSecretId string: The OCID of the Secret that stores the content of the configuration file containing additional properties for the REST catalog. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm
uri string: The URL endpoint for the Polaris API. e.g.: 'https://.snowflakecomputing.com/polaris/api/catalog'

branch str: The active branch of the Nessie catalog from which Iceberg reads and writes table metadata.
catalog_type str: The catalog type.
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_secret_id str: The OCID of the Secret where the client secret is stored. Note: When provided, 'clientSecret' field must not be provided.
glue_id str: The AWS Glue Catalog ID where Iceberg tables are registered.
name str: The catalog name within Polaris where Iceberg tables are registered.
principal_role str: The Snowflake role used to access Polaris.
properties_secret_id str: The OCID of the Secret that stores the content of the configuration file containing additional properties for the REST catalog. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm
uri str: The URL endpoint for the Polaris API. e.g.: 'https://.snowflakecomputing.com/polaris/api/catalog'

branch String: The active branch of the Nessie catalog from which Iceberg reads and writes table metadata.
catalogType String: The catalog type.
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
clientSecretSecretId String: The OCID of the Secret where the client secret is stored. Note: When provided, 'clientSecret' field must not be provided.
glueId String: The AWS Glue Catalog ID where Iceberg tables are registered.
name String: The catalog name within Polaris where Iceberg tables are registered.
principalRole String: The Snowflake role used to access Polaris.
propertiesSecretId String: The OCID of the Secret that stores the content of the configuration file containing additional properties for the REST catalog. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm
uri String: The URL endpoint for the Polaris API. e.g.: 'https://.snowflakecomputing.com/polaris/api/catalog'

GetConnectionIngressIp

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

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

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

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

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

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

GetConnectionLock

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.

GetConnectionStorage

AccessKeyId string: Access key ID to access the Amazon S3 bucket.
AccountKeySecretId string: The OCID of the Secret where the account key is stored.
AccountName string: Sets the Azure storage account name.
Bucket string: Google Cloud Storage bucket where Iceberg stores metadata and data files.
Container string: The Azure Blob Storage container where Iceberg tables are stored.
Endpoint string: The Azure Blob Storage endpoint where Iceberg data is stored. e.g.: 'https://my-azure-storage-account.blob.core.windows.net'
ProjectId string: The Google Cloud Project where the bucket exists.
Region string: The AMAZON region where the S3 bucket is hosted. e.g.: 'us-east-2'
SchemeType string: The scheme of the storage.
SecretAccessKeySecretId string: The OCID of the Secret where the Secret Access Key is stored.
ServiceAccountKeyFileSecretId string: The OCID of the Secret where the content of the service account key file is stored, which contains the credentials required to use Google Cloud Storage.
StorageType string: The storage type used in the Iceberg connection.

AccessKeyId string: Access key ID to access the Amazon S3 bucket.
AccountKeySecretId string: The OCID of the Secret where the account key is stored.
AccountName string: Sets the Azure storage account name.
Bucket string: Google Cloud Storage bucket where Iceberg stores metadata and data files.
Container string: The Azure Blob Storage container where Iceberg tables are stored.
Endpoint string: The Azure Blob Storage endpoint where Iceberg data is stored. e.g.: 'https://my-azure-storage-account.blob.core.windows.net'
ProjectId string: The Google Cloud Project where the bucket exists.
Region string: The AMAZON region where the S3 bucket is hosted. e.g.: 'us-east-2'
SchemeType string: The scheme of the storage.
SecretAccessKeySecretId string: The OCID of the Secret where the Secret Access Key is stored.
ServiceAccountKeyFileSecretId string: The OCID of the Secret where the content of the service account key file is stored, which contains the credentials required to use Google Cloud Storage.
StorageType string: The storage type used in the Iceberg connection.

accessKeyId String: Access key ID to access the Amazon S3 bucket.
accountKeySecretId String: The OCID of the Secret where the account key is stored.
accountName String: Sets the Azure storage account name.
bucket String: Google Cloud Storage bucket where Iceberg stores metadata and data files.
container String: The Azure Blob Storage container where Iceberg tables are stored.
endpoint String: The Azure Blob Storage endpoint where Iceberg data is stored. e.g.: 'https://my-azure-storage-account.blob.core.windows.net'
projectId String: The Google Cloud Project where the bucket exists.
region String: The AMAZON region where the S3 bucket is hosted. e.g.: 'us-east-2'
schemeType String: The scheme of the storage.
secretAccessKeySecretId String: The OCID of the Secret where the Secret Access Key is stored.
serviceAccountKeyFileSecretId String: The OCID of the Secret where the content of the service account key file is stored, which contains the credentials required to use Google Cloud Storage.
storageType String: The storage type used in the Iceberg connection.

accessKeyId string: Access key ID to access the Amazon S3 bucket.
accountKeySecretId string: The OCID of the Secret where the account key is stored.
accountName string: Sets the Azure storage account name.
bucket string: Google Cloud Storage bucket where Iceberg stores metadata and data files.
container string: The Azure Blob Storage container where Iceberg tables are stored.
endpoint string: The Azure Blob Storage endpoint where Iceberg data is stored. e.g.: 'https://my-azure-storage-account.blob.core.windows.net'
projectId string: The Google Cloud Project where the bucket exists.
region string: The AMAZON region where the S3 bucket is hosted. e.g.: 'us-east-2'
schemeType string: The scheme of the storage.
secretAccessKeySecretId string: The OCID of the Secret where the Secret Access Key is stored.
serviceAccountKeyFileSecretId string: The OCID of the Secret where the content of the service account key file is stored, which contains the credentials required to use Google Cloud Storage.
storageType string: The storage type used in the Iceberg connection.

access_key_id str: Access key ID to access the Amazon S3 bucket.
account_key_secret_id str: The OCID of the Secret where the account key is stored.
account_name str: Sets the Azure storage account name.
bucket str: Google Cloud Storage bucket where Iceberg stores metadata and data files.
container str: The Azure Blob Storage container where Iceberg tables are stored.
endpoint str: The Azure Blob Storage endpoint where Iceberg data is stored. e.g.: 'https://my-azure-storage-account.blob.core.windows.net'
project_id str: The Google Cloud Project where the bucket exists.
region str: The AMAZON region where the S3 bucket is hosted. e.g.: 'us-east-2'
scheme_type str: The scheme of the storage.
secret_access_key_secret_id str: The OCID of the Secret where the Secret Access Key is stored.
service_account_key_file_secret_id str: The OCID of the Secret where the content of the service account key file is stored, which contains the credentials required to use Google Cloud Storage.
storage_type str: The storage type used in the Iceberg connection.

accessKeyId String: Access key ID to access the Amazon S3 bucket.
accountKeySecretId String: The OCID of the Secret where the account key is stored.
accountName String: Sets the Azure storage account name.
bucket String: Google Cloud Storage bucket where Iceberg stores metadata and data files.
container String: The Azure Blob Storage container where Iceberg tables are stored.
endpoint String: The Azure Blob Storage endpoint where Iceberg data is stored. e.g.: 'https://my-azure-storage-account.blob.core.windows.net'
projectId String: The Google Cloud Project where the bucket exists.
region String: The AMAZON region where the S3 bucket is hosted. e.g.: 'us-east-2'
schemeType String: The scheme of the storage.
secretAccessKeySecretId String: The OCID of the Secret where the Secret Access Key is stored.
serviceAccountKeyFileSecretId String: The OCID of the Secret where the content of the service account key file is stored, which contains the credentials required to use Google Cloud Storage.
storageType String: The storage type used in the Iceberg connection.

Package Details

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

Oracle Cloud Infrastructure v3.2.0 published on Thursday, Jul 10, 2025 by Pulumi

pulumi/pulumi-oci

oci.GoldenGate.getConnection

On this page

On this page

Example Usage

Using getConnection

getConnection Result

Supporting Types

GetConnectionAdditionalAttribute

GetConnectionBootstrapServer

GetConnectionCatalog

GetConnectionIngressIp

GetConnectionLock

GetConnectionStorage

Package Details

On this page

On this page