Oracle Cloud Infrastructure

v0.5.0 published on Monday, Sep 12, 2022 by Pulumi

getDatabaseRegistration

This data source provides details about a specific Database Registration resource in Oracle Cloud Infrastructure Golden Gate service.

Retrieves a DatabaseRegistration.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var testDatabaseRegistration = Oci.GoldenGate.GetDatabaseRegistration.Invoke(new()
    {
        DatabaseRegistrationId = oci_golden_gate_database_registration.Test_database_registration.Id,
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := GoldenGate.GetDatabaseRegistration(ctx, &goldengate.GetDatabaseRegistrationArgs{
			DatabaseRegistrationId: oci_golden_gate_database_registration.Test_database_registration.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

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

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

    public static void stack(Context ctx) {
        final var testDatabaseRegistration = GoldenGateFunctions.getDatabaseRegistration(GetDatabaseRegistrationArgs.builder()
            .databaseRegistrationId(oci_golden_gate_database_registration.test_database_registration().id())
            .build());

    }
}

import pulumi
import pulumi_oci as oci

test_database_registration = oci.GoldenGate.get_database_registration(database_registration_id=oci_golden_gate_database_registration["test_database_registration"]["id"])

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

const testDatabaseRegistration = oci.GoldenGate.getDatabaseRegistration({
    databaseRegistrationId: oci_golden_gate_database_registration.test_database_registration.id,
});

variables:
  testDatabaseRegistration:
    Fn::Invoke:
      Function: oci:GoldenGate:getDatabaseRegistration
      Arguments:
        databaseRegistrationId: ${oci_golden_gate_database_registration.test_database_registration.id}

Using getDatabaseRegistration

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDatabaseRegistration(args: GetDatabaseRegistrationArgs, opts?: InvokeOptions): Promise<GetDatabaseRegistrationResult>
function getDatabaseRegistrationOutput(args: GetDatabaseRegistrationOutputArgs, opts?: InvokeOptions): Output<GetDatabaseRegistrationResult>

def get_database_registration(database_registration_id: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetDatabaseRegistrationResult
def get_database_registration_output(database_registration_id: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetDatabaseRegistrationResult]

func GetDatabaseRegistration(ctx *Context, args *GetDatabaseRegistrationArgs, opts ...InvokeOption) (*GetDatabaseRegistrationResult, error)
func GetDatabaseRegistrationOutput(ctx *Context, args *GetDatabaseRegistrationOutputArgs, opts ...InvokeOption) GetDatabaseRegistrationResultOutput

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

public static class GetDatabaseRegistration 
{
    public static Task<GetDatabaseRegistrationResult> InvokeAsync(GetDatabaseRegistrationArgs args, InvokeOptions? opts = null)
    public static Output<GetDatabaseRegistrationResult> Invoke(GetDatabaseRegistrationInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDatabaseRegistrationResult> getDatabaseRegistration(GetDatabaseRegistrationArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

The following arguments are supported:

DatabaseRegistrationId string: A unique DatabaseRegistration identifier.

DatabaseRegistrationId string: A unique DatabaseRegistration identifier.

databaseRegistrationId String: A unique DatabaseRegistration identifier.

databaseRegistrationId string: A unique DatabaseRegistration identifier.

database_registration_id str: A unique DatabaseRegistration identifier.

databaseRegistrationId String: A unique DatabaseRegistration identifier.

getDatabaseRegistration Result

The following output properties are available:

AliasName string: Credential store alias.
CompartmentId string: The OCID of the compartment being referenced.
ConnectionString string: Connect descriptor or Easy Connect Naming method that Oracle GoldenGate uses to connect to a database.
DatabaseId string: The OCID of the database being referenced.
DatabaseRegistrationId string
DefinedTags Dictionary<string, object>: Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
Description string: Metadata about this specific object.
DisplayName string: An object's Display Name.
Fqdn string: A three-label Fully Qualified Domain Name (FQDN) for a resource.
FreeformTags Dictionary<string, object>: A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id string: The OCID of the databaseRegistration being referenced.
IpAddress string: The private IP address in the customer's VCN of the customer's endpoint, typically a database.
KeyId string: The OCID of the customer "Master" key being referenced. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this key to manage secrets.
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
RcePrivateIp string: A Private Endpoint IP Address created in the customer's subnet. A customer database can expect network traffic initiated by GGS from this IP address and send network traffic to this IP address, typically in response to requests from GGS (OGG). The customer may utilize this IP address in Security Lists or Network Security Groups (NSG) as needed.
SecretCompartmentId string: The OCID of the compartment where the the GGS Secret will be created. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this Compartment in which to create a Secret.
SecretId string: The OCID of the customer GGS Secret being referenced. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this Secret
SessionMode string: The mode of the database connection session to be established by the data client. REDIRECT - for a RAC database, DIRECT - for a non-RAC database. Connection to a RAC database involves a redirection received from the SCAN listeners to the database node to connect to. By default the mode would be DIRECT.
State string: Possible lifecycle states.
SubnetId string: The OCID of the subnet being referenced.
SystemTags Dictionary<string, object>: 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: The username Oracle GoldenGate uses to connect the associated RDBMS. This username must already exist and be available for use by the database. It must conform to the security requirements implemented by the database including length, case sensitivity, and so on.
VaultId string: The OCID of the customer vault being referenced. If provided, this will reference a vault which the customer will be required to ensure the policies are established to permit the GoldenGate Service to manage secrets contained within this vault.
Wallet string

AliasName string: Credential store alias.
CompartmentId string: The OCID of the compartment being referenced.
ConnectionString string: Connect descriptor or Easy Connect Naming method that Oracle GoldenGate uses to connect to a database.
DatabaseId string: The OCID of the database being referenced.
DatabaseRegistrationId string
DefinedTags map[string]interface{}: Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
Description string: Metadata about this specific object.
DisplayName string: An object's Display Name.
Fqdn string: A three-label Fully Qualified Domain Name (FQDN) for a resource.
FreeformTags map[string]interface{}: A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id string: The OCID of the databaseRegistration being referenced.
IpAddress string: The private IP address in the customer's VCN of the customer's endpoint, typically a database.
KeyId string: The OCID of the customer "Master" key being referenced. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this key to manage secrets.
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
RcePrivateIp string: A Private Endpoint IP Address created in the customer's subnet. A customer database can expect network traffic initiated by GGS from this IP address and send network traffic to this IP address, typically in response to requests from GGS (OGG). The customer may utilize this IP address in Security Lists or Network Security Groups (NSG) as needed.
SecretCompartmentId string: The OCID of the compartment where the the GGS Secret will be created. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this Compartment in which to create a Secret.
SecretId string: The OCID of the customer GGS Secret being referenced. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this Secret
SessionMode string: The mode of the database connection session to be established by the data client. REDIRECT - for a RAC database, DIRECT - for a non-RAC database. Connection to a RAC database involves a redirection received from the SCAN listeners to the database node to connect to. By default the mode would be DIRECT.
State string: Possible lifecycle states.
SubnetId string: The OCID of the subnet being referenced.
SystemTags map[string]interface{}: 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: The username Oracle GoldenGate uses to connect the associated RDBMS. This username must already exist and be available for use by the database. It must conform to the security requirements implemented by the database including length, case sensitivity, and so on.
VaultId string: The OCID of the customer vault being referenced. If provided, this will reference a vault which the customer will be required to ensure the policies are established to permit the GoldenGate Service to manage secrets contained within this vault.
Wallet string

aliasName String: Credential store alias.
compartmentId String: The OCID of the compartment being referenced.
connectionString String: Connect descriptor or Easy Connect Naming method that Oracle GoldenGate uses to connect to a database.
databaseId String: The OCID of the database being referenced.
databaseRegistrationId String
definedTags Map<String,Object>: Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description String: Metadata about this specific object.
displayName String: An object's Display Name.
fqdn String: A three-label Fully Qualified Domain Name (FQDN) for a resource.
freeformTags Map<String,Object>: A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id String: The OCID of the databaseRegistration being referenced.
ipAddress String: The private IP address in the customer's VCN of the customer's endpoint, typically a database.
keyId String: The OCID of the customer "Master" key being referenced. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this key to manage secrets.
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
rcePrivateIp String: A Private Endpoint IP Address created in the customer's subnet. A customer database can expect network traffic initiated by GGS from this IP address and send network traffic to this IP address, typically in response to requests from GGS (OGG). The customer may utilize this IP address in Security Lists or Network Security Groups (NSG) as needed.
secretCompartmentId String: The OCID of the compartment where the the GGS Secret will be created. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this Compartment in which to create a Secret.
secretId String: The OCID of the customer GGS Secret being referenced. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this Secret
sessionMode String: The mode of the database connection session to be established by the data client. REDIRECT - for a RAC database, DIRECT - for a non-RAC database. Connection to a RAC database involves a redirection received from the SCAN listeners to the database node to connect to. By default the mode would be DIRECT.
state String: Possible lifecycle states.
subnetId String: The OCID of the subnet being referenced.
systemTags Map<String,Object>: 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: The username Oracle GoldenGate uses to connect the associated RDBMS. This username must already exist and be available for use by the database. It must conform to the security requirements implemented by the database including length, case sensitivity, and so on.
vaultId String: The OCID of the customer vault being referenced. If provided, this will reference a vault which the customer will be required to ensure the policies are established to permit the GoldenGate Service to manage secrets contained within this vault.
wallet String

aliasName string: Credential store alias.
compartmentId string: The OCID of the compartment being referenced.
connectionString string: Connect descriptor or Easy Connect Naming method that Oracle GoldenGate uses to connect to a database.
databaseId string: The OCID of the database being referenced.
databaseRegistrationId string
definedTags {[key: string]: any}: Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description string: Metadata about this specific object.
displayName string: An object's Display Name.
fqdn string: A three-label Fully Qualified Domain Name (FQDN) for a resource.
freeformTags {[key: string]: any}: A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id string: The OCID of the databaseRegistration being referenced.
ipAddress string: The private IP address in the customer's VCN of the customer's endpoint, typically a database.
keyId string: The OCID of the customer "Master" key being referenced. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this key to manage secrets.
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
rcePrivateIp string: A Private Endpoint IP Address created in the customer's subnet. A customer database can expect network traffic initiated by GGS from this IP address and send network traffic to this IP address, typically in response to requests from GGS (OGG). The customer may utilize this IP address in Security Lists or Network Security Groups (NSG) as needed.
secretCompartmentId string: The OCID of the compartment where the the GGS Secret will be created. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this Compartment in which to create a Secret.
secretId string: The OCID of the customer GGS Secret being referenced. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this Secret
sessionMode string: The mode of the database connection session to be established by the data client. REDIRECT - for a RAC database, DIRECT - for a non-RAC database. Connection to a RAC database involves a redirection received from the SCAN listeners to the database node to connect to. By default the mode would be DIRECT.
state string: Possible lifecycle states.
subnetId string: The OCID of the subnet being referenced.
systemTags {[key: string]: any}: 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: The username Oracle GoldenGate uses to connect the associated RDBMS. This username must already exist and be available for use by the database. It must conform to the security requirements implemented by the database including length, case sensitivity, and so on.
vaultId string: The OCID of the customer vault being referenced. If provided, this will reference a vault which the customer will be required to ensure the policies are established to permit the GoldenGate Service to manage secrets contained within this vault.
wallet string

alias_name str: Credential store alias.
compartment_id str: The OCID of the compartment being referenced.
connection_string str: Connect descriptor or Easy Connect Naming method that Oracle GoldenGate uses to connect to a database.
database_id str: The OCID of the database being referenced.
database_registration_id str
defined_tags Mapping[str, Any]: Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description str: Metadata about this specific object.
display_name str: An object's Display Name.
fqdn str: A three-label Fully Qualified Domain Name (FQDN) for a resource.
freeform_tags Mapping[str, Any]: A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id str: The OCID of the databaseRegistration being referenced.
ip_address str: The private IP address in the customer's VCN of the customer's endpoint, typically a database.
key_id str: The OCID of the customer "Master" key being referenced. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this key to manage secrets.
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
rce_private_ip str: A Private Endpoint IP Address created in the customer's subnet. A customer database can expect network traffic initiated by GGS from this IP address and send network traffic to this IP address, typically in response to requests from GGS (OGG). The customer may utilize this IP address in Security Lists or Network Security Groups (NSG) as needed.
secret_compartment_id str: The OCID of the compartment where the the GGS Secret will be created. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this Compartment in which to create a Secret.
secret_id str: The OCID of the customer GGS Secret being referenced. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this Secret
session_mode str: 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 subnet being referenced.
system_tags Mapping[str, Any]: 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: The username Oracle GoldenGate uses to connect the associated RDBMS. This username must already exist and be available for use by the database. It must conform to the security requirements implemented by the database including length, case sensitivity, and so on.
vault_id str: The OCID of the customer vault being referenced. If provided, this will reference a vault which the customer will be required to ensure the policies are established to permit the GoldenGate Service to manage secrets contained within this vault.
wallet str

aliasName String: Credential store alias.
compartmentId String: The OCID of the compartment being referenced.
connectionString String: Connect descriptor or Easy Connect Naming method that Oracle GoldenGate uses to connect to a database.
databaseId String: The OCID of the database being referenced.
databaseRegistrationId String
definedTags Map<Any>: Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description String: Metadata about this specific object.
displayName String: An object's Display Name.
fqdn String: A three-label Fully Qualified Domain Name (FQDN) for a resource.
freeformTags Map<Any>: A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id String: The OCID of the databaseRegistration being referenced.
ipAddress String: The private IP address in the customer's VCN of the customer's endpoint, typically a database.
keyId String: The OCID of the customer "Master" key being referenced. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this key to manage secrets.
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
rcePrivateIp String: A Private Endpoint IP Address created in the customer's subnet. A customer database can expect network traffic initiated by GGS from this IP address and send network traffic to this IP address, typically in response to requests from GGS (OGG). The customer may utilize this IP address in Security Lists or Network Security Groups (NSG) as needed.
secretCompartmentId String: The OCID of the compartment where the the GGS Secret will be created. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this Compartment in which to create a Secret.
secretId String: The OCID of the customer GGS Secret being referenced. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this Secret
sessionMode String: The mode of the database connection session to be established by the data client. REDIRECT - for a RAC database, DIRECT - for a non-RAC database. Connection to a RAC database involves a redirection received from the SCAN listeners to the database node to connect to. By default the mode would be DIRECT.
state String: Possible lifecycle states.
subnetId String: The OCID of the subnet being referenced.
systemTags Map<Any>: 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: The username Oracle GoldenGate uses to connect the associated RDBMS. This username must already exist and be available for use by the database. It must conform to the security requirements implemented by the database including length, case sensitivity, and so on.
vaultId String: The OCID of the customer vault being referenced. If provided, this will reference a vault which the customer will be required to ensure the policies are established to permit the GoldenGate Service to manage secrets contained within this vault.
wallet String

Package Details

Repository: https://github.com/pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.