Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DatabaseManagement
  5. CloudDbSystem
Oracle Cloud Infrastructure v3.7.0 published on Saturday, Sep 13, 2025 by Pulumi
pulumi/pulumi-oci

oci.DatabaseManagement.CloudDbSystem

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v3.7.0 published on Saturday, Sep 13, 2025 by Pulumi
pulumi/pulumi-oci

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

    Creates a cloud DB system and its related resources.

    Example Usage

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

const testCloudDbSystem = new oci.databasemanagement.CloudDbSystem("test_cloud_db_system", {
    compartmentId: compartmentId,
    dbSystemDiscoveryId: testDbSystemDiscovery.id,
    databaseManagementConfig: {
        isEnabled: cloudDbSystemDatabaseManagementConfigIsEnabled,
        metadata: cloudDbSystemDatabaseManagementConfigMetadata,
    },
    definedTags: {
        "Operations.CostCenter": "42",
    },
    displayName: cloudDbSystemDisplayName,
    freeformTags: {
        Department: "Finance",
    },
    stackMonitoringConfig: {
        isEnabled: cloudDbSystemStackMonitoringConfigIsEnabled,
        metadata: cloudDbSystemStackMonitoringConfigMetadata,
    },
});

    import pulumi
import pulumi_oci as oci

test_cloud_db_system = oci.databasemanagement.CloudDbSystem("test_cloud_db_system",
    compartment_id=compartment_id,
    db_system_discovery_id=test_db_system_discovery["id"],
    database_management_config={
        "is_enabled": cloud_db_system_database_management_config_is_enabled,
        "metadata": cloud_db_system_database_management_config_metadata,
    },
    defined_tags={
        "Operations.CostCenter": "42",
    },
    display_name=cloud_db_system_display_name,
    freeform_tags={
        "Department": "Finance",
    },
    stack_monitoring_config={
        "is_enabled": cloud_db_system_stack_monitoring_config_is_enabled,
        "metadata": cloud_db_system_stack_monitoring_config_metadata,
    })

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := databasemanagement.NewCloudDbSystem(ctx, "test_cloud_db_system", &databasemanagement.CloudDbSystemArgs{
			CompartmentId:       pulumi.Any(compartmentId),
			DbSystemDiscoveryId: pulumi.Any(testDbSystemDiscovery.Id),
			DatabaseManagementConfig: &databasemanagement.CloudDbSystemDatabaseManagementConfigArgs{
				IsEnabled: pulumi.Any(cloudDbSystemDatabaseManagementConfigIsEnabled),
				Metadata:  pulumi.Any(cloudDbSystemDatabaseManagementConfigMetadata),
			},
			DefinedTags: pulumi.StringMap{
				"Operations.CostCenter": pulumi.String("42"),
			},
			DisplayName: pulumi.Any(cloudDbSystemDisplayName),
			FreeformTags: pulumi.StringMap{
				"Department": pulumi.String("Finance"),
			},
			StackMonitoringConfig: &databasemanagement.CloudDbSystemStackMonitoringConfigArgs{
				IsEnabled: pulumi.Any(cloudDbSystemStackMonitoringConfigIsEnabled),
				Metadata:  pulumi.Any(cloudDbSystemStackMonitoringConfigMetadata),
			},
		})
		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 testCloudDbSystem = new Oci.DatabaseManagement.CloudDbSystem("test_cloud_db_system", new()
    {
        CompartmentId = compartmentId,
        DbSystemDiscoveryId = testDbSystemDiscovery.Id,
        DatabaseManagementConfig = new Oci.DatabaseManagement.Inputs.CloudDbSystemDatabaseManagementConfigArgs
        {
            IsEnabled = cloudDbSystemDatabaseManagementConfigIsEnabled,
            Metadata = cloudDbSystemDatabaseManagementConfigMetadata,
        },
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        DisplayName = cloudDbSystemDisplayName,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
        StackMonitoringConfig = new Oci.DatabaseManagement.Inputs.CloudDbSystemStackMonitoringConfigArgs
        {
            IsEnabled = cloudDbSystemStackMonitoringConfigIsEnabled,
            Metadata = cloudDbSystemStackMonitoringConfigMetadata,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DatabaseManagement.CloudDbSystem;
import com.pulumi.oci.DatabaseManagement.CloudDbSystemArgs;
import com.pulumi.oci.DatabaseManagement.inputs.CloudDbSystemDatabaseManagementConfigArgs;
import com.pulumi.oci.DatabaseManagement.inputs.CloudDbSystemStackMonitoringConfigArgs;
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 testCloudDbSystem = new CloudDbSystem("testCloudDbSystem", CloudDbSystemArgs.builder()
            .compartmentId(compartmentId)
            .dbSystemDiscoveryId(testDbSystemDiscovery.id())
            .databaseManagementConfig(CloudDbSystemDatabaseManagementConfigArgs.builder()
                .isEnabled(cloudDbSystemDatabaseManagementConfigIsEnabled)
                .metadata(cloudDbSystemDatabaseManagementConfigMetadata)
                .build())
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .displayName(cloudDbSystemDisplayName)
            .freeformTags(Map.of("Department", "Finance"))
            .stackMonitoringConfig(CloudDbSystemStackMonitoringConfigArgs.builder()
                .isEnabled(cloudDbSystemStackMonitoringConfigIsEnabled)
                .metadata(cloudDbSystemStackMonitoringConfigMetadata)
                .build())
            .build());

    }
}

    resources:
  testCloudDbSystem:
    type: oci:DatabaseManagement:CloudDbSystem
    name: test_cloud_db_system
    properties:
      compartmentId: ${compartmentId}
      dbSystemDiscoveryId: ${testDbSystemDiscovery.id}
      databaseManagementConfig:
        isEnabled: ${cloudDbSystemDatabaseManagementConfigIsEnabled}
        metadata: ${cloudDbSystemDatabaseManagementConfigMetadata}
      definedTags:
        Operations.CostCenter: '42'
      displayName: ${cloudDbSystemDisplayName}
      freeformTags:
        Department: Finance
      stackMonitoringConfig:
        isEnabled: ${cloudDbSystemStackMonitoringConfigIsEnabled}
        metadata: ${cloudDbSystemStackMonitoringConfigMetadata}

    Create CloudDbSystem Resource

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

    Constructor syntax

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

@overload
def CloudDbSystem(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  compartment_id: Optional[str] = None,
                  db_system_discovery_id: Optional[str] = None,
                  database_management_config: Optional[CloudDbSystemDatabaseManagementConfigArgs] = None,
                  defined_tags: Optional[Mapping[str, str]] = None,
                  display_name: Optional[str] = None,
                  freeform_tags: Optional[Mapping[str, str]] = None,
                  stack_monitoring_config: Optional[CloudDbSystemStackMonitoringConfigArgs] = None)
    func NewCloudDbSystem(ctx *Context, name string, args CloudDbSystemArgs, opts ...ResourceOption) (*CloudDbSystem, error)
    public CloudDbSystem(string name, CloudDbSystemArgs args, CustomResourceOptions? opts = null)
    public CloudDbSystem(String name, CloudDbSystemArgs args)
public CloudDbSystem(String name, CloudDbSystemArgs args, CustomResourceOptions options)

    type: oci:DatabaseManagement:CloudDbSystem
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 CloudDbSystemArgs
    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 CloudDbSystemArgs
    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 CloudDbSystemArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CloudDbSystemArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CloudDbSystemArgs
    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 cloudDbSystemResource = new Oci.DatabaseManagement.CloudDbSystem("cloudDbSystemResource", new()
{
    CompartmentId = "string",
    DbSystemDiscoveryId = "string",
    DatabaseManagementConfig = new Oci.DatabaseManagement.Inputs.CloudDbSystemDatabaseManagementConfigArgs
    {
        IsEnabled = false,
        Metadata = "string",
    },
    DefinedTags = 
    {
        { "string", "string" },
    },
    DisplayName = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    StackMonitoringConfig = new Oci.DatabaseManagement.Inputs.CloudDbSystemStackMonitoringConfigArgs
    {
        IsEnabled = false,
        Metadata = "string",
    },
});

    example, err := databasemanagement.NewCloudDbSystem(ctx, "cloudDbSystemResource", &databasemanagement.CloudDbSystemArgs{
	CompartmentId:       pulumi.String("string"),
	DbSystemDiscoveryId: pulumi.String("string"),
	DatabaseManagementConfig: &databasemanagement.CloudDbSystemDatabaseManagementConfigArgs{
		IsEnabled: pulumi.Bool(false),
		Metadata:  pulumi.String("string"),
	},
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	DisplayName: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	StackMonitoringConfig: &databasemanagement.CloudDbSystemStackMonitoringConfigArgs{
		IsEnabled: pulumi.Bool(false),
		Metadata:  pulumi.String("string"),
	},
})

    var cloudDbSystemResource = new CloudDbSystem("cloudDbSystemResource", CloudDbSystemArgs.builder()
    .compartmentId("string")
    .dbSystemDiscoveryId("string")
    .databaseManagementConfig(CloudDbSystemDatabaseManagementConfigArgs.builder()
        .isEnabled(false)
        .metadata("string")
        .build())
    .definedTags(Map.of("string", "string"))
    .displayName("string")
    .freeformTags(Map.of("string", "string"))
    .stackMonitoringConfig(CloudDbSystemStackMonitoringConfigArgs.builder()
        .isEnabled(false)
        .metadata("string")
        .build())
    .build());

    cloud_db_system_resource = oci.databasemanagement.CloudDbSystem("cloudDbSystemResource",
    compartment_id="string",
    db_system_discovery_id="string",
    database_management_config={
        "is_enabled": False,
        "metadata": "string",
    },
    defined_tags={
        "string": "string",
    },
    display_name="string",
    freeform_tags={
        "string": "string",
    },
    stack_monitoring_config={
        "is_enabled": False,
        "metadata": "string",
    })

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

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

    CloudDbSystem Resource Properties

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

    Inputs

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

    The CloudDbSystem resource accepts the following input properties:

    CompartmentId string
    The OCID of the compartment in which the cloud DB system resides.
    DbSystemDiscoveryId string
    The OCID of the DB system discovery.
    DatabaseManagementConfig CloudDbSystemDatabaseManagementConfig
    The configuration details of Database Management for a cloud DB system.
    DefinedTags Dictionary<string, string>
    (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, string>
    (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 CloudDbSystemStackMonitoringConfig
    The configuration details of Stack Monitoring for a cloud DB system.
    CompartmentId string
    The OCID of the compartment in which the cloud DB system resides.
    DbSystemDiscoveryId string
    The OCID of the DB system discovery.
    DatabaseManagementConfig CloudDbSystemDatabaseManagementConfigArgs
    The configuration details of Database Management for a cloud DB system.
    DefinedTags map[string]string
    (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]string
    (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 CloudDbSystemStackMonitoringConfigArgs
    The configuration details of Stack Monitoring for a cloud DB system.
    compartmentId String
    The OCID of the compartment in which the cloud DB system resides.
    dbSystemDiscoveryId String
    The OCID of the DB system discovery.
    databaseManagementConfig CloudDbSystemConfig
    The configuration details of Database Management for a cloud DB system.
    definedTags Map<String,String>
    (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,String>
    (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 CloudDbSystemStackMonitoringConfig
    The configuration details of Stack Monitoring for a cloud DB system.
    compartmentId string
    The OCID of the compartment in which the cloud DB system resides.
    dbSystemDiscoveryId string
    The OCID of the DB system discovery.
    databaseManagementConfig CloudDbSystemDatabaseManagementConfig
    The configuration details of Database Management for a cloud DB system.
    definedTags {[key: string]: string}
    (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]: string}
    (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 CloudDbSystemStackMonitoringConfig
    The configuration details of Stack Monitoring for a cloud DB system.
    compartment_id str
    The OCID of the compartment in which the cloud DB system resides.
    db_system_discovery_id str
    The OCID of the DB system discovery.
    database_management_config CloudDbSystemDatabaseManagementConfigArgs
    The configuration details of Database Management for a cloud DB system.
    defined_tags Mapping[str, str]
    (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, str]
    (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 CloudDbSystemStackMonitoringConfigArgs
    The configuration details of Stack Monitoring for a cloud DB system.
    compartmentId String
    The OCID of the compartment in which the cloud DB system resides.
    dbSystemDiscoveryId String
    The OCID of the DB system discovery.
    databaseManagementConfig Property Map
    The configuration details of Database Management for a cloud DB system.
    definedTags Map<String>
    (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>
    (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 configuration details of Stack Monitoring for a cloud DB system.

    Outputs

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

    DbaasParentInfrastructureId string
    The OCID of the parent cloud DB Infrastructure. For VM Dbsystems , it will be the DBSystem Id. For ExaCS and ExaCC, it will be the cloudVmClusterId and vmClusterId respectively.
    DeploymentType string
    The deployment type of cloud dbsystem.
    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 cloud DB system resource.
    SystemTags Dictionary<string, string>
    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 cloud DB system was created.
    TimeUpdated string
    The date and time the cloud DB system was last updated.
    DbaasParentInfrastructureId string
    The OCID of the parent cloud DB Infrastructure. For VM Dbsystems , it will be the DBSystem Id. For ExaCS and ExaCC, it will be the cloudVmClusterId and vmClusterId respectively.
    DeploymentType string
    The deployment type of cloud dbsystem.
    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 cloud DB system resource.
    SystemTags map[string]string
    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 cloud DB system was created.
    TimeUpdated string
    The date and time the cloud DB system was last updated.
    dbaasParentInfrastructureId String
    The OCID of the parent cloud DB Infrastructure. For VM Dbsystems , it will be the DBSystem Id. For ExaCS and ExaCC, it will be the cloudVmClusterId and vmClusterId respectively.
    deploymentType String
    The deployment type of cloud dbsystem.
    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 cloud DB system resource.
    systemTags Map<String,String>
    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 cloud DB system was created.
    timeUpdated String
    The date and time the cloud DB system was last updated.
    dbaasParentInfrastructureId string
    The OCID of the parent cloud DB Infrastructure. For VM Dbsystems , it will be the DBSystem Id. For ExaCS and ExaCC, it will be the cloudVmClusterId and vmClusterId respectively.
    deploymentType string
    The deployment type of cloud dbsystem.
    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 cloud DB system resource.
    systemTags {[key: string]: string}
    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 cloud DB system was created.
    timeUpdated string
    The date and time the cloud DB system was last updated.
    dbaas_parent_infrastructure_id str
    The OCID of the parent cloud DB Infrastructure. For VM Dbsystems , it will be the DBSystem Id. For ExaCS and ExaCC, it will be the cloudVmClusterId and vmClusterId respectively.
    deployment_type str
    The deployment type of cloud dbsystem.
    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 cloud DB system resource.
    system_tags Mapping[str, str]
    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 cloud DB system was created.
    time_updated str
    The date and time the cloud DB system was last updated.
    dbaasParentInfrastructureId String
    The OCID of the parent cloud DB Infrastructure. For VM Dbsystems , it will be the DBSystem Id. For ExaCS and ExaCC, it will be the cloudVmClusterId and vmClusterId respectively.
    deploymentType String
    The deployment type of cloud dbsystem.
    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 cloud DB system resource.
    systemTags Map<String>
    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 cloud DB system was created.
    timeUpdated String
    The date and time the cloud DB system was last updated.

    Look up Existing CloudDbSystem Resource

    Get an existing CloudDbSystem 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?: CloudDbSystemState, opts?: CustomResourceOptions): CloudDbSystem
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        database_management_config: Optional[CloudDbSystemDatabaseManagementConfigArgs] = None,
        db_system_discovery_id: Optional[str] = None,
        dbaas_parent_infrastructure_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        deployment_type: Optional[str] = None,
        discovery_agent_id: Optional[str] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        home_directory: Optional[str] = None,
        is_cluster: Optional[bool] = None,
        lifecycle_details: Optional[str] = None,
        stack_monitoring_config: Optional[CloudDbSystemStackMonitoringConfigArgs] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None) -> CloudDbSystem
    func GetCloudDbSystem(ctx *Context, name string, id IDInput, state *CloudDbSystemState, opts ...ResourceOption) (*CloudDbSystem, error)
    public static CloudDbSystem Get(string name, Input<string> id, CloudDbSystemState? state, CustomResourceOptions? opts = null)
    public static CloudDbSystem get(String name, Output<String> id, CloudDbSystemState state, CustomResourceOptions options)
    resources:  _:    type: oci:DatabaseManagement:CloudDbSystem    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CompartmentId string
    The OCID of the compartment in which the cloud DB system resides.
    DatabaseManagementConfig CloudDbSystemDatabaseManagementConfig
    The configuration details of Database Management for a cloud DB system.
    DbSystemDiscoveryId string
    The OCID of the DB system discovery.
    DbaasParentInfrastructureId string
    The OCID of the parent cloud DB Infrastructure. For VM Dbsystems , it will be the DBSystem Id. For ExaCS and ExaCC, it will be the cloudVmClusterId and vmClusterId respectively.
    DefinedTags Dictionary<string, string>
    (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"}
    DeploymentType string
    The deployment type of cloud dbsystem.
    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, string>
    (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 CloudDbSystemStackMonitoringConfig
    The configuration details of Stack Monitoring for a cloud DB system.
    State string
    The current lifecycle state of the cloud DB system resource.
    SystemTags Dictionary<string, string>
    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 cloud DB system was created.
    TimeUpdated string
    The date and time the cloud DB system was last updated.
    CompartmentId string
    The OCID of the compartment in which the cloud DB system resides.
    DatabaseManagementConfig CloudDbSystemDatabaseManagementConfigArgs
    The configuration details of Database Management for a cloud DB system.
    DbSystemDiscoveryId string
    The OCID of the DB system discovery.
    DbaasParentInfrastructureId string
    The OCID of the parent cloud DB Infrastructure. For VM Dbsystems , it will be the DBSystem Id. For ExaCS and ExaCC, it will be the cloudVmClusterId and vmClusterId respectively.
    DefinedTags map[string]string
    (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"}
    DeploymentType string
    The deployment type of cloud dbsystem.
    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]string
    (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 CloudDbSystemStackMonitoringConfigArgs
    The configuration details of Stack Monitoring for a cloud DB system.
    State string
    The current lifecycle state of the cloud DB system resource.
    SystemTags map[string]string
    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 cloud DB system was created.
    TimeUpdated string
    The date and time the cloud DB system was last updated.
    compartmentId String
    The OCID of the compartment in which the cloud DB system resides.
    databaseManagementConfig CloudDbSystemConfig
    The configuration details of Database Management for a cloud DB system.
    dbSystemDiscoveryId String
    The OCID of the DB system discovery.
    dbaasParentInfrastructureId String
    The OCID of the parent cloud DB Infrastructure. For VM Dbsystems , it will be the DBSystem Id. For ExaCS and ExaCC, it will be the cloudVmClusterId and vmClusterId respectively.
    definedTags Map<String,String>
    (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"}
    deploymentType String
    The deployment type of cloud dbsystem.
    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,String>
    (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 CloudDbSystemStackMonitoringConfig
    The configuration details of Stack Monitoring for a cloud DB system.
    state String
    The current lifecycle state of the cloud DB system resource.
    systemTags Map<String,String>
    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 cloud DB system was created.
    timeUpdated String
    The date and time the cloud DB system was last updated.
    compartmentId string
    The OCID of the compartment in which the cloud DB system resides.
    databaseManagementConfig CloudDbSystemDatabaseManagementConfig
    The configuration details of Database Management for a cloud DB system.
    dbSystemDiscoveryId string
    The OCID of the DB system discovery.
    dbaasParentInfrastructureId string
    The OCID of the parent cloud DB Infrastructure. For VM Dbsystems , it will be the DBSystem Id. For ExaCS and ExaCC, it will be the cloudVmClusterId and vmClusterId respectively.
    definedTags {[key: string]: string}
    (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"}
    deploymentType string
    The deployment type of cloud dbsystem.
    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]: string}
    (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 CloudDbSystemStackMonitoringConfig
    The configuration details of Stack Monitoring for a cloud DB system.
    state string
    The current lifecycle state of the cloud DB system resource.
    systemTags {[key: string]: string}
    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 cloud DB system was created.
    timeUpdated string
    The date and time the cloud DB system was last updated.
    compartment_id str
    The OCID of the compartment in which the cloud DB system resides.
    database_management_config CloudDbSystemDatabaseManagementConfigArgs
    The configuration details of Database Management for a cloud DB system.
    db_system_discovery_id str
    The OCID of the DB system discovery.
    dbaas_parent_infrastructure_id str
    The OCID of the parent cloud DB Infrastructure. For VM Dbsystems , it will be the DBSystem Id. For ExaCS and ExaCC, it will be the cloudVmClusterId and vmClusterId respectively.
    defined_tags Mapping[str, str]
    (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"}
    deployment_type str
    The deployment type of cloud dbsystem.
    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, str]
    (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 CloudDbSystemStackMonitoringConfigArgs
    The configuration details of Stack Monitoring for a cloud DB system.
    state str
    The current lifecycle state of the cloud DB system resource.
    system_tags Mapping[str, str]
    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 cloud DB system was created.
    time_updated str
    The date and time the cloud DB system was last updated.
    compartmentId String
    The OCID of the compartment in which the cloud DB system resides.
    databaseManagementConfig Property Map
    The configuration details of Database Management for a cloud DB system.
    dbSystemDiscoveryId String
    The OCID of the DB system discovery.
    dbaasParentInfrastructureId String
    The OCID of the parent cloud DB Infrastructure. For VM Dbsystems , it will be the DBSystem Id. For ExaCS and ExaCC, it will be the cloudVmClusterId and vmClusterId respectively.
    definedTags Map<String>
    (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"}
    deploymentType String
    The deployment type of cloud dbsystem.
    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>
    (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 configuration details of Stack Monitoring for a cloud DB system.
    state String
    The current lifecycle state of the cloud DB system resource.
    systemTags Map<String>
    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 cloud DB system was created.
    timeUpdated String
    The date and time the cloud DB system was last updated.

    Supporting Types

    CloudDbSystemDatabaseManagementConfig, CloudDbSystemDatabaseManagementConfigArgs

    IsEnabled bool
    The status of the associated service.
    Metadata string
    The associated service-specific inputs in JSON string format, which Database Management can identify.
    IsEnabled bool
    The status of the associated service.
    Metadata string
    The associated service-specific inputs in JSON string format, which Database Management can identify.
    isEnabled Boolean
    The status of the associated service.
    metadata String
    The associated service-specific inputs in JSON string format, which Database Management can identify.
    isEnabled boolean
    The status of the associated service.
    metadata string
    The associated service-specific inputs in JSON string format, which Database Management can identify.
    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.
    isEnabled Boolean
    The status of the associated service.
    metadata String
    The associated service-specific inputs in JSON string format, which Database Management can identify.

    CloudDbSystemStackMonitoringConfig, CloudDbSystemStackMonitoringConfigArgs

    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

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

    $ pulumi import oci:DatabaseManagement/cloudDbSystem:CloudDbSystem test_cloud_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 v3.7.0 published on Saturday, Sep 13, 2025 by Pulumi
    pulumi/pulumi-oci