Oracle Cloud Infrastructure v0.20.0, May 31 23
Oracle Cloud Infrastructure v0.20.0, May 31 23
oci.Database.DbNodeConsoleConnection
Explore with Pulumi AI
This resource provides the Db Node Console Connection resource in Oracle Cloud Infrastructure Database service.
Creates a new console connection to the specified database node. After the console connection has been created and is available, you connect to the console using SSH.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() =>
{
var testDbNodeConsoleConnection = new Oci.Database.DbNodeConsoleConnection("testDbNodeConsoleConnection", new()
{
DbNodeId = oci_database_db_node.Test_db_node.Id,
PublicKey = @var.Db_node_console_connection_public_key,
});
});
package main
import (
"github.com/pulumi/pulumi-oci/sdk/go/oci/Database"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := Database.NewDbNodeConsoleConnection(ctx, "testDbNodeConsoleConnection", &Database.DbNodeConsoleConnectionArgs{
DbNodeId: pulumi.Any(oci_database_db_node.Test_db_node.Id),
PublicKey: pulumi.Any(_var.Db_node_console_connection_public_key),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Database.DbNodeConsoleConnection;
import com.pulumi.oci.Database.DbNodeConsoleConnectionArgs;
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 testDbNodeConsoleConnection = new DbNodeConsoleConnection("testDbNodeConsoleConnection", DbNodeConsoleConnectionArgs.builder()
.dbNodeId(oci_database_db_node.test_db_node().id())
.publicKey(var_.db_node_console_connection_public_key())
.build());
}
}
import pulumi
import pulumi_oci as oci
test_db_node_console_connection = oci.database.DbNodeConsoleConnection("testDbNodeConsoleConnection",
db_node_id=oci_database_db_node["test_db_node"]["id"],
public_key=var["db_node_console_connection_public_key"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testDbNodeConsoleConnection = new oci.database.DbNodeConsoleConnection("testDbNodeConsoleConnection", {
dbNodeId: oci_database_db_node.test_db_node.id,
publicKey: _var.db_node_console_connection_public_key,
});
resources:
testDbNodeConsoleConnection:
type: oci:Database:DbNodeConsoleConnection
properties:
#Required
dbNodeId: ${oci_database_db_node.test_db_node.id}
publicKey: ${var.db_node_console_connection_public_key}
Create DbNodeConsoleConnection Resource
new DbNodeConsoleConnection(name: string, args: DbNodeConsoleConnectionArgs, opts?: CustomResourceOptions);
@overload
def DbNodeConsoleConnection(resource_name: str,
opts: Optional[ResourceOptions] = None,
db_node_id: Optional[str] = None,
public_key: Optional[str] = None)
@overload
def DbNodeConsoleConnection(resource_name: str,
args: DbNodeConsoleConnectionArgs,
opts: Optional[ResourceOptions] = None)
func NewDbNodeConsoleConnection(ctx *Context, name string, args DbNodeConsoleConnectionArgs, opts ...ResourceOption) (*DbNodeConsoleConnection, error)
public DbNodeConsoleConnection(string name, DbNodeConsoleConnectionArgs args, CustomResourceOptions? opts = null)
public DbNodeConsoleConnection(String name, DbNodeConsoleConnectionArgs args)
public DbNodeConsoleConnection(String name, DbNodeConsoleConnectionArgs args, CustomResourceOptions options)
type: oci:Database:DbNodeConsoleConnection
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DbNodeConsoleConnectionArgs
- 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 DbNodeConsoleConnectionArgs
- 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 DbNodeConsoleConnectionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DbNodeConsoleConnectionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DbNodeConsoleConnectionArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
DbNodeConsoleConnection 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 DbNodeConsoleConnection resource accepts the following input properties:
- db_
node_ strid The database node OCID.
- public_
key str The SSH public key used to authenticate the console connection.
** 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 DbNodeConsoleConnection resource produces the following output properties:
- Compartment
Id string The OCID of the compartment to contain the console connection.
- Connection
String string The SSH connection string for the console connection.
- Fingerprint string
The SSH public key fingerprint for the console connection.
- Id string
The provider-assigned unique ID for this managed resource.
- State string
The current state of the console connection.
- Compartment
Id string The OCID of the compartment to contain the console connection.
- Connection
String string The SSH connection string for the console connection.
- Fingerprint string
The SSH public key fingerprint for the console connection.
- Id string
The provider-assigned unique ID for this managed resource.
- State string
The current state of the console connection.
- compartment
Id String The OCID of the compartment to contain the console connection.
- connection
String String The SSH connection string for the console connection.
- fingerprint String
The SSH public key fingerprint for the console connection.
- id String
The provider-assigned unique ID for this managed resource.
- state String
The current state of the console connection.
- compartment
Id string The OCID of the compartment to contain the console connection.
- connection
String string The SSH connection string for the console connection.
- fingerprint string
The SSH public key fingerprint for the console connection.
- id string
The provider-assigned unique ID for this managed resource.
- state string
The current state of the console connection.
- compartment_
id str The OCID of the compartment to contain the console connection.
- connection_
string str The SSH connection string for the console connection.
- fingerprint str
The SSH public key fingerprint for the console connection.
- id str
The provider-assigned unique ID for this managed resource.
- state str
The current state of the console connection.
- compartment
Id String The OCID of the compartment to contain the console connection.
- connection
String String The SSH connection string for the console connection.
- fingerprint String
The SSH public key fingerprint for the console connection.
- id String
The provider-assigned unique ID for this managed resource.
- state String
The current state of the console connection.
Look up Existing DbNodeConsoleConnection Resource
Get an existing DbNodeConsoleConnection 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?: DbNodeConsoleConnectionState, opts?: CustomResourceOptions): DbNodeConsoleConnection
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
compartment_id: Optional[str] = None,
connection_string: Optional[str] = None,
db_node_id: Optional[str] = None,
fingerprint: Optional[str] = None,
public_key: Optional[str] = None,
state: Optional[str] = None) -> DbNodeConsoleConnection
func GetDbNodeConsoleConnection(ctx *Context, name string, id IDInput, state *DbNodeConsoleConnectionState, opts ...ResourceOption) (*DbNodeConsoleConnection, error)
public static DbNodeConsoleConnection Get(string name, Input<string> id, DbNodeConsoleConnectionState? state, CustomResourceOptions? opts = null)
public static DbNodeConsoleConnection get(String name, Output<String> id, DbNodeConsoleConnectionState 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.
- Compartment
Id string The OCID of the compartment to contain the console connection.
- Connection
String string The SSH connection string for the console connection.
- Db
Node stringId The database node OCID.
- Fingerprint string
The SSH public key fingerprint for the console connection.
- Public
Key string The SSH public key used to authenticate the console connection.
** 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
- State string
The current state of the console connection.
- Compartment
Id string The OCID of the compartment to contain the console connection.
- Connection
String string The SSH connection string for the console connection.
- Db
Node stringId The database node OCID.
- Fingerprint string
The SSH public key fingerprint for the console connection.
- Public
Key string The SSH public key used to authenticate the console connection.
** 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
- State string
The current state of the console connection.
- compartment
Id String The OCID of the compartment to contain the console connection.
- connection
String String The SSH connection string for the console connection.
- db
Node StringId The database node OCID.
- fingerprint String
The SSH public key fingerprint for the console connection.
- public
Key String The SSH public key used to authenticate the console connection.
** 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
- state String
The current state of the console connection.
- compartment
Id string The OCID of the compartment to contain the console connection.
- connection
String string The SSH connection string for the console connection.
- db
Node stringId The database node OCID.
- fingerprint string
The SSH public key fingerprint for the console connection.
- public
Key string The SSH public key used to authenticate the console connection.
** 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
- state string
The current state of the console connection.
- compartment_
id str The OCID of the compartment to contain the console connection.
- connection_
string str The SSH connection string for the console connection.
- db_
node_ strid The database node OCID.
- fingerprint str
The SSH public key fingerprint for the console connection.
- public_
key str The SSH public key used to authenticate the console connection.
** 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
- state str
The current state of the console connection.
- compartment
Id String The OCID of the compartment to contain the console connection.
- connection
String String The SSH connection string for the console connection.
- db
Node StringId The database node OCID.
- fingerprint String
The SSH public key fingerprint for the console connection.
- public
Key String The SSH public key used to authenticate the console connection.
** 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
- state String
The current state of the console connection.
Import
DbNodeConsoleConnections can be imported using the id
, e.g.
$ pulumi import oci:Database/dbNodeConsoleConnection:DbNodeConsoleConnection test_db_node_console_connection "dbNodes/{dbNodeId}/consoleConnections/{consoleConnectionId}"
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
oci
Terraform Provider.