Keypair

Create a Keypair Resource

new Keypair(name: string, args?: KeypairArgs, opts?: CustomResourceOptions);

def Keypair(resource_name, opts=None, name=None, public_key=None, region=None, value_specs=None, __props__=None);

func NewKeypair(ctx *Context, name string, args *KeypairArgs, opts ...ResourceOption) (*Keypair, error)

public Keypair(string name, KeypairArgs? args = null, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args KeypairArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args KeypairArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args KeypairArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Keypair Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Keypair resource accepts the following input properties:

Name string: A unique name for the keypair. Changing this creates a new keypair.
PublicKey string: A pregenerated OpenSSH-formatted public key. Changing this creates a new keypair. If a public key is not specified, then a public/private key pair will be automatically generated. If a pair is created, then destroying this resource means you will lose access to that keypair forever.
Region string: The region in which to obtain the V2 Compute client. Keypairs are associated with accounts, but a Compute client is needed to create one. If omitted, the region argument of the provider is used. Changing this creates a new keypair.
ValueSpecs Dictionary<string, object>: Map of additional options.

Name string: A unique name for the keypair. Changing this creates a new keypair.
PublicKey string: A pregenerated OpenSSH-formatted public key. Changing this creates a new keypair. If a public key is not specified, then a public/private key pair will be automatically generated. If a pair is created, then destroying this resource means you will lose access to that keypair forever.
Region string: The region in which to obtain the V2 Compute client. Keypairs are associated with accounts, but a Compute client is needed to create one. If omitted, the region argument of the provider is used. Changing this creates a new keypair.
ValueSpecs map[string]interface{}: Map of additional options.

name string: A unique name for the keypair. Changing this creates a new keypair.
publicKey string: A pregenerated OpenSSH-formatted public key. Changing this creates a new keypair. If a public key is not specified, then a public/private key pair will be automatically generated. If a pair is created, then destroying this resource means you will lose access to that keypair forever.
region string: The region in which to obtain the V2 Compute client. Keypairs are associated with accounts, but a Compute client is needed to create one. If omitted, the region argument of the provider is used. Changing this creates a new keypair.
valueSpecs {[key: string]: any}: Map of additional options.

name str: A unique name for the keypair. Changing this creates a new keypair.
public_key str: A pregenerated OpenSSH-formatted public key. Changing this creates a new keypair. If a public key is not specified, then a public/private key pair will be automatically generated. If a pair is created, then destroying this resource means you will lose access to that keypair forever.
region str: The region in which to obtain the V2 Compute client. Keypairs are associated with accounts, but a Compute client is needed to create one. If omitted, the region argument of the provider is used. Changing this creates a new keypair.
value_specs Dict[str, Any]: Map of additional options.

Outputs

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

Fingerprint string: The fingerprint of the public key.
Id string: The provider-assigned unique ID for this managed resource.
PrivateKey string: The generated private key when no public key is specified.

Fingerprint string: The fingerprint of the public key.
Id string: The provider-assigned unique ID for this managed resource.
PrivateKey string: The generated private key when no public key is specified.

fingerprint string: The fingerprint of the public key.
id string: The provider-assigned unique ID for this managed resource.
privateKey string: The generated private key when no public key is specified.

fingerprint str: The fingerprint of the public key.
id str: The provider-assigned unique ID for this managed resource.
private_key str: The generated private key when no public key is specified.

Look up an Existing Keypair Resource

Get an existing Keypair 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?: KeypairState, opts?: CustomResourceOptions): Keypair

static get(resource_name, id, opts=None, fingerprint=None, name=None, private_key=None, public_key=None, region=None, value_specs=None, __props__=None);

func GetKeypair(ctx *Context, name string, id IDInput, state *KeypairState, opts ...ResourceOption) (*Keypair, error)

public static Keypair Get(string name, Input<string> id, KeypairState? state, CustomResourceOptions? opts = null)

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.

The following state arguments are supported:

Fingerprint string: The fingerprint of the public key.
Name string: A unique name for the keypair. Changing this creates a new keypair.
PrivateKey string: The generated private key when no public key is specified.
PublicKey string: A pregenerated OpenSSH-formatted public key. Changing this creates a new keypair. If a public key is not specified, then a public/private key pair will be automatically generated. If a pair is created, then destroying this resource means you will lose access to that keypair forever.
Region string: The region in which to obtain the V2 Compute client. Keypairs are associated with accounts, but a Compute client is needed to create one. If omitted, the region argument of the provider is used. Changing this creates a new keypair.
ValueSpecs Dictionary<string, object>: Map of additional options.

Fingerprint string: The fingerprint of the public key.
Name string: A unique name for the keypair. Changing this creates a new keypair.
PrivateKey string: The generated private key when no public key is specified.
PublicKey string: A pregenerated OpenSSH-formatted public key. Changing this creates a new keypair. If a public key is not specified, then a public/private key pair will be automatically generated. If a pair is created, then destroying this resource means you will lose access to that keypair forever.
Region string: The region in which to obtain the V2 Compute client. Keypairs are associated with accounts, but a Compute client is needed to create one. If omitted, the region argument of the provider is used. Changing this creates a new keypair.
ValueSpecs map[string]interface{}: Map of additional options.

fingerprint string: The fingerprint of the public key.
name string: A unique name for the keypair. Changing this creates a new keypair.
privateKey string: The generated private key when no public key is specified.
publicKey string: A pregenerated OpenSSH-formatted public key. Changing this creates a new keypair. If a public key is not specified, then a public/private key pair will be automatically generated. If a pair is created, then destroying this resource means you will lose access to that keypair forever.
region string: The region in which to obtain the V2 Compute client. Keypairs are associated with accounts, but a Compute client is needed to create one. If omitted, the region argument of the provider is used. Changing this creates a new keypair.
valueSpecs {[key: string]: any}: Map of additional options.

fingerprint str: The fingerprint of the public key.
name str: A unique name for the keypair. Changing this creates a new keypair.
private_key str: The generated private key when no public key is specified.
public_key str: A pregenerated OpenSSH-formatted public key. Changing this creates a new keypair. If a public key is not specified, then a public/private key pair will be automatically generated. If a pair is created, then destroying this resource means you will lose access to that keypair forever.
region str: The region in which to obtain the V2 Compute client. Keypairs are associated with accounts, but a Compute client is needed to create one. If omitted, the region argument of the provider is used. Changing this creates a new keypair.
value_specs Dict[str, Any]: Map of additional options.

Package Details

Repository: https://github.com/pulumi/pulumi-openstack
License: Apache-2.0
Notes: This Pulumi package is based on the openstack Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud