hcloud.SshKey
Explore with Pulumi AI
Provides a Hetzner Cloud SSH key resource to manage SSH keys for server access.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as hcloud from "@pulumi/hcloud";
import * as std from "@pulumi/std";
// Create a new SSH key
const _default = new hcloud.SshKey("default", {
name: "Terraform Example",
publicKey: std.file({
input: "~/.ssh/id_rsa.pub",
}).then(invoke => invoke.result),
});
import pulumi
import pulumi_hcloud as hcloud
import pulumi_std as std
# Create a new SSH key
default = hcloud.SshKey("default",
name="Terraform Example",
public_key=std.file(input="~/.ssh/id_rsa.pub").result)
package main
import (
"github.com/pulumi/pulumi-hcloud/sdk/go/hcloud"
"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
}
// Create a new SSH key
_, err = hcloud.NewSshKey(ctx, "default", &hcloud.SshKeyArgs{
Name: pulumi.String("Terraform Example"),
PublicKey: pulumi.String(invokeFile.Result),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using HCloud = Pulumi.HCloud;
using Std = Pulumi.Std;
return await Deployment.RunAsync(() =>
{
// Create a new SSH key
var @default = new HCloud.SshKey("default", new()
{
Name = "Terraform Example",
PublicKey = Std.File.Invoke(new()
{
Input = "~/.ssh/id_rsa.pub",
}).Apply(invoke => invoke.Result),
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.hcloud.SshKey;
import com.pulumi.hcloud.SshKeyArgs;
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) {
// Create a new SSH key
var default_ = new SshKey("default", SshKeyArgs.builder()
.name("Terraform Example")
.publicKey(StdFunctions.file(FileArgs.builder()
.input("~/.ssh/id_rsa.pub")
.build()).result())
.build());
}
}
resources:
# Create a new SSH key
default:
type: hcloud:SshKey
properties:
name: Terraform Example
publicKey:
fn::invoke:
Function: std:file
Arguments:
input: ~/.ssh/id_rsa.pub
Return: result
Create SshKey Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new SshKey(name: string, args: SshKeyArgs, opts?: CustomResourceOptions);
@overload
def SshKey(resource_name: str,
args: SshKeyArgs,
opts: Optional[ResourceOptions] = None)
@overload
def SshKey(resource_name: str,
opts: Optional[ResourceOptions] = None,
public_key: Optional[str] = None,
labels: Optional[Mapping[str, str]] = None,
name: Optional[str] = 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: hcloud:SshKey
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var sshKeyResource = new HCloud.SshKey("sshKeyResource", new()
{
PublicKey = "string",
Labels =
{
{ "string", "string" },
},
Name = "string",
});
example, err := hcloud.NewSshKey(ctx, "sshKeyResource", &hcloud.SshKeyArgs{
PublicKey: pulumi.String("string"),
Labels: pulumi.StringMap{
"string": pulumi.String("string"),
},
Name: pulumi.String("string"),
})
var sshKeyResource = new SshKey("sshKeyResource", SshKeyArgs.builder()
.publicKey("string")
.labels(Map.of("string", "string"))
.name("string")
.build());
ssh_key_resource = hcloud.SshKey("sshKeyResource",
public_key="string",
labels={
"string": "string",
},
name="string")
const sshKeyResource = new hcloud.SshKey("sshKeyResource", {
publicKey: "string",
labels: {
string: "string",
},
name: "string",
});
type: hcloud:SshKey
properties:
labels:
string: string
name: string
publicKey: string
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
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
- labels Mapping[str, str]
- User-defined labels (key-value pairs) should be created with.
- name str
- Name of the SSH key.
Outputs
All input properties are implicitly available as output properties. Additionally, the SshKey resource produces the following output properties:
- Fingerprint string
- (string) The fingerprint of the SSH key
- Id string
- The provider-assigned unique ID for this managed resource.
- Fingerprint string
- (string) The fingerprint of the SSH key
- Id string
- The provider-assigned unique ID for this managed resource.
- fingerprint String
- (string) The fingerprint of the SSH key
- id String
- The provider-assigned unique ID for this managed resource.
- fingerprint string
- (string) The fingerprint of the SSH key
- id string
- The provider-assigned unique ID for this managed resource.
- fingerprint str
- (string) The fingerprint of the SSH key
- id str
- The provider-assigned unique ID for this managed resource.
- fingerprint String
- (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,
labels: Optional[Mapping[str, 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.
- Fingerprint string
- (string) The fingerprint of the SSH key
- Labels Dictionary<string, string>
- User-defined labels (key-value pairs) should be created with.
- Name string
- Name of the SSH key.
- Public
Key string - The public key. If this is a file, it can be read using the file interpolation function
- Fingerprint string
- (string) The fingerprint of the SSH key
- Labels map[string]string
- User-defined labels (key-value pairs) should be created with.
- Name string
- Name of the SSH key.
- Public
Key string - The public key. If this is a file, it can be read using the file interpolation function
- fingerprint String
- (string) The fingerprint of the SSH key
- labels Map<String,String>
- User-defined labels (key-value pairs) should be created with.
- name String
- Name of the SSH key.
- public
Key String - The public key. If this is a file, it can be read using the file interpolation function
- fingerprint string
- (string) The fingerprint of the SSH key
- labels {[key: string]: string}
- User-defined labels (key-value pairs) should be created with.
- name string
- Name of the SSH key.
- public
Key string - The public key. If this is a file, it can be read using the file interpolation function
- fingerprint str
- (string) The fingerprint of the SSH key
- labels Mapping[str, str]
- User-defined labels (key-value pairs) should be created with.
- name str
- Name of the SSH key.
- public_
key str - The public key. If this is a file, it can be read using the file interpolation function
- fingerprint String
- (string) The fingerprint of the SSH key
- labels Map<String>
- User-defined labels (key-value pairs) should be created with.
- name String
- Name of the SSH key.
- public
Key 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
:
$ pulumi import hcloud:index/sshKey:SshKey mykey id
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Hetzner Cloud pulumi/pulumi-hcloud
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
hcloud
Terraform Provider.