Docs Packages
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DatabaseManagement
  5. ExternalDbSystem
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
pulumi/pulumi-oci

oci.DatabaseManagement.ExternalDbSystem

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
pulumi/pulumi-oci

    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

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

const testExternalDbSystem = new oci.databasemanagement.ExternalDbSystem("test_external_db_system", {
    compartmentId: compartmentId,
    dbSystemDiscoveryId: testDbSystemDiscovery.id,
    databaseManagementConfig: {
        licenseModel: externalDbSystemDatabaseManagementConfigLicenseModel,
    },
    definedTags: {
        "Operations.CostCenter": "42",
    },
    displayName: externalDbSystemDisplayName,
    freeformTags: {
        Department: "Finance",
    },
    stackMonitoringConfig: {
        isEnabled: externalDbSystemStackMonitoringConfigIsEnabled,
        metadata: externalDbSystemStackMonitoringConfigMetadata,
    },
});

    import pulumi
import pulumi_oci as oci

test_external_db_system = oci.database_management.ExternalDbSystem("test_external_db_system",
    compartment_id=compartment_id,
    db_system_discovery_id=test_db_system_discovery["id"],
    database_management_config=oci.database_management.ExternalDbSystemDatabaseManagementConfigArgs(
        license_model=external_db_system_database_management_config_license_model,
    ),
    defined_tags={
        "Operations.CostCenter": "42",
    },
    display_name=external_db_system_display_name,
    freeform_tags={
        "Department": "Finance",
    },
    stack_monitoring_config=oci.database_management.ExternalDbSystemStackMonitoringConfigArgs(
        is_enabled=external_db_system_stack_monitoring_config_is_enabled,
        metadata=external_db_system_stack_monitoring_config_metadata,
    ))

    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, "test_external_db_system", &DatabaseManagement.ExternalDbSystemArgs{
			CompartmentId:       pulumi.Any(compartmentId),
			DbSystemDiscoveryId: pulumi.Any(testDbSystemDiscovery.Id),
			DatabaseManagementConfig: &databasemanagement.ExternalDbSystemDatabaseManagementConfigArgs{
				LicenseModel: pulumi.Any(externalDbSystemDatabaseManagementConfigLicenseModel),
			},
			DefinedTags: pulumi.Map{
				"Operations.CostCenter": pulumi.Any("42"),
			},
			DisplayName: pulumi.Any(externalDbSystemDisplayName),
			FreeformTags: pulumi.Map{
				"Department": pulumi.Any("Finance"),
			},
			StackMonitoringConfig: &databasemanagement.ExternalDbSystemStackMonitoringConfigArgs{
				IsEnabled: pulumi.Any(externalDbSystemStackMonitoringConfigIsEnabled),
				Metadata:  pulumi.Any(externalDbSystemStackMonitoringConfigMetadata),
			},
		})
		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 testExternalDbSystem = new Oci.DatabaseManagement.ExternalDbSystem("test_external_db_system", new()
    {
        CompartmentId = compartmentId,
        DbSystemDiscoveryId = testDbSystemDiscovery.Id,
        DatabaseManagementConfig = new Oci.DatabaseManagement.Inputs.ExternalDbSystemDatabaseManagementConfigArgs
        {
            LicenseModel = externalDbSystemDatabaseManagementConfigLicenseModel,
        },
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        DisplayName = externalDbSystemDisplayName,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
        StackMonitoringConfig = new Oci.DatabaseManagement.Inputs.ExternalDbSystemStackMonitoringConfigArgs
        {
            IsEnabled = externalDbSystemStackMonitoringConfigIsEnabled,
            Metadata = externalDbSystemStackMonitoringConfigMetadata,
        },
    });

});

    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 com.pulumi.oci.DatabaseManagement.inputs.ExternalDbSystemStackMonitoringConfigArgs;
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(compartmentId)
            .dbSystemDiscoveryId(testDbSystemDiscovery.id())
            .databaseManagementConfig(ExternalDbSystemDatabaseManagementConfigArgs.builder()
                .licenseModel(externalDbSystemDatabaseManagementConfigLicenseModel)
                .build())
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .displayName(externalDbSystemDisplayName)
            .freeformTags(Map.of("Department", "Finance"))
            .stackMonitoringConfig(ExternalDbSystemStackMonitoringConfigArgs.builder()
                .isEnabled(externalDbSystemStackMonitoringConfigIsEnabled)
                .metadata(externalDbSystemStackMonitoringConfigMetadata)
                .build())
            .build());

    }
}

    resources:
  testExternalDbSystem:
    type: oci:DatabaseManagement:ExternalDbSystem
    name: test_external_db_system
    properties:
      compartmentId: ${compartmentId}
      dbSystemDiscoveryId: ${testDbSystemDiscovery.id}
      databaseManagementConfig:
        licenseModel: ${externalDbSystemDatabaseManagementConfigLicenseModel}
      definedTags:
        Operations.CostCenter: '42'
      displayName: ${externalDbSystemDisplayName}
      freeformTags:
        Department: Finance
      stackMonitoringConfig:
        isEnabled: ${externalDbSystemStackMonitoringConfigIsEnabled}
        metadata: ${externalDbSystemStackMonitoringConfigMetadata}

    Create ExternalDbSystem Resource

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

    Constructor syntax

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

@overload
def ExternalDbSystem(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     compartment_id: Optional[str] = None,
                     db_system_discovery_id: Optional[str] = None,
                     database_management_config: Optional[_databasemanagement.ExternalDbSystemDatabaseManagementConfigArgs] = None,
                     defined_tags: Optional[Mapping[str, Any]] = None,
                     display_name: Optional[str] = None,
                     freeform_tags: Optional[Mapping[str, Any]] = None,
                     stack_monitoring_config: Optional[_databasemanagement.ExternalDbSystemStackMonitoringConfigArgs] = 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.

    Parameters

    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.

    Constructor example

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

    var externalDbSystemResource = new Oci.DatabaseManagement.ExternalDbSystem("externalDbSystemResource", new()
{
    CompartmentId = "string",
    DbSystemDiscoveryId = "string",
    DatabaseManagementConfig = new Oci.DatabaseManagement.Inputs.ExternalDbSystemDatabaseManagementConfigArgs
    {
        LicenseModel = "string",
    },
    DefinedTags = 
    {
        { "string", "any" },
    },
    DisplayName = "string",
    FreeformTags = 
    {
        { "string", "any" },
    },
    StackMonitoringConfig = new Oci.DatabaseManagement.Inputs.ExternalDbSystemStackMonitoringConfigArgs
    {
        IsEnabled = false,
        Metadata = "string",
    },
});

    example, err := DatabaseManagement.NewExternalDbSystem(ctx, "externalDbSystemResource", &DatabaseManagement.ExternalDbSystemArgs{
	CompartmentId:       pulumi.String("string"),
	DbSystemDiscoveryId: pulumi.String("string"),
	DatabaseManagementConfig: &databasemanagement.ExternalDbSystemDatabaseManagementConfigArgs{
		LicenseModel: pulumi.String("string"),
	},
	DefinedTags: pulumi.Map{
		"string": pulumi.Any("any"),
	},
	DisplayName: pulumi.String("string"),
	FreeformTags: pulumi.Map{
		"string": pulumi.Any("any"),
	},
	StackMonitoringConfig: &databasemanagement.ExternalDbSystemStackMonitoringConfigArgs{
		IsEnabled: pulumi.Bool(false),
		Metadata:  pulumi.String("string"),
	},
})

    var externalDbSystemResource = new ExternalDbSystem("externalDbSystemResource", ExternalDbSystemArgs.builder()
    .compartmentId("string")
    .dbSystemDiscoveryId("string")
    .databaseManagementConfig(ExternalDbSystemDatabaseManagementConfigArgs.builder()
        .licenseModel("string")
        .build())
    .definedTags(Map.of("string", "any"))
    .displayName("string")
    .freeformTags(Map.of("string", "any"))
    .stackMonitoringConfig(ExternalDbSystemStackMonitoringConfigArgs.builder()
        .isEnabled(false)
        .metadata("string")
        .build())
    .build());

    external_db_system_resource = oci.database_management.ExternalDbSystem("externalDbSystemResource",
    compartment_id="string",
    db_system_discovery_id="string",
    database_management_config=oci.database_management.ExternalDbSystemDatabaseManagementConfigArgs(
        license_model="string",
    ),
    defined_tags={
        "string": "any",
    },
    display_name="string",
    freeform_tags={
        "string": "any",
    },
    stack_monitoring_config=oci.database_management.ExternalDbSystemStackMonitoringConfigArgs(
        is_enabled=False,
        metadata="string",
    ))

    const externalDbSystemResource = new oci.databasemanagement.ExternalDbSystem("externalDbSystemResource", {
    compartmentId: "string",
    dbSystemDiscoveryId: "string",
    databaseManagementConfig: {
        licenseModel: "string",
    },
    definedTags: {
        string: "any",
    },
    displayName: "string",
    freeformTags: {
        string: "any",
    },
    stackMonitoringConfig: {
        isEnabled: false,
        metadata: "string",
    },
});

    type: oci:DatabaseManagement:ExternalDbSystem
properties:
    compartmentId: string
    databaseManagementConfig:
        licenseModel: string
    dbSystemDiscoveryId: string
    definedTags:
        string: any
    displayName: string
    freeformTags:
        string: any
    stackMonitoringConfig:
        isEnabled: false
        metadata: string

    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 ExternalDbSystemDatabaseManagementConfig
    The details required to enable Database Management for an external DB system.
    DefinedTags Dictionary<string, object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    (Updatable) The user-friendly name for the DB system. The name does not have to be unique.
    FreeformTags Dictionary<string, object>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    StackMonitoringConfig ExternalDbSystemStackMonitoringConfig
    The details of the associated service that will be enabled or disabled for an external DB System.
    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.
    DefinedTags map[string]interface{}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    (Updatable) The user-friendly name for the DB system. The name does not have to be unique.
    FreeformTags map[string]interface{}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    StackMonitoringConfig ExternalDbSystemStackMonitoringConfigArgs
    The details of the associated service that will be enabled or disabled for an external DB System.
    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 ExternalDbSystemConfig
    The details required to enable Database Management for an external DB system.
    definedTags Map<String,Object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    (Updatable) The user-friendly name for the DB system. The name does not have to be unique.
    freeformTags Map<String,Object>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    stackMonitoringConfig ExternalDbSystemStackMonitoringConfig
    The details of the associated service that will be enabled or disabled for an external DB System.
    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 ExternalDbSystemDatabaseManagementConfig
    The details required to enable Database Management for an external DB system.
    definedTags {[key: string]: any}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName string
    (Updatable) The user-friendly name for the DB system. The name does not have to be unique.
    freeformTags {[key: string]: any}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    stackMonitoringConfig ExternalDbSystemStackMonitoringConfig
    The details of the associated service that will be enabled or disabled for an external DB System.
    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 databasemanagement.ExternalDbSystemDatabaseManagementConfigArgs
    The details required to enable Database Management for an external DB system.
    defined_tags Mapping[str, Any]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    display_name str
    (Updatable) The user-friendly name for the DB system. The name does not have to be unique.
    freeform_tags Mapping[str, Any]
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    stack_monitoring_config databasemanagement.ExternalDbSystemStackMonitoringConfigArgs
    The details of the associated service that will be enabled or disabled for an external DB System.
    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.
    definedTags Map<Any>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    (Updatable) The user-friendly name for the DB system. The name does not have to be unique.
    freeformTags Map<Any>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    stackMonitoringConfig Property Map
    The details of the associated service that will be enabled or disabled for an external DB System.

    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.
    SystemTags Dictionary<string, object>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    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.
    SystemTags map[string]interface{}
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    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.
    systemTags Map<String,Object>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    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.
    systemTags {[key: string]: any}
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    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.
    system_tags Mapping[str, Any]
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    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.
    systemTags Map<Any>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    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,
        defined_tags: Optional[Mapping[str, Any]] = None,
        discovery_agent_id: Optional[str] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, Any]] = None,
        home_directory: Optional[str] = None,
        is_cluster: Optional[bool] = None,
        lifecycle_details: Optional[str] = None,
        stack_monitoring_config: Optional[_databasemanagement.ExternalDbSystemStackMonitoringConfigArgs] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, Any]] = 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 ExternalDbSystemDatabaseManagementConfig
    The details required to enable Database Management for an external DB system.
    DbSystemDiscoveryId string
    The OCID of the DB system discovery.
    DefinedTags Dictionary<string, object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    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.
    FreeformTags Dictionary<string, object>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    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.
    StackMonitoringConfig ExternalDbSystemStackMonitoringConfig
    The details of the associated service that will be enabled or disabled for an external DB System.
    State string
    The current lifecycle state of the external DB system resource.
    SystemTags Dictionary<string, object>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    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.
    DefinedTags map[string]interface{}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    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.
    FreeformTags map[string]interface{}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    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.
    StackMonitoringConfig ExternalDbSystemStackMonitoringConfigArgs
    The details of the associated service that will be enabled or disabled for an external DB System.
    State string
    The current lifecycle state of the external DB system resource.
    SystemTags map[string]interface{}
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    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 ExternalDbSystemConfig
    The details required to enable Database Management for an external DB system.
    dbSystemDiscoveryId String
    The OCID of the DB system discovery.
    definedTags Map<String,Object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    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.
    freeformTags Map<String,Object>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    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.
    stackMonitoringConfig ExternalDbSystemStackMonitoringConfig
    The details of the associated service that will be enabled or disabled for an external DB System.
    state String
    The current lifecycle state of the external DB system resource.
    systemTags Map<String,Object>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    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 ExternalDbSystemDatabaseManagementConfig
    The details required to enable Database Management for an external DB system.
    dbSystemDiscoveryId string
    The OCID of the DB system discovery.
    definedTags {[key: string]: any}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    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.
    freeformTags {[key: string]: any}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    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.
    stackMonitoringConfig ExternalDbSystemStackMonitoringConfig
    The details of the associated service that will be enabled or disabled for an external DB System.
    state string
    The current lifecycle state of the external DB system resource.
    systemTags {[key: string]: any}
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    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 databasemanagement.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.
    defined_tags Mapping[str, Any]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    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.
    freeform_tags Mapping[str, Any]
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    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.
    stack_monitoring_config databasemanagement.ExternalDbSystemStackMonitoringConfigArgs
    The details of the associated service that will be enabled or disabled for an external DB System.
    state str
    The current lifecycle state of the external DB system resource.
    system_tags Mapping[str, Any]
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    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.
    definedTags Map<Any>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    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.
    freeformTags Map<Any>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    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.
    stackMonitoringConfig Property Map
    The details of the associated service that will be enabled or disabled for an external DB System.
    state String
    The current lifecycle state of the external DB system resource.
    systemTags Map<Any>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    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, ExternalDbSystemDatabaseManagementConfigArgs

    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.

    ExternalDbSystemStackMonitoringConfig, ExternalDbSystemStackMonitoringConfigArgs

    IsEnabled bool
    The status of the associated service.
    Metadata string

    The associated service-specific inputs in JSON string format, which Database Management can identify.

    ** 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

    IsEnabled bool
    The status of the associated service.
    Metadata string

    The associated service-specific inputs in JSON string format, which Database Management can identify.

    ** 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

    isEnabled Boolean
    The status of the associated service.
    metadata String

    The associated service-specific inputs in JSON string format, which Database Management can identify.

    ** 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

    isEnabled boolean
    The status of the associated service.
    metadata string

    The associated service-specific inputs in JSON string format, which Database Management can identify.

    ** 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

    is_enabled bool
    The status of the associated service.
    metadata str

    The associated service-specific inputs in JSON string format, which Database Management can identify.

    ** 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

    isEnabled Boolean
    The status of the associated service.
    metadata String

    The associated service-specific inputs in JSON string format, which Database Management can identify.

    ** 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

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

    $ pulumi import oci:DatabaseManagement/externalDbSystem:ExternalDbSystem test_external_db_system "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 v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
    pulumi/pulumi-oci