UserSshKey

class UserSshKey : KotlinCustomResource

Provides a GitHub user's SSH key resource. This resource allows you to add/remove SSH keys from your user account.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as github from "@pulumi/github";
import * as std from "@pulumi/std";
const example = new github.UserSshKey("example", {
title: "example title",
key: std.file({
input: "~/.ssh/id_rsa.pub",
}).then(invoke => invoke.result),
});
import pulumi
import pulumi_github as github
import pulumi_std as std
example = github.UserSshKey("example",
title="example title",
key=std.file(input="~/.ssh/id_rsa.pub").result)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Github = Pulumi.Github;
using Std = Pulumi.Std;
return await Deployment.RunAsync(() =>
{
var example = new Github.UserSshKey("example", new()
{
Title = "example title",
Key = Std.File.Invoke(new()
{
Input = "~/.ssh/id_rsa.pub",
}).Apply(invoke => invoke.Result),
});
});
package main
import (
"github.com/pulumi/pulumi-github/sdk/v6/go/github"
"github.com/pulumi/pulumi-std/sdk/go/std"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
invokeFile, err := std.File(ctx, &std.FileArgs{
Input: "~/.ssh/id_rsa.pub",
}, nil)
if err != nil {
return err
}
_, err = github.NewUserSshKey(ctx, "example", &github.UserSshKeyArgs{
Title: pulumi.String("example title"),
Key: pulumi.String(invokeFile.Result),
})
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.github.UserSshKey;
import com.pulumi.github.UserSshKeyArgs;
import com.pulumi.std.StdFunctions;
import com.pulumi.std.inputs.FileArgs;
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 example = new UserSshKey("example", UserSshKeyArgs.builder()
.title("example title")
.key(StdFunctions.file(FileArgs.builder()
.input("~/.ssh/id_rsa.pub")
.build()).result())
.build());
}
}
resources:
example:
type: github:UserSshKey
properties:
title: example title
key:
fn::invoke:
function: std:file
arguments:
input: ~/.ssh/id_rsa.pub
return: result

Import

SSH keys can be imported using their ID e.g.

$ pulumi import github:index/userSshKey:UserSshKey example 1234567

Properties

Link copied to clipboard
val etag: Output<String>
Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val key: Output<String>

The public SSH key to add to your GitHub account.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val title: Output<String>

A descriptive name for the new key. e.g. Personal MacBook Air

Link copied to clipboard
val url: Output<String>

The URL of the SSH key

Link copied to clipboard
val urn: Output<String>