linode.SshKey

Provides a Linode SSH Key resource. This can be used to create, modify, and delete Linodes SSH Keys. Managed SSH Keys allow instances to be created with a list of Linode usernames, whose SSH keys will be automatically applied to the root account’s ~/.ssh/authorized_keys file. For more information, see the Linode APIv4 docs. NOTE: This does not generate a new ssh key, you must have an existing key generated and saved locally.

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,
           label: Optional[str] = None,
           ssh_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)

public SshKey(String name, SshKeyArgs args)
public SshKey(String name, SshKeyArgs args, CustomResourceOptions options)

type: linode:SshKey
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

Example

The following reference example uses placeholder values for all input properties.

var sshKeyResource = new Linode.SshKey("sshKeyResource", new()
{
    Label = "string",
    SshKeyName = "string",
});

example, err := linode.NewSshKey(ctx, "sshKeyResource", &linode.SshKeyArgs{
	Label:  pulumi.String("string"),
	SshKey: pulumi.String("string"),
})

var sshKeyResource = new SshKey("sshKeyResource", SshKeyArgs.builder()        
    .label("string")
    .sshKey("string")
    .build());

ssh_key_resource = linode.SshKey("sshKeyResource",
    label="string",
    ssh_key="string")

const sshKeyResource = new linode.SshKey("sshKeyResource", {
    label: "string",
    sshKey: "string",
});

type: linode:SshKey
properties:
    label: string
    sshKey: 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

The SshKey resource accepts the following input properties:

Outputs

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

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,
        created: Optional[str] = None,
        label: Optional[str] = None,
        ssh_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

Import

Linodes SSH Keys can be imported using the Linode SSH Key id, e.g.

$ pulumi import linode:index/sshKey:SshKey mysshkey 1234567

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository

Linode pulumi/pulumi-linode

License

Apache-2.0

Notes

This Pulumi package is based on the linode Terraform Provider.