published on Thursday, Nov 5, 2026 by dimeskigj
published on Thursday, Nov 5, 2026 by dimeskigj
A Dokploy SSH key for Git and registry access.
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,
name: Optional[str] = None,
private_key: Optional[str] = None,
public_key: Optional[str] = None,
description: 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: dokploy:SSHKey
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "dokploy_s_s_h_key" "name" {
# resource properties
}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 Dokploy.SSHKey("sshkeyResource", new()
{
Name = "string",
PrivateKey = "string",
PublicKey = "string",
Description = "string",
});
example, err := dokploy.NewSSHKey(ctx, "sshkeyResource", &dokploy.SSHKeyArgs{
Name: pulumi.String("string"),
PrivateKey: pulumi.String("string"),
PublicKey: pulumi.String("string"),
Description: pulumi.String("string"),
})
resource "dokploy_s_s_h_key" "sshkeyResource" {
lifecycle {
create_before_destroy = true
}
name = "string"
private_key = "string"
public_key = "string"
description = "string"
}
var sshkeyResource = new SSHKey("sshkeyResource", SSHKeyArgs.builder()
.name("string")
.privateKey("string")
.publicKey("string")
.description("string")
.build());
sshkey_resource = dokploy.SSHKey("sshkeyResource",
name="string",
private_key="string",
public_key="string",
description="string")
const sshkeyResource = new dokploy.SSHKey("sshkeyResource", {
name: "string",
privateKey: "string",
publicKey: "string",
description: "string",
});
type: dokploy:SSHKey
properties:
description: string
name: string
privateKey: 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:
- Name string
- The SSH key name.
- Private
Key string - The private SSH key material.
- Public
Key string - The public SSH key material.
- Description string
- The optional SSH key description.
- Name string
- The SSH key name.
- Private
Key string - The private SSH key material.
- Public
Key string - The public SSH key material.
- Description string
- The optional SSH key description.
- name string
- The SSH key name.
- private_
key string - The private SSH key material.
- public_
key string - The public SSH key material.
- description string
- The optional SSH key description.
- name String
- The SSH key name.
- private
Key String - The private SSH key material.
- public
Key String - The public SSH key material.
- description String
- The optional SSH key description.
- name string
- The SSH key name.
- private
Key string - The private SSH key material.
- public
Key string - The public SSH key material.
- description string
- The optional SSH key description.
- name str
- The SSH key name.
- private_
key str - The private SSH key material.
- public_
key str - The public SSH key material.
- description str
- The optional SSH key description.
- name String
- The SSH key name.
- private
Key String - The private SSH key material.
- public
Key String - The public SSH key material.
- description String
- The optional SSH key description.
Outputs
All input properties are implicitly available as output properties. Additionally, the SSHKey resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Organization
Id string - The Dokploy organization ID owning this SSH key.
- Ssh
Key stringId - The stable Dokploy SSH key ID.
- Id string
- The provider-assigned unique ID for this managed resource.
- Organization
Id string - The Dokploy organization ID owning this SSH key.
- Ssh
Key stringId - The stable Dokploy SSH key ID.
- id string
- The provider-assigned unique ID for this managed resource.
- organization_
id string - The Dokploy organization ID owning this SSH key.
- ssh_
key_ stringid - The stable Dokploy SSH key ID.
- id String
- The provider-assigned unique ID for this managed resource.
- organization
Id String - The Dokploy organization ID owning this SSH key.
- ssh
Key StringId - The stable Dokploy SSH key ID.
- id string
- The provider-assigned unique ID for this managed resource.
- organization
Id string - The Dokploy organization ID owning this SSH key.
- ssh
Key stringId - The stable Dokploy SSH key ID.
- id str
- The provider-assigned unique ID for this managed resource.
- organization_
id str - The Dokploy organization ID owning this SSH key.
- ssh_
key_ strid - The stable Dokploy SSH key ID.
- id String
- The provider-assigned unique ID for this managed resource.
- organization
Id String - The Dokploy organization ID owning this SSH key.
- ssh
Key StringId - The stable Dokploy SSH key ID.
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>, opts?: CustomResourceOptions): SSHKey@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None) -> SSHKeyfunc GetSSHKey(ctx *Context, name string, id IDInput, state *SSHKeyState, opts ...ResourceOption) (*SSHKey, error)public static SSHKey Get(string name, Input<string> id, CustomResourceOptions? opts = null)public static SSHKey get(String name, Output<String> id, CustomResourceOptions options)resources: existingSSHKey: type: dokploy:SSHKey get: id: ${id}import {
to = dokploy_s_s_h_key.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- 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 resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state SSHKeyState
- Pass nil. This resource has no state arguments.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Package Details
- Repository
- dokploy dimeskigj/pulumi-dokploy
- License
- Apache-2.0
published on Thursday, Nov 5, 2026 by dimeskigj