SshKey
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.IO;
using Pulumi;
using DigitalOcean = Pulumi.DigitalOcean;
class MyStack : Stack
{
public MyStack()
{
// Create a new SSH key
var @default = new DigitalOcean.SshKey("default", new DigitalOcean.SshKeyArgs
{
PublicKey = File.ReadAllText("/Users/myuser/.ssh/id_rsa.pub"),
});
// Create a new Droplet using the SSH key
var web = new DigitalOcean.Droplet("web", new DigitalOcean.DropletArgs
{
Image = "ubuntu-18-04-x64",
Region = "nyc3",
Size = "s-1vcpu-1gb",
SshKeys =
{
@default.Fingerprint,
},
});
}
}
Coming soon!
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 * 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],
});Create a SshKey Resource
new SshKey(name: string, args: SshKeyArgs, opts?: CustomResourceOptions);def SshKey(resource_name, opts=None, name=None, public_key=None, __props__=None);func NewSshKey(ctx *Context, name string, args SshKeyArgs, opts ...ResourceOption) (*SshKey, error)public SshKey(string name, SshKeyArgs args, CustomResourceOptions? opts = null)- 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.
- opts ResourceOptions
- A bag of options that control this 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.
SshKey Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.
Inputs
The SshKey resource accepts the following input properties:
- 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
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 str
The fingerprint of the SSH key
- id str
- The provider-assigned unique ID for this managed resource.
Look up an 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): SshKeystatic get(resource_name, id, opts=None, fingerprint=None, name=None, public_key=None, __props__=None);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)- 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.
The following state arguments are supported:
- 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
Package Details
- Repository
- https://github.com/pulumi/pulumi-digitalocean
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
digitaloceanTerraform Provider.