1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Database
  5. DbNodeConsoleConnection
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi

oci.Database.DbNodeConsoleConnection

Explore with Pulumi AI

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

    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

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testDbNodeConsoleConnection = new oci.database.DbNodeConsoleConnection("test_db_node_console_connection", {
        dbNodeId: testDbNode.id,
        publicKey: dbNodeConsoleConnectionPublicKey,
        definedTags: dbNodeConsoleConnectionDefinedTags,
        freeformTags: {
            Department: "Finance",
        },
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_db_node_console_connection = oci.database.DbNodeConsoleConnection("test_db_node_console_connection",
        db_node_id=test_db_node["id"],
        public_key=db_node_console_connection_public_key,
        defined_tags=db_node_console_connection_defined_tags,
        freeform_tags={
            "Department": "Finance",
        })
    
    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, "test_db_node_console_connection", &Database.DbNodeConsoleConnectionArgs{
    			DbNodeId:    pulumi.Any(testDbNode.Id),
    			PublicKey:   pulumi.Any(dbNodeConsoleConnectionPublicKey),
    			DefinedTags: pulumi.Any(dbNodeConsoleConnectionDefinedTags),
    			FreeformTags: pulumi.Map{
    				"Department": pulumi.Any("Finance"),
    			},
    		})
    		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 testDbNodeConsoleConnection = new Oci.Database.DbNodeConsoleConnection("test_db_node_console_connection", new()
        {
            DbNodeId = testDbNode.Id,
            PublicKey = dbNodeConsoleConnectionPublicKey,
            DefinedTags = dbNodeConsoleConnectionDefinedTags,
            FreeformTags = 
            {
                { "Department", "Finance" },
            },
        });
    
    });
    
    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(testDbNode.id())
                .publicKey(dbNodeConsoleConnectionPublicKey)
                .definedTags(dbNodeConsoleConnectionDefinedTags)
                .freeformTags(Map.of("Department", "Finance"))
                .build());
    
        }
    }
    
    resources:
      testDbNodeConsoleConnection:
        type: oci:Database:DbNodeConsoleConnection
        name: test_db_node_console_connection
        properties:
          dbNodeId: ${testDbNode.id}
          publicKey: ${dbNodeConsoleConnectionPublicKey}
          definedTags: ${dbNodeConsoleConnectionDefinedTags}
          freeformTags:
            Department: Finance
    

    Create DbNodeConsoleConnection Resource

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

    Constructor syntax

    new DbNodeConsoleConnection(name: string, args: DbNodeConsoleConnectionArgs, opts?: CustomResourceOptions);
    @overload
    def DbNodeConsoleConnection(resource_name: str,
                                args: DbNodeConsoleConnectionArgs,
                                opts: Optional[ResourceOptions] = None)
    
    @overload
    def DbNodeConsoleConnection(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                db_node_id: Optional[str] = None,
                                public_key: Optional[str] = None,
                                defined_tags: Optional[Mapping[str, Any]] = None,
                                freeform_tags: Optional[Mapping[str, Any]] = 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.
    
    

    Parameters

    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.

    Example

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

    var dbNodeConsoleConnectionResource = new Oci.Database.DbNodeConsoleConnection("dbNodeConsoleConnectionResource", new()
    {
        DbNodeId = "string",
        PublicKey = "string",
        DefinedTags = 
        {
            { "string", "any" },
        },
        FreeformTags = 
        {
            { "string", "any" },
        },
    });
    
    example, err := Database.NewDbNodeConsoleConnection(ctx, "dbNodeConsoleConnectionResource", &Database.DbNodeConsoleConnectionArgs{
    	DbNodeId:  pulumi.String("string"),
    	PublicKey: pulumi.String("string"),
    	DefinedTags: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    	FreeformTags: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    })
    
    var dbNodeConsoleConnectionResource = new DbNodeConsoleConnection("dbNodeConsoleConnectionResource", DbNodeConsoleConnectionArgs.builder()
        .dbNodeId("string")
        .publicKey("string")
        .definedTags(Map.of("string", "any"))
        .freeformTags(Map.of("string", "any"))
        .build());
    
    db_node_console_connection_resource = oci.database.DbNodeConsoleConnection("dbNodeConsoleConnectionResource",
        db_node_id="string",
        public_key="string",
        defined_tags={
            "string": "any",
        },
        freeform_tags={
            "string": "any",
        })
    
    const dbNodeConsoleConnectionResource = new oci.database.DbNodeConsoleConnection("dbNodeConsoleConnectionResource", {
        dbNodeId: "string",
        publicKey: "string",
        definedTags: {
            string: "any",
        },
        freeformTags: {
            string: "any",
        },
    });
    
    type: oci:Database:DbNodeConsoleConnection
    properties:
        dbNodeId: string
        definedTags:
            string: any
        freeformTags:
            string: any
        publicKey: string
    

    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:

    DbNodeId string
    The database node OCID.
    PublicKey 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

    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.
    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"}
    DbNodeId string
    The database node OCID.
    PublicKey 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

    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.
    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"}
    dbNodeId String
    The database node OCID.
    publicKey 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

    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.
    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"}
    dbNodeId string
    The database node OCID.
    publicKey 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

    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.
    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"}
    db_node_id str
    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

    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.
    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"}
    dbNodeId String
    The database node OCID.
    publicKey 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

    definedTags Map<Any>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    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"}

    Outputs

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

    CompartmentId string
    The OCID of the compartment to contain the console connection.
    ConnectionString 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.
    LifecycleDetails string
    Information about the current lifecycle state.
    ServiceHostKeyFingerprint string
    The SSH public key's fingerprint for the console connection service host.
    State string
    The current state of the console connection.
    CompartmentId string
    The OCID of the compartment to contain the console connection.
    ConnectionString 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.
    LifecycleDetails string
    Information about the current lifecycle state.
    ServiceHostKeyFingerprint string
    The SSH public key's fingerprint for the console connection service host.
    State string
    The current state of the console connection.
    compartmentId String
    The OCID of the compartment to contain the console connection.
    connectionString 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.
    lifecycleDetails String
    Information about the current lifecycle state.
    serviceHostKeyFingerprint String
    The SSH public key's fingerprint for the console connection service host.
    state String
    The current state of the console connection.
    compartmentId string
    The OCID of the compartment to contain the console connection.
    connectionString 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.
    lifecycleDetails string
    Information about the current lifecycle state.
    serviceHostKeyFingerprint string
    The SSH public key's fingerprint for the console connection service host.
    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.
    lifecycle_details str
    Information about the current lifecycle state.
    service_host_key_fingerprint str
    The SSH public key's fingerprint for the console connection service host.
    state str
    The current state of the console connection.
    compartmentId String
    The OCID of the compartment to contain the console connection.
    connectionString 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.
    lifecycleDetails String
    Information about the current lifecycle state.
    serviceHostKeyFingerprint String
    The SSH public key's fingerprint for the console connection service host.
    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,
            defined_tags: Optional[Mapping[str, Any]] = None,
            fingerprint: Optional[str] = None,
            freeform_tags: Optional[Mapping[str, Any]] = None,
            lifecycle_details: Optional[str] = None,
            public_key: Optional[str] = None,
            service_host_key_fingerprint: 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.
    The following state arguments are supported:
    CompartmentId string
    The OCID of the compartment to contain the console connection.
    ConnectionString string
    The SSH connection string for the console connection.
    DbNodeId string
    The database node OCID.
    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.
    Fingerprint string
    The SSH public key fingerprint for the console connection.
    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"}
    LifecycleDetails string
    Information about the current lifecycle state.
    PublicKey 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

    ServiceHostKeyFingerprint string
    The SSH public key's fingerprint for the console connection service host.
    State string
    The current state of the console connection.
    CompartmentId string
    The OCID of the compartment to contain the console connection.
    ConnectionString string
    The SSH connection string for the console connection.
    DbNodeId string
    The database node OCID.
    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.
    Fingerprint string
    The SSH public key fingerprint for the console connection.
    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"}
    LifecycleDetails string
    Information about the current lifecycle state.
    PublicKey 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

    ServiceHostKeyFingerprint string
    The SSH public key's fingerprint for the console connection service host.
    State string
    The current state of the console connection.
    compartmentId String
    The OCID of the compartment to contain the console connection.
    connectionString String
    The SSH connection string for the console connection.
    dbNodeId String
    The database node OCID.
    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.
    fingerprint String
    The SSH public key fingerprint for the console connection.
    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"}
    lifecycleDetails String
    Information about the current lifecycle state.
    publicKey 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

    serviceHostKeyFingerprint String
    The SSH public key's fingerprint for the console connection service host.
    state String
    The current state of the console connection.
    compartmentId string
    The OCID of the compartment to contain the console connection.
    connectionString string
    The SSH connection string for the console connection.
    dbNodeId string
    The database node OCID.
    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.
    fingerprint string
    The SSH public key fingerprint for the console connection.
    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"}
    lifecycleDetails string
    Information about the current lifecycle state.
    publicKey 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

    serviceHostKeyFingerprint string
    The SSH public key's fingerprint for the console connection service host.
    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_id str
    The database node OCID.
    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.
    fingerprint str
    The SSH public key fingerprint for the console connection.
    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"}
    lifecycle_details str
    Information about the current lifecycle state.
    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

    service_host_key_fingerprint str
    The SSH public key's fingerprint for the console connection service host.
    state str
    The current state of the console connection.
    compartmentId String
    The OCID of the compartment to contain the console connection.
    connectionString String
    The SSH connection string for the console connection.
    dbNodeId String
    The database node OCID.
    definedTags Map<Any>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    fingerprint String
    The SSH public key fingerprint for the console connection.
    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"}
    lifecycleDetails String
    Information about the current lifecycle state.
    publicKey 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

    serviceHostKeyFingerprint String
    The SSH public key's fingerprint for the console connection service host.
    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}"
    

    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