Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Equinix Metal (Deprecated)
  3. API Docs
  4. ProjectSshKey

This package is deprecated. We recommend using the new Equinix package.

Equinix Metal v3.2.1 published on Thursday, Dec 30, 2021 by DEPRECATED
pulumi/pulumi-equinix-metal

equinix-metal.ProjectSshKey

Explore with Pulumi AI

This package is deprecated. We recommend using the new Equinix package.

Equinix Metal v3.2.1 published on Thursday, Dec 30, 2021 by DEPRECATED
pulumi/pulumi-equinix-metal

Provides an Equinix Metal project SSH key resource to manage project-specific SSH keys. Project SSH keys will only be populated onto servers that belong to that project, in contrast to User SSH Keys.

Example Usage

using Pulumi;
using EquinixMetal = Pulumi.EquinixMetal;

class MyStack : Stack
{
    public MyStack()
    {
        var projectId = "<UUID_of_your_project>";
        var testProjectSshKey = new EquinixMetal.ProjectSshKey("testProjectSshKey", new EquinixMetal.ProjectSshKeyArgs
        {
            PublicKey = "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQDM/unxJeFqxsTJcu6mhqsMHSaVlpu+Jj/P+44zrm6X/MAoHSX3X9oLgujEjjZ74yLfdfe0bJrbL2YgJzNaEkIQQ1VPMHB5EhTKUBGnzlPP0hHTnxsjAm9qDHgUPgvgFDQSAMzdJRJ0Cexo16Ph9VxCoLh3dxiE7s2gaM2FdVg7P8aSxKypsxAhYV3D0AwqzoOyT6WWhBoQ0xZ85XevOTnJCpImSemEGs6nVGEsWcEc1d1YvdxFjAK4SdsKUMkj4Dsy/leKsdi/DEAf356vbMT1UHsXXvy5TlHu/Pa6qF53v32Enz+nhKy7/8W2Yt2yWx8HnQcT2rug9lvCXagJO6oauqRTO77C4QZn13ZLMZgLT66S/tNh2EX0gi6vmIs5dth8uF+K6nxIyKJXbcA4ASg7F1OJrHKFZdTc5v1cPeq6PcbqGgc+8SrPYQmzvQqLoMBuxyos2hUkYOmw3aeWJj9nFa8Wu5WaN89mUeOqSkU4S5cgUzWUOmKey56B/j/s1sVys9rMhZapVs0wL4L9GBBM48N5jAQZnnpo85A8KsZq5ME22bTLqnxsDXqDYZvS7PSI6Dxi7eleOFE/NYYDkrgDLHTQri8ucDMVeVWHgoMY2bPXdn7KKy5jW5jKsf8EPARXg77A4gRYmgKrcwIKqJEUPqyxJBe0CPoGTqgXPRsUiQ== tomk@hp2",
            ProjectId = projectId,
        });
        var testDevice = new EquinixMetal.Device("testDevice", new EquinixMetal.DeviceArgs
        {
            Hostname = "test",
            Plan = "c3.medium.x86",
            Facilities = 
            {
                "ny5",
            },
            OperatingSystem = "ubuntu_20_04",
            BillingCycle = "hourly",
            ProjectSshKeyIds = 
            {
                testProjectSshKey.Id,
            },
            ProjectId = projectId,
        });
    }

}
Copy
package main

import (
	"github.com/pulumi/pulumi-equinix-metal/sdk/v3/go/equinix-metal"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		projectId := "<UUID_of_your_project>"
		testProjectSshKey, err := equinix - metal.NewProjectSshKey(ctx, "testProjectSshKey", &equinix-metal.ProjectSshKeyArgs{
			PublicKey: pulumi.String("ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQDM/unxJeFqxsTJcu6mhqsMHSaVlpu+Jj/P+44zrm6X/MAoHSX3X9oLgujEjjZ74yLfdfe0bJrbL2YgJzNaEkIQQ1VPMHB5EhTKUBGnzlPP0hHTnxsjAm9qDHgUPgvgFDQSAMzdJRJ0Cexo16Ph9VxCoLh3dxiE7s2gaM2FdVg7P8aSxKypsxAhYV3D0AwqzoOyT6WWhBoQ0xZ85XevOTnJCpImSemEGs6nVGEsWcEc1d1YvdxFjAK4SdsKUMkj4Dsy/leKsdi/DEAf356vbMT1UHsXXvy5TlHu/Pa6qF53v32Enz+nhKy7/8W2Yt2yWx8HnQcT2rug9lvCXagJO6oauqRTO77C4QZn13ZLMZgLT66S/tNh2EX0gi6vmIs5dth8uF+K6nxIyKJXbcA4ASg7F1OJrHKFZdTc5v1cPeq6PcbqGgc+8SrPYQmzvQqLoMBuxyos2hUkYOmw3aeWJj9nFa8Wu5WaN89mUeOqSkU4S5cgUzWUOmKey56B/j/s1sVys9rMhZapVs0wL4L9GBBM48N5jAQZnnpo85A8KsZq5ME22bTLqnxsDXqDYZvS7PSI6Dxi7eleOFE/NYYDkrgDLHTQri8ucDMVeVWHgoMY2bPXdn7KKy5jW5jKsf8EPARXg77A4gRYmgKrcwIKqJEUPqyxJBe0CPoGTqgXPRsUiQ== tomk@hp2"),
			ProjectId: pulumi.String(projectId),
		})
		if err != nil {
			return err
		}
		_, err = equinix - metal.NewDevice(ctx, "testDevice", &equinix-metal.DeviceArgs{
			Hostname: pulumi.String("test"),
			Plan:     pulumi.String("c3.medium.x86"),
			Facilities: pulumi.StringArray{
				pulumi.String("ny5"),
			},
			OperatingSystem: pulumi.String("ubuntu_20_04"),
			BillingCycle:    pulumi.String("hourly"),
			ProjectSshKeyIds: pulumi.StringArray{
				testProjectSshKey.ID(),
			},
			ProjectId: pulumi.String(projectId),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy

Coming soon!

import * as pulumi from "@pulumi/pulumi";
import * as equinix_metal from "@pulumi/equinix-metal";

const projectId = "<UUID_of_your_project>";
const testProjectSshKey = new equinix_metal.ProjectSshKey("testProjectSshKey", {
    publicKey: "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQDM/unxJeFqxsTJcu6mhqsMHSaVlpu+Jj/P+44zrm6X/MAoHSX3X9oLgujEjjZ74yLfdfe0bJrbL2YgJzNaEkIQQ1VPMHB5EhTKUBGnzlPP0hHTnxsjAm9qDHgUPgvgFDQSAMzdJRJ0Cexo16Ph9VxCoLh3dxiE7s2gaM2FdVg7P8aSxKypsxAhYV3D0AwqzoOyT6WWhBoQ0xZ85XevOTnJCpImSemEGs6nVGEsWcEc1d1YvdxFjAK4SdsKUMkj4Dsy/leKsdi/DEAf356vbMT1UHsXXvy5TlHu/Pa6qF53v32Enz+nhKy7/8W2Yt2yWx8HnQcT2rug9lvCXagJO6oauqRTO77C4QZn13ZLMZgLT66S/tNh2EX0gi6vmIs5dth8uF+K6nxIyKJXbcA4ASg7F1OJrHKFZdTc5v1cPeq6PcbqGgc+8SrPYQmzvQqLoMBuxyos2hUkYOmw3aeWJj9nFa8Wu5WaN89mUeOqSkU4S5cgUzWUOmKey56B/j/s1sVys9rMhZapVs0wL4L9GBBM48N5jAQZnnpo85A8KsZq5ME22bTLqnxsDXqDYZvS7PSI6Dxi7eleOFE/NYYDkrgDLHTQri8ucDMVeVWHgoMY2bPXdn7KKy5jW5jKsf8EPARXg77A4gRYmgKrcwIKqJEUPqyxJBe0CPoGTqgXPRsUiQ== tomk@hp2",
    projectId: projectId,
});
const testDevice = new equinix_metal.Device("testDevice", {
    hostname: "test",
    plan: "c3.medium.x86",
    facilities: ["ny5"],
    operatingSystem: "ubuntu_20_04",
    billingCycle: "hourly",
    projectSshKeyIds: [testProjectSshKey.id],
    projectId: projectId,
});
Copy
import pulumi
import pulumi_equinix_metal as equinix_metal

project_id = "<UUID_of_your_project>"
test_project_ssh_key = equinix_metal.ProjectSshKey("testProjectSshKey",
    public_key="ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQDM/unxJeFqxsTJcu6mhqsMHSaVlpu+Jj/P+44zrm6X/MAoHSX3X9oLgujEjjZ74yLfdfe0bJrbL2YgJzNaEkIQQ1VPMHB5EhTKUBGnzlPP0hHTnxsjAm9qDHgUPgvgFDQSAMzdJRJ0Cexo16Ph9VxCoLh3dxiE7s2gaM2FdVg7P8aSxKypsxAhYV3D0AwqzoOyT6WWhBoQ0xZ85XevOTnJCpImSemEGs6nVGEsWcEc1d1YvdxFjAK4SdsKUMkj4Dsy/leKsdi/DEAf356vbMT1UHsXXvy5TlHu/Pa6qF53v32Enz+nhKy7/8W2Yt2yWx8HnQcT2rug9lvCXagJO6oauqRTO77C4QZn13ZLMZgLT66S/tNh2EX0gi6vmIs5dth8uF+K6nxIyKJXbcA4ASg7F1OJrHKFZdTc5v1cPeq6PcbqGgc+8SrPYQmzvQqLoMBuxyos2hUkYOmw3aeWJj9nFa8Wu5WaN89mUeOqSkU4S5cgUzWUOmKey56B/j/s1sVys9rMhZapVs0wL4L9GBBM48N5jAQZnnpo85A8KsZq5ME22bTLqnxsDXqDYZvS7PSI6Dxi7eleOFE/NYYDkrgDLHTQri8ucDMVeVWHgoMY2bPXdn7KKy5jW5jKsf8EPARXg77A4gRYmgKrcwIKqJEUPqyxJBe0CPoGTqgXPRsUiQ== tomk@hp2",
    project_id=project_id)
test_device = equinix_metal.Device("testDevice",
    hostname="test",
    plan="c3.medium.x86",
    facilities=["ny5"],
    operating_system="ubuntu_20_04",
    billing_cycle="hourly",
    project_ssh_key_ids=[test_project_ssh_key.id],
    project_id=project_id)
Copy

Coming soon!

Create ProjectSshKey Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ProjectSshKey(name: string, args: ProjectSshKeyArgs, opts?: CustomResourceOptions);
@overload
def ProjectSshKey(resource_name: str,
                  args: ProjectSshKeyArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def ProjectSshKey(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  project_id: Optional[str] = None,
                  public_key: Optional[str] = None,
                  name: Optional[str] = None)
func NewProjectSshKey(ctx *Context, name string, args ProjectSshKeyArgs, opts ...ResourceOption) (*ProjectSshKey, error)
public ProjectSshKey(string name, ProjectSshKeyArgs args, CustomResourceOptions? opts = null)
public ProjectSshKey(String name, ProjectSshKeyArgs args)
public ProjectSshKey(String name, ProjectSshKeyArgs args, CustomResourceOptions options)

type: equinix-metal:ProjectSshKey
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ProjectSshKeyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ProjectSshKeyArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ProjectSshKeyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ProjectSshKeyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ProjectSshKeyArgs
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 projectSshKeyResource = new EquinixMetal.ProjectSshKey("projectSshKeyResource", new()
{
    ProjectId = "string",
    PublicKey = "string",
    Name = "string",
});
Copy
example, err := equinixmetal.NewProjectSshKey(ctx, "projectSshKeyResource", &equinixmetal.ProjectSshKeyArgs{
	ProjectId: pulumi.String("string"),
	PublicKey: pulumi.String("string"),
	Name:      pulumi.String("string"),
})
Copy
var projectSshKeyResource = new ProjectSshKey("projectSshKeyResource", ProjectSshKeyArgs.builder()
    .projectId("string")
    .publicKey("string")
    .name("string")
    .build());
Copy
project_ssh_key_resource = equinix_metal.ProjectSshKey("projectSshKeyResource",
    project_id="string",
    public_key="string",
    name="string")
Copy
const projectSshKeyResource = new equinix_metal.ProjectSshKey("projectSshKeyResource", {
    projectId: "string",
    publicKey: "string",
    name: "string",
});
Copy
type: equinix-metal:ProjectSshKey
properties:
    name: string
    projectId: string
    publicKey: string
Copy

ProjectSshKey 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 ProjectSshKey resource accepts the following input properties:

ProjectId This property is required. string
The ID of parent project
PublicKey This property is required. 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
ProjectId This property is required. string
The ID of parent project
PublicKey This property is required. 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
projectId This property is required. String
The ID of parent project
publicKey This property is required. 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
projectId This property is required. string
The ID of parent project
publicKey This property is required. 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
project_id This property is required. str
The ID of parent project
public_key This property is required. str
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
projectId This property is required. String
The ID of parent project
publicKey This property is required. 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

Outputs

All input properties are implicitly available as output properties. Additionally, the ProjectSshKey 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 ID of parent project (same as project_id)
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 ID of parent project (same as project_id)
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 ID of parent project (same as project_id)
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 ID of parent project (same as project_id)
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 ID of parent project (same as project_id)
updated str
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 ID of parent project (same as project_id)
updated String
The timestamp for the last time the SSH key was updated

Look up Existing ProjectSshKey Resource

Get an existing ProjectSshKey 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?: ProjectSshKeyState, opts?: CustomResourceOptions): ProjectSshKey
@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,
        project_id: Optional[str] = None,
        public_key: Optional[str] = None,
        updated: Optional[str] = None) -> ProjectSshKey
func GetProjectSshKey(ctx *Context, name string, id IDInput, state *ProjectSshKeyState, opts ...ResourceOption) (*ProjectSshKey, error)
public static ProjectSshKey Get(string name, Input<string> id, ProjectSshKeyState? state, CustomResourceOptions? opts = null)
public static ProjectSshKey get(String name, Output<String> id, ProjectSshKeyState state, CustomResourceOptions options)
resources:  _:    type: equinix-metal:ProjectSshKey    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 ID of parent project (same as project_id)
ProjectId string
The ID of parent project
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 ID of parent project (same as project_id)
ProjectId string
The ID of parent project
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 ID of parent project (same as project_id)
projectId String
The ID of parent project
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 ID of parent project (same as project_id)
projectId string
The ID of parent project
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 ID of parent project (same as project_id)
project_id str
The ID of parent project
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
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 ID of parent project (same as project_id)
projectId String
The ID of parent project
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

Package Details

Repository
Equinix Metal pulumi/pulumi-equinix-metal
License
Apache-2.0
Notes
This Pulumi package is based on the metal Terraform Provider.

This package is deprecated. We recommend using the new Equinix package.

Equinix Metal v3.2.1 published on Thursday, Dec 30, 2021 by DEPRECATED
pulumi/pulumi-equinix-metal