goldengate_connections

Creates, updates, deletes, gets or lists a goldengate_connections resource.

Overview

Name	goldengate_connections
Type	Resource
Id	google.oracledatabase.goldengate_connections

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Identifier. The name of the GoldengateConnection resource in the following format: projects/{project}/locations/{region}/goldengateConnections/{goldengate_connection}
createTime	string (google-datetime)	Output only. The date and time that the GoldengateConnection was created.
entitlementId	string	Output only. The ID of the subscription entitlement associated with the GoldengateConnection.
gcpOracleZone	string	Optional. The GCP Oracle zone where Oracle GoldengateConnection is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability.
labels	object	Optional. The labels or tags associated with the GoldengateConnection.
ociUrl	string	Output only. HTTPS link to OCI resources exposed to Customer via UI Interface.
odbNetwork	string	Optional. The name of the OdbNetwork associated with the GoldengateConnection. The format is projects/{project}/locations/{location}/odbNetworks/{odb_network}. It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet.
odbSubnet	string	Optional. The name of the OdbSubnet associated with the GoldengateConnection for IP allocation. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}
properties	object	Required. The properties of the GoldengateConnection. (id: GoldengateConnectionProperties)

list

Name	Datatype	Description
name	string	Identifier. The name of the GoldengateConnection resource in the following format: projects/{project}/locations/{region}/goldengateConnections/{goldengate_connection}
createTime	string (google-datetime)	Output only. The date and time that the GoldengateConnection was created.
entitlementId	string	Output only. The ID of the subscription entitlement associated with the GoldengateConnection.
gcpOracleZone	string	Optional. The GCP Oracle zone where Oracle GoldengateConnection is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability.
labels	object	Optional. The labels or tags associated with the GoldengateConnection.
ociUrl	string	Output only. HTTPS link to OCI resources exposed to Customer via UI Interface.
odbNetwork	string	Optional. The name of the OdbNetwork associated with the GoldengateConnection. The format is projects/{project}/locations/{location}/odbNetworks/{odb_network}. It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet.
odbSubnet	string	Optional. The name of the OdbSubnet associated with the GoldengateConnection for IP allocation. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}
properties	object	Required. The properties of the GoldengateConnection. (id: GoldengateConnectionProperties)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, goldengateConnectionsId		Gets details of a single GoldengateConnection.
list	select	projectsId, locationsId	filter, orderBy, pageSize, pageToken	Lists all the GoldengateConnections for the given project and location.
create	insert	projectsId, locationsId	goldengateConnectionId, requestId	Creates a new GoldengateConnection in a given project and location.
delete	delete	projectsId, locationsId, goldengateConnectionsId	requestId	Deletes a single GoldengateConnection.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
goldengateConnectionsId	string
locationsId	string
projectsId	string
filter	string
goldengateConnectionId	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string

SELECT examples

get

Gets details of a single GoldengateConnection.

SELECT
name,
createTime,
entitlementId,
gcpOracleZone,
labels,
ociUrl,
odbNetwork,
odbSubnet,
properties
FROM google.oracledatabase.goldengate_connections
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND goldengateConnectionsId = '{{ goldengateConnectionsId }}' -- required
;

list

Lists all the GoldengateConnections for the given project and location.

SELECT
name,
createTime,
entitlementId,
gcpOracleZone,
labels,
ociUrl,
odbNetwork,
odbSubnet,
properties
FROM google.oracledatabase.goldengate_connections
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

INSERT examples

create

Creates a new GoldengateConnection in a given project and location.

INSERT INTO google.oracledatabase.goldengate_connections (
data__gcpOracleZone,
data__labels,
data__name,
data__odbNetwork,
data__odbSubnet,
data__properties,
projectsId,
locationsId,
goldengateConnectionId,
requestId
)
SELECT 
'{{ gcpOracleZone }}',
'{{ labels }}',
'{{ name }}',
'{{ odbNetwork }}',
'{{ odbSubnet }}',
'{{ properties }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ goldengateConnectionId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: goldengate_connections
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the goldengate_connections resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the goldengate_connections resource.
  - name: gcpOracleZone
    value: "{{ gcpOracleZone }}"
    description: |
      Optional. The GCP Oracle zone where Oracle GoldengateConnection is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability.
  - name: labels
    value: "{{ labels }}"
    description: |
      Optional. The labels or tags associated with the GoldengateConnection.
  - name: name
    value: "{{ name }}"
    description: |
      Identifier. The name of the GoldengateConnection resource in the following format: projects/{project}/locations/{region}/goldengateConnections/{goldengate_connection}
  - name: odbNetwork
    value: "{{ odbNetwork }}"
    description: |
      Optional. The name of the OdbNetwork associated with the GoldengateConnection. The format is projects/{project}/locations/{location}/odbNetworks/{odb_network}. It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet.
  - name: odbSubnet
    value: "{{ odbSubnet }}"
    description: |
      Optional. The name of the OdbSubnet associated with the GoldengateConnection for IP allocation. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}
  - name: properties
    description: |
      Required. The properties of the GoldengateConnection.
    value:
      amazonKinesisConnectionProperties:
        accessKeyId: "{{ accessKeyId }}"
        awsRegion: "{{ awsRegion }}"
        endpoint: "{{ endpoint }}"
        secretAccessKeySecret: "{{ secretAccessKeySecret }}"
        technologyType: "{{ technologyType }}"
      amazonRedshiftConnectionProperties:
        connectionUrl: "{{ connectionUrl }}"
        password: "{{ password }}"
        passwordSecretVersion: "{{ passwordSecretVersion }}"
        technologyType: "{{ technologyType }}"
        username: "{{ username }}"
      amazonS3ConnectionProperties:
        accessKeyId: "{{ accessKeyId }}"
        endpoint: "{{ endpoint }}"
        region: "{{ region }}"
        secretAccessKeySecret: "{{ secretAccessKeySecret }}"
        technologyType: "{{ technologyType }}"
      azureDataLakeStorageConnectionProperties:
        account: "{{ account }}"
        accountKeySecret: "{{ accountKeySecret }}"
        authenticationType: "{{ authenticationType }}"
        azureAuthorityHost: "{{ azureAuthorityHost }}"
        azureTenantId: "{{ azureTenantId }}"
        clientId: "{{ clientId }}"
        clientSecret: "{{ clientSecret }}"
        endpoint: "{{ endpoint }}"
        sasTokenSecret: "{{ sasTokenSecret }}"
        technologyType: "{{ technologyType }}"
      azureSynapseAnalyticsConnectionProperties:
        connectionString: "{{ connectionString }}"
        password: "{{ password }}"
        passwordSecretVersion: "{{ passwordSecretVersion }}"
        technologyType: "{{ technologyType }}"
        username: "{{ username }}"
      connectionType: "{{ connectionType }}"
      databricksConnectionProperties:
        authenticationType: "{{ authenticationType }}"
        clientId: "{{ clientId }}"
        clientSecret: "{{ clientSecret }}"
        connectionUrl: "{{ connectionUrl }}"
        password: "{{ password }}"
        passwordSecretVersion: "{{ passwordSecretVersion }}"
        storageCredential: "{{ storageCredential }}"
        technologyType: "{{ technologyType }}"
      db2ConnectionProperties:
        additionalAttributes:
          - key: "{{ key }}"
            value: "{{ value }}"
        database: "{{ database }}"
        host: "{{ host }}"
        password: "{{ password }}"
        passwordSecretVersion: "{{ passwordSecretVersion }}"
        port: {{ port }}
        securityProtocol: "{{ securityProtocol }}"
        sslClientKeystashFile: "{{ sslClientKeystashFile }}"
        sslClientKeystoredbFile: "{{ sslClientKeystoredbFile }}"
        sslServerCertificateFile: "{{ sslServerCertificateFile }}"
        technologyType: "{{ technologyType }}"
        username: "{{ username }}"
      description: "{{ description }}"
      displayName: "{{ displayName }}"
      elasticsearchConnectionProperties:
        authenticationType: "{{ authenticationType }}"
        fingerprint: "{{ fingerprint }}"
        password: "{{ password }}"
        passwordSecretVersion: "{{ passwordSecretVersion }}"
        securityProtocol: "{{ securityProtocol }}"
        servers: "{{ servers }}"
        technologyType: "{{ technologyType }}"
        username: "{{ username }}"
      genericConnectionProperties:
        host: "{{ host }}"
        technologyType: "{{ technologyType }}"
      goldengateConnectionProperties:
        goldengateDeploymentId: "{{ goldengateDeploymentId }}"
        host: "{{ host }}"
        password: "{{ password }}"
        passwordSecretVersion: "{{ passwordSecretVersion }}"
        port: {{ port }}
        technologyType: "{{ technologyType }}"
        username: "{{ username }}"
      googleBigQueryConnectionProperties:
        serviceAccountKeyFile: "{{ serviceAccountKeyFile }}"
        technologyType: "{{ technologyType }}"
      googleCloudStorageConnectionProperties:
        serviceAccountKeyFile: "{{ serviceAccountKeyFile }}"
        technologyType: "{{ technologyType }}"
      googlePubsubConnectionProperties:
        serviceAccountKeyFile: "{{ serviceAccountKeyFile }}"
        technologyType: "{{ technologyType }}"
      hdfsConnectionProperties:
        coreSiteXml: "{{ coreSiteXml }}"
        technologyType: "{{ technologyType }}"
      icebergConnectionProperties:
        catalog:
          catalogType: "{{ catalogType }}"
          glueIcebergCatalog:
            glueId: "{{ glueId }}"
          nessieIcebergCatalog:
            branch: "{{ branch }}"
            uri: "{{ uri }}"
          polarisIcebergCatalog:
            clientId: "{{ clientId }}"
            clientSecret: "{{ clientSecret }}"
            polarisCatalog: "{{ polarisCatalog }}"
            principalRole: "{{ principalRole }}"
            uri: "{{ uri }}"
          restIcebergCatalog:
            properties: "{{ properties }}"
            uri: "{{ uri }}"
        storage:
          amazonS3IcebergStorage:
            accessKeyId: "{{ accessKeyId }}"
            bucket: "{{ bucket }}"
            endpoint: "{{ endpoint }}"
            region: "{{ region }}"
            schemeType: "{{ schemeType }}"
            secretAccessKeySecret: "{{ secretAccessKeySecret }}"
          azureDataLakeStorageIcebergStorage:
            accountKeySecret: "{{ accountKeySecret }}"
            azureAccount: "{{ azureAccount }}"
            container: "{{ container }}"
            endpoint: "{{ endpoint }}"
          googleCloudStorageIcebergStorage:
            bucket: "{{ bucket }}"
            projectId: "{{ projectId }}"
            serviceAccountKeyFile: "{{ serviceAccountKeyFile }}"
          storageType: "{{ storageType }}"
        technologyType: "{{ technologyType }}"
      ingressIpAddresses:
        - "{{ ingressIpAddresses }}"
      javaMessageServiceConnectionProperties:
        authenticationType: "{{ authenticationType }}"
        connectionFactory: "{{ connectionFactory }}"
        connectionUrl: "{{ connectionUrl }}"
        jndiConnectionFactory: "{{ jndiConnectionFactory }}"
        jndiInitialContextFactory: "{{ jndiInitialContextFactory }}"
        jndiProviderUrl: "{{ jndiProviderUrl }}"
        jndiSecurityCredentialsSecret: "{{ jndiSecurityCredentialsSecret }}"
        jndiSecurityPrincipal: "{{ jndiSecurityPrincipal }}"
        keyStoreFile: "{{ keyStoreFile }}"
        keyStorePassword: "{{ keyStorePassword }}"
        keyStorePasswordSecretVersion: "{{ keyStorePasswordSecretVersion }}"
        password: "{{ password }}"
        passwordSecretVersion: "{{ passwordSecretVersion }}"
        securityProtocol: "{{ securityProtocol }}"
        sslKeyPassword: "{{ sslKeyPassword }}"
        sslKeyPasswordSecretVersion: "{{ sslKeyPasswordSecretVersion }}"
        technologyType: "{{ technologyType }}"
        trustStoreFile: "{{ trustStoreFile }}"
        trustStorePassword: "{{ trustStorePassword }}"
        trustStorePasswordSecretVersion: "{{ trustStorePasswordSecretVersion }}"
        useJndi: {{ useJndi }}
        username: "{{ username }}"
      kafkaConnectionProperties:
        bootstrapServers:
          - host: "{{ host }}"
            port: {{ port }}
            privateIpAddress: "{{ privateIpAddress }}"
        clusterId: "{{ clusterId }}"
        consumerPropertiesFile: "{{ consumerPropertiesFile }}"
        keyStoreFile: "{{ keyStoreFile }}"
        keyStorePassword: "{{ keyStorePassword }}"
        keyStorePasswordSecretVersion: "{{ keyStorePasswordSecretVersion }}"
        password: "{{ password }}"
        passwordSecretVersion: "{{ passwordSecretVersion }}"
        producerPropertiesFile: "{{ producerPropertiesFile }}"
        securityProtocol: "{{ securityProtocol }}"
        sslKeyPassword: "{{ sslKeyPassword }}"
        sslKeyPasswordSecretVersion: "{{ sslKeyPasswordSecretVersion }}"
        streamPoolId: "{{ streamPoolId }}"
        technologyType: "{{ technologyType }}"
        trustStoreFile: "{{ trustStoreFile }}"
        trustStorePassword: "{{ trustStorePassword }}"
        trustStorePasswordSecretVersion: "{{ trustStorePasswordSecretVersion }}"
        useResourcePrincipal: {{ useResourcePrincipal }}
        username: "{{ username }}"
      kafkaSchemaRegistryConnectionProperties:
        authenticationType: "{{ authenticationType }}"
        keyStoreFile: "{{ keyStoreFile }}"
        keyStorePassword: "{{ keyStorePassword }}"
        keyStorePasswordSecretVersion: "{{ keyStorePasswordSecretVersion }}"
        password: "{{ password }}"
        passwordSecretVersion: "{{ passwordSecretVersion }}"
        sslKeyPassword: "{{ sslKeyPassword }}"
        sslKeyPasswordSecretVersion: "{{ sslKeyPasswordSecretVersion }}"
        technologyType: "{{ technologyType }}"
        trustStoreFile: "{{ trustStoreFile }}"
        trustStorePassword: "{{ trustStorePassword }}"
        trustStorePasswordSecretVersion: "{{ trustStorePasswordSecretVersion }}"
        url: "{{ url }}"
        username: "{{ username }}"
      lifecycleDetails: "{{ lifecycleDetails }}"
      lifecycleState: "{{ lifecycleState }}"
      microsoftFabricConnectionProperties:
        clientId: "{{ clientId }}"
        clientSecret: "{{ clientSecret }}"
        endpoint: "{{ endpoint }}"
        technologyType: "{{ technologyType }}"
        tenantId: "{{ tenantId }}"
      microsoftSqlserverConnectionProperties:
        additionalAttributes:
          - key: "{{ key }}"
            value: "{{ value }}"
        database: "{{ database }}"
        host: "{{ host }}"
        password: "{{ password }}"
        passwordSecretVersion: "{{ passwordSecretVersion }}"
        port: {{ port }}
        securityProtocol: "{{ securityProtocol }}"
        serverCertificateValidationRequired: {{ serverCertificateValidationRequired }}
        sslCaFile: "{{ sslCaFile }}"
        technologyType: "{{ technologyType }}"
        username: "{{ username }}"
      mongodbConnectionProperties:
        connectionString: "{{ connectionString }}"
        databaseId: "{{ databaseId }}"
        password: "{{ password }}"
        passwordSecretVersion: "{{ passwordSecretVersion }}"
        securityProtocol: "{{ securityProtocol }}"
        technologyType: "{{ technologyType }}"
        tlsCaFile: "{{ tlsCaFile }}"
        tlsCertificateKeyFile: "{{ tlsCertificateKeyFile }}"
        tlsCertificateKeyFilePassword: "{{ tlsCertificateKeyFilePassword }}"
        tlsCertificateKeyFilePasswordSecretVersion: "{{ tlsCertificateKeyFilePasswordSecretVersion }}"
        username: "{{ username }}"
      mysqlConnectionProperties:
        additionalAttributes:
          - key: "{{ key }}"
            value: "{{ value }}"
        database: "{{ database }}"
        dbSystemId: "{{ dbSystemId }}"
        host: "{{ host }}"
        password: "{{ password }}"
        passwordSecretVersion: "{{ passwordSecretVersion }}"
        port: {{ port }}
        securityProtocol: "{{ securityProtocol }}"
        sslCaFile: "{{ sslCaFile }}"
        sslCertFile: "{{ sslCertFile }}"
        sslCrlFile: "{{ sslCrlFile }}"
        sslKeyFile: "{{ sslKeyFile }}"
        sslMode: "{{ sslMode }}"
        technologyType: "{{ technologyType }}"
        username: "{{ username }}"
      ociObjectStorageConnectionProperties:
        privateKeyFile: "{{ privateKeyFile }}"
        privateKeyPassphraseSecret: "{{ privateKeyPassphraseSecret }}"
        publicKeyFingerprint: "{{ publicKeyFingerprint }}"
        region: "{{ region }}"
        technologyType: "{{ technologyType }}"
        tenancyId: "{{ tenancyId }}"
        useResourcePrincipal: {{ useResourcePrincipal }}
        userId: "{{ userId }}"
      ocid: "{{ ocid }}"
      oracleAiDataPlatformConnectionProperties:
        connectionUrl: "{{ connectionUrl }}"
        privateKeyFile: "{{ privateKeyFile }}"
        privateKeyPassphraseSecret: "{{ privateKeyPassphraseSecret }}"
        publicKeyFingerprint: "{{ publicKeyFingerprint }}"
        region: "{{ region }}"
        technologyType: "{{ technologyType }}"
        tenancyId: "{{ tenancyId }}"
        useResourcePrincipal: {{ useResourcePrincipal }}
        userId: "{{ userId }}"
      oracleConnectionProperties:
        authenticationMode: "{{ authenticationMode }}"
        connectionString: "{{ connectionString }}"
        gcpOracleDatabaseId: "{{ gcpOracleDatabaseId }}"
        password: "{{ password }}"
        passwordSecretVersion: "{{ passwordSecretVersion }}"
        sessionMode: "{{ sessionMode }}"
        technologyType: "{{ technologyType }}"
        username: "{{ username }}"
        walletFile: "{{ walletFile }}"
      oracleNosqlConnectionProperties:
        privateKeyFile: "{{ privateKeyFile }}"
        privateKeyPassphraseSecret: "{{ privateKeyPassphraseSecret }}"
        publicKeyFingerprint: "{{ publicKeyFingerprint }}"
        region: "{{ region }}"
        technologyType: "{{ technologyType }}"
        tenancyId: "{{ tenancyId }}"
        useResourcePrincipal: {{ useResourcePrincipal }}
        userId: "{{ userId }}"
      postgresqlConnectionProperties:
        additionalAttributes:
          - key: "{{ key }}"
            value: "{{ value }}"
        database: "{{ database }}"
        dbSystemId: "{{ dbSystemId }}"
        host: "{{ host }}"
        password: "{{ password }}"
        passwordSecretVersion: "{{ passwordSecretVersion }}"
        port: {{ port }}
        securityProtocol: "{{ securityProtocol }}"
        sslCaFile: "{{ sslCaFile }}"
        sslCertFile: "{{ sslCertFile }}"
        sslCrlFile: "{{ sslCrlFile }}"
        sslKeyFile: "{{ sslKeyFile }}"
        sslMode: "{{ sslMode }}"
        technologyType: "{{ technologyType }}"
        username: "{{ username }}"
      redisConnectionProperties:
        authenticationType: "{{ authenticationType }}"
        keyStoreFile: "{{ keyStoreFile }}"
        keyStorePassword: "{{ keyStorePassword }}"
        keyStorePasswordSecretVersion: "{{ keyStorePasswordSecretVersion }}"
        password: "{{ password }}"
        passwordSecretVersion: "{{ passwordSecretVersion }}"
        redisClusterId: "{{ redisClusterId }}"
        securityProtocol: "{{ securityProtocol }}"
        servers: "{{ servers }}"
        technologyType: "{{ technologyType }}"
        trustStoreFile: "{{ trustStoreFile }}"
        trustStorePassword: "{{ trustStorePassword }}"
        trustStorePasswordSecretVersion: "{{ trustStorePasswordSecretVersion }}"
        username: "{{ username }}"
      routingMethod: "{{ routingMethod }}"
      snowflakeConnectionProperties:
        authenticationType: "{{ authenticationType }}"
        connectionUrl: "{{ connectionUrl }}"
        password: "{{ password }}"
        passwordSecretVersion: "{{ passwordSecretVersion }}"
        privateKeyFile: "{{ privateKeyFile }}"
        privateKeyPassphraseSecret: "{{ privateKeyPassphraseSecret }}"
        technologyType: "{{ technologyType }}"
        username: "{{ username }}"
      updateTime: "{{ updateTime }}"
  - name: goldengateConnectionId
    value: "{{ goldengateConnectionId }}"
  - name: requestId
    value: "{{ requestId }}"

DELETE examples

delete

Deletes a single GoldengateConnection.

DELETE FROM google.oracledatabase.goldengate_connections
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND goldengateConnectionsId = '{{ goldengateConnectionsId }}' --required
AND requestId = '{{ requestId }}'
;