Oracle Cloud Infrastructure v2.31.0, Apr 17 25

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

oci.GoldenGate.getConnections

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testConnections = oci.GoldenGate.getConnections({
    compartmentId: compartmentId,
    assignableDeploymentId: testDeployment.id,
    assignableDeploymentType: connectionAssignableDeploymentType,
    assignedDeploymentId: testDeployment.id,
    connectionTypes: connectionConnectionType,
    displayName: connectionDisplayName,
    state: connectionState,
    technologyTypes: connectionTechnologyType,
});

import pulumi
import pulumi_oci as oci

test_connections = oci.GoldenGate.get_connections(compartment_id=compartment_id,
    assignable_deployment_id=test_deployment["id"],
    assignable_deployment_type=connection_assignable_deployment_type,
    assigned_deployment_id=test_deployment["id"],
    connection_types=connection_connection_type,
    display_name=connection_display_name,
    state=connection_state,
    technology_types=connection_technology_type)

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := goldengate.GetConnections(ctx, &goldengate.GetConnectionsArgs{
			CompartmentId:            compartmentId,
			AssignableDeploymentId:   pulumi.StringRef(testDeployment.Id),
			AssignableDeploymentType: pulumi.StringRef(connectionAssignableDeploymentType),
			AssignedDeploymentId:     pulumi.StringRef(testDeployment.Id),
			ConnectionTypes:          connectionConnectionType,
			DisplayName:              pulumi.StringRef(connectionDisplayName),
			State:                    pulumi.StringRef(connectionState),
			TechnologyTypes:          connectionTechnologyType,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testConnections = Oci.GoldenGate.GetConnections.Invoke(new()
    {
        CompartmentId = compartmentId,
        AssignableDeploymentId = testDeployment.Id,
        AssignableDeploymentType = connectionAssignableDeploymentType,
        AssignedDeploymentId = testDeployment.Id,
        ConnectionTypes = connectionConnectionType,
        DisplayName = connectionDisplayName,
        State = connectionState,
        TechnologyTypes = connectionTechnologyType,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.GoldenGate.GoldenGateFunctions;
import com.pulumi.oci.GoldenGate.inputs.GetConnectionsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

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

    public static void stack(Context ctx) {
        final var testConnections = GoldenGateFunctions.getConnections(GetConnectionsArgs.builder()
            .compartmentId(compartmentId)
            .assignableDeploymentId(testDeployment.id())
            .assignableDeploymentType(connectionAssignableDeploymentType)
            .assignedDeploymentId(testDeployment.id())
            .connectionTypes(connectionConnectionType)
            .displayName(connectionDisplayName)
            .state(connectionState)
            .technologyTypes(connectionTechnologyType)
            .build());

    }
}

variables:
  testConnections:
    fn::invoke:
      function: oci:GoldenGate:getConnections
      arguments:
        compartmentId: ${compartmentId}
        assignableDeploymentId: ${testDeployment.id}
        assignableDeploymentType: ${connectionAssignableDeploymentType}
        assignedDeploymentId: ${testDeployment.id}
        connectionTypes: ${connectionConnectionType}
        displayName: ${connectionDisplayName}
        state: ${connectionState}
        technologyTypes: ${connectionTechnologyType}

Using getConnections

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 getConnections(args: GetConnectionsArgs, opts?: InvokeOptions): Promise<GetConnectionsResult>
function getConnectionsOutput(args: GetConnectionsOutputArgs, opts?: InvokeOptions): Output<GetConnectionsResult>

def get_connections(assignable_deployment_id: Optional[str] = None,
                    assignable_deployment_type: Optional[str] = None,
                    assigned_deployment_id: Optional[str] = None,
                    compartment_id: Optional[str] = None,
                    connection_types: Optional[Sequence[str]] = None,
                    display_name: Optional[str] = None,
                    filters: Optional[Sequence[_goldengate.GetConnectionsFilter]] = None,
                    state: Optional[str] = None,
                    technology_types: Optional[Sequence[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> GetConnectionsResult
def get_connections_output(assignable_deployment_id: Optional[pulumi.Input[str]] = None,
                    assignable_deployment_type: Optional[pulumi.Input[str]] = None,
                    assigned_deployment_id: Optional[pulumi.Input[str]] = None,
                    compartment_id: Optional[pulumi.Input[str]] = None,
                    connection_types: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                    display_name: Optional[pulumi.Input[str]] = None,
                    filters: Optional[pulumi.Input[Sequence[pulumi.Input[_goldengate.GetConnectionsFilterArgs]]]] = None,
                    state: Optional[pulumi.Input[str]] = None,
                    technology_types: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetConnectionsResult]

func GetConnections(ctx *Context, args *GetConnectionsArgs, opts ...InvokeOption) (*GetConnectionsResult, error)
func GetConnectionsOutput(ctx *Context, args *GetConnectionsOutputArgs, opts ...InvokeOption) GetConnectionsResultOutput

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

public static class GetConnections 
{
    public static Task<GetConnectionsResult> InvokeAsync(GetConnectionsArgs args, InvokeOptions? opts = null)
    public static Output<GetConnectionsResult> Invoke(GetConnectionsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetConnectionsResult> getConnections(GetConnectionsArgs args, InvokeOptions options)
public static Output<GetConnectionsResult> getConnections(GetConnectionsArgs args, InvokeOptions options)

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

The following arguments are supported:

CompartmentId string: 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.
AssignableDeploymentId string: Filters for compatible connections which can be, but currently not assigned to the deployment specified by its id.
AssignableDeploymentType string: Filters for connections which can be assigned to the latest version of the specified deployment type.
AssignedDeploymentId string: The OCID of the deployment which for the connection must be assigned.
ConnectionTypes List<string>: The array of connection types.
DisplayName string: A filter to return only the resources that match the entire 'displayName' given.
Filters List<GetConnectionsFilter>
State string: A filter to return only connections having the 'lifecycleState' given.
TechnologyTypes List<string>: The array of technology types.

CompartmentId string: 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.
AssignableDeploymentId string: Filters for compatible connections which can be, but currently not assigned to the deployment specified by its id.
AssignableDeploymentType string: Filters for connections which can be assigned to the latest version of the specified deployment type.
AssignedDeploymentId string: The OCID of the deployment which for the connection must be assigned.
ConnectionTypes []string: The array of connection types.
DisplayName string: A filter to return only the resources that match the entire 'displayName' given.
Filters []GetConnectionsFilter
State string: A filter to return only connections having the 'lifecycleState' given.
TechnologyTypes []string: The array of technology types.

compartmentId String: 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.
assignableDeploymentId String: Filters for compatible connections which can be, but currently not assigned to the deployment specified by its id.
assignableDeploymentType String: Filters for connections which can be assigned to the latest version of the specified deployment type.
assignedDeploymentId String: The OCID of the deployment which for the connection must be assigned.
connectionTypes List<String>: The array of connection types.
displayName String: A filter to return only the resources that match the entire 'displayName' given.
filters List<GetConnectionsFilter>
state String: A filter to return only connections having the 'lifecycleState' given.
technologyTypes List<String>: The array of technology types.

compartmentId string: 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.
assignableDeploymentId string: Filters for compatible connections which can be, but currently not assigned to the deployment specified by its id.
assignableDeploymentType string: Filters for connections which can be assigned to the latest version of the specified deployment type.
assignedDeploymentId string: The OCID of the deployment which for the connection must be assigned.
connectionTypes string[]: The array of connection types.
displayName string: A filter to return only the resources that match the entire 'displayName' given.
filters GetConnectionsFilter[]
state string: A filter to return only connections having the 'lifecycleState' given.
technologyTypes string[]: The array of technology types.

compartment_id str: 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.
assignable_deployment_id str: Filters for compatible connections which can be, but currently not assigned to the deployment specified by its id.
assignable_deployment_type str: Filters for connections which can be assigned to the latest version of the specified deployment type.
assigned_deployment_id str: The OCID of the deployment which for the connection must be assigned.
connection_types Sequence[str]: The array of connection types.
display_name str: A filter to return only the resources that match the entire 'displayName' given.
filters Sequence[goldengate.GetConnectionsFilter]
state str: A filter to return only connections having the 'lifecycleState' given.
technology_types Sequence[str]: The array of technology types.

compartmentId String: 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.
assignableDeploymentId String: Filters for compatible connections which can be, but currently not assigned to the deployment specified by its id.
assignableDeploymentType String: Filters for connections which can be assigned to the latest version of the specified deployment type.
assignedDeploymentId String: The OCID of the deployment which for the connection must be assigned.
connectionTypes List<String>: The array of connection types.
displayName String: A filter to return only the resources that match the entire 'displayName' given.
filters List<Property Map>
state String: A filter to return only connections having the 'lifecycleState' given.
technologyTypes List<String>: The array of technology types.

getConnections Result

The following output properties are available:

CompartmentId string: The OCID of the compartment being referenced.
ConnectionCollections List<GetConnectionsConnectionCollection>: The list of connection_collection.
Id string: The provider-assigned unique ID for this managed resource.
AssignableDeploymentId string
AssignableDeploymentType string
AssignedDeploymentId string
ConnectionTypes List<string>: The connection type.
DisplayName string: An object's Display Name.
Filters List<GetConnectionsFilter>
State string: Possible lifecycle states for connection.
TechnologyTypes List<string>: The technology type.

CompartmentId string: The OCID of the compartment being referenced.
ConnectionCollections []GetConnectionsConnectionCollection: The list of connection_collection.
Id string: The provider-assigned unique ID for this managed resource.
AssignableDeploymentId string
AssignableDeploymentType string
AssignedDeploymentId string
ConnectionTypes []string: The connection type.
DisplayName string: An object's Display Name.
Filters []GetConnectionsFilter
State string: Possible lifecycle states for connection.
TechnologyTypes []string: The technology type.

compartmentId String: The OCID of the compartment being referenced.
connectionCollections List<GetConnectionsConnectionCollection>: The list of connection_collection.
id String: The provider-assigned unique ID for this managed resource.
assignableDeploymentId String
assignableDeploymentType String
assignedDeploymentId String
connectionTypes List<String>: The connection type.
displayName String: An object's Display Name.
filters List<GetConnectionsFilter>
state String: Possible lifecycle states for connection.
technologyTypes List<String>: The technology type.

compartmentId string: The OCID of the compartment being referenced.
connectionCollections GetConnectionsConnectionCollection[]: The list of connection_collection.
id string: The provider-assigned unique ID for this managed resource.
assignableDeploymentId string
assignableDeploymentType string
assignedDeploymentId string
connectionTypes string[]: The connection type.
displayName string: An object's Display Name.
filters GetConnectionsFilter[]
state string: Possible lifecycle states for connection.
technologyTypes string[]: The technology type.

compartment_id str: The OCID of the compartment being referenced.
connection_collections Sequence[goldengate.GetConnectionsConnectionCollection]: The list of connection_collection.
id str: The provider-assigned unique ID for this managed resource.
assignable_deployment_id str
assignable_deployment_type str
assigned_deployment_id str
connection_types Sequence[str]: The connection type.
display_name str: An object's Display Name.
filters Sequence[goldengate.GetConnectionsFilter]
state str: Possible lifecycle states for connection.
technology_types Sequence[str]: The technology type.

compartmentId String: The OCID of the compartment being referenced.
connectionCollections List<Property Map>: The list of connection_collection.
id String: The provider-assigned unique ID for this managed resource.
assignableDeploymentId String
assignableDeploymentType String
assignedDeploymentId String
connectionTypes List<String>: The connection type.
displayName String: An object's Display Name.
filters List<Property Map>
state String: Possible lifecycle states for connection.
technologyTypes List<String>: The technology type.

Supporting Types

GetConnectionsConnectionCollection

Items List<GetConnectionsConnectionCollectionItem>

Items []GetConnectionsConnectionCollectionItem

items List<GetConnectionsConnectionCollectionItem>

items GetConnectionsConnectionCollectionItem[]

items Sequence[goldengate.GetConnectionsConnectionCollectionItem]

items List<Property Map>

GetConnectionsConnectionCollectionItem

AccessKeyId string

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

AccountKey string

AccountKeySecretId string

The OCID of the Secret where the account key is stored. Note: When provided, 'accountKey' field must not be provided.

AccountName string

Sets the Azure storage account name.

AdditionalAttributes List<GetConnectionsConnectionCollectionItemAdditionalAttribute>

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:

SNOWFLAKE, AZURE_DATA_LAKE_STORAGE, ELASTICSEARCH, KAFKA_SCHEMA_REGISTRY, REDIS
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<GetConnectionsConnectionCollectionItemBootstrapServer>

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

ClientId string

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

ClientSecret string

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

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'

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 array of connection types.

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

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

A filter to return only the resources that match the entire 'displayName' given.

DoesUseSecretIds bool

Indicates that sensitive attributes are provided via Secrets.

Endpoint string

Service endpoint. e.g for Azure Storage service: https://test.blob.core.windows.net. Optional for Microsoft Fabric service endpoint. Default value: https://onelake.dfs.fabric.microsoft.com

Fingerprint string

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<GetConnectionsConnectionCollectionItemIngressIp>

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<GetConnectionsConnectionCollectionItemLock>

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

RedisClusterId string

The OCID of the Redis cluster.

Region string

The name of the region. e.g.: us-ashburn-1 If the region is not provided, backend will default to the default region.

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. Note: When provided, 'secretAccessKey' field must not be provided.

SecurityProtocol string

Security Protocol to be provided for the following connection types:

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

Servers string

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

ServiceAccountKeyFile string

ServiceAccountKeyFileSecretId string

The OCID of the Secret where the content of the service account key file is stored, which containing the credentials required to use Google Cloud Storage. Note: When provided, 'serviceAccountKeyFile' field must not be provided.

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

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

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

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

State string

A filter to return only connections having the 'lifecycleState' given.

StorageCredentialName string

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

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 array of technology types.

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

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. e.g.: "this-is-not-the-secret"

AccountKey string

AccountKeySecretId string

The OCID of the Secret where the account key is stored. Note: When provided, 'accountKey' field must not be provided.

AccountName string

Sets the Azure storage account name.

AdditionalAttributes []GetConnectionsConnectionCollectionItemAdditionalAttribute

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:

SNOWFLAKE, AZURE_DATA_LAKE_STORAGE, ELASTICSEARCH, KAFKA_SCHEMA_REGISTRY, REDIS
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 []GetConnectionsConnectionCollectionItemBootstrapServer

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

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'

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 array of connection types.

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

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

A filter to return only the resources that match the entire 'displayName' given.

DoesUseSecretIds bool

Indicates that sensitive attributes are provided via Secrets.

Endpoint string

Service endpoint. e.g for Azure Storage service: https://test.blob.core.windows.net. Optional for Microsoft Fabric service endpoint. Default value: https://onelake.dfs.fabric.microsoft.com

Fingerprint string

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

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

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

RedisClusterId string

The OCID of the Redis cluster.

Region string

The name of the region. e.g.: us-ashburn-1 If the region is not provided, backend will default to the default region.

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. Note: When provided, 'secretAccessKey' field must not be provided.

SecurityProtocol string

Security Protocol to be provided for the following connection types:

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

Servers string

ServiceAccountKeyFile string

ServiceAccountKeyFileSecretId string

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

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

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

A filter to return only connections having the 'lifecycleState' given.

StorageCredentialName string

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

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 array of technology types.

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. e.g.: "this-is-not-the-secret"

accountKey String

accountKeySecretId String

The OCID of the Secret where the account key is stored. Note: When provided, 'accountKey' field must not be provided.

accountName String

Sets the Azure storage account name.

additionalAttributes List<GetConnectionsConnectionCollectionItemAdditionalAttribute>

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:

SNOWFLAKE, AZURE_DATA_LAKE_STORAGE, ELASTICSEARCH, KAFKA_SCHEMA_REGISTRY, REDIS
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<GetConnectionsConnectionCollectionItemBootstrapServer>

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

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'

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 array of connection types.

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

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

A filter to return only the resources that match the entire 'displayName' given.

doesUseSecretIds Boolean

Indicates that sensitive attributes are provided via Secrets.

endpoint String

Service endpoint. e.g for Azure Storage service: https://test.blob.core.windows.net. Optional for Microsoft Fabric service endpoint. Default value: https://onelake.dfs.fabric.microsoft.com

fingerprint String

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<GetConnectionsConnectionCollectionItemIngressIp>

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<GetConnectionsConnectionCollectionItemLock>

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

redisClusterId String

The OCID of the Redis cluster.

region String

The name of the region. e.g.: us-ashburn-1 If the region is not provided, backend will default to the default region.

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. Note: When provided, 'secretAccessKey' field must not be provided.

securityProtocol String

Security Protocol to be provided for the following connection types:

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

servers String

serviceAccountKeyFile String

serviceAccountKeyFileSecretId String

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

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

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

A filter to return only connections having the 'lifecycleState' given.

storageCredentialName String

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

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 array of technology types.

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. e.g.: "this-is-not-the-secret"

accountKey string

accountKeySecretId string

The OCID of the Secret where the account key is stored. Note: When provided, 'accountKey' field must not be provided.

accountName string

Sets the Azure storage account name.

additionalAttributes GetConnectionsConnectionCollectionItemAdditionalAttribute[]

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:

SNOWFLAKE, AZURE_DATA_LAKE_STORAGE, ELASTICSEARCH, KAFKA_SCHEMA_REGISTRY, REDIS
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 GetConnectionsConnectionCollectionItemBootstrapServer[]

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

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'

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 array of connection types.

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

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

A filter to return only the resources that match the entire 'displayName' given.

doesUseSecretIds boolean

Indicates that sensitive attributes are provided via Secrets.

endpoint string

Service endpoint. e.g for Azure Storage service: https://test.blob.core.windows.net. Optional for Microsoft Fabric service endpoint. Default value: https://onelake.dfs.fabric.microsoft.com

fingerprint string

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

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

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

redisClusterId string

The OCID of the Redis cluster.

region string

The name of the region. e.g.: us-ashburn-1 If the region is not provided, backend will default to the default region.

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. Note: When provided, 'secretAccessKey' field must not be provided.

securityProtocol string

Security Protocol to be provided for the following connection types:

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

servers string

serviceAccountKeyFile string

serviceAccountKeyFileSecretId string

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

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

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

A filter to return only connections having the 'lifecycleState' given.

storageCredentialName string

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

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 array of technology types.

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. e.g.: "this-is-not-the-secret"

account_key str

account_key_secret_id str

The OCID of the Secret where the account key is stored. Note: When provided, 'accountKey' field must not be provided.

account_name str

Sets the Azure storage account name.

additional_attributes Sequence[goldengate.GetConnectionsConnectionCollectionItemAdditionalAttribute]

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:

SNOWFLAKE, AZURE_DATA_LAKE_STORAGE, ELASTICSEARCH, KAFKA_SCHEMA_REGISTRY, REDIS
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[goldengate.GetConnectionsConnectionCollectionItemBootstrapServer]

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

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_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 array of connection types.

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

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

A filter to return only the resources that match the entire 'displayName' given.

does_use_secret_ids bool

Indicates that sensitive attributes are provided via Secrets.

endpoint str

Service endpoint. e.g for Azure Storage service: https://test.blob.core.windows.net. Optional for Microsoft Fabric service endpoint. Default value: https://onelake.dfs.fabric.microsoft.com

fingerprint str

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[goldengate.GetConnectionsConnectionCollectionItemIngressIp]

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[goldengate.GetConnectionsConnectionCollectionItemLock]

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

redis_cluster_id str

The OCID of the Redis cluster.

region str

The name of the region. e.g.: us-ashburn-1 If the region is not provided, backend will default to the default region.

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. Note: When provided, 'secretAccessKey' field must not be provided.

security_protocol str

Security Protocol to be provided for the following connection types:

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

servers str

service_account_key_file str

service_account_key_file_secret_id str

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

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

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

A filter to return only connections having the 'lifecycleState' given.

storage_credential_name str

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

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 array of technology types.

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. e.g.: "this-is-not-the-secret"

accountKey String

accountKeySecretId String

The OCID of the Secret where the account key is stored. Note: When provided, 'accountKey' field must not be provided.

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:

SNOWFLAKE, AZURE_DATA_LAKE_STORAGE, ELASTICSEARCH, KAFKA_SCHEMA_REGISTRY, REDIS
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>

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

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'

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 array of connection types.

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

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

A filter to return only the resources that match the entire 'displayName' given.

doesUseSecretIds Boolean

Indicates that sensitive attributes are provided via Secrets.

endpoint String

Service endpoint. e.g for Azure Storage service: https://test.blob.core.windows.net. Optional for Microsoft Fabric service endpoint. Default value: https://onelake.dfs.fabric.microsoft.com

fingerprint String

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

redisClusterId String

The OCID of the Redis cluster.

region String

The name of the region. e.g.: us-ashburn-1 If the region is not provided, backend will default to the default region.

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. Note: When provided, 'secretAccessKey' field must not be provided.

securityProtocol String

Security Protocol to be provided for the following connection types:

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

servers String

serviceAccountKeyFile String

serviceAccountKeyFileSecretId String

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

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

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

A filter to return only connections having the 'lifecycleState' given.

storageCredentialName String

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

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 array of technology types.

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.

GetConnectionsConnectionCollectionItemAdditionalAttribute

Name string: The name of the property entry.
Value string: The value of the property entry.

Name string: The name of the property entry.
Value string: The value of the property entry.

name String: The name of the property entry.
value String: The value of the property entry.

name string: The name of the property entry.
value string: The value of the property entry.

name str: The name of the property entry.
value str: The value of the property entry.

name String: The name of the property entry.
value String: The value of the property entry.

GetConnectionsConnectionCollectionItemBootstrapServer

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.

GetConnectionsConnectionCollectionItemIngressIp

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.

GetConnectionsConnectionCollectionItemLock

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.

GetConnectionsFilter

Name string: The name of the property entry.
Values List<string>
Regex bool

Name string: The name of the property entry.
Values []string
Regex bool

name String: The name of the property entry.
values List<String>
regex Boolean

name string: The name of the property entry.
values string[]
regex boolean

name str: The name of the property entry.
values Sequence[str]
regex bool

name String: The name of the property entry.
values List<String>
regex Boolean

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 v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

pulumi/pulumi-oci

oci.GoldenGate.getConnections

On this page

On this page

Example Usage

Using getConnections

getConnections Result

Supporting Types

GetConnectionsConnectionCollection

GetConnectionsConnectionCollectionItem

GetConnectionsConnectionCollectionItemAdditionalAttribute

GetConnectionsConnectionCollectionItemBootstrapServer

GetConnectionsConnectionCollectionItemIngressIp

GetConnectionsConnectionCollectionItemLock

GetConnectionsFilter

Package Details

On this page

On this page