Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. GoldenGate
  5. DatabaseRegistration
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

oci.GoldenGate.DatabaseRegistration

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

    This resource provides the Database Registration resource in Oracle Cloud Infrastructure Golden Gate service.

    Note: Deprecated. Use the /connections API instead. Creates a new DatabaseRegistration.

    Example Usage

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

const testDatabaseRegistration = new oci.goldengate.DatabaseRegistration("test_database_registration", {
    aliasName: databaseRegistrationAliasName,
    compartmentId: compartmentId,
    displayName: databaseRegistrationDisplayName,
    fqdn: databaseRegistrationFqdn,
    password: databaseRegistrationPassword,
    username: databaseRegistrationUsername,
    connectionString: databaseRegistrationConnectionString,
    databaseId: testDatabase.id,
    definedTags: {
        "foo-namespace.bar-key": "value",
    },
    description: databaseRegistrationDescription,
    freeformTags: {
        "bar-key": "value",
    },
    ipAddress: databaseRegistrationIpAddress,
    keyId: testKey.id,
    secretCompartmentId: testCompartment.id,
    sessionMode: databaseRegistrationSessionMode,
    subnetId: testSubnet.id,
    vaultId: testVault.id,
    wallet: databaseRegistrationWallet,
});

    import pulumi
import pulumi_oci as oci

test_database_registration = oci.golden_gate.DatabaseRegistration("test_database_registration",
    alias_name=database_registration_alias_name,
    compartment_id=compartment_id,
    display_name=database_registration_display_name,
    fqdn=database_registration_fqdn,
    password=database_registration_password,
    username=database_registration_username,
    connection_string=database_registration_connection_string,
    database_id=test_database["id"],
    defined_tags={
        "foo-namespace.bar-key": "value",
    },
    description=database_registration_description,
    freeform_tags={
        "bar-key": "value",
    },
    ip_address=database_registration_ip_address,
    key_id=test_key["id"],
    secret_compartment_id=test_compartment["id"],
    session_mode=database_registration_session_mode,
    subnet_id=test_subnet["id"],
    vault_id=test_vault["id"],
    wallet=database_registration_wallet)

    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.NewDatabaseRegistration(ctx, "test_database_registration", &goldengate.DatabaseRegistrationArgs{
			AliasName:        pulumi.Any(databaseRegistrationAliasName),
			CompartmentId:    pulumi.Any(compartmentId),
			DisplayName:      pulumi.Any(databaseRegistrationDisplayName),
			Fqdn:             pulumi.Any(databaseRegistrationFqdn),
			Password:         pulumi.Any(databaseRegistrationPassword),
			Username:         pulumi.Any(databaseRegistrationUsername),
			ConnectionString: pulumi.Any(databaseRegistrationConnectionString),
			DatabaseId:       pulumi.Any(testDatabase.Id),
			DefinedTags: pulumi.StringMap{
				"foo-namespace.bar-key": pulumi.String("value"),
			},
			Description: pulumi.Any(databaseRegistrationDescription),
			FreeformTags: pulumi.StringMap{
				"bar-key": pulumi.String("value"),
			},
			IpAddress:           pulumi.Any(databaseRegistrationIpAddress),
			KeyId:               pulumi.Any(testKey.Id),
			SecretCompartmentId: pulumi.Any(testCompartment.Id),
			SessionMode:         pulumi.Any(databaseRegistrationSessionMode),
			SubnetId:            pulumi.Any(testSubnet.Id),
			VaultId:             pulumi.Any(testVault.Id),
			Wallet:              pulumi.Any(databaseRegistrationWallet),
		})
		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 testDatabaseRegistration = new Oci.GoldenGate.DatabaseRegistration("test_database_registration", new()
    {
        AliasName = databaseRegistrationAliasName,
        CompartmentId = compartmentId,
        DisplayName = databaseRegistrationDisplayName,
        Fqdn = databaseRegistrationFqdn,
        Password = databaseRegistrationPassword,
        Username = databaseRegistrationUsername,
        ConnectionString = databaseRegistrationConnectionString,
        DatabaseId = testDatabase.Id,
        DefinedTags = 
        {
            { "foo-namespace.bar-key", "value" },
        },
        Description = databaseRegistrationDescription,
        FreeformTags = 
        {
            { "bar-key", "value" },
        },
        IpAddress = databaseRegistrationIpAddress,
        KeyId = testKey.Id,
        SecretCompartmentId = testCompartment.Id,
        SessionMode = databaseRegistrationSessionMode,
        SubnetId = testSubnet.Id,
        VaultId = testVault.Id,
        Wallet = databaseRegistrationWallet,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.GoldenGate.DatabaseRegistration;
import com.pulumi.oci.GoldenGate.DatabaseRegistrationArgs;
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) {
        var testDatabaseRegistration = new DatabaseRegistration("testDatabaseRegistration", DatabaseRegistrationArgs.builder()
            .aliasName(databaseRegistrationAliasName)
            .compartmentId(compartmentId)
            .displayName(databaseRegistrationDisplayName)
            .fqdn(databaseRegistrationFqdn)
            .password(databaseRegistrationPassword)
            .username(databaseRegistrationUsername)
            .connectionString(databaseRegistrationConnectionString)
            .databaseId(testDatabase.id())
            .definedTags(Map.of("foo-namespace.bar-key", "value"))
            .description(databaseRegistrationDescription)
            .freeformTags(Map.of("bar-key", "value"))
            .ipAddress(databaseRegistrationIpAddress)
            .keyId(testKey.id())
            .secretCompartmentId(testCompartment.id())
            .sessionMode(databaseRegistrationSessionMode)
            .subnetId(testSubnet.id())
            .vaultId(testVault.id())
            .wallet(databaseRegistrationWallet)
            .build());

    }
}

    resources:
  testDatabaseRegistration:
    type: oci:GoldenGate:DatabaseRegistration
    name: test_database_registration
    properties:
      aliasName: ${databaseRegistrationAliasName}
      compartmentId: ${compartmentId}
      displayName: ${databaseRegistrationDisplayName}
      fqdn: ${databaseRegistrationFqdn}
      password: ${databaseRegistrationPassword}
      username: ${databaseRegistrationUsername}
      connectionString: ${databaseRegistrationConnectionString}
      databaseId: ${testDatabase.id}
      definedTags:
        foo-namespace.bar-key: value
      description: ${databaseRegistrationDescription}
      freeformTags:
        bar-key: value
      ipAddress: ${databaseRegistrationIpAddress}
      keyId: ${testKey.id}
      secretCompartmentId: ${testCompartment.id}
      sessionMode: ${databaseRegistrationSessionMode}
      subnetId: ${testSubnet.id}
      vaultId: ${testVault.id}
      wallet: ${databaseRegistrationWallet}

    Create DatabaseRegistration Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new DatabaseRegistration(name: string, args: DatabaseRegistrationArgs, opts?: CustomResourceOptions);
    @overload
def DatabaseRegistration(resource_name: str,
                         args: DatabaseRegistrationArgs,
                         opts: Optional[ResourceOptions] = None)

@overload
def DatabaseRegistration(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         display_name: Optional[str] = None,
                         compartment_id: Optional[str] = None,
                         username: Optional[str] = None,
                         password: Optional[str] = None,
                         alias_name: Optional[str] = None,
                         fqdn: Optional[str] = None,
                         freeform_tags: Optional[Mapping[str, str]] = None,
                         description: Optional[str] = None,
                         defined_tags: Optional[Mapping[str, str]] = None,
                         ip_address: Optional[str] = None,
                         key_id: Optional[str] = None,
                         database_id: Optional[str] = None,
                         secret_compartment_id: Optional[str] = None,
                         session_mode: Optional[str] = None,
                         subnet_id: Optional[str] = None,
                         connection_string: Optional[str] = None,
                         vault_id: Optional[str] = None,
                         wallet: Optional[str] = None)
    func NewDatabaseRegistration(ctx *Context, name string, args DatabaseRegistrationArgs, opts ...ResourceOption) (*DatabaseRegistration, error)
    public DatabaseRegistration(string name, DatabaseRegistrationArgs args, CustomResourceOptions? opts = null)
    public DatabaseRegistration(String name, DatabaseRegistrationArgs args)
public DatabaseRegistration(String name, DatabaseRegistrationArgs args, CustomResourceOptions options)

    type: oci:GoldenGate:DatabaseRegistration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args DatabaseRegistrationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DatabaseRegistrationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DatabaseRegistrationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DatabaseRegistrationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DatabaseRegistrationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var databaseRegistrationResource = new Oci.GoldenGate.DatabaseRegistration("databaseRegistrationResource", new()
{
    DisplayName = "string",
    CompartmentId = "string",
    Username = "string",
    Password = "string",
    AliasName = "string",
    Fqdn = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    Description = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    IpAddress = "string",
    KeyId = "string",
    DatabaseId = "string",
    SecretCompartmentId = "string",
    SessionMode = "string",
    SubnetId = "string",
    ConnectionString = "string",
    VaultId = "string",
    Wallet = "string",
});

    example, err := goldengate.NewDatabaseRegistration(ctx, "databaseRegistrationResource", &goldengate.DatabaseRegistrationArgs{
	DisplayName:   pulumi.String("string"),
	CompartmentId: pulumi.String("string"),
	Username:      pulumi.String("string"),
	Password:      pulumi.String("string"),
	AliasName:     pulumi.String("string"),
	Fqdn:          pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	IpAddress:           pulumi.String("string"),
	KeyId:               pulumi.String("string"),
	DatabaseId:          pulumi.String("string"),
	SecretCompartmentId: pulumi.String("string"),
	SessionMode:         pulumi.String("string"),
	SubnetId:            pulumi.String("string"),
	ConnectionString:    pulumi.String("string"),
	VaultId:             pulumi.String("string"),
	Wallet:              pulumi.String("string"),
})

    var databaseRegistrationResource = new DatabaseRegistration("databaseRegistrationResource", DatabaseRegistrationArgs.builder()
    .displayName("string")
    .compartmentId("string")
    .username("string")
    .password("string")
    .aliasName("string")
    .fqdn("string")
    .freeformTags(Map.of("string", "string"))
    .description("string")
    .definedTags(Map.of("string", "string"))
    .ipAddress("string")
    .keyId("string")
    .databaseId("string")
    .secretCompartmentId("string")
    .sessionMode("string")
    .subnetId("string")
    .connectionString("string")
    .vaultId("string")
    .wallet("string")
    .build());

    database_registration_resource = oci.golden_gate.DatabaseRegistration("databaseRegistrationResource",
    display_name="string",
    compartment_id="string",
    username="string",
    password="string",
    alias_name="string",
    fqdn="string",
    freeform_tags={
        "string": "string",
    },
    description="string",
    defined_tags={
        "string": "string",
    },
    ip_address="string",
    key_id="string",
    database_id="string",
    secret_compartment_id="string",
    session_mode="string",
    subnet_id="string",
    connection_string="string",
    vault_id="string",
    wallet="string")

    const databaseRegistrationResource = new oci.goldengate.DatabaseRegistration("databaseRegistrationResource", {
    displayName: "string",
    compartmentId: "string",
    username: "string",
    password: "string",
    aliasName: "string",
    fqdn: "string",
    freeformTags: {
        string: "string",
    },
    description: "string",
    definedTags: {
        string: "string",
    },
    ipAddress: "string",
    keyId: "string",
    databaseId: "string",
    secretCompartmentId: "string",
    sessionMode: "string",
    subnetId: "string",
    connectionString: "string",
    vaultId: "string",
    wallet: "string",
});

    type: oci:GoldenGate:DatabaseRegistration
properties:
    aliasName: string
    compartmentId: string
    connectionString: string
    databaseId: string
    definedTags:
        string: string
    description: string
    displayName: string
    fqdn: string
    freeformTags:
        string: string
    ipAddress: string
    keyId: string
    password: string
    secretCompartmentId: string
    sessionMode: string
    subnetId: string
    username: string
    vaultId: string
    wallet: string

    DatabaseRegistration Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The DatabaseRegistration resource accepts the following input properties:

    AliasName string
    (Updatable) Credential store alias.
    CompartmentId string
    (Updatable) The OCID of the compartment being referenced.
    DisplayName string
    (Updatable) An object's Display Name.
    Fqdn string
    (Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
    Password string
    (Updatable) 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. Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
    Username string
    (Updatable) 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.
    ConnectionString string
    (Updatable) Connect descriptor or Easy Connect Naming method used to connect to a database.
    DatabaseId string
    The OCID of the database being referenced.
    DefinedTags Dictionary<string, string>
    (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    (Updatable) Metadata about this specific object.
    FreeformTags Dictionary<string, string>
    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    IpAddress string
    The private IP address in the customer's VCN of the customer's endpoint, typically a database.
    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.
    SecretCompartmentId string
    The OCID of the compartment where the GoldenGate Secret will be created. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
    SessionMode string
    (Updatable) 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.
    SubnetId string
    The OCID of the target subnet of the dedicated connection.
    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

    (Updatable) The wallet contents Oracle GoldenGate uses to make connections to a database. This attribute is expected to be base64 encoded. Deprecated: This field is deprecated and replaced by "walletSecretId". This field will be removed after February 15 2026.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    AliasName string
    (Updatable) Credential store alias.
    CompartmentId string
    (Updatable) The OCID of the compartment being referenced.
    DisplayName string
    (Updatable) An object's Display Name.
    Fqdn string
    (Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
    Password string
    (Updatable) 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. Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
    Username string
    (Updatable) 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.
    ConnectionString string
    (Updatable) Connect descriptor or Easy Connect Naming method used to connect to a database.
    DatabaseId string
    The OCID of the database being referenced.
    DefinedTags map[string]string
    (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    (Updatable) Metadata about this specific object.
    FreeformTags map[string]string
    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    IpAddress string
    The private IP address in the customer's VCN of the customer's endpoint, typically a database.
    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.
    SecretCompartmentId string
    The OCID of the compartment where the GoldenGate Secret will be created. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
    SessionMode string
    (Updatable) 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.
    SubnetId string
    The OCID of the target subnet of the dedicated connection.
    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

    (Updatable) The wallet contents Oracle GoldenGate uses to make connections to a database. This attribute is expected to be base64 encoded. Deprecated: This field is deprecated and replaced by "walletSecretId". This field will be removed after February 15 2026.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    aliasName String
    (Updatable) Credential store alias.
    compartmentId String
    (Updatable) The OCID of the compartment being referenced.
    displayName String
    (Updatable) An object's Display Name.
    fqdn String
    (Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
    password String
    (Updatable) 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. Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
    username String
    (Updatable) 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.
    connectionString String
    (Updatable) Connect descriptor or Easy Connect Naming method used to connect to a database.
    databaseId String
    The OCID of the database being referenced.
    definedTags Map<String,String>
    (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    (Updatable) Metadata about this specific object.
    freeformTags Map<String,String>
    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    ipAddress String
    The private IP address in the customer's VCN of the customer's endpoint, typically a database.
    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.
    secretCompartmentId String
    The OCID of the compartment where the GoldenGate Secret will be created. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
    sessionMode String
    (Updatable) 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.
    subnetId String
    The OCID of the target subnet of the dedicated connection.
    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

    (Updatable) The wallet contents Oracle GoldenGate uses to make connections to a database. This attribute is expected to be base64 encoded. Deprecated: This field is deprecated and replaced by "walletSecretId". This field will be removed after February 15 2026.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    aliasName string
    (Updatable) Credential store alias.
    compartmentId string
    (Updatable) The OCID of the compartment being referenced.
    displayName string
    (Updatable) An object's Display Name.
    fqdn string
    (Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
    password string
    (Updatable) 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. Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
    username string
    (Updatable) 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.
    connectionString string
    (Updatable) Connect descriptor or Easy Connect Naming method used to connect to a database.
    databaseId string
    The OCID of the database being referenced.
    definedTags {[key: string]: string}
    (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description string
    (Updatable) Metadata about this specific object.
    freeformTags {[key: string]: string}
    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    ipAddress string
    The private IP address in the customer's VCN of the customer's endpoint, typically a database.
    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.
    secretCompartmentId string
    The OCID of the compartment where the GoldenGate Secret will be created. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
    sessionMode string
    (Updatable) 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.
    subnetId string
    The OCID of the target subnet of the dedicated connection.
    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

    (Updatable) The wallet contents Oracle GoldenGate uses to make connections to a database. This attribute is expected to be base64 encoded. Deprecated: This field is deprecated and replaced by "walletSecretId". This field will be removed after February 15 2026.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    alias_name str
    (Updatable) Credential store alias.
    compartment_id str
    (Updatable) The OCID of the compartment being referenced.
    display_name str
    (Updatable) An object's Display Name.
    fqdn str
    (Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
    password str
    (Updatable) 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. Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
    username str
    (Updatable) 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.
    connection_string str
    (Updatable) Connect descriptor or Easy Connect Naming method used to connect to a database.
    database_id str
    The OCID of the database being referenced.
    defined_tags Mapping[str, str]
    (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description str
    (Updatable) Metadata about this specific object.
    freeform_tags Mapping[str, str]
    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    ip_address str
    The private IP address in the customer's VCN of the customer's endpoint, typically a database.
    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.
    secret_compartment_id str
    The OCID of the compartment where the GoldenGate Secret will be created. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
    session_mode str
    (Updatable) 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.
    subnet_id str
    The OCID of the target subnet of the dedicated connection.
    vault_id str
    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 str

    (Updatable) The wallet contents Oracle GoldenGate uses to make connections to a database. This attribute is expected to be base64 encoded. Deprecated: This field is deprecated and replaced by "walletSecretId". This field will be removed after February 15 2026.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    aliasName String
    (Updatable) Credential store alias.
    compartmentId String
    (Updatable) The OCID of the compartment being referenced.
    displayName String
    (Updatable) An object's Display Name.
    fqdn String
    (Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
    password String
    (Updatable) 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. Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
    username String
    (Updatable) 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.
    connectionString String
    (Updatable) Connect descriptor or Easy Connect Naming method used to connect to a database.
    databaseId String
    The OCID of the database being referenced.
    definedTags Map<String>
    (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    (Updatable) Metadata about this specific object.
    freeformTags Map<String>
    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    ipAddress String
    The private IP address in the customer's VCN of the customer's endpoint, typically a database.
    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.
    secretCompartmentId String
    The OCID of the compartment where the GoldenGate Secret will be created. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
    sessionMode String
    (Updatable) 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.
    subnetId String
    The OCID of the target subnet of the dedicated connection.
    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

    (Updatable) The wallet contents Oracle GoldenGate uses to make connections to a database. This attribute is expected to be base64 encoded. Deprecated: This field is deprecated and replaced by "walletSecretId". This field will be removed after February 15 2026.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DatabaseRegistration resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    RcePrivateIp string
    A Private Endpoint IP address created in the customer's subnet. A customer database can expect network traffic initiated by GoldenGate Service from this IP address. It can also send network traffic to this IP address, typically in response to requests from GoldenGate Service. The customer may use this IP address in Security Lists or Network Security Groups (NSG) as needed.
    SecretId string
    The OCID of the customer's GoldenGate Service Secret. If provided, it references a key that customers will be required to ensure the policies are established to permit GoldenGate to use this Secret.
    State string
    Possible lifecycle states.
    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}}
    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    RcePrivateIp string
    A Private Endpoint IP address created in the customer's subnet. A customer database can expect network traffic initiated by GoldenGate Service from this IP address. It can also send network traffic to this IP address, typically in response to requests from GoldenGate Service. The customer may use this IP address in Security Lists or Network Security Groups (NSG) as needed.
    SecretId string
    The OCID of the customer's GoldenGate Service Secret. If provided, it references a key that customers will be required to ensure the policies are established to permit GoldenGate to use this Secret.
    State string
    Possible lifecycle states.
    SystemTags map[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}}
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    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.
    rcePrivateIp String
    A Private Endpoint IP address created in the customer's subnet. A customer database can expect network traffic initiated by GoldenGate Service from this IP address. It can also send network traffic to this IP address, typically in response to requests from GoldenGate Service. The customer may use this IP address in Security Lists or Network Security Groups (NSG) as needed.
    secretId String
    The OCID of the customer's GoldenGate Service Secret. If provided, it references a key that customers will be required to ensure the policies are established to permit GoldenGate to use this Secret.
    state String
    Possible lifecycle states.
    systemTags Map<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}}
    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.
    id string
    The provider-assigned unique ID for this managed resource.
    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.
    rcePrivateIp string
    A Private Endpoint IP address created in the customer's subnet. A customer database can expect network traffic initiated by GoldenGate Service from this IP address. It can also send network traffic to this IP address, typically in response to requests from GoldenGate Service. The customer may use this IP address in Security Lists or Network Security Groups (NSG) as needed.
    secretId string
    The OCID of the customer's GoldenGate Service Secret. If provided, it references a key that customers will be required to ensure the policies are established to permit GoldenGate to use this Secret.
    state string
    Possible lifecycle states.
    systemTags {[key: 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}}
    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.
    id str
    The provider-assigned unique ID for this managed resource.
    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.
    rce_private_ip str
    A Private Endpoint IP address created in the customer's subnet. A customer database can expect network traffic initiated by GoldenGate Service from this IP address. It can also send network traffic to this IP address, typically in response to requests from GoldenGate Service. The customer may use this IP address in Security Lists or Network Security Groups (NSG) as needed.
    secret_id str
    The OCID of the customer's GoldenGate Service Secret. If provided, it references a key that customers will be required to ensure the policies are established to permit GoldenGate to use this Secret.
    state str
    Possible lifecycle states.
    system_tags Mapping[str, str]
    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}}
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    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.
    rcePrivateIp String
    A Private Endpoint IP address created in the customer's subnet. A customer database can expect network traffic initiated by GoldenGate Service from this IP address. It can also send network traffic to this IP address, typically in response to requests from GoldenGate Service. The customer may use this IP address in Security Lists or Network Security Groups (NSG) as needed.
    secretId String
    The OCID of the customer's GoldenGate Service Secret. If provided, it references a key that customers will be required to ensure the policies are established to permit GoldenGate to use this Secret.
    state String
    Possible lifecycle states.
    systemTags Map<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}}
    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.

    Look up Existing DatabaseRegistration Resource

    Get an existing DatabaseRegistration resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: DatabaseRegistrationState, opts?: CustomResourceOptions): DatabaseRegistration
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        alias_name: Optional[str] = None,
        compartment_id: Optional[str] = None,
        connection_string: Optional[str] = None,
        database_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        fqdn: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        ip_address: Optional[str] = None,
        key_id: Optional[str] = None,
        lifecycle_details: Optional[str] = None,
        password: Optional[str] = None,
        rce_private_ip: Optional[str] = None,
        secret_compartment_id: Optional[str] = None,
        secret_id: Optional[str] = None,
        session_mode: Optional[str] = None,
        state: Optional[str] = None,
        subnet_id: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None,
        username: Optional[str] = None,
        vault_id: Optional[str] = None,
        wallet: Optional[str] = None) -> DatabaseRegistration
    func GetDatabaseRegistration(ctx *Context, name string, id IDInput, state *DatabaseRegistrationState, opts ...ResourceOption) (*DatabaseRegistration, error)
    public static DatabaseRegistration Get(string name, Input<string> id, DatabaseRegistrationState? state, CustomResourceOptions? opts = null)
    public static DatabaseRegistration get(String name, Output<String> id, DatabaseRegistrationState state, CustomResourceOptions options)
    resources:  _:    type: oci:GoldenGate:DatabaseRegistration    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AliasName string
    (Updatable) Credential store alias.
    CompartmentId string
    (Updatable) The OCID of the compartment being referenced.
    ConnectionString string
    (Updatable) Connect descriptor or Easy Connect Naming method used to connect to a database.
    DatabaseId string
    The OCID of the database being referenced.
    DefinedTags Dictionary<string, string>
    (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    (Updatable) Metadata about this specific object.
    DisplayName string
    (Updatable) An object's Display Name.
    Fqdn string
    (Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
    FreeformTags Dictionary<string, string>
    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    IpAddress string
    The private IP address in the customer's VCN of the customer's endpoint, typically a database.
    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.
    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.
    Password string
    (Updatable) 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. Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
    RcePrivateIp string
    A Private Endpoint IP address created in the customer's subnet. A customer database can expect network traffic initiated by GoldenGate Service from this IP address. It can also send network traffic to this IP address, typically in response to requests from GoldenGate Service. The customer may use this IP address in Security Lists or Network Security Groups (NSG) as needed.
    SecretCompartmentId string
    The OCID of the compartment where the GoldenGate Secret will be created. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
    SecretId string
    The OCID of the customer's GoldenGate Service Secret. If provided, it references a key that customers will be required to ensure the policies are established to permit GoldenGate to use this Secret.
    SessionMode string
    (Updatable) 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.
    State string
    Possible lifecycle states.
    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}}
    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.
    Username string
    (Updatable) 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

    (Updatable) The wallet contents Oracle GoldenGate uses to make connections to a database. This attribute is expected to be base64 encoded. Deprecated: This field is deprecated and replaced by "walletSecretId". This field will be removed after February 15 2026.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    AliasName string
    (Updatable) Credential store alias.
    CompartmentId string
    (Updatable) The OCID of the compartment being referenced.
    ConnectionString string
    (Updatable) Connect descriptor or Easy Connect Naming method used to connect to a database.
    DatabaseId string
    The OCID of the database being referenced.
    DefinedTags map[string]string
    (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    (Updatable) Metadata about this specific object.
    DisplayName string
    (Updatable) An object's Display Name.
    Fqdn string
    (Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
    FreeformTags map[string]string
    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    IpAddress string
    The private IP address in the customer's VCN of the customer's endpoint, typically a database.
    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.
    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.
    Password string
    (Updatable) 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. Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
    RcePrivateIp string
    A Private Endpoint IP address created in the customer's subnet. A customer database can expect network traffic initiated by GoldenGate Service from this IP address. It can also send network traffic to this IP address, typically in response to requests from GoldenGate Service. The customer may use this IP address in Security Lists or Network Security Groups (NSG) as needed.
    SecretCompartmentId string
    The OCID of the compartment where the GoldenGate Secret will be created. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
    SecretId string
    The OCID of the customer's GoldenGate Service Secret. If provided, it references a key that customers will be required to ensure the policies are established to permit GoldenGate to use this Secret.
    SessionMode string
    (Updatable) 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.
    State string
    Possible lifecycle states.
    SubnetId string
    The OCID of the target subnet of the dedicated connection.
    SystemTags map[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}}
    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.
    Username string
    (Updatable) 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

    (Updatable) The wallet contents Oracle GoldenGate uses to make connections to a database. This attribute is expected to be base64 encoded. Deprecated: This field is deprecated and replaced by "walletSecretId". This field will be removed after February 15 2026.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    aliasName String
    (Updatable) Credential store alias.
    compartmentId String
    (Updatable) The OCID of the compartment being referenced.
    connectionString String
    (Updatable) Connect descriptor or Easy Connect Naming method used to connect to a database.
    databaseId String
    The OCID of the database being referenced.
    definedTags Map<String,String>
    (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    (Updatable) Metadata about this specific object.
    displayName String
    (Updatable) An object's Display Name.
    fqdn String
    (Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
    freeformTags Map<String,String>
    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    ipAddress String
    The private IP address in the customer's VCN of the customer's endpoint, typically a database.
    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.
    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.
    password String
    (Updatable) 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. Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
    rcePrivateIp String
    A Private Endpoint IP address created in the customer's subnet. A customer database can expect network traffic initiated by GoldenGate Service from this IP address. It can also send network traffic to this IP address, typically in response to requests from GoldenGate Service. The customer may use this IP address in Security Lists or Network Security Groups (NSG) as needed.
    secretCompartmentId String
    The OCID of the compartment where the GoldenGate Secret will be created. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
    secretId String
    The OCID of the customer's GoldenGate Service Secret. If provided, it references a key that customers will be required to ensure the policies are established to permit GoldenGate to use this Secret.
    sessionMode String
    (Updatable) 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.
    state String
    Possible lifecycle states.
    subnetId String
    The OCID of the target subnet of the dedicated connection.
    systemTags Map<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}}
    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.
    username String
    (Updatable) 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

    (Updatable) The wallet contents Oracle GoldenGate uses to make connections to a database. This attribute is expected to be base64 encoded. Deprecated: This field is deprecated and replaced by "walletSecretId". This field will be removed after February 15 2026.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    aliasName string
    (Updatable) Credential store alias.
    compartmentId string
    (Updatable) The OCID of the compartment being referenced.
    connectionString string
    (Updatable) Connect descriptor or Easy Connect Naming method used to connect to a database.
    databaseId string
    The OCID of the database being referenced.
    definedTags {[key: string]: string}
    (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description string
    (Updatable) Metadata about this specific object.
    displayName string
    (Updatable) An object's Display Name.
    fqdn string
    (Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
    freeformTags {[key: string]: string}
    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    ipAddress string
    The private IP address in the customer's VCN of the customer's endpoint, typically a database.
    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.
    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.
    password string
    (Updatable) 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. Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
    rcePrivateIp string
    A Private Endpoint IP address created in the customer's subnet. A customer database can expect network traffic initiated by GoldenGate Service from this IP address. It can also send network traffic to this IP address, typically in response to requests from GoldenGate Service. The customer may use this IP address in Security Lists or Network Security Groups (NSG) as needed.
    secretCompartmentId string
    The OCID of the compartment where the GoldenGate Secret will be created. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
    secretId string
    The OCID of the customer's GoldenGate Service Secret. If provided, it references a key that customers will be required to ensure the policies are established to permit GoldenGate to use this Secret.
    sessionMode string
    (Updatable) 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.
    state string
    Possible lifecycle states.
    subnetId string
    The OCID of the target subnet of the dedicated connection.
    systemTags {[key: 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}}
    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.
    username string
    (Updatable) 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

    (Updatable) The wallet contents Oracle GoldenGate uses to make connections to a database. This attribute is expected to be base64 encoded. Deprecated: This field is deprecated and replaced by "walletSecretId". This field will be removed after February 15 2026.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    alias_name str
    (Updatable) Credential store alias.
    compartment_id str
    (Updatable) The OCID of the compartment being referenced.
    connection_string str
    (Updatable) Connect descriptor or Easy Connect Naming method used to connect to a database.
    database_id str
    The OCID of the database being referenced.
    defined_tags Mapping[str, str]
    (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description str
    (Updatable) Metadata about this specific object.
    display_name str
    (Updatable) An object's Display Name.
    fqdn str
    (Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
    freeform_tags Mapping[str, str]
    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    ip_address str
    The private IP address in the customer's VCN of the customer's endpoint, typically a database.
    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.
    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.
    password str
    (Updatable) 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. Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
    rce_private_ip str
    A Private Endpoint IP address created in the customer's subnet. A customer database can expect network traffic initiated by GoldenGate Service from this IP address. It can also send network traffic to this IP address, typically in response to requests from GoldenGate Service. The customer may use this IP address in Security Lists or Network Security Groups (NSG) as needed.
    secret_compartment_id str
    The OCID of the compartment where the GoldenGate Secret will be created. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
    secret_id str
    The OCID of the customer's GoldenGate Service Secret. If provided, it references a key that customers will be required to ensure the policies are established to permit GoldenGate to use this Secret.
    session_mode str
    (Updatable) 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.
    state str
    Possible lifecycle states.
    subnet_id str
    The OCID of the target subnet of the dedicated connection.
    system_tags Mapping[str, str]
    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}}
    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.
    username str
    (Updatable) The username Oracle GoldenGate uses to connect the associated system of the given technology. This username must already exist and be available by the system/application to be connected to and must conform to the case sensitivty requirments defined in it.
    vault_id str
    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 str

    (Updatable) The wallet contents Oracle GoldenGate uses to make connections to a database. This attribute is expected to be base64 encoded. Deprecated: This field is deprecated and replaced by "walletSecretId". This field will be removed after February 15 2026.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    aliasName String
    (Updatable) Credential store alias.
    compartmentId String
    (Updatable) The OCID of the compartment being referenced.
    connectionString String
    (Updatable) Connect descriptor or Easy Connect Naming method used to connect to a database.
    databaseId String
    The OCID of the database being referenced.
    definedTags Map<String>
    (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    (Updatable) Metadata about this specific object.
    displayName String
    (Updatable) An object's Display Name.
    fqdn String
    (Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
    freeformTags Map<String>
    (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    ipAddress String
    The private IP address in the customer's VCN of the customer's endpoint, typically a database.
    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.
    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.
    password String
    (Updatable) 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. Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.
    rcePrivateIp String
    A Private Endpoint IP address created in the customer's subnet. A customer database can expect network traffic initiated by GoldenGate Service from this IP address. It can also send network traffic to this IP address, typically in response to requests from GoldenGate Service. The customer may use this IP address in Security Lists or Network Security Groups (NSG) as needed.
    secretCompartmentId String
    The OCID of the compartment where the GoldenGate Secret will be created. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
    secretId String
    The OCID of the customer's GoldenGate Service Secret. If provided, it references a key that customers will be required to ensure the policies are established to permit GoldenGate to use this Secret.
    sessionMode String
    (Updatable) 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.
    state String
    Possible lifecycle states.
    subnetId String
    The OCID of the target subnet of the dedicated connection.
    systemTags Map<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}}
    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.
    username String
    (Updatable) 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

    (Updatable) The wallet contents Oracle GoldenGate uses to make connections to a database. This attribute is expected to be base64 encoded. Deprecated: This field is deprecated and replaced by "walletSecretId". This field will be removed after February 15 2026.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Import

    DatabaseRegistrations can be imported using the id, e.g.

    $ pulumi import oci:GoldenGate/databaseRegistration:DatabaseRegistration test_database_registration "id"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
    pulumi/pulumi-oci