SshKey
Provides a Hetzner Cloud SSH key resource to manage SSH keys for server access.
Example Usage
using System.IO;
using Pulumi;
using HCloud = Pulumi.HCloud;
class MyStack : Stack
{
public MyStack()
{
// Create a new SSH key
var @default = new HCloud.SshKey("default", new HCloud.SshKeyArgs
{
PublicKey = File.ReadAllText("~/.ssh/id_rsa.pub"),
});
}
}
Coming soon!
import pulumi
import pulumi_hcloud as hcloud
# Create a new SSH key
default = hcloud.SshKey("default", public_key=(lambda path: open(path).read())("~/.ssh/id_rsa.pub"))
import * as pulumi from "@pulumi/pulumi";
import * as hcloud from "@pulumi/hcloud";
import * from "fs";
// Create a new SSH key
const _default = new hcloud.SshKey("default", {publicKey: fs.readFileSync("~/.ssh/id_rsa.pub")});
Create a SshKey Resource
new SshKey(name: string, args: SshKeyArgs, opts?: CustomResourceOptions);
@overload
def SshKey(resource_name: str,
opts: Optional[ResourceOptions] = None,
labels: Optional[Mapping[str, Any]] = None,
name: Optional[str] = None,
public_key: Optional[str] = None)
@overload
def SshKey(resource_name: str,
args: SshKeyArgs,
opts: Optional[ResourceOptions] = 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.
- 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.
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
- labels Mapping[str, Any]
- (map) User-defined labels (key-value pairs)
- 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 str
- (string) 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): SshKey
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
fingerprint: Optional[str] = None,
labels: Optional[Mapping[str, Any]] = 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)
- 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 string
- (string) The fingerprint of the SSH key
- Labels Dictionary<string, object>
- (map) User-defined labels (key-value pairs)
- 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]interface{}
- (map) User-defined labels (key-value pairs)
- 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]: any}
- (map) User-defined labels (key-value pairs)
- 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, Any]
- (map) User-defined labels (key-value pairs)
- 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
Import
SSH keys can be imported using the SSH key id
$ pulumi import hcloud:index/sshKey:SshKey mykey <id>
Package Details
- Repository
- https://github.com/pulumi/pulumi-hcloud
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
hcloud
Terraform Provider.