Data Source: oci_golden_gate_connections
This data source provides the list of Connections in Oracle Cloud Infrastructure Golden Gate service.
Lists the Connections in the compartment.
Example Usage
data "oci_golden_gate_connections" "test_connections" {
#Required
compartment_id = var.compartment_id
#Optional
assignable_deployment_id = oci_golden_gate_deployment.test_deployment.id
assignable_deployment_type = var.connection_assignable_deployment_type
assigned_deployment_id = oci_golden_gate_deployment.test_deployment.id
connection_type = var.connection_connection_type
connection_type_not_equal_to = var.connection_connection_type_not_equal_to
display_name = var.connection_display_name
state = var.connection_state
technology_type = var.connection_technology_type
}
Argument Reference
The following arguments are supported:
assignable_deployment_id- (Optional) Filters for compatible connections which can be, but currently not assigned to the deployment specified by its id.assignable_deployment_type- (Optional) Filters for connections which can be assigned to the latest version of the specified deployment type.assigned_deployment_id- (Optional) The OCID of the deployment which for the connection must be assigned.compartment_id- (Required) The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used.connection_type- (Optional) The array of connection types.connection_type_not_equal_to- (Optional) The array of connection types to exclude.display_name- (Optional) A filter to return only the resources that match the entire ‘displayName’ given.state- (Optional) A filter to return only connections having the ‘lifecycleState’ given.technology_type- (Optional) The array of technology types.
Attributes Reference
The following attributes are exported:
connection_collection- The list of connection_collection.
Connection Reference
The following attributes are exported:
access_key_id- AMAZON_KINESIS: Access key ID used to access Amazon Kinesis.
- AMAZON_S3: Access key ID used to access the Amazon S3 bucket.
Note: Despite the “Id” suffix, this value is not an Oracle Cloud Infrastructure OCID.
account_key_secret_id- The OCID of the Secret where the account key is stored. Note: When provided, ‘accountKey’ field must not be provided.account_name- Sets the Azure storage account name.additional_attributes- An array of name-value pair attribute entries. Used as additional parameters in connection string.name- The name of the property entry.value- The value of the property entry.
artifact_location- Location used to share engine application artifacts.DATABRICKS_ENGINE: Location used to share Databricks application artifacts.
SPARK: Location used to share Spark application artifacts with a remote cluster.
account_key_secret_id- The OCID of the Secret that stores the storage account access key. Note: When provided, ‘accountKey’ field must not be provided.configuration- Oracle Cloud Infrastructure Object Storage configuration for the artifact location.access_key_id- Access key identifier used for Oracle Cloud Infrastructure Object Storage secret-key authentication. Note: Despite the “Id” suffix, this value is not an Oracle Cloud Infrastructure OCID.authentication_type- Authentication method used to access Oracle Cloud Infrastructure Object Storage.bucket- Oracle Cloud Infrastructure Object Storage bucket containing application artifacts.namespace- The Oracle Cloud Infrastructure Object Storage namespace containing the bucket. Example: “mynamespace”par_url_secret_id- The OCID of the Secret that stores the pre-authenticated request (PAR) URL. Note: When provided,parUrlmust not be provided.path- Object path used for application artifacts.private_key_file_secret_id- The OCID of the Secret that stores the content of the private key file (PEM file) corresponding to the API key of the fingerprint. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm Note: When provided, ‘privateKeyFile’ field must not be provided.private_key_passphrase_secret_id- The OCID of the Secret that stores the passphrase of the private key. Note: When provided, ‘privateKeyPassphrase’ field must not be provided.public_key_fingerprint- 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.htmregion- The name of the region. e.g.: us-ashburn-1 If the region is not provided, backend will default to the default region.secret_access_key_secret_id- The OCID of the Secret that stores the secret access key. Note: When provided,secretAccessKeymust not be provided.tenancy_id- The OCID of the related Oracle Cloud Infrastructure tenancy.user_id- The OCID of the Oracle Cloud Infrastructure user whose API key is used to access the artifact location. If not provided it will default to the current user.
endpoint_suffix- Endpoint suffix. Defaults to dfs.core.windows.net.filesystem- Azure Data Lake Storage Gen2 filesystem containing the application artifacts. Example: “ggs-artifacts”location_type- The type of location used to share Databricks application artifacts.path- AZURE_DATE_LAKE_STORAGE: Artifact path within the Azure Data Lake Storage filesystem.
- UC_VOLUME: Unity Catalog volume artifact path.
should_overwrite_existing- Controls whether a staged Spark application artifact replaces an existing file or object with the same name at the configured destination. The artifact is typically a GGFAB pipeline package or one of its dependency files.When set to
true, the existing file or object is replaced with the newly staged version. When set tofalse, staging fails or skips the upload rather than replacing it. This setting does not replace the entire target directory or prefix. It allows an updated pipeline or dependency to be deployed when artifact names remain the same across versions.storage_account- Azure Data Lake Storage Gen2 storage-account name.
auth_details- Authentication details for an AI Model or AI Provider connection.api_key- API key for the AI model connection. Deprecated: This field is deprecated and replaced by “apiKeySecretId”. This change follows the GoldenGate “Plain Text Fields in Connections” deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGateapi_key_secret_id- API key secret OCID for the AI model connection.auth_type- Authentication type used by the AI model connection.base_url- Base URL of the AI model endpoint. If not specified, the default base URL for the selected AI provider will be used.key_fingerprint- Oracle Cloud Infrastructure Generative AI key fingerprint.region- The name of the region. e.g.: us-ashburn-1 If the region is not provided, backend will default to the default region.tenancy_id- Oracle Cloud Infrastructure Generative AI tenancy OCID. If this value is not provided, or is updated to an empty value, it defaults to the tenancy OCID of the user who is executing the operation.user_id- Oracle Cloud Infrastructure Generative AI user OCID. If this value is not provided, or is updated to an empty value, it defaults to the OCID of the user who is executing the operation.
auth_secret_secret_id- The OCID of the Secret that stores the Spark authentication shared secret. Applicable when authenticationType is SHARED_SECRET. Note: When provided, ‘authSecret’ field must not be provided.auth_token_secret_id- The OCID of the Secret where the personal access token is stored. Only applicable for authenticationType == PERSONAL_ACCESS_TOKEN. Note: When provided, ‘authToken’ field must not be provided.authentication_mode- 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- Authentication mechanism; supported values depend onconnection_type.- DATABRICKS: Use PERSONAL_ACCESS_TOKEN or OAUTH_M2M.
- DATABRICKS_ENGINE: Use PERSONAL_ACCESS_TOKEN or OAUTH_M2M for the Databricks Engine REST API.
- JAVA_MESSAGE_SERVICE: Authentication type for Java Message Service. The default is NONE.
- SPARK: Use SHARED_SECRET only when the target cluster has
spark.authenticate=true. AES_RPC and SASL_ENCRYPTED require SHARED_SECRET. - AZURE_DATA_LAKE_STORAGE, ELASTICSEARCH, KAFKA_SCHEMA_REGISTRY, REDIS, SNOWFLAKE: Authentication type supported by the target service.
azure_authority_host- The endpoint used for authentication with Microsoft Entra ID (formerly Azure Active Directory). Default value: https://login.microsoftonline.com When connecting to a non-public Azure Cloud, the endpoint must be provided, eg:- Azure China: https://login.chinacloudapi.cn/
- Azure US Government: https://login.microsoftonline.us/
azure_tenant_id- Azure tenant ID of the application. This property is required when ‘authenticationType’ is set to ‘AZURE_ACTIVE_DIRECTORY’. e.g.: 14593954-d337-4a61-a364-9f758c64f97fbootstrap_servers- 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"host- The name or address of a host.port- The port of an endpoint usually specified for a connection.private_ip- This property is not available when creating connections. For existing deprecated connections having this value set, the value cannot be updated; set it to empty.For deprecated connections created with this field in the past, either the private IP had to be specified in the connectionString or host field, or the host name had to be resolvable in the target VCN.
catalog- Represents the catalog of given type used in an Iceberg connection.branch- The active branch of the Nessie catalog from which Iceberg reads and writes table metadata.catalog_type- The catalog type.client_id- The OAuth client ID used for authentication.client_secret_secret_id- The OCID of the Secret that stores the password Oracle GoldenGate uses to connect to Polaris.glue_id- The AWS Glue Catalog ID where Iceberg tables are registered.name- The catalog name within Polaris where Iceberg tables are registered.principal_role- The Snowflake role used to access Polaris.properties_secret_id- 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.htmuri- The URL endpoint for the Polaris API. e.g.: ‘https://.snowflakecomputing.com/polaris/api/catalog’
client_id- AZURE_DATA_LAKE_STORAGE: Azure application client ID, required for AZURE_ACTIVE_DIRECTORY authentication.
- DATABRICKS, DATABRICKS_ENGINE: OAuth client ID, applicable to OAUTH_M2M authentication.
- MICROSOFT_FABRIC: Azure application client ID.
client_secret_secret_id- Secret OCID containing the client secret. For DATABRICKS and DATABRICKS_ENGINE it applies to OAUTH_M2M authentication. When provided,client_secretmust not be provided.cluster_endpoint- Spark master URL used for job submission. Required for both submitMode SUBMIT and REST. e.g.: ‘spark://spark-master.example.com:7077’ High availability can be configured with a comma-separated list, for example: ‘spark://h1.example.com:7077,h2.example.com:7077’cluster_id- The OCID of the Kafka cluster being referenced from Oracle Cloud Infrastructure Streaming with Apache Kafka.cluster_placement_group_id- The OCID(https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cluster placement group for the resource. Only applicable for multicloud subscriptions. The cluster placement group id must be provided when a multicloud subscription id is provided. Otherwise the cluster placement group must not be provided.compartment_id- The OCID of the compartment being referenced.connection_factory- The of Java class implementing javax.jms.ConnectionFactory interface supplied by the Java Message Service provider. e.g.: ‘com.stc.jmsjca.core.JConnectionFactoryXA’connection_string- JDBC connection string. e.g.: ‘jdbc:sqlserver://.sql.azuresynapse.net:1433;database= ;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;’ connection_type- The connection type.connection_url- AMAZON_REDSHIFT: JDBC connection URL. e.g.:
jdbc:redshift://aws-redshift-instance.aaaaaaaaaaaa.us-east-2.redshift.amazonaws.com:5439/mydb - DATABRICKS: JDBC connection URL. e.g.:
jdbc:databricks://adb-33934.4.azuredatabricks.net:443/default;transportMode=http;ssl=1;httpPath=sql/protocolv1/o/3393########44/0##3-7-hlrb - JAVA_MESSAGE_SERVICE: Connection URL specifying the protocol, host, and port. e.g.:
mq://myjms.host.domain:7676 - ORACLE_AI_DATA_PLATFORM: Connection URL beginning with
jdbc:spark://. - SNOWFLAKE: JDBC connection URL. e.g.:
jdbc:snowflake://<account_name>.snowflakecomputing.com/?warehouse=<warehouse-name>&db=<db-name>
- AMAZON_REDSHIFT: JDBC connection URL. e.g.:
consumer_properties- The base64 encoded content of the consumer.properties file.core_site_xml- The base64 encoded content of the Hadoop Distributed File System configuration file (core-site.xml). It is not included in GET responses if theview=COMPACTquery parameter is specified.database_id- The OCID of the Oracle Autonomous Json Database.database_name- The name of the database.db_system_id- The OCID of the database system being referenced.defined_tags- Tags defined for this resource. Each key is predefined and scoped to a namespace. Example:{"foo-namespace.bar-key": "value"}deployment_id- The OCID of the deployment being referenced.description- Metadata about this specific object.display_name- An object’s Display Name.does_use_secret_ids- Indicates that sensitive attributes are provided via Secrets.
Deprecated: This field is deprecated. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example, passwordSecretId) instead of plain-text attributes. This change follows the GoldenGate “Plain Text Fields in Connections” deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
When set to true, all sensitive information must be provided as Oracle Cloud Infrastructure Vault secrets using the corresponding *SecretId attributes of the connection (for example, passwordSecretId). Plain-text sensitive attributes (for example, password) must not be used. This ensures that sensitive information remains stored and managed in the customer’s Oracle Cloud Infrastructure Vault rather than by the GoldenGate service.
When set to false, sensitive information must be provided in the corresponding plain-text attributes (for example, password) rather than in secret OCID attributes. In this mode, the sensitive information is stored by the GoldenGate service. If vaultId and keyId are not specified, the GoldenGate service uses Oracle-managed encryption keys to encrypt the stored data.
If vaultId and keyId are provided, the specified customer-managed key is used.
* endpoint
* AMAZON_KINESIS: The endpoint URL of the Amazon Kinesis service. e.g.: ‘https://kinesis.us-east-1.amazonaws.com’ If not provided, GoldenGate will default to ‘https://kinesis.fingerprint - Fingerprint required by TLS security protocol. E.g.: ‘6152b2dfbff200f973c5074a5b91d06ab3b472c07c09a1ea57bb7fd406cdce9c’
* freeform_tags - 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 - 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 - The OCID of the connection being referenced.
* ingress_ips - 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.
* ingress_ip - A Private Endpoint IPv4 or IPv6 Address created in the customer’s subnet.
* jndi_connection_factory - The Connection Factory can be looked up using this name. e.g.: ‘ConnectionFactory’
* jndi_initial_context_factory - 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 - 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_secret_id - 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 - Specifies the identity of the principal (user) to be authenticated. e.g.: ‘admin2’
* key_id - References the Oracle Cloud Infrastructure Vault key in the Oracle Cloud Infrastructure Vault identified by vaultId.
Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example, `passwordSecretId`) instead of plain-text attributes encrypted with `vaultId` and `keyId`. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
The GoldenGate service uses this key to encrypt sensitive information (for example, `password`) that is provided in plain-text connection attributes through the API. This field is applicable only when `doesUseSecretIds` is set to `false`. If both `vaultId` and `keyId` are provided, the GoldenGate service uses the specified customer-managed key to encrypt the sensitive data. If neither `vaultId` nor `keyId` is provided, the GoldenGate service uses Oracle-managed encryption keys.
key_store_password_secret_id- Secret OCID containing the key store password.- SPARK: Applicable when
security_protocolis TLS and a client key store is provided. Required whenkey_store_secret_idis provided. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY, REDIS: Password for the target connection’s key store.
When provided,
key_store_passwordmust not be provided.- SPARK: Applicable when
key_store_secret_id- Secret OCID containing the key store content.- SPARK: Applicable when
security_protocolis TLS. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY, REDIS: Key store file used by the target connection.
When provided,
key_storemust not be provided.- SPARK: Applicable when
key_store_type- Client key store format used for mutual TLS.lifecycle_details- 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- Locks associated with this resource.message- 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- The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.time_created- When the lock was created.type- Type of the lock.
max_input_chars- Maximum number of input characters supported by this AI model connection.model_key- AI model identifier.nsg_ids- An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.password_secret_id- 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- The port of an endpoint usually specified for a connection.private_ip- This property is not available when creating connections. For existing deprecated connections having this value set, the value cannot be updated; set it to empty.For deprecated connections created with this field in the past, either the private IP had to be specified in the connectionString or host field, or the host name had to be resolvable in the target VCN.
private_key_file_secret_id- The OCID of the Secret that stores the content of the private key file (PEM file) corresponding to the API key of the fingerprint. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm Note: When provided, ‘privateKeyFile’ field must not be provided.private_key_passphrase_secret_id- 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- The base64 encoded content of the producer.properties file.provider_id- Optional identifier of the AI Provider Connection backing this AI Model Connection. When provided, it must reference an existing Active connection of typeAI_PROVIDER. WhenproviderIdis set,providerTypeandauthDetailsmust not be provided on the AI Model Connection, because provider metadata is resolved from the referenced AI Provider Connection. WhenproviderIdis not set, the AI Model Connection must provide inline provider metadata usingproviderTypeandauthDetails.provider_type- AI Provider type used by the AI Model Connection.public_key_fingerprint- 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.htmredis_cluster_id- The OCID of the Redis cluster.region- The name of the AWS region where the bucket is created. If not provided, GoldenGate will default to ‘us-west-2’. Note: this property will become mandatory after May 20, 2026.rest_auth_secret_key_secret_id- The OCID of the Secret that stores the REST submission signing key. Applicable only when submitMode is REST and the cluster enforces REST request signing. This setting is independent of authenticationType. Note: When provided, ‘restAuthSecretKey’ field must not be provided.rest_endpoint- Spark standalone REST submission base URL. e.g.: ‘https://spark-master.example.com:6066’ Applicable only and required when submitMode is REST.routing_method- Controls the network traffic direction to the target: SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment’s private endpoint through the deployment’s subnet. DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected. SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service’s network to public hosts. Cannot be used for private targets.Deprecated: SHARED_SERVICE_ENDPOINT is deprecated. Use another supported routingMethod value, or update existing connections to use a supported routing method. This change follows the GoldenGate “Plain Text Fields in Connections” deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
rpc_cipher- Cipher transform used for Spark RPC encryption. Applicable when securityProtocol is AES_RPC.sas_token_secret_id- The OCID of the Secret where the sas token is stored. Note: When provided, ‘sasToken’ field must not be provided.secret_access_key_secret_id- The OCID of the Secret where the secret access key is stored. Note: When provided, ‘secretAccessKey’ field must not be provided.security_attributes- Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}security_protocol- Security protocol; supported values depend onconnection_type.- SPARK: PLAINTEXT, TLS, AES_RPC, or SASL_ENCRYPTED. AES_RPC and SASL_ENCRYPTED require SHARED_SECRET authentication.
- Other connection types: Use the protocol supported by the target service.
servers- Comma separated list of Elasticsearch server addresses, specified as host:port entries, where :port is optional. If port is not specified, it defaults to 9200. Used for establishing the initial connection to the Elasticsearch cluster. Example:"server1.example.com:4000,server2.example.com:4000"service_account_key_file_secret_id- The OCID of the Secret where the content of the service account key file is stored, which contains the credentials required to use Google Cloud Storage. Note: When provided, ‘serviceAccountKeyFile’ field must not be provided.session_mode- Specifies the session mode for the database connection. Use REDIRECT only for RAC databases with SCAN listeners that return IP addresses. For RAC databases with SCAN listeners that return FQDNs, and for all other Oracle database technologies, use DIRECT. In RAC deployments, SCAN listeners redirects a connection to a specific database node, identified by either IP address or FQDN. It is recommended to configure RAC with FQDN-based SCAN listeners.The default is DIRECT, except when databaseId is provided and the discovered database relies on the SCAN listener. In this case, the default is REDIRECT.
Deprecated: Defaulting to the REDIRECT session mode will be removed after April 21, 2027.
should_use_jndi- If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.should_use_resource_principal- KAFKA: Specifies resource-principal authentication for Oracle Cloud Infrastructure Streaming connections. Available from GoldenGate 23.9.0.0.0. When set,
username,password, andpassword_secret_idmust not be provided. Default: false. - OCI_OBJECT_STORAGE, ORACLE_AI_DATA_PLATFORM, ORACLE_NOSQL: Specifies resource-principal authentication. Default: false.
- KAFKA: Specifies resource-principal authentication for Oracle Cloud Infrastructure Streaming connections. Available from GoldenGate 23.9.0.0.0. When set,
should_validate_server_certificate- If set to true, the driver validates the certificate that is sent by the database server.ssl_ca- The base64 encoded certificate of the trusted certificate authorities (Trusted CA) for PostgreSQL. The supported file formats are .pem and .crt. It is not included in GET responses if theview=COMPACTquery parameter is specified.ssl_cert- 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 theview=COMPACTquery parameter is specified.ssl_client_keystash_secret_id- The OCID of the Secret where the keystash file is stored, which contains the encrypted password to the key database file. This property is not supported for IBM Db2 for i, as client TLS mode is not available.Note: When provided, ‘sslClientKeystash’ field must not be provided.
ssl_client_keystoredb_secret_id- The OCID of the Secret where the keystore file stored, which created at the client containing the server certificate / CA root certificate. This property is not supported for IBM Db2 for i, as client TLS mode is not available.Note: When provided, ‘sslClientKeystoredb’ field must not be provided.
ssl_crl- 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 theview=COMPACTquery parameter is specified.ssl_key_password_secret_id- Secret OCID containing the certificate private-key password inside the client key store.- SPARK: Applicable when
security_protocolis TLS and a client key store is provided. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY: Provide it when the private-key password differs from the key store password.
When provided,
ssl_key_passwordmust not be provided.- SPARK: Applicable when
ssl_key_secret_id- 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- SSL mode for PostgreSQL.ssl_server_certificate- The base64 encoded file which contains the self-signed server certificate / Certificate Authority (CA) certificate. It is not included in GET responses if theview=COMPACTquery parameter is specified.state- Possible lifecycle states for connection.storage- Represents the storage of given type used in an Iceberg connection.access_key_id- Access Key ID from the Oracle Cloud Infrastructure IAM user’s Customer Secret Key pair used to authenticate to Oracle Cloud Infrastructure Object Storage via the S3 Compatibility API.Note: Despite the “Id” suffix, this value is not an Oracle Cloud Infrastructure OCID.
account_key_secret_id- The OCID of the Secret where the account key is stored.account_name- Sets the Azure storage account name.bucket- Target Oracle Cloud Infrastructure Object Storage bucket name where Iceberg stores table metadata and data files.container- The Azure Blob Storage container where Iceberg tables are stored.endpoint- Oracle Cloud Infrastructure Object Storage S3 Compatibility API endpoint URL. Format: “https://.compat.objectstorage. . ” Example: “https://mynamespace.compat.objectstorage.us-ashburn-1.oraclecloud.com” project_id- The Google Cloud Project where the bucket exists.region- The AMAZON region where the S3 bucket is hosted. e.g.: ‘us-east-2’scheme_type- The scheme of the storage.secret_access_key_secret_id- The OCID of the Secret where the Secret Access Key used for Oracle Cloud Infrastructure Object Storage S3 Compatibility authentication.service_account_key_file_secret_id- 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- The storage type used in the Iceberg connection. Supported storage types by catalog type:- GLUE: AMAZON_S3.
- HADOOP: AMAZON_S3, GOOGLE_CLOUD_STORAGE, AZURE_DATA_LAKE_STORAGE, or OCI_OBJECT_STORAGE_S3_API.
- NESSIE: AMAZON_S3, GOOGLE_CLOUD_STORAGE, or AZURE_DATA_LAKE_STORAGE.
- POLARIS: AMAZON_S3, GOOGLE_CLOUD_STORAGE, or AZURE_DATA_LAKE_STORAGE.
- REST: AMAZON_S3, GOOGLE_CLOUD_STORAGE, AZURE_DATA_LAKE_STORAGE, or NONE.
storage_credential_name- Optional. External storage credential name to access files on object storage such as ADLS Gen2, S3 or GCS.stream_pool_id- The OCID of the stream pool being referenced.submit_mode- Submission channel used to connect to Spark.subnet_id- The OCID of the target subnet of the dedicated connection.subscription_id- The OCID of the subscription with which resource needs to be associated with.system_tags- The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example:{orcl-cloud: {free-tier-retain: true}}technology_type- Technology type selected for the connection.- AI_MODEL: AI Model technology type.
- AI_PROVIDER: AI Provider technology type.
- DATABRICKS_ENGINE: Databricks Engine technology type.
- ICEBERG: Iceberg technology type. APACHE_ICEBERG supports all catalog types; AMAZON_S3_TABLES supports only REST catalog and S3 storage.
- KAFKA_SCHEMA_REGISTRY: Kafka Schema Registry technology type.
- ORACLE_AI_DATA_PLATFORM_ENGINE: Oracle AI Data Platform Engine technology type.
- SPARK: Spark technology type.
tenancy_id- The OCID of the related Oracle Cloud Infrastructure tenancy.tenant_id- Azure tenant ID of the application. e.g.: 14593954-d337-4a61-a364-9f758c64f97ftime_created- The time the resource was created. The format is defined by RFC3339, such as2016-08-25T21:10:29.600Z.time_updated- The time the resource was last updated. The format is defined by RFC3339, such as2016-08-25T21:10:29.600Z.tls_ca_file- 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 theview=COMPACTquery parameter is specified.tls_certificate_key_file_password_secret_id- 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- The OCID of the Secret that stores the certificate key file of the mtls connection.- The content of a .pem file containing the client private key (for 2-way SSL). Note: When provided, ‘tlsCertificateKeyFile’ field must not be provided.
tls_protocol- TLS protocol negotiated by the Spark client.trust_store_password_secret_id- Secret OCID containing the trust store password.- SPARK: Applicable when
security_protocolis TLS and a trust store is provided. Required whentrust_store_secret_idis provided. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY, REDIS: Password for the target connection’s trust store.
When provided,
trust_store_passwordmust not be provided.- SPARK: Applicable when
trust_store_secret_id- Secret OCID containing the trust store content.- SPARK: Applicable when
security_protocolis TLS. Provide it when the server certificate is not already trusted by the JVM. - JAVA_MESSAGE_SERVICE, KAFKA, KAFKA_SCHEMA_REGISTRY, REDIS: Trust store file used by the target connection.
When provided,
trust_storemust not be provided.- SPARK: Applicable when
trust_store_type- Trust store format used by the Spark client.url- Kafka Schema Registry URL. e.g.: ‘https://server1.us.oracle.com:8081’user_id- OCI_OBJECT_STORAGE, ORACLE_AI_DATA_PLATFORM: The OCID of the Oracle Cloud Infrastructure user who accesses Object Storage. The user must have write access to the bucket. If omitted, the service defaults to the user calling the API.
- ORACLE_NOSQL: The OCID of the Oracle Cloud Infrastructure user who accesses the Oracle NoSQL database. The user must have write access to the table. If omitted, the service defaults to the user calling the API.
username- The username Oracle GoldenGate uses to connect the associated system of the given technology. This username must already exist and be available by the system/application to be connected to and must conform to the case sensitivty requirments defined in it.vault_id- References the Oracle Cloud Infrastructure Vault that contains the customer-managed encryption key identified bykeyId.Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example,
passwordSecretId) instead of plain-text attributes encrypted withvaultIdandkeyId. This change follows the GoldenGate “Plain Text Fields in Connections” deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGateThis field is applicable only when
doesUseSecretIdsis set tofalse. IfvaultIdis provided,keyIdmust also be provided.wallet_secret_id- The OCID of the Secret where the wallet file is stored. The wallet contents Oracle GoldenGate uses to make connections to a database. Note: When provided, ‘wallet’ field must not be provided.workspace_url- DATABRICKS_ENGINE: Databricks workspace base URL for the REST API, for example
https://<workspace>.cloud.databricks.com/api/2.0/. - ORACLE_AI_DATA_PLATFORM_ENGINE: Oracle AI Data Platform workspace URL.
- DATABRICKS_ENGINE: Databricks workspace base URL for the REST API, for example