Oracle Cloud Infrastructure v0.13.0, Mar 28 23

oci.DatabaseManagement.getExternalDbSystem

This data source provides details about a specific External Db System resource in Oracle Cloud Infrastructure Database Management service.

Gets the details for the external DB system specified by externalDbSystemId.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var testExternalDbSystem = Oci.DatabaseManagement.GetExternalDbSystem.Invoke(new()
    {
        ExternalDbSystemId = oci_database_management_external_db_system.Test_external_db_system.Id,
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := DatabaseManagement.GetExternalDbSystem(ctx, &databasemanagement.GetExternalDbSystemArgs{
			ExternalDbSystemId: oci_database_management_external_db_system.Test_external_db_system.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.DatabaseManagement.DatabaseManagementFunctions;
import com.pulumi.oci.DatabaseManagement.inputs.GetExternalDbSystemArgs;
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 testExternalDbSystem = DatabaseManagementFunctions.getExternalDbSystem(GetExternalDbSystemArgs.builder()
            .externalDbSystemId(oci_database_management_external_db_system.test_external_db_system().id())
            .build());

    }
}

import pulumi
import pulumi_oci as oci

test_external_db_system = oci.DatabaseManagement.get_external_db_system(external_db_system_id=oci_database_management_external_db_system["test_external_db_system"]["id"])

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

const testExternalDbSystem = oci.DatabaseManagement.getExternalDbSystem({
    externalDbSystemId: oci_database_management_external_db_system.test_external_db_system.id,
});

variables:
  testExternalDbSystem:
    fn::invoke:
      Function: oci:DatabaseManagement:getExternalDbSystem
      Arguments:
        externalDbSystemId: ${oci_database_management_external_db_system.test_external_db_system.id}

Using getExternalDbSystem

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 getExternalDbSystem(args: GetExternalDbSystemArgs, opts?: InvokeOptions): Promise<GetExternalDbSystemResult>
function getExternalDbSystemOutput(args: GetExternalDbSystemOutputArgs, opts?: InvokeOptions): Output<GetExternalDbSystemResult>

def get_external_db_system(external_db_system_id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetExternalDbSystemResult
def get_external_db_system_output(external_db_system_id: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetExternalDbSystemResult]

func GetExternalDbSystem(ctx *Context, args *GetExternalDbSystemArgs, opts ...InvokeOption) (*GetExternalDbSystemResult, error)
func GetExternalDbSystemOutput(ctx *Context, args *GetExternalDbSystemOutputArgs, opts ...InvokeOption) GetExternalDbSystemResultOutput

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

public static class GetExternalDbSystem 
{
    public static Task<GetExternalDbSystemResult> InvokeAsync(GetExternalDbSystemArgs args, InvokeOptions? opts = null)
    public static Output<GetExternalDbSystemResult> Invoke(GetExternalDbSystemInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetExternalDbSystemResult> getExternalDbSystem(GetExternalDbSystemArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: oci:DatabaseManagement/getExternalDbSystem:getExternalDbSystem
  arguments:
    # arguments dictionary

The following arguments are supported:

ExternalDbSystemId string: The OCID of the external DB system.

ExternalDbSystemId string: The OCID of the external DB system.

externalDbSystemId String: The OCID of the external DB system.

externalDbSystemId string: The OCID of the external DB system.

external_db_system_id str: The OCID of the external DB system.

externalDbSystemId String: The OCID of the external DB system.

getExternalDbSystem Result

The following output properties are available:

CompartmentId string: The OCID of the compartment.
DatabaseManagementConfigs List<GetExternalDbSystemDatabaseManagementConfig>: The details required to enable Database Management for an external DB system.
DbSystemDiscoveryId string: The OCID of the DB system discovery.
DiscoveryAgentId string: The OCID of the management agent used during the discovery of the DB system.
DisplayName string: The user-friendly name for the DB system. The name does not have to be unique.
ExternalDbSystemId string
HomeDirectory string: The Oracle Grid home directory in case of cluster-based DB system and Oracle home directory in case of single instance-based DB system.
Id string: The OCID of the external DB system.
IsCluster bool: Indicates whether the DB system is a cluster DB system or not.
LifecycleDetails string: Additional information about the current lifecycle state.
State string: The current lifecycle state of the external DB system resource.
TimeCreated string: The date and time the external DB system was created.
TimeUpdated string: The date and time the external DB system was last updated.

CompartmentId string: The OCID of the compartment.
DatabaseManagementConfigs []GetExternalDbSystemDatabaseManagementConfig: The details required to enable Database Management for an external DB system.
DbSystemDiscoveryId string: The OCID of the DB system discovery.
DiscoveryAgentId string: The OCID of the management agent used during the discovery of the DB system.
DisplayName string: The user-friendly name for the DB system. The name does not have to be unique.
ExternalDbSystemId string
HomeDirectory string: The Oracle Grid home directory in case of cluster-based DB system and Oracle home directory in case of single instance-based DB system.
Id string: The OCID of the external DB system.
IsCluster bool: Indicates whether the DB system is a cluster DB system or not.
LifecycleDetails string: Additional information about the current lifecycle state.
State string: The current lifecycle state of the external DB system resource.
TimeCreated string: The date and time the external DB system was created.
TimeUpdated string: The date and time the external DB system was last updated.

compartmentId String: The OCID of the compartment.
databaseManagementConfigs List<GetExternalDbSystemConfig>: The details required to enable Database Management for an external DB system.
dbSystemDiscoveryId String: The OCID of the DB system discovery.
discoveryAgentId String: The OCID of the management agent used during the discovery of the DB system.
displayName String: The user-friendly name for the DB system. The name does not have to be unique.
externalDbSystemId String
homeDirectory String: The Oracle Grid home directory in case of cluster-based DB system and Oracle home directory in case of single instance-based DB system.
id String: The OCID of the external DB system.
isCluster Boolean: Indicates whether the DB system is a cluster DB system or not.
lifecycleDetails String: Additional information about the current lifecycle state.
state String: The current lifecycle state of the external DB system resource.
timeCreated String: The date and time the external DB system was created.
timeUpdated String: The date and time the external DB system was last updated.

compartmentId string: The OCID of the compartment.
databaseManagementConfigs GetExternalDbSystemDatabaseManagementConfig[]: The details required to enable Database Management for an external DB system.
dbSystemDiscoveryId string: The OCID of the DB system discovery.
discoveryAgentId string: The OCID of the management agent used during the discovery of the DB system.
displayName string: The user-friendly name for the DB system. The name does not have to be unique.
externalDbSystemId string
homeDirectory string: The Oracle Grid home directory in case of cluster-based DB system and Oracle home directory in case of single instance-based DB system.
id string: The OCID of the external DB system.
isCluster boolean: Indicates whether the DB system is a cluster DB system or not.
lifecycleDetails string: Additional information about the current lifecycle state.
state string: The current lifecycle state of the external DB system resource.
timeCreated string: The date and time the external DB system was created.
timeUpdated string: The date and time the external DB system was last updated.

compartment_id str: The OCID of the compartment.
database_management_configs GetExternalDbSystemDatabaseManagementConfig]: The details required to enable Database Management for an external DB system.
db_system_discovery_id str: The OCID of the DB system discovery.
discovery_agent_id str: The OCID of the management agent used during the discovery of the DB system.
display_name str: The user-friendly name for the DB system. The name does not have to be unique.
external_db_system_id str
home_directory str: The Oracle Grid home directory in case of cluster-based DB system and Oracle home directory in case of single instance-based DB system.
id str: The OCID of the external DB system.
is_cluster bool: Indicates whether the DB system is a cluster DB system or not.
lifecycle_details str: Additional information about the current lifecycle state.
state str: The current lifecycle state of the external DB system resource.
time_created str: The date and time the external DB system was created.
time_updated str: The date and time the external DB system was last updated.

compartmentId String: The OCID of the compartment.
databaseManagementConfigs List<Property Map>: The details required to enable Database Management for an external DB system.
dbSystemDiscoveryId String: The OCID of the DB system discovery.
discoveryAgentId String: The OCID of the management agent used during the discovery of the DB system.
displayName String: The user-friendly name for the DB system. The name does not have to be unique.
externalDbSystemId String
homeDirectory String: The Oracle Grid home directory in case of cluster-based DB system and Oracle home directory in case of single instance-based DB system.
id String: The OCID of the external DB system.
isCluster Boolean: Indicates whether the DB system is a cluster DB system or not.
lifecycleDetails String: Additional information about the current lifecycle state.
state String: The current lifecycle state of the external DB system resource.
timeCreated String: The date and time the external DB system was created.
timeUpdated String: The date and time the external DB system was last updated.

Supporting Types

GetExternalDbSystemDatabaseManagementConfig

LicenseModel string: The Oracle license model that applies to the external database.

LicenseModel string: The Oracle license model that applies to the external database.

licenseModel String: The Oracle license model that applies to the external database.

licenseModel string: The Oracle license model that applies to the external database.

license_model str: The Oracle license model that applies to the external database.

licenseModel String: The Oracle license model that applies to the external database.

Package Details

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