1. Packages
  2. Exoscale
  3. API Docs
  4. SshKey
Exoscale v0.62.7 published on Tuesday, Dec 10, 2024 by Pulumiverse

exoscale.SshKey

Explore with Pulumi AI

Import

An existing SSH key may be imported as a resource by <name>:

$ pulumi import exoscale:index/sshKey:SshKey \
Copy

exoscale_ssh_key.my_ssh_key \

my-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: exoscale:SshKey
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. SshKeyArgs
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. 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 This property is required. string
The unique name of the resource.
args This property is required. SshKeyArgs
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. SshKeyArgs
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. 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 Exoscale.SshKey("sshKeyResource", new()
{
    PublicKey = "string",
    Name = "string",
});
Copy
example, err := exoscale.NewSshKey(ctx, "sshKeyResource", &exoscale.SshKeyArgs{
	PublicKey: pulumi.String("string"),
	Name:      pulumi.String("string"),
})
Copy
var sshKeyResource = new SshKey("sshKeyResource", SshKeyArgs.builder()
    .publicKey("string")
    .name("string")
    .build());
Copy
ssh_key_resource = exoscale.SshKey("sshKeyResource",
    public_key="string",
    name="string")
Copy
const sshKeyResource = new exoscale.SshKey("sshKeyResource", {
    publicKey: "string",
    name: "string",
});
Copy
type: exoscale:SshKey
properties:
    name: string
    publicKey: string
Copy

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:

PublicKey
This property is required.
Changes to this property will trigger replacement.
string
❗ The SSH public key that will be authorized in compute instances.
Name Changes to this property will trigger replacement. string
❗ The SSH key name.
PublicKey
This property is required.
Changes to this property will trigger replacement.
string
❗ The SSH public key that will be authorized in compute instances.
Name Changes to this property will trigger replacement. string
❗ The SSH key name.
publicKey
This property is required.
Changes to this property will trigger replacement.
String
❗ The SSH public key that will be authorized in compute instances.
name Changes to this property will trigger replacement. String
❗ The SSH key name.
publicKey
This property is required.
Changes to this property will trigger replacement.
string
❗ The SSH public key that will be authorized in compute instances.
name Changes to this property will trigger replacement. string
❗ The SSH key name.
public_key
This property is required.
Changes to this property will trigger replacement.
str
❗ The SSH public key that will be authorized in compute instances.
name Changes to this property will trigger replacement. str
❗ The SSH key name.
publicKey
This property is required.
Changes to this property will trigger replacement.
String
❗ The SSH public key that will be authorized in compute instances.
name Changes to this property will trigger replacement. String
❗ The SSH key name.

Outputs

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

Fingerprint string
The SSH key unique identifier.
Id string
The provider-assigned unique ID for this managed resource.
Fingerprint string
The SSH key unique identifier.
Id string
The provider-assigned unique ID for this managed resource.
fingerprint String
The SSH key unique identifier.
id String
The provider-assigned unique ID for this managed resource.
fingerprint string
The SSH key unique identifier.
id string
The provider-assigned unique ID for this managed resource.
fingerprint str
The SSH key unique identifier.
id str
The provider-assigned unique ID for this managed resource.
fingerprint String
The SSH key unique identifier.
id String
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,
        fingerprint: Optional[str] = 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)
public static SshKey get(String name, Output<String> id, SshKeyState state, CustomResourceOptions options)
resources:  _:    type: exoscale:SshKey    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:
Fingerprint string
The SSH key unique identifier.
Name Changes to this property will trigger replacement. string
❗ The SSH key name.
PublicKey Changes to this property will trigger replacement. string
❗ The SSH public key that will be authorized in compute instances.
Fingerprint string
The SSH key unique identifier.
Name Changes to this property will trigger replacement. string
❗ The SSH key name.
PublicKey Changes to this property will trigger replacement. string
❗ The SSH public key that will be authorized in compute instances.
fingerprint String
The SSH key unique identifier.
name Changes to this property will trigger replacement. String
❗ The SSH key name.
publicKey Changes to this property will trigger replacement. String
❗ The SSH public key that will be authorized in compute instances.
fingerprint string
The SSH key unique identifier.
name Changes to this property will trigger replacement. string
❗ The SSH key name.
publicKey Changes to this property will trigger replacement. string
❗ The SSH public key that will be authorized in compute instances.
fingerprint str
The SSH key unique identifier.
name Changes to this property will trigger replacement. str
❗ The SSH key name.
public_key Changes to this property will trigger replacement. str
❗ The SSH public key that will be authorized in compute instances.
fingerprint String
The SSH key unique identifier.
name Changes to this property will trigger replacement. String
❗ The SSH key name.
publicKey Changes to this property will trigger replacement. String
❗ The SSH public key that will be authorized in compute instances.

Package Details

Repository
exoscale pulumiverse/pulumi-exoscale
License
Apache-2.0
Notes
This Pulumi package is based on the exoscale Terraform Provider.