1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Database
  5. DbNodeConsoleHistory
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

oci.Database.DbNodeConsoleHistory

Explore with Pulumi AI

This resource provides the Db Node Console History resource in Oracle Cloud Infrastructure Database service.

Captures the most recent serial console data (up to a megabyte) for the specified database node.

Example Usage

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

const testDbNodeConsoleHistory = new oci.database.DbNodeConsoleHistory("test_db_node_console_history", {
    dbNodeId: testDbNode.id,
    displayName: dbNodeConsoleHistoryDisplayName,
    definedTags: dbNodeConsoleHistoryDefinedTags,
    freeformTags: {
        Department: "Finance",
    },
});
Copy
import pulumi
import pulumi_oci as oci

test_db_node_console_history = oci.database.DbNodeConsoleHistory("test_db_node_console_history",
    db_node_id=test_db_node["id"],
    display_name=db_node_console_history_display_name,
    defined_tags=db_node_console_history_defined_tags,
    freeform_tags={
        "Department": "Finance",
    })
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := database.NewDbNodeConsoleHistory(ctx, "test_db_node_console_history", &database.DbNodeConsoleHistoryArgs{
			DbNodeId:    pulumi.Any(testDbNode.Id),
			DisplayName: pulumi.Any(dbNodeConsoleHistoryDisplayName),
			DefinedTags: pulumi.Any(dbNodeConsoleHistoryDefinedTags),
			FreeformTags: pulumi.StringMap{
				"Department": pulumi.String("Finance"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testDbNodeConsoleHistory = new Oci.Database.DbNodeConsoleHistory("test_db_node_console_history", new()
    {
        DbNodeId = testDbNode.Id,
        DisplayName = dbNodeConsoleHistoryDisplayName,
        DefinedTags = dbNodeConsoleHistoryDefinedTags,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Database.DbNodeConsoleHistory;
import com.pulumi.oci.Database.DbNodeConsoleHistoryArgs;
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 testDbNodeConsoleHistory = new DbNodeConsoleHistory("testDbNodeConsoleHistory", DbNodeConsoleHistoryArgs.builder()
            .dbNodeId(testDbNode.id())
            .displayName(dbNodeConsoleHistoryDisplayName)
            .definedTags(dbNodeConsoleHistoryDefinedTags)
            .freeformTags(Map.of("Department", "Finance"))
            .build());

    }
}
Copy
resources:
  testDbNodeConsoleHistory:
    type: oci:Database:DbNodeConsoleHistory
    name: test_db_node_console_history
    properties:
      dbNodeId: ${testDbNode.id}
      displayName: ${dbNodeConsoleHistoryDisplayName}
      definedTags: ${dbNodeConsoleHistoryDefinedTags}
      freeformTags:
        Department: Finance
Copy

Create DbNodeConsoleHistory Resource

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

Constructor syntax

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

@overload
def DbNodeConsoleHistory(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         db_node_id: Optional[str] = None,
                         display_name: Optional[str] = None,
                         defined_tags: Optional[Mapping[str, str]] = None,
                         freeform_tags: Optional[Mapping[str, str]] = None)
func NewDbNodeConsoleHistory(ctx *Context, name string, args DbNodeConsoleHistoryArgs, opts ...ResourceOption) (*DbNodeConsoleHistory, error)
public DbNodeConsoleHistory(string name, DbNodeConsoleHistoryArgs args, CustomResourceOptions? opts = null)
public DbNodeConsoleHistory(String name, DbNodeConsoleHistoryArgs args)
public DbNodeConsoleHistory(String name, DbNodeConsoleHistoryArgs args, CustomResourceOptions options)
type: oci:Database:DbNodeConsoleHistory
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. DbNodeConsoleHistoryArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. DbNodeConsoleHistoryArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. DbNodeConsoleHistoryArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DbNodeConsoleHistoryArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. DbNodeConsoleHistoryArgs
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 dbNodeConsoleHistoryResource = new Oci.Database.DbNodeConsoleHistory("dbNodeConsoleHistoryResource", new()
{
    DbNodeId = "string",
    DisplayName = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    FreeformTags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := Database.NewDbNodeConsoleHistory(ctx, "dbNodeConsoleHistoryResource", &Database.DbNodeConsoleHistoryArgs{
	DbNodeId:    pulumi.String("string"),
	DisplayName: pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var dbNodeConsoleHistoryResource = new DbNodeConsoleHistory("dbNodeConsoleHistoryResource", DbNodeConsoleHistoryArgs.builder()
    .dbNodeId("string")
    .displayName("string")
    .definedTags(Map.of("string", "string"))
    .freeformTags(Map.of("string", "string"))
    .build());
Copy
db_node_console_history_resource = oci.database.DbNodeConsoleHistory("dbNodeConsoleHistoryResource",
    db_node_id="string",
    display_name="string",
    defined_tags={
        "string": "string",
    },
    freeform_tags={
        "string": "string",
    })
Copy
const dbNodeConsoleHistoryResource = new oci.database.DbNodeConsoleHistory("dbNodeConsoleHistoryResource", {
    dbNodeId: "string",
    displayName: "string",
    definedTags: {
        string: "string",
    },
    freeformTags: {
        string: "string",
    },
});
Copy
type: oci:Database:DbNodeConsoleHistory
properties:
    dbNodeId: string
    definedTags:
        string: string
    displayName: string
    freeformTags:
        string: string
Copy

DbNodeConsoleHistory 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 DbNodeConsoleHistory resource accepts the following input properties:

DbNodeId
This property is required.
Changes to this property will trigger replacement.
string
The database node OCID.
DisplayName This property is required. string
(Updatable) The user-friendly name for the console history. The name does not need to be unique.
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.
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"}

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

DbNodeId
This property is required.
Changes to this property will trigger replacement.
string
The database node OCID.
DisplayName This property is required. string
(Updatable) The user-friendly name for the console history. The name does not need to be unique.
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.
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"}

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

dbNodeId
This property is required.
Changes to this property will trigger replacement.
String
The database node OCID.
displayName This property is required. String
(Updatable) The user-friendly name for the console history. The name does not need to be unique.
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.
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"}

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

dbNodeId
This property is required.
Changes to this property will trigger replacement.
string
The database node OCID.
displayName This property is required. string
(Updatable) The user-friendly name for the console history. The name does not need to be unique.
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.
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"}

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

db_node_id
This property is required.
Changes to this property will trigger replacement.
str
The database node OCID.
display_name This property is required. str
(Updatable) The user-friendly name for the console history. The name does not need to be unique.
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.
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"}

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

dbNodeId
This property is required.
Changes to this property will trigger replacement.
String
The database node OCID.
displayName This property is required. String
(Updatable) The user-friendly name for the console history. The name does not need to be unique.
definedTags Map<String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
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"}

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

Outputs

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

CompartmentId string
The OCID of the compartment containing the console history.
Id string
The provider-assigned unique ID for this managed resource.
LifecycleDetails string
Additional information about the current lifecycle state.
State string
The current state of the console history.
TimeCreated string
The date and time the console history was created.
CompartmentId string
The OCID of the compartment containing the console history.
Id string
The provider-assigned unique ID for this managed resource.
LifecycleDetails string
Additional information about the current lifecycle state.
State string
The current state of the console history.
TimeCreated string
The date and time the console history was created.
compartmentId String
The OCID of the compartment containing the console history.
id String
The provider-assigned unique ID for this managed resource.
lifecycleDetails String
Additional information about the current lifecycle state.
state String
The current state of the console history.
timeCreated String
The date and time the console history was created.
compartmentId string
The OCID of the compartment containing the console history.
id string
The provider-assigned unique ID for this managed resource.
lifecycleDetails string
Additional information about the current lifecycle state.
state string
The current state of the console history.
timeCreated string
The date and time the console history was created.
compartment_id str
The OCID of the compartment containing the console history.
id str
The provider-assigned unique ID for this managed resource.
lifecycle_details str
Additional information about the current lifecycle state.
state str
The current state of the console history.
time_created str
The date and time the console history was created.
compartmentId String
The OCID of the compartment containing the console history.
id String
The provider-assigned unique ID for this managed resource.
lifecycleDetails String
Additional information about the current lifecycle state.
state String
The current state of the console history.
timeCreated String
The date and time the console history was created.

Look up Existing DbNodeConsoleHistory Resource

Get an existing DbNodeConsoleHistory 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?: DbNodeConsoleHistoryState, opts?: CustomResourceOptions): DbNodeConsoleHistory
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        db_node_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        lifecycle_details: Optional[str] = None,
        state: Optional[str] = None,
        time_created: Optional[str] = None) -> DbNodeConsoleHistory
func GetDbNodeConsoleHistory(ctx *Context, name string, id IDInput, state *DbNodeConsoleHistoryState, opts ...ResourceOption) (*DbNodeConsoleHistory, error)
public static DbNodeConsoleHistory Get(string name, Input<string> id, DbNodeConsoleHistoryState? state, CustomResourceOptions? opts = null)
public static DbNodeConsoleHistory get(String name, Output<String> id, DbNodeConsoleHistoryState state, CustomResourceOptions options)
resources:  _:    type: oci:Database:DbNodeConsoleHistory    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 containing the console history.
DbNodeId Changes to this property will trigger replacement. string
The database node OCID.
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.
DisplayName string
(Updatable) The user-friendly name for the console history. The name does not need 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"}

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

LifecycleDetails string
Additional information about the current lifecycle state.
State string
The current state of the console history.
TimeCreated string
The date and time the console history was created.
CompartmentId string
The OCID of the compartment containing the console history.
DbNodeId Changes to this property will trigger replacement. string
The database node OCID.
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.
DisplayName string
(Updatable) The user-friendly name for the console history. The name does not need 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"}

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

LifecycleDetails string
Additional information about the current lifecycle state.
State string
The current state of the console history.
TimeCreated string
The date and time the console history was created.
compartmentId String
The OCID of the compartment containing the console history.
dbNodeId Changes to this property will trigger replacement. String
The database node OCID.
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.
displayName String
(Updatable) The user-friendly name for the console history. The name does not need 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"}

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

lifecycleDetails String
Additional information about the current lifecycle state.
state String
The current state of the console history.
timeCreated String
The date and time the console history was created.
compartmentId string
The OCID of the compartment containing the console history.
dbNodeId Changes to this property will trigger replacement. string
The database node OCID.
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.
displayName string
(Updatable) The user-friendly name for the console history. The name does not need 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"}

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

lifecycleDetails string
Additional information about the current lifecycle state.
state string
The current state of the console history.
timeCreated string
The date and time the console history was created.
compartment_id str
The OCID of the compartment containing the console history.
db_node_id Changes to this property will trigger replacement. str
The database node OCID.
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.
display_name str
(Updatable) The user-friendly name for the console history. The name does not need 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"}

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

lifecycle_details str
Additional information about the current lifecycle state.
state str
The current state of the console history.
time_created str
The date and time the console history was created.
compartmentId String
The OCID of the compartment containing the console history.
dbNodeId Changes to this property will trigger replacement. String
The database node OCID.
definedTags Map<String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
displayName String
(Updatable) The user-friendly name for the console history. The name does not need 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"}

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

lifecycleDetails String
Additional information about the current lifecycle state.
state String
The current state of the console history.
timeCreated String
The date and time the console history was created.

Import

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

$ pulumi import oci:Database/dbNodeConsoleHistory:DbNodeConsoleHistory test_db_node_console_history "dbNodes/{dbNodeId}/consoleHistories/{consoleHistoryId}"
Copy

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.