oracle.oci.oci_golden_gate_connection – Manage a Connection resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.11.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_golden_gate_connection.

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create, update and delete a Connection resource in Oracle Cloud Infrastructure

  • For state=present, creates a new Connection.

  • This resource has the following action operations in the oracle.oci.oci_golden_gate_connection_actions module: change_compartment.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
account_key
string
Azure storage account key. This property is required when 'authenticationType' is set to 'SHARED_KEY'. e.g.: pa3WbhVATzj56xD4DH1VjOUhApRGEGHvOo58eQJVWIzX+j8j4CUVFcTjpIqDSRaSa1Wo2LbWY5at+AStEgLOIQ==
This parameter is updatable.
Applicable when connection_type is 'AZURE_DATA_LAKE_STORAGE'
account_name
string
Sets the Azure storage account name.
This parameter is updatable.
Applicable when connection_type is 'AZURE_DATA_LAKE_STORAGE'
Required when connection_type is 'AZURE_DATA_LAKE_STORAGE'
additional_attributes
list / elements=dictionary
An array of name-value pair attribute entries. Used as additional parameters in connection string.
This parameter is updatable.
Applicable when connection_type is one of ['MYSQL', 'POSTGRESQL']
name
string / required
The name of the property entry.
Required when connection_type is 'POSTGRESQL'
value
string / required
The value of the property entry.
Required when connection_type is 'POSTGRESQL'
api_user
string
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See config_file_location). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint
string
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See config_file_location). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file
string
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See config_file_location). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided.
api_user_key_pass_phrase
string
Passphrase used by the key referenced in api_user_key_file, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location).
auth_purpose
string
    Choices:
  • service_principal
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
The type of authentication to use for making API requests. By default auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
authentication_type
string
Used authentication mechanism to access Schema Registry.
This parameter is updatable.
Applicable when connection_type is one of ['AZURE_DATA_LAKE_STORAGE', 'KAFKA_SCHEMA_REGISTRY']
Required when connection_type is one of ['AZURE_DATA_LAKE_STORAGE', 'KAFKA_SCHEMA_REGISTRY']
azure_tenant_id
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
This parameter is updatable.
Applicable when connection_type is 'AZURE_DATA_LAKE_STORAGE'
bootstrap_servers
list / elements=dictionary
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"`
This parameter is updatable.
Applicable when connection_type is 'KAFKA'
host
string / required
The name or address of a host.
Required when connection_type is 'KAFKA'
port
integer
The port of an endpoint usually specified for a connection.
Applicable when connection_type is 'KAFKA'
private_ip
string
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.
Applicable when connection_type is 'KAFKA'
cert_bundle
string
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
client_id
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
This parameter is updatable.
Applicable when connection_type is 'AZURE_DATA_LAKE_STORAGE'
client_secret
string
Azure client secret (aka application password) for authentication. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: dO29Q~F5-VwnA.lZdd11xFF_t5NAXCaGwDl9NbT1
This parameter is updatable.
Applicable when connection_type is 'AZURE_DATA_LAKE_STORAGE'
compartment_id
string
The OCID of the compartment being referenced.
Required for create using state=present.
Required for update when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
Required for delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
config_file_location
string
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name
string
The profile to load from the config file referenced by config_file_location. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location.
connection_id
string
The OCID of a Connection.
Required for update using state=present when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.
Required for delete using state=absent when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: id
connection_string
string
JDBC connection string. e.g.: 'jdbc:sqlserver://<synapse-workspace>.sql.azuresynapse.net:1433;database=<db- name>;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'
This parameter is updatable.
Applicable when connection_type is one of ['AZURE_SYNAPSE_ANALYTICS', 'ORACLE']
Required when connection_type is 'AZURE_SYNAPSE_ANALYTICS'
connection_type
string
    Choices:
  • POSTGRESQL
  • KAFKA_SCHEMA_REGISTRY
  • AZURE_SYNAPSE_ANALYTICS
  • AZURE_DATA_LAKE_STORAGE
  • MYSQL
  • OCI_OBJECT_STORAGE
  • KAFKA
  • ORACLE
  • GOLDENGATE
The connection type.
Required for create using state=present, update using state=present with connection_id present.
Applicable when connection_type is one of ['AZURE_DATA_LAKE_STORAGE', 'MYSQL', 'OCI_OBJECT_STORAGE', 'KAFKA', 'GOLDENGATE', 'KAFKA_SCHEMA_REGISTRY', 'AZURE_SYNAPSE_ANALYTICS', 'POSTGRESQL', 'ORACLE']
consumer_properties
string
The base64 encoded content of the consumer.properties file.
This parameter is updatable.
Applicable when connection_type is 'KAFKA'
database_id
string
The OCID of the database being referenced.
This parameter is updatable.
Applicable when connection_type is 'ORACLE'
database_name
string
The name of the database.
This parameter is updatable.
Applicable when connection_type is one of ['MYSQL', 'POSTGRESQL']
Required when connection_type is one of ['MYSQL', 'POSTGRESQL']
db_system_id
string
The OCID of the database system being referenced.
This parameter is updatable.
Applicable when connection_type is 'MYSQL'
defined_tags
dictionary
Tags defined for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
This parameter is updatable.
deployment_id
string
The OCID of the deployment being referenced.
This parameter is updatable.
Applicable when connection_type is 'GOLDENGATE'
description
string
Metadata about this specific object.
This parameter is updatable.
display_name
string
An object's Display Name.
Required for create using state=present.
Required for update, delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
This parameter is updatable when OCI_USE_NAME_AS_IDENTIFIER is not set.
Applicable when connection_type is one of ['AZURE_DATA_LAKE_STORAGE', 'MYSQL', 'OCI_OBJECT_STORAGE', 'KAFKA', 'GOLDENGATE', 'KAFKA_SCHEMA_REGISTRY', 'AZURE_SYNAPSE_ANALYTICS', 'POSTGRESQL', 'ORACLE']

aliases: name
endpoint
string
Azure Storage service endpoint. e.g: https://test.blob.core.windows.net
This parameter is updatable.
Applicable when connection_type is 'AZURE_DATA_LAKE_STORAGE'
force_create
boolean
    Choices:
  • no ←
  • yes
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
freeform_tags
dictionary
A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
This parameter is updatable.
host
string
The name or address of a host.
This parameter is updatable.
Applicable when connection_type is one of ['MYSQL', 'GOLDENGATE', 'POSTGRESQL']
Required when connection_type is 'POSTGRESQL'
key_by
list / elements=string
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
key_id
string
The OCID of the customer "Master" key being referenced. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this key to manage secrets.
This parameter is updatable.
key_store
string
The base64 encoded content of the KeyStore file.
This parameter is updatable.
Applicable when connection_type is one of ['KAFKA', 'KAFKA_SCHEMA_REGISTRY']
key_store_password
string
The KeyStore password.
This parameter is updatable.
Applicable when connection_type is one of ['KAFKA', 'KAFKA_SCHEMA_REGISTRY']
nsg_ids
list / elements=string
An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
This parameter is updatable.
password
string
The password Oracle GoldenGate uses to connect the associated RDBMS. It must conform to the specific security requirements implemented by the database including length, case sensitivity, and so on.
This parameter is updatable.
Applicable when connection_type is one of ['MYSQL', 'KAFKA', 'KAFKA_SCHEMA_REGISTRY', 'AZURE_SYNAPSE_ANALYTICS', 'POSTGRESQL', 'ORACLE']
Required when connection_type is one of ['MYSQL', 'AZURE_SYNAPSE_ANALYTICS', 'POSTGRESQL', 'ORACLE']
port
integer
The port of an endpoint usually specified for a connection.
This parameter is updatable.
Applicable when connection_type is one of ['MYSQL', 'GOLDENGATE', 'POSTGRESQL']
Required when connection_type is 'POSTGRESQL'
private_ip
string
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.
This parameter is updatable.
Applicable when connection_type is one of ['MYSQL', 'GOLDENGATE', 'KAFKA_SCHEMA_REGISTRY', 'POSTGRESQL', 'ORACLE']
private_key_file
string
The base64 encoded content of the private key file (PEM file) corresponding to the API key of the fingerprint. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm
This parameter is updatable.
Applicable when connection_type is 'OCI_OBJECT_STORAGE'
Required when connection_type is 'OCI_OBJECT_STORAGE'
private_key_passphrase
string
The passphrase of the private key.
This parameter is updatable.
Applicable when connection_type is 'OCI_OBJECT_STORAGE'
producer_properties
string
The base64 encoded content of the producer.properties file.
This parameter is updatable.
Applicable when connection_type is 'KAFKA'
public_key_fingerprint
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
This parameter is updatable.
Applicable when connection_type is 'OCI_OBJECT_STORAGE'
Required when connection_type is 'OCI_OBJECT_STORAGE'
region
string
The name of the region. e.g.: us-ashburn-1
This parameter is updatable.
Applicable when connection_type is 'OCI_OBJECT_STORAGE'
sas_token
string
Credential that uses a shared access signature (SAS) to authenticate to an Azure Service. This property is required when 'authenticationType' is set to 'SHARED_ACCESS_SIGNATURE'. e.g.: ?sv=2020-06-08&ss=bfqt&srt=sco&sp=rwdlacupyx&se=2020-09-10T20:27:28Z&st=2022-08-05T12:27:28Z&spr=https&sig=C1IgHsiLBmTSStYkXXGLTP8it0xBrArcg CqOsZbXwIQ%3D
This parameter is updatable.
Applicable when connection_type is 'AZURE_DATA_LAKE_STORAGE'
security_protocol
string
Security protocol for PostgreSQL.
This parameter is updatable.
Applicable when connection_type is one of ['MYSQL', 'KAFKA', 'POSTGRESQL']
Required when connection_type is one of ['MYSQL', 'POSTGRESQL']
session_mode
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.
This parameter is updatable.
Applicable when connection_type is 'ORACLE'
ssl_ca
string
The base64 encoded certificate of the trusted certificate authorities (Trusted CA) for PostgreSQL.
This parameter is updatable.
Applicable when connection_type is one of ['MYSQL', 'POSTGRESQL']
ssl_cert
string
The base64 encoded certificate of the PostgreSQL server.
This parameter is updatable.
Applicable when connection_type is one of ['MYSQL', 'POSTGRESQL']
ssl_crl
string
The base64 encoded list of certificates revoked by the trusted certificate authorities (Trusted CA) for PostgreSQL.
This parameter is updatable.
Applicable when connection_type is one of ['MYSQL', 'POSTGRESQL']
ssl_key
string
The base64 encoded private key of the PostgreSQL server.
This parameter is updatable.
Applicable when connection_type is one of ['MYSQL', 'POSTGRESQL']
ssl_key_password
string
The password for the cert inside the KeyStore. In case it differs from the KeyStore password, it should be provided.
This parameter is updatable.
Applicable when connection_type is one of ['KAFKA', 'KAFKA_SCHEMA_REGISTRY']
ssl_mode
string
SSL modes for PostgreSQL.
This parameter is updatable.
Applicable when connection_type is one of ['MYSQL', 'POSTGRESQL']
state
string
    Choices:
  • present ←
  • absent
The state of the Connection.
Use state=present to create or update a Connection.
Use state=absent to delete a Connection.
stream_pool_id
string
The OCID of the stream pool being referenced.
This parameter is updatable.
Applicable when connection_type is 'KAFKA'
subnet_id
string
The OCID of the subnet being referenced.
technology_type
string
The PostgreSQL technology type.
Required for create using state=present.
tenancy
string
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See config_file_location). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm
tenancy_id
string
The OCID of the related OCI tenancy.
This parameter is updatable.
Applicable when connection_type is 'OCI_OBJECT_STORAGE'
trust_store
string
The base64 encoded content of the TrustStore file.
This parameter is updatable.
Applicable when connection_type is one of ['KAFKA', 'KAFKA_SCHEMA_REGISTRY']
trust_store_password
string
The TrustStore password.
This parameter is updatable.
Applicable when connection_type is one of ['KAFKA', 'KAFKA_SCHEMA_REGISTRY']
url
string
Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'
This parameter is updatable.
Applicable when connection_type is 'KAFKA_SCHEMA_REGISTRY'
Required when connection_type is 'KAFKA_SCHEMA_REGISTRY'
user_id
string
The OCID of the OCI user who will access the Object Storage. The user must have write access to the bucket they want to connect to.
This parameter is updatable.
Applicable when connection_type is 'OCI_OBJECT_STORAGE'
username
string
The username Oracle GoldenGate uses to connect the associated RDBMS. This username must already exist and be available for use by the database. It must conform to the security requirements implemented by the database including length, case sensitivity, and so on.
This parameter is updatable.
Applicable when connection_type is one of ['MYSQL', 'KAFKA', 'KAFKA_SCHEMA_REGISTRY', 'AZURE_SYNAPSE_ANALYTICS', 'POSTGRESQL', 'ORACLE']
Required when connection_type is one of ['MYSQL', 'AZURE_SYNAPSE_ANALYTICS', 'POSTGRESQL', 'ORACLE']
vault_id
string
The OCID of the customer vault being referenced. If provided, this will reference a vault which the customer will be required to ensure the policies are established to permit the GoldenGate Service to manage secrets contained within this vault.
This parameter is updatable.
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.
wallet
string
The wallet contents Oracle GoldenGate uses to make connections to a database. This attribute is expected to be base64 encoded.
This parameter is updatable.
Applicable when connection_type is 'ORACLE'

Examples

- name: Create connection with connection_type = POSTGRESQL
  oci_golden_gate_connection:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    technology_type: technology_type_example
    connection_type: POSTGRESQL

    # optional
    subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
    database_name: database_name_example
    ssl_mode: ssl_mode_example
    ssl_ca: ssl_ca_example
    ssl_crl: ssl_crl_example
    ssl_cert: ssl_cert_example
    ssl_key: ssl_key_example
    additional_attributes:
    - # required
      name: name_example
      value: value_example
    security_protocol: security_protocol_example
    host: host_example
    port: 56
    private_ip: private_ip_example
    display_name: display_name_example
    description: description_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    vault_id: "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx"
    key_id: "ocid1.key.oc1..xxxxxxEXAMPLExxxxxx"
    nsg_ids: [ "nsg_ids_example" ]
    username: username_example
    password: example-password

- name: Create connection with connection_type = KAFKA_SCHEMA_REGISTRY
  oci_golden_gate_connection:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    technology_type: technology_type_example
    connection_type: KAFKA_SCHEMA_REGISTRY

    # optional
    subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
    url: url_example
    trust_store: trust_store_example
    trust_store_password: example-password
    key_store: key_store_example
    key_store_password: example-password
    ssl_key_password: example-password
    authentication_type: authentication_type_example
    private_ip: private_ip_example
    display_name: display_name_example
    description: description_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    vault_id: "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx"
    key_id: "ocid1.key.oc1..xxxxxxEXAMPLExxxxxx"
    nsg_ids: [ "nsg_ids_example" ]
    username: username_example
    password: example-password

- name: Create connection with connection_type = AZURE_SYNAPSE_ANALYTICS
  oci_golden_gate_connection:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    technology_type: technology_type_example
    connection_type: AZURE_SYNAPSE_ANALYTICS

    # optional
    subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    description: description_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    vault_id: "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx"
    key_id: "ocid1.key.oc1..xxxxxxEXAMPLExxxxxx"
    nsg_ids: [ "nsg_ids_example" ]
    connection_string: connection_string_example
    username: username_example
    password: example-password

- name: Create connection with connection_type = AZURE_DATA_LAKE_STORAGE
  oci_golden_gate_connection:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    technology_type: technology_type_example
    connection_type: AZURE_DATA_LAKE_STORAGE

    # optional
    subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
    authentication_type: authentication_type_example
    account_name: account_name_example
    account_key: account_key_example
    sas_token: sas_token_example
    azure_tenant_id: "ocid1.azuretenant.oc1..xxxxxxEXAMPLExxxxxx"
    client_id: "ocid1.client.oc1..xxxxxxEXAMPLExxxxxx"
    client_secret: client_secret_example
    endpoint: endpoint_example
    display_name: display_name_example
    description: description_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    vault_id: "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx"
    key_id: "ocid1.key.oc1..xxxxxxEXAMPLExxxxxx"
    nsg_ids: [ "nsg_ids_example" ]

- name: Create connection with connection_type = MYSQL
  oci_golden_gate_connection:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    technology_type: technology_type_example
    connection_type: MYSQL

    # optional
    subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
    database_name: database_name_example
    ssl_mode: ssl_mode_example
    ssl_ca: ssl_ca_example
    ssl_crl: ssl_crl_example
    ssl_cert: ssl_cert_example
    ssl_key: ssl_key_example
    additional_attributes:
    - # required
      name: name_example
      value: value_example
    db_system_id: "ocid1.dbsystem.oc1..xxxxxxEXAMPLExxxxxx"
    security_protocol: security_protocol_example
    host: host_example
    port: 56
    private_ip: private_ip_example
    display_name: display_name_example
    description: description_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    vault_id: "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx"
    key_id: "ocid1.key.oc1..xxxxxxEXAMPLExxxxxx"
    nsg_ids: [ "nsg_ids_example" ]
    username: username_example
    password: example-password

- name: Create connection with connection_type = OCI_OBJECT_STORAGE
  oci_golden_gate_connection:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    technology_type: technology_type_example
    connection_type: OCI_OBJECT_STORAGE

    # optional
    subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
    tenancy_id: "ocid1.tenancy.oc1..xxxxxxEXAMPLExxxxxx"
    region: us-phoenix-1
    user_id: "ocid1.user.oc1..xxxxxxEXAMPLExxxxxx"
    private_key_file: private_key_file_example
    private_key_passphrase: private_key_passphrase_example
    public_key_fingerprint: public_key_fingerprint_example
    display_name: display_name_example
    description: description_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    vault_id: "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx"
    key_id: "ocid1.key.oc1..xxxxxxEXAMPLExxxxxx"
    nsg_ids: [ "nsg_ids_example" ]

- name: Create connection with connection_type = KAFKA
  oci_golden_gate_connection:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    technology_type: technology_type_example
    connection_type: KAFKA

    # optional
    subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
    stream_pool_id: "ocid1.streampool.oc1..xxxxxxEXAMPLExxxxxx"
    bootstrap_servers:
    - # required
      host: host_example

      # optional
      port: 56
      private_ip: private_ip_example
    security_protocol: security_protocol_example
    trust_store: trust_store_example
    trust_store_password: example-password
    key_store: key_store_example
    key_store_password: example-password
    ssl_key_password: example-password
    consumer_properties: consumer_properties_example
    producer_properties: producer_properties_example
    display_name: display_name_example
    description: description_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    vault_id: "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx"
    key_id: "ocid1.key.oc1..xxxxxxEXAMPLExxxxxx"
    nsg_ids: [ "nsg_ids_example" ]
    username: username_example
    password: example-password

- name: Create connection with connection_type = ORACLE
  oci_golden_gate_connection:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    technology_type: technology_type_example
    connection_type: ORACLE

    # optional
    subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
    wallet: wallet_example
    session_mode: session_mode_example
    database_id: "ocid1.database.oc1..xxxxxxEXAMPLExxxxxx"
    private_ip: private_ip_example
    display_name: display_name_example
    description: description_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    vault_id: "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx"
    key_id: "ocid1.key.oc1..xxxxxxEXAMPLExxxxxx"
    nsg_ids: [ "nsg_ids_example" ]
    connection_string: connection_string_example
    username: username_example
    password: example-password

- name: Create connection with connection_type = GOLDENGATE
  oci_golden_gate_connection:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    technology_type: technology_type_example
    connection_type: GOLDENGATE

    # optional
    subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
    deployment_id: "ocid1.deployment.oc1..xxxxxxEXAMPLExxxxxx"
    host: host_example
    port: 56
    private_ip: private_ip_example
    display_name: display_name_example
    description: description_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    vault_id: "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx"
    key_id: "ocid1.key.oc1..xxxxxxEXAMPLExxxxxx"
    nsg_ids: [ "nsg_ids_example" ]

- name: Update connection with connection_type = POSTGRESQL
  oci_golden_gate_connection:
    # required
    connection_type: POSTGRESQL

    # optional
    database_name: database_name_example
    ssl_mode: ssl_mode_example
    ssl_ca: ssl_ca_example
    ssl_crl: ssl_crl_example
    ssl_cert: ssl_cert_example
    ssl_key: ssl_key_example
    additional_attributes:
    - # required
      name: name_example
      value: value_example
    security_protocol: security_protocol_example
    host: host_example
    port: 56
    private_ip: private_ip_example
    display_name: display_name_example
    description: description_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    vault_id: "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx"
    key_id: "ocid1.key.oc1..xxxxxxEXAMPLExxxxxx"
    nsg_ids: [ "nsg_ids_example" ]
    username: username_example
    password: example-password

- name: Update connection with connection_type = KAFKA_SCHEMA_REGISTRY
  oci_golden_gate_connection:
    # required
    connection_type: KAFKA_SCHEMA_REGISTRY

    # optional
    url: url_example
    trust_store: trust_store_example
    trust_store_password: example-password
    key_store: key_store_example
    key_store_password: example-password
    ssl_key_password: example-password
    authentication_type: authentication_type_example
    private_ip: private_ip_example
    display_name: display_name_example
    description: description_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    vault_id: "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx"
    key_id: "ocid1.key.oc1..xxxxxxEXAMPLExxxxxx"
    nsg_ids: [ "nsg_ids_example" ]
    username: username_example
    password: example-password

- name: Update connection with connection_type = AZURE_SYNAPSE_ANALYTICS
  oci_golden_gate_connection:
    # required
    connection_type: AZURE_SYNAPSE_ANALYTICS

    # optional
    display_name: display_name_example
    description: description_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    vault_id: "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx"
    key_id: "ocid1.key.oc1..xxxxxxEXAMPLExxxxxx"
    nsg_ids: [ "nsg_ids_example" ]
    connection_string: connection_string_example
    username: username_example
    password: example-password

- name: Update connection with connection_type = AZURE_DATA_LAKE_STORAGE
  oci_golden_gate_connection:
    # required
    connection_type: AZURE_DATA_LAKE_STORAGE

    # optional
    authentication_type: authentication_type_example
    account_name: account_name_example
    account_key: account_key_example
    sas_token: sas_token_example
    azure_tenant_id: "ocid1.azuretenant.oc1..xxxxxxEXAMPLExxxxxx"
    client_id: "ocid1.client.oc1..xxxxxxEXAMPLExxxxxx"
    client_secret: client_secret_example
    endpoint: endpoint_example
    display_name: display_name_example
    description: description_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    vault_id: "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx"
    key_id: "ocid1.key.oc1..xxxxxxEXAMPLExxxxxx"
    nsg_ids: [ "nsg_ids_example" ]

- name: Update connection with connection_type = MYSQL
  oci_golden_gate_connection:
    # required
    connection_type: MYSQL

    # optional
    database_name: database_name_example
    ssl_mode: ssl_mode_example
    ssl_ca: ssl_ca_example
    ssl_crl: ssl_crl_example
    ssl_cert: ssl_cert_example
    ssl_key: ssl_key_example
    additional_attributes:
    - # required
      name: name_example
      value: value_example
    db_system_id: "ocid1.dbsystem.oc1..xxxxxxEXAMPLExxxxxx"
    security_protocol: security_protocol_example
    host: host_example
    port: 56
    private_ip: private_ip_example
    display_name: display_name_example
    description: description_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    vault_id: "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx"
    key_id: "ocid1.key.oc1..xxxxxxEXAMPLExxxxxx"
    nsg_ids: [ "nsg_ids_example" ]
    username: username_example
    password: example-password

- name: Update connection with connection_type = OCI_OBJECT_STORAGE
  oci_golden_gate_connection:
    # required
    connection_type: OCI_OBJECT_STORAGE

    # optional
    tenancy_id: "ocid1.tenancy.oc1..xxxxxxEXAMPLExxxxxx"
    region: us-phoenix-1
    user_id: "ocid1.user.oc1..xxxxxxEXAMPLExxxxxx"
    private_key_file: private_key_file_example
    private_key_passphrase: private_key_passphrase_example
    public_key_fingerprint: public_key_fingerprint_example
    display_name: display_name_example
    description: description_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    vault_id: "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx"
    key_id: "ocid1.key.oc1..xxxxxxEXAMPLExxxxxx"
    nsg_ids: [ "nsg_ids_example" ]

- name: Update connection with connection_type = KAFKA
  oci_golden_gate_connection:
    # required
    connection_type: KAFKA

    # optional
    stream_pool_id: "ocid1.streampool.oc1..xxxxxxEXAMPLExxxxxx"
    bootstrap_servers:
    - # required
      host: host_example

      # optional
      port: 56
      private_ip: private_ip_example
    security_protocol: security_protocol_example
    trust_store: trust_store_example
    trust_store_password: example-password
    key_store: key_store_example
    key_store_password: example-password
    ssl_key_password: example-password
    consumer_properties: consumer_properties_example
    producer_properties: producer_properties_example
    display_name: display_name_example
    description: description_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    vault_id: "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx"
    key_id: "ocid1.key.oc1..xxxxxxEXAMPLExxxxxx"
    nsg_ids: [ "nsg_ids_example" ]
    username: username_example
    password: example-password

- name: Update connection with connection_type = ORACLE
  oci_golden_gate_connection:
    # required
    connection_type: ORACLE

    # optional
    wallet: wallet_example
    session_mode: session_mode_example
    database_id: "ocid1.database.oc1..xxxxxxEXAMPLExxxxxx"
    private_ip: private_ip_example
    display_name: display_name_example
    description: description_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    vault_id: "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx"
    key_id: "ocid1.key.oc1..xxxxxxEXAMPLExxxxxx"
    nsg_ids: [ "nsg_ids_example" ]
    connection_string: connection_string_example
    username: username_example
    password: example-password

- name: Update connection with connection_type = GOLDENGATE
  oci_golden_gate_connection:
    # required
    connection_type: GOLDENGATE

    # optional
    deployment_id: "ocid1.deployment.oc1..xxxxxxEXAMPLExxxxxx"
    host: host_example
    port: 56
    private_ip: private_ip_example
    display_name: display_name_example
    description: description_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    vault_id: "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx"
    key_id: "ocid1.key.oc1..xxxxxxEXAMPLExxxxxx"
    nsg_ids: [ "nsg_ids_example" ]

- name: Update connection using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with connection_type = POSTGRESQL
  oci_golden_gate_connection:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    connection_type: POSTGRESQL

    # optional
    database_name: database_name_example
    ssl_mode: ssl_mode_example
    ssl_ca: ssl_ca_example
    ssl_crl: ssl_crl_example
    ssl_cert: ssl_cert_example
    ssl_key: ssl_key_example
    additional_attributes:
    - # required
      name: name_example
      value: value_example
    security_protocol: security_protocol_example
    host: host_example
    port: 56
    private_ip: private_ip_example
    display_name: display_name_example
    description: description_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    vault_id: "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx"
    key_id: "ocid1.key.oc1..xxxxxxEXAMPLExxxxxx"
    nsg_ids: [ "nsg_ids_example" ]
    username: username_example
    password: example-password

- name: Update connection using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with connection_type = KAFKA_SCHEMA_REGISTRY
  oci_golden_gate_connection:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    connection_type: KAFKA_SCHEMA_REGISTRY

    # optional
    url: url_example
    trust_store: trust_store_example
    trust_store_password: example-password
    key_store: key_store_example
    key_store_password: example-password
    ssl_key_password: example-password
    authentication_type: authentication_type_example
    private_ip: private_ip_example
    display_name: display_name_example
    description: description_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    vault_id: "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx"
    key_id: "ocid1.key.oc1..xxxxxxEXAMPLExxxxxx"
    nsg_ids: [ "nsg_ids_example" ]
    username: username_example
    password: example-password

- name: Update connection using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with connection_type = AZURE_SYNAPSE_ANALYTICS
  oci_golden_gate_connection:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    connection_type: AZURE_SYNAPSE_ANALYTICS

    # optional
    display_name: display_name_example
    description: description_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    vault_id: "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx"
    key_id: "ocid1.key.oc1..xxxxxxEXAMPLExxxxxx"
    nsg_ids: [ "nsg_ids_example" ]
    connection_string: connection_string_example
    username: username_example
    password: example-password

- name: Update connection using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with connection_type = AZURE_DATA_LAKE_STORAGE
  oci_golden_gate_connection:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    connection_type: AZURE_DATA_LAKE_STORAGE

    # optional
    authentication_type: authentication_type_example
    account_name: account_name_example
    account_key: account_key_example
    sas_token: sas_token_example
    azure_tenant_id: "ocid1.azuretenant.oc1..xxxxxxEXAMPLExxxxxx"
    client_id: "ocid1.client.oc1..xxxxxxEXAMPLExxxxxx"
    client_secret: client_secret_example
    endpoint: endpoint_example
    display_name: display_name_example
    description: description_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    vault_id: "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx"
    key_id: "ocid1.key.oc1..xxxxxxEXAMPLExxxxxx"
    nsg_ids: [ "nsg_ids_example" ]

- name: Update connection using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with connection_type = MYSQL
  oci_golden_gate_connection:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    connection_type: MYSQL

    # optional
    database_name: database_name_example
    ssl_mode: ssl_mode_example
    ssl_ca: ssl_ca_example
    ssl_crl: ssl_crl_example
    ssl_cert: ssl_cert_example
    ssl_key: ssl_key_example
    additional_attributes:
    - # required
      name: name_example
      value: value_example
    db_system_id: "ocid1.dbsystem.oc1..xxxxxxEXAMPLExxxxxx"
    security_protocol: security_protocol_example
    host: host_example
    port: 56
    private_ip: private_ip_example
    display_name: display_name_example
    description: description_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    vault_id: "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx"
    key_id: "ocid1.key.oc1..xxxxxxEXAMPLExxxxxx"
    nsg_ids: [ "nsg_ids_example" ]
    username: username_example
    password: example-password

- name: Update connection using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with connection_type = OCI_OBJECT_STORAGE
  oci_golden_gate_connection:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    connection_type: OCI_OBJECT_STORAGE

    # optional
    tenancy_id: "ocid1.tenancy.oc1..xxxxxxEXAMPLExxxxxx"
    region: us-phoenix-1
    user_id: "ocid1.user.oc1..xxxxxxEXAMPLExxxxxx"
    private_key_file: private_key_file_example
    private_key_passphrase: private_key_passphrase_example
    public_key_fingerprint: public_key_fingerprint_example
    display_name: display_name_example
    description: description_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    vault_id: "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx"
    key_id: "ocid1.key.oc1..xxxxxxEXAMPLExxxxxx"
    nsg_ids: [ "nsg_ids_example" ]

- name: Update connection using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with connection_type = KAFKA
  oci_golden_gate_connection:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    connection_type: KAFKA

    # optional
    stream_pool_id: "ocid1.streampool.oc1..xxxxxxEXAMPLExxxxxx"
    bootstrap_servers:
    - # required
      host: host_example

      # optional
      port: 56
      private_ip: private_ip_example
    security_protocol: security_protocol_example
    trust_store: trust_store_example
    trust_store_password: example-password
    key_store: key_store_example
    key_store_password: example-password
    ssl_key_password: example-password
    consumer_properties: consumer_properties_example
    producer_properties: producer_properties_example
    display_name: display_name_example
    description: description_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    vault_id: "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx"
    key_id: "ocid1.key.oc1..xxxxxxEXAMPLExxxxxx"
    nsg_ids: [ "nsg_ids_example" ]
    username: username_example
    password: example-password

- name: Update connection using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with connection_type = ORACLE
  oci_golden_gate_connection:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    connection_type: ORACLE

    # optional
    wallet: wallet_example
    session_mode: session_mode_example
    database_id: "ocid1.database.oc1..xxxxxxEXAMPLExxxxxx"
    private_ip: private_ip_example
    display_name: display_name_example
    description: description_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    vault_id: "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx"
    key_id: "ocid1.key.oc1..xxxxxxEXAMPLExxxxxx"
    nsg_ids: [ "nsg_ids_example" ]
    connection_string: connection_string_example
    username: username_example
    password: example-password

- name: Update connection using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with connection_type = GOLDENGATE
  oci_golden_gate_connection:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    connection_type: GOLDENGATE

    # optional
    deployment_id: "ocid1.deployment.oc1..xxxxxxEXAMPLExxxxxx"
    host: host_example
    port: 56
    private_ip: private_ip_example
    display_name: display_name_example
    description: description_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    vault_id: "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx"
    key_id: "ocid1.key.oc1..xxxxxxEXAMPLExxxxxx"
    nsg_ids: [ "nsg_ids_example" ]

- name: Delete connection
  oci_golden_gate_connection:
    # required
    connection_id: "ocid1.connection.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete connection using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_golden_gate_connection:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
connection
complex
on success
Details of the Connection resource acted upon by the current operation

Sample:
{'account_name': 'account_name_example', 'additional_attributes': [{'name': 'name_example', 'value': 'value_example'}], 'authentication_type': 'SHARED_KEY', 'azure_tenant_id': 'ocid1.azuretenant.oc1..xxxxxxEXAMPLExxxxxx', 'bootstrap_servers': [{'host': 'host_example', 'port': 56, 'private_ip': 'private_ip_example'}], 'client_id': 'ocid1.client.oc1..xxxxxxEXAMPLExxxxxx', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'connection_string': 'connection_string_example', 'connection_type': 'GOLDENGATE', 'database_id': 'ocid1.database.oc1..xxxxxxEXAMPLExxxxxx', 'database_name': 'database_name_example', 'db_system_id': 'ocid1.dbsystem.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'deployment_id': 'ocid1.deployment.oc1..xxxxxxEXAMPLExxxxxx', 'description': 'description_example', 'display_name': 'display_name_example', 'endpoint': 'endpoint_example', 'freeform_tags': {'Department': 'Finance'}, 'host': 'host_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'ingress_ips': [{'ingress_ip': 'ingress_ip_example'}], 'key_id': 'ocid1.key.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'nsg_ids': [], 'port': 56, 'private_ip': 'private_ip_example', 'region': 'us-phoenix-1', 'security_protocol': 'SSL', 'session_mode': 'DIRECT', 'ssl_mode': 'DISABLED', 'stream_pool_id': 'ocid1.streampool.oc1..xxxxxxEXAMPLExxxxxx', 'subnet_id': 'ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx', 'system_tags': {}, 'technology_type': 'AZURE_DATA_LAKE_STORAGE', 'tenancy_id': 'ocid1.tenancy.oc1..xxxxxxEXAMPLExxxxxx', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'url': 'url_example', 'user_id': 'ocid1.user.oc1..xxxxxxEXAMPLExxxxxx', 'username': 'username_example', 'vault_id': 'ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx'}
 
account_name
string
on success
Sets the Azure storage account name.

Sample:
account_name_example
 
additional_attributes
complex
on success
An array of name-value pair attribute entries. Used as additional parameters in connection string.

   
name
string
on success
The name of the property entry.

Sample:
name_example
   
value
string
on success
The value of the property entry.

Sample:
value_example
 
authentication_type
string
on success
Used authentication mechanism to access Azure Data Lake Storage.

Sample:
SHARED_KEY
 
azure_tenant_id
string
on success
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

Sample:
ocid1.azuretenant.oc1..xxxxxxEXAMPLExxxxxx
 
bootstrap_servers
complex
on success
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
string
on success
The name or address of a host.

Sample:
host_example
   
port
integer
on success
The port of an endpoint usually specified for a connection.

Sample:
56
   
private_ip
string
on success
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.

Sample:
private_ip_example
 
client_id
string
on success
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

Sample:
ocid1.client.oc1..xxxxxxEXAMPLExxxxxx
 
compartment_id
string
on success
The OCID of the compartment being referenced.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
connection_string
string
on success
JDBC connection string. e.g.: 'jdbc:sqlserver://<synapse-workspace>.sql.azuresynapse.net:1433;database=<db- name>;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'

Sample:
connection_string_example
 
connection_type
string
on success
The connection type.

Sample:
GOLDENGATE
 
database_id
string
on success
The OCID of the database being referenced.

Sample:
ocid1.database.oc1..xxxxxxEXAMPLExxxxxx
 
database_name
string
on success
The name of the database.

Sample:
database_name_example
 
db_system_id
string
on success
The OCID of the database system being referenced.

Sample:
ocid1.dbsystem.oc1..xxxxxxEXAMPLExxxxxx
 
defined_tags
dictionary
on success
Tags defined for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
deployment_id
string
on success
The OCID of the deployment being referenced.

Sample:
ocid1.deployment.oc1..xxxxxxEXAMPLExxxxxx
 
description
string
on success
Metadata about this specific object.

Sample:
description_example
 
display_name
string
on success
An object's Display Name.

Sample:
display_name_example
 
endpoint
string
on success
Azure Storage service endpoint. e.g: https://test.blob.core.windows.net

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

Sample:
{'Department': 'Finance'}
 
host
string
on success
The name or address of a host.

Sample:
host_example
 
id
string
on success
The OCID of the connection being referenced.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
ingress_ips
complex
on success
List of ingress IP addresses, from where the GoldenGate deployment connects to this connection's privateIp.

   
ingress_ip
string
on success
A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet.

Sample:
ingress_ip_example
 
key_id
string
on success
The OCID of the customer "Master" key being referenced. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this key to manage secrets.

Sample:
ocid1.key.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_details
string
on success
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.

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
Possible lifecycle states for connection.

Sample:
CREATING
 
nsg_ids
list / elements=string
on success
An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.

 
port
integer
on success
The port of an endpoint usually specified for a connection.

Sample:
56
 
private_ip
string
on success
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.

Sample:
private_ip_example
 
region
string
on success
The name of the region. e.g.: us-ashburn-1

Sample:
us-phoenix-1
 
security_protocol
string
on success
Kafka security protocol.

Sample:
SSL
 
session_mode
string
on success
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.

Sample:
DIRECT
 
ssl_mode
string
on success
SSL modes for MySQL.

Sample:
DISABLED
 
stream_pool_id
string
on success
The OCID of the stream pool being referenced.

Sample:
ocid1.streampool.oc1..xxxxxxEXAMPLExxxxxx
 
subnet_id
string
on success
The OCID of the subnet being referenced.

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

 
technology_type
string
on success
The Azure Data Lake Storage technology type.

Sample:
AZURE_DATA_LAKE_STORAGE
 
tenancy_id
string
on success
The OCID of the related OCI tenancy.

Sample:
ocid1.tenancy.oc1..xxxxxxEXAMPLExxxxxx
 
time_created
string
on success
The time the resource was created. The format is defined by RFC3339, such as `2016-08-25T21:10:29.600Z`.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The time the resource was last updated. The format is defined by RFC3339, such as `2016-08-25T21:10:29.600Z`.

Sample:
2013-10-20T19:20:30+01:00
 
url
string
on success
Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'

Sample:
url_example
 
user_id
string
on success
The OCID of the OCI user who will access the Object Storage. The user must have write access to the bucket they want to connect to.

Sample:
ocid1.user.oc1..xxxxxxEXAMPLExxxxxx
 
username
string
on success
The username Oracle GoldenGate uses to connect the associated RDBMS. This username must already exist and be available for use by the database. It must conform to the security requirements implemented by the database including length, case sensitivity, and so on.

Sample:
username_example
 
vault_id
string
on success
The OCID of the customer vault being referenced. If provided, this will reference a vault which the customer will be required to ensure the policies are established to permit the GoldenGate Service to manage secrets contained within this vault.

Sample:
ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx


Authors

  • Oracle (@oracle)