Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now

SshKey

Provides a resource to manage User SSH keys on your Packet user account. If you create a new device in a project, all the keys of the project’s collaborators will be injected to the device.

The link between User SSH key and device is implicit. If you want to make sure that a key will be copied to a device, you must ensure that the device resource depends_on the key resource.

Example Usage

using System.IO;
using Pulumi;
using Packet = Pulumi.Packet;

class MyStack : Stack
{
    public MyStack()
    {
        // Create a new SSH key
        var key1 = new Packet.SshKey("key1", new Packet.SshKeyArgs
        {
            Name = "terraform-1",
            PublicKey = File.ReadAllText("/home/terraform/.ssh/id_rsa.pub"),
        });
        // Create new device with "key1" included. The device resource "depends_on" the
        // key, in order to make sure the key is created before the device.
        var test = new Packet.Device("test", new Packet.DeviceArgs
        {
            Hostname = "test-device",
            Plan = "t1.small.x86",
            Facilities = 
            {
                "sjc1",
            },
            OperatingSystem = "ubuntu_16_04",
            BillingCycle = "hourly",
            ProjectId = local.Project_id,
        }, new CustomResourceOptions
        {
            DependsOn = 
            {
                "packet_ssh_key.key1",
            },
        });
    }

}

Coming soon!

import pulumi
import pulumi_packet as packet

# Create a new SSH key
key1 = packet.SshKey("key1",
    name="terraform-1",
    public_key=(lambda path: open(path).read())("/home/terraform/.ssh/id_rsa.pub"))
# Create new device with "key1" included. The device resource "depends_on" the
# key, in order to make sure the key is created before the device.
test = packet.Device("test",
    hostname="test-device",
    plan="t1.small.x86",
    facilities=["sjc1"],
    operating_system="ubuntu_16_04",
    billing_cycle="hourly",
    project_id=local["project_id"],
    opts=ResourceOptions(depends_on=["packet_ssh_key.key1"]))
import * as pulumi from "@pulumi/pulumi";
import * as packet from "@pulumi/packet";
import * from "fs";

// Create a new SSH key
const key1 = new packet.SshKey("key1", {
    name: "terraform-1",
    publicKey: fs.readFileSync("/home/terraform/.ssh/id_rsa.pub"),
});
// Create new device with "key1" included. The device resource "depends_on" the
// key, in order to make sure the key is created before the device.
const test = new packet.Device("test", {
    hostname: "test-device",
    plan: "t1.small.x86",
    facilities: ["sjc1"],
    operatingSystem: "ubuntu_16_04",
    billingCycle: "hourly",
    projectId: local.project_id,
}, {
    dependsOn: ["packet_ssh_key.key1"],
});

Create a SshKey Resource

new SshKey(name: string, args: SshKeyArgs, opts?: CustomResourceOptions);
def SshKey(resource_name: str, opts: Optional[ResourceOptions] = None, name: Optional[str] = None, public_key: Optional[str] = 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:

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 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

Outputs

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

Created string

The timestamp for when the SSH key was created

Fingerprint string

The fingerprint of the SSH key

Id string
The provider-assigned unique ID for this managed resource.
OwnerId string

The UUID of the Packet API User who owns this key

Updated string

The timestamp for the last time the SSH key was updated

Created string

The timestamp for when the SSH key was created

Fingerprint string

The fingerprint of the SSH key

Id string
The provider-assigned unique ID for this managed resource.
OwnerId string

The UUID of the Packet API User who owns this key

Updated string

The timestamp for the last time the SSH key was updated

created string

The timestamp for when the SSH key was created

fingerprint string

The fingerprint of the SSH key

id string
The provider-assigned unique ID for this managed resource.
ownerId string

The UUID of the Packet API User who owns this key

updated string

The timestamp for the last time the SSH key was updated

created str

The timestamp for when the SSH key was created

fingerprint str

The fingerprint of the SSH key

id str
The provider-assigned unique ID for this managed resource.
owner_id str

The UUID of the Packet API User who owns this key

updated str

The timestamp for the last time the SSH key was updated

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): SshKey
@staticmethod
def get(resource_name: str, id: str, opts: Optional[ResourceOptions] = None, created: Optional[str] = None, fingerprint: Optional[str] = None, name: Optional[str] = None, owner_id: Optional[str] = None, public_key: Optional[str] = None, updated: 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)
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:

Created string

The timestamp for when the SSH key was created

Fingerprint string

The fingerprint of the SSH key

Name string

The name of the SSH key for identification

OwnerId string

The UUID of the Packet API User who owns this key

PublicKey string

The public key. If this is a file, it can be read using the file interpolation function

Updated string

The timestamp for the last time the SSH key was updated

Created string

The timestamp for when the SSH key was created

Fingerprint string

The fingerprint of the SSH key

Name string

The name of the SSH key for identification

OwnerId string

The UUID of the Packet API User who owns this key

PublicKey string

The public key. If this is a file, it can be read using the file interpolation function

Updated string

The timestamp for the last time the SSH key was updated

created string

The timestamp for when the SSH key was created

fingerprint string

The fingerprint of the SSH key

name string

The name of the SSH key for identification

ownerId string

The UUID of the Packet API User who owns this key

publicKey string

The public key. If this is a file, it can be read using the file interpolation function

updated string

The timestamp for the last time the SSH key was updated

created str

The timestamp for when the SSH key was created

fingerprint str

The fingerprint of the SSH key

name str

The name of the SSH key for identification

owner_id str

The UUID of the Packet API User who owns this key

public_key str

The public key. If this is a file, it can be read using the file interpolation function

updated str

The timestamp for the last time the SSH key was updated

Package Details

Repository
https://github.com/pulumi/pulumi-packet
License
Apache-2.0
Notes
This Pulumi package is based on the packet Terraform Provider.