Docs Home
pgEdge v0.0.40 published on Friday, Jan 10, 2025 by pgEdge
pgedge.SSHKey
Explore with Pulumi AI
Manages a pgEdge SSH key.
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,
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: pgedge: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 Pgedge.SSHKey("sshkeyResource", new()
{
PublicKey = "string",
Name = "string",
});
example, err := pgedge.NewSSHKey(ctx, "sshkeyResource", &pgedge.SSHKeyArgs{
PublicKey: pulumi.String("string"),
Name: pulumi.String("string"),
})
var sshkeyResource = new SSHKey("sshkeyResource", SSHKeyArgs.builder()
.publicKey("string")
.name("string")
.build());
sshkey_resource = pgedge.SSHKey("sshkeyResource",
public_key="string",
name="string")
const sshkeyResource = new pgedge.SSHKey("sshkeyResource", {
publicKey: "string",
name: "string",
});
type: pgedge:SSHKey
properties:
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.
- name str
- The name of the SSH key.
Outputs
All input properties are implicitly available as output properties. Additionally, the SSHKey resource produces the following output properties:
- created_
at str - The timestamp when the SSH key was created.
- id str
- 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,
created_at: Optional[str] = None,
name: Optional[str] = None,
public_key: Optional[str] = None) -> SSHKeyfunc 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)resources: _: type: pgedge:SSHKey get: id: ${id}- 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.
- created_
at str - The timestamp when the SSH key was created.
- name str
- The name of the SSH key.
- public_
key str - The public key.
Package Details
- Repository
- pgedge pgEdge/pulumi-pgedge
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
pgedgeTerraform Provider.