getSshKey

Get information on a ssh key. This data source provides the name, public key, and fingerprint as configured on your DigitalOcean account. This is useful if the ssh key in question is not managed by the provider or you need to utilize any of the keys data. An error is triggered if the provided ssh key name does not exist.

Example Usage

Get the ssh key:

import * as pulumi from "@pulumi/pulumi";
import * as digitalocean from "@pulumi/digitalocean";
const example = digitalocean.getSshKey({
name: "example",
});
const exampleDroplet = new digitalocean.Droplet("example", {
image: "ubuntu-18-04-x64",
name: "example-1",
region: digitalocean.Region.NYC2,
size: digitalocean.DropletSlug.DropletS1VCPU1GB,
sshKeys: [example.then(example => example.id)],
});
import pulumi
import pulumi_digitalocean as digitalocean
example = digitalocean.get_ssh_key(name="example")
example_droplet = digitalocean.Droplet("example",
image="ubuntu-18-04-x64",
name="example-1",
region=digitalocean.Region.NYC2,
size=digitalocean.DropletSlug.DROPLET_S1_VCPU1_GB,
ssh_keys=[example.id])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using DigitalOcean = Pulumi.DigitalOcean;
return await Deployment.RunAsync(() =>
{
var example = DigitalOcean.GetSshKey.Invoke(new()
{
Name = "example",
});
var exampleDroplet = new DigitalOcean.Droplet("example", new()
{
Image = "ubuntu-18-04-x64",
Name = "example-1",
Region = DigitalOcean.Region.NYC2,
Size = DigitalOcean.DropletSlug.DropletS1VCPU1GB,
SshKeys = new[]
{
example.Apply(getSshKeyResult => getSshKeyResult.Id),
},
});
});
package main
import (
"github.com/pulumi/pulumi-digitalocean/sdk/v4/go/digitalocean"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := digitalocean.LookupSshKey(ctx, &digitalocean.LookupSshKeyArgs{
Name: "example",
}, nil)
if err != nil {
return err
}
_, err = digitalocean.NewDroplet(ctx, "example", &digitalocean.DropletArgs{
Image: pulumi.String("ubuntu-18-04-x64"),
Name: pulumi.String("example-1"),
Region: pulumi.String(digitalocean.RegionNYC2),
Size: pulumi.String(digitalocean.DropletSlugDropletS1VCPU1GB),
SshKeys: pulumi.StringArray{
pulumi.Int(example.Id),
},
})
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.DigitaloceanFunctions;
import com.pulumi.digitalocean.inputs.GetSshKeyArgs;
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) {
final var example = DigitaloceanFunctions.getSshKey(GetSshKeyArgs.builder()
.name("example")
.build());
var exampleDroplet = new Droplet("exampleDroplet", DropletArgs.builder()
.image("ubuntu-18-04-x64")
.name("example-1")
.region("nyc2")
.size("s-1vcpu-1gb")
.sshKeys(example.id())
.build());
}
}
resources:
exampleDroplet:
type: digitalocean:Droplet
name: example
properties:
image: ubuntu-18-04-x64
name: example-1
region: nyc2
size: s-1vcpu-1gb
sshKeys:
- ${example.id}
variables:
example:
fn::invoke:
function: digitalocean:getSshKey
arguments:
name: example

Return

A collection of values returned by getSshKey.

Parameters

argument

A collection of arguments for invoking getSshKey.


suspend fun getSshKey(name: String): GetSshKeyResult

Return

A collection of values returned by getSshKey.

Parameters

name

The name of the ssh key.

See also


suspend fun getSshKey(argument: suspend GetSshKeyPlainArgsBuilder.() -> Unit): GetSshKeyResult

Return

A collection of values returned by getSshKey.

Parameters

argument

Builder for com.pulumi.digitalocean.kotlin.inputs.GetSshKeyPlainArgs.

See also