DigitalOcean v4.19.3, May 24 23

digitalocean.SshKey

Explore with Pulumi AI

Provides a DigitalOcean SSH key resource to allow you to manage SSH keys for Droplet access. Keys created with this resource can be referenced in your Droplet configuration via their ID or fingerprint.

Example Usage

using System.Collections.Generic;
using System.IO;
using System.Linq;
using Pulumi;
using DigitalOcean = Pulumi.DigitalOcean;

return await Deployment.RunAsync(() => 
{
    // Create a new SSH key
    var @default = new DigitalOcean.SshKey("default", new()
    {
        PublicKey = File.ReadAllText("/Users/myuser/.ssh/id_rsa.pub"),
    });

    // Create a new Droplet using the SSH key
    var web = new DigitalOcean.Droplet("web", new()
    {
        Image = "ubuntu-18-04-x64",
        Region = "nyc3",
        Size = "s-1vcpu-1gb",
        SshKeys = new[]
        {
            @default.Fingerprint,
        },
    });

});

package main

import (
	"os"

	"github.com/pulumi/pulumi-digitalocean/sdk/v4/go/digitalocean"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func readFileOrPanic(path string) pulumi.StringPtrInput {
	data, err := os.ReadFile(path)
	if err != nil {
		panic(err.Error())
	}
	return pulumi.String(string(data))
}

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := digitalocean.NewSshKey(ctx, "default", &digitalocean.SshKeyArgs{
			PublicKey: readFileOrPanic("/Users/myuser/.ssh/id_rsa.pub"),
		})
		if err != nil {
			return err
		}
		_, err = digitalocean.NewDroplet(ctx, "web", &digitalocean.DropletArgs{
			Image:  pulumi.String("ubuntu-18-04-x64"),
			Region: pulumi.String("nyc3"),
			Size:   pulumi.String("s-1vcpu-1gb"),
			SshKeys: pulumi.StringArray{
				_default.Fingerprint,
			},
		})
		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.digitalocean.SshKey;
import com.pulumi.digitalocean.SshKeyArgs;
import com.pulumi.digitalocean.Droplet;
import com.pulumi.digitalocean.DropletArgs;
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 default_ = new SshKey("default", SshKeyArgs.builder()        
            .publicKey(Files.readString(Paths.get("/Users/myuser/.ssh/id_rsa.pub")))
            .build());

        var web = new Droplet("web", DropletArgs.builder()        
            .image("ubuntu-18-04-x64")
            .region("nyc3")
            .size("s-1vcpu-1gb")
            .sshKeys(default_.fingerprint())
            .build());

    }
}

import pulumi
import pulumi_digitalocean as digitalocean

# Create a new SSH key
default = digitalocean.SshKey("default", public_key=(lambda path: open(path).read())("/Users/myuser/.ssh/id_rsa.pub"))
# Create a new Droplet using the SSH key
web = digitalocean.Droplet("web",
    image="ubuntu-18-04-x64",
    region="nyc3",
    size="s-1vcpu-1gb",
    ssh_keys=[default.fingerprint])

import * as pulumi from "@pulumi/pulumi";
import * as digitalocean from "@pulumi/digitalocean";
import * as fs from "fs";

// Create a new SSH key
const _default = new digitalocean.SshKey("default", {publicKey: fs.readFileSync("/Users/myuser/.ssh/id_rsa.pub")});
// Create a new Droplet using the SSH key
const web = new digitalocean.Droplet("web", {
    image: "ubuntu-18-04-x64",
    region: "nyc3",
    size: "s-1vcpu-1gb",
    sshKeys: [_default.fingerprint],
});

resources:
  # Create a new SSH key
  default:
    type: digitalocean:SshKey
    properties:
      publicKey:
        fn::readFile: /Users/myuser/.ssh/id_rsa.pub
  # Create a new Droplet using the SSH key
  web:
    type: digitalocean:Droplet
    properties:
      image: ubuntu-18-04-x64
      region: nyc3
      size: s-1vcpu-1gb
      sshKeys:
        - ${default.fingerprint}

Create SshKey Resource

new SshKey(name: string, args: SshKeyArgs, opts?: CustomResourceOptions);

@overload
def SshKey(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           name: Optional[str] = None,
           public_key: Optional[str] = None)
@overload
def SshKey(resource_name: str,
           args: SshKeyArgs,
           opts: Optional[ResourceOptions] = None)

func NewSshKey(ctx *Context, name string, args SshKeyArgs, opts ...ResourceOption) (*SshKey, error)

public SshKey(string name, SshKeyArgs args, CustomResourceOptions? opts = null)

public SshKey(String name, SshKeyArgs args)
public SshKey(String name, SshKeyArgs args, CustomResourceOptions options)

type: digitalocean:SshKey
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SshKeyArgs: 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 SshKeyArgs: 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 SshKeyArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SshKeyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args SshKeyArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

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

PublicKey string: The public key. If this is a file, it can be read using the file interpolation function
Name string: The name of the SSH key for identification

PublicKey string: The public key. If this is a file, it can be read using the file interpolation function
Name string: The name of the SSH key for identification

publicKey String: The public key. If this is a file, it can be read using the file interpolation function
name String: The name of the SSH key for identification

publicKey string: The public key. If this is a file, it can be read using the file interpolation function
name string: The name of the SSH key for identification

public_key str: The public key. If this is a file, it can be read using the file interpolation function
name str: The name of the SSH key for identification

publicKey String: The public key. If this is a file, it can be read using the file interpolation function
name String: The name of the SSH key for identification

Outputs

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

Fingerprint string: The fingerprint of the SSH key
Id string: The provider-assigned unique ID for this managed resource.

Fingerprint string: The fingerprint of the SSH key
Id string: The provider-assigned unique ID for this managed resource.

fingerprint String: The fingerprint of the SSH key
id String: The provider-assigned unique ID for this managed resource.

fingerprint string: The fingerprint of the SSH key
id string: The provider-assigned unique ID for this managed resource.

fingerprint str: The fingerprint of the SSH key
id str: The provider-assigned unique ID for this managed resource.

fingerprint String: The fingerprint of the SSH key
id String: The provider-assigned unique ID for this managed resource.

Look up Existing SshKey Resource

Get an existing SshKey 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?: SshKeyState, opts?: CustomResourceOptions): SshKey

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        fingerprint: Optional[str] = None,
        name: Optional[str] = None,
        public_key: Optional[str] = None) -> SshKey

func GetSshKey(ctx *Context, name string, id IDInput, state *SshKeyState, opts ...ResourceOption) (*SshKey, error)

public static SshKey Get(string name, Input<string> id, SshKeyState? state, CustomResourceOptions? opts = null)

public static SshKey get(String name, Output<String> id, SshKeyState 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:

Fingerprint string: The fingerprint of the SSH key
Name string: The name of the SSH key for identification
PublicKey string: The public key. If this is a file, it can be read using the file interpolation function

Fingerprint string: The fingerprint of the SSH key
Name string: The name of the SSH key for identification
PublicKey string: The public key. If this is a file, it can be read using the file interpolation function

fingerprint String: The fingerprint of the SSH key
name String: The name of the SSH key for identification
publicKey String: The public key. If this is a file, it can be read using the file interpolation function

fingerprint string: The fingerprint of the SSH key
name string: The name of the SSH key for identification
publicKey string: The public key. If this is a file, it can be read using the file interpolation function

fingerprint str: The fingerprint of the SSH key
name str: The name of the SSH key for identification
public_key str: The public key. If this is a file, it can be read using the file interpolation function

fingerprint String: The fingerprint of the SSH key
name String: The name of the SSH key for identification
publicKey String: The public key. If this is a file, it can be read using the file interpolation function

Import

SSH Keys can be imported using the ssh key id, e.g.

 $ pulumi import digitalocean:index/sshKey:SshKey mykey 263654

Package Details

Repository: DigitalOcean pulumi/pulumi-digitalocean
License: Apache-2.0
Notes: This Pulumi package is based on the digitalocean Terraform Provider.