Oracle Cloud Infrastructure v0.13.0, Mar 28 23

oci.DatabaseManagement.ExternalDbSystem

This resource provides the External Db System resource in Oracle Cloud Infrastructure Database Management service.

Creates an external DB system and its related resources.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var testExternalDbSystem = new Oci.DatabaseManagement.ExternalDbSystem("testExternalDbSystem", new()
    {
        CompartmentId = @var.Compartment_id,
        DbSystemDiscoveryId = oci_database_management_db_system_discovery.Test_db_system_discovery.Id,
        DatabaseManagementConfig = new Oci.DatabaseManagement.Inputs.ExternalDbSystemDatabaseManagementConfigArgs
        {
            LicenseModel = @var.External_db_system_database_management_config_license_model,
        },
        DisplayName = @var.External_db_system_display_name,
    });

});

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.NewExternalDbSystem(ctx, "testExternalDbSystem", &DatabaseManagement.ExternalDbSystemArgs{
			CompartmentId:       pulumi.Any(_var.Compartment_id),
			DbSystemDiscoveryId: pulumi.Any(oci_database_management_db_system_discovery.Test_db_system_discovery.Id),
			DatabaseManagementConfig: &databasemanagement.ExternalDbSystemDatabaseManagementConfigArgs{
				LicenseModel: pulumi.Any(_var.External_db_system_database_management_config_license_model),
			},
			DisplayName: pulumi.Any(_var.External_db_system_display_name),
		})
		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.ExternalDbSystem;
import com.pulumi.oci.DatabaseManagement.ExternalDbSystemArgs;
import com.pulumi.oci.DatabaseManagement.inputs.ExternalDbSystemDatabaseManagementConfigArgs;
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 testExternalDbSystem = new ExternalDbSystem("testExternalDbSystem", ExternalDbSystemArgs.builder()        
            .compartmentId(var_.compartment_id())
            .dbSystemDiscoveryId(oci_database_management_db_system_discovery.test_db_system_discovery().id())
            .databaseManagementConfig(ExternalDbSystemDatabaseManagementConfigArgs.builder()
                .licenseModel(var_.external_db_system_database_management_config_license_model())
                .build())
            .displayName(var_.external_db_system_display_name())
            .build());

    }
}

import pulumi
import pulumi_oci as oci

test_external_db_system = oci.database_management.ExternalDbSystem("testExternalDbSystem",
    compartment_id=var["compartment_id"],
    db_system_discovery_id=oci_database_management_db_system_discovery["test_db_system_discovery"]["id"],
    database_management_config=oci.database_management.ExternalDbSystemDatabaseManagementConfigArgs(
        license_model=var["external_db_system_database_management_config_license_model"],
    ),
    display_name=var["external_db_system_display_name"])

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

const testExternalDbSystem = new oci.databasemanagement.ExternalDbSystem("testExternalDbSystem", {
    compartmentId: _var.compartment_id,
    dbSystemDiscoveryId: oci_database_management_db_system_discovery.test_db_system_discovery.id,
    databaseManagementConfig: {
        licenseModel: _var.external_db_system_database_management_config_license_model,
    },
    displayName: _var.external_db_system_display_name,
});

resources:
  testExternalDbSystem:
    type: oci:DatabaseManagement:ExternalDbSystem
    properties:
      #Required
      compartmentId: ${var.compartment_id}
      dbSystemDiscoveryId: ${oci_database_management_db_system_discovery.test_db_system_discovery.id}
      databaseManagementConfig:
        licenseModel: ${var.external_db_system_database_management_config_license_model}
      displayName: ${var.external_db_system_display_name}

Create ExternalDbSystem Resource

new ExternalDbSystem(name: string, args: ExternalDbSystemArgs, opts?: CustomResourceOptions);

@overload
def ExternalDbSystem(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     compartment_id: Optional[str] = None,
                     database_management_config: Optional[_databasemanagement.ExternalDbSystemDatabaseManagementConfigArgs] = None,
                     db_system_discovery_id: Optional[str] = None,
                     display_name: Optional[str] = None)
@overload
def ExternalDbSystem(resource_name: str,
                     args: ExternalDbSystemArgs,
                     opts: Optional[ResourceOptions] = None)

func NewExternalDbSystem(ctx *Context, name string, args ExternalDbSystemArgs, opts ...ResourceOption) (*ExternalDbSystem, error)

public ExternalDbSystem(string name, ExternalDbSystemArgs args, CustomResourceOptions? opts = null)

public ExternalDbSystem(String name, ExternalDbSystemArgs args)
public ExternalDbSystem(String name, ExternalDbSystemArgs args, CustomResourceOptions options)

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

name string: The unique name of the resource.
args ExternalDbSystemArgs: 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 ExternalDbSystemArgs: 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 ExternalDbSystemArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ExternalDbSystemArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ExternalDbSystemArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

ExternalDbSystem Resource Properties

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

Inputs

The ExternalDbSystem resource accepts the following input properties:

CompartmentId string: (Updatable) The OCID of the compartment in which the external DB system resides.
DbSystemDiscoveryId string: The OCID of the DB system discovery.
DatabaseManagementConfig ExternalDbSystemDatabaseManagementConfigArgs: The details required to enable Database Management for an external DB system.
DisplayName string: (Updatable) The user-friendly name for the DB system. The name does not have to be unique.

CompartmentId string: (Updatable) The OCID of the compartment in which the external DB system resides.
DbSystemDiscoveryId string: The OCID of the DB system discovery.
DatabaseManagementConfig ExternalDbSystemDatabaseManagementConfigArgs: The details required to enable Database Management for an external DB system.
DisplayName string: (Updatable) The user-friendly name for the DB system. The name does not have to be unique.

compartmentId String: (Updatable) The OCID of the compartment in which the external DB system resides.
dbSystemDiscoveryId String: The OCID of the DB system discovery.
databaseManagementConfig ExternalDbSystemConfigArgs: The details required to enable Database Management for an external DB system.
displayName String: (Updatable) The user-friendly name for the DB system. The name does not have to be unique.

compartmentId string: (Updatable) The OCID of the compartment in which the external DB system resides.
dbSystemDiscoveryId string: The OCID of the DB system discovery.
databaseManagementConfig ExternalDbSystemDatabaseManagementConfigArgs: The details required to enable Database Management for an external DB system.
displayName string: (Updatable) The user-friendly name for the DB system. The name does not have to be unique.

compartment_id str: (Updatable) The OCID of the compartment in which the external DB system resides.
db_system_discovery_id str: The OCID of the DB system discovery.
database_management_config ExternalDbSystemDatabaseManagementConfigArgs: The details required to enable Database Management for an external DB system.
display_name str: (Updatable) The user-friendly name for the DB system. The name does not have to be unique.

compartmentId String: (Updatable) The OCID of the compartment in which the external DB system resides.
dbSystemDiscoveryId String: The OCID of the DB system discovery.
databaseManagementConfig Property Map: The details required to enable Database Management for an external DB system.
displayName String: (Updatable) The user-friendly name for the DB system. The name does not have to be unique.

Outputs

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

DiscoveryAgentId string: The OCID of the management agent used during the discovery of the DB system.
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 provider-assigned unique ID for this managed resource.
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.

DiscoveryAgentId string: The OCID of the management agent used during the discovery of the DB system.
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 provider-assigned unique ID for this managed resource.
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.

discoveryAgentId String: The OCID of the management agent used during the discovery of the DB system.
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 provider-assigned unique ID for this managed resource.
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.

discoveryAgentId string: The OCID of the management agent used during the discovery of the DB system.
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 provider-assigned unique ID for this managed resource.
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.

discovery_agent_id str: The OCID of the management agent used during the discovery of the DB system.
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 provider-assigned unique ID for this managed resource.
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.

discoveryAgentId String: The OCID of the management agent used during the discovery of the DB system.
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 provider-assigned unique ID for this managed resource.
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.

Look up Existing ExternalDbSystem Resource

Get an existing ExternalDbSystem 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?: ExternalDbSystemState, opts?: CustomResourceOptions): ExternalDbSystem

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        database_management_config: Optional[_databasemanagement.ExternalDbSystemDatabaseManagementConfigArgs] = None,
        db_system_discovery_id: Optional[str] = None,
        discovery_agent_id: Optional[str] = None,
        display_name: Optional[str] = None,
        home_directory: Optional[str] = None,
        is_cluster: Optional[bool] = None,
        lifecycle_details: Optional[str] = None,
        state: Optional[str] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None) -> ExternalDbSystem

func GetExternalDbSystem(ctx *Context, name string, id IDInput, state *ExternalDbSystemState, opts ...ResourceOption) (*ExternalDbSystem, error)

public static ExternalDbSystem Get(string name, Input<string> id, ExternalDbSystemState? state, CustomResourceOptions? opts = null)

public static ExternalDbSystem get(String name, Output<String> id, ExternalDbSystemState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

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:

CompartmentId string: (Updatable) The OCID of the compartment in which the external DB system resides.
DatabaseManagementConfig ExternalDbSystemDatabaseManagementConfigArgs: 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: (Updatable) The user-friendly name for the DB system. The name does not have to be unique.
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.
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: (Updatable) The OCID of the compartment in which the external DB system resides.
DatabaseManagementConfig ExternalDbSystemDatabaseManagementConfigArgs: 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: (Updatable) The user-friendly name for the DB system. The name does not have to be unique.
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.
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: (Updatable) The OCID of the compartment in which the external DB system resides.
databaseManagementConfig ExternalDbSystemConfigArgs: 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: (Updatable) The user-friendly name for the DB system. The name does not have to be unique.
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.
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: (Updatable) The OCID of the compartment in which the external DB system resides.
databaseManagementConfig ExternalDbSystemDatabaseManagementConfigArgs: 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: (Updatable) The user-friendly name for the DB system. The name does not have to be unique.
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.
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: (Updatable) The OCID of the compartment in which the external DB system resides.
database_management_config ExternalDbSystemDatabaseManagementConfigArgs: 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: (Updatable) The user-friendly name for the DB system. The name does not have to be unique.
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.
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: (Updatable) The OCID of the compartment in which the external DB system resides.
databaseManagementConfig 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: (Updatable) The user-friendly name for the DB system. The name does not have to be unique.
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.
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

ExternalDbSystemDatabaseManagementConfig

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.

Import

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

 $ pulumi import oci:DatabaseManagement/externalDbSystem:ExternalDbSystem test_external_db_system "id"

Package Details

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