AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreateKeyPair operation. Creates an ED25519 or 2048-bit RSA key pair with the specified name and in the specified PEM or PPK format. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#1 private key or an unencrypted PPK formatted private key for use with PuTTY. If a key with the specified name already exists, Amazon EC2 returns an error.

The key pair returned to you is available only in the Amazon Web Services Region in which you create it. If you prefer, you can create your own key pair using a third-party tool and upload it to any Region using ImportKeyPair.

You can have up to 5,000 key pairs per Amazon Web Services Region.

For more information, see Amazon EC2 key pairs in the Amazon Elastic Compute Cloud User Guide.

Inheritance Hierarchy


Namespace: Amazon.EC2.Model
Assembly: AWSSDK.EC2.dll
Version: 3.x.y.z


public class CreateKeyPairRequest : AmazonEC2Request

The CreateKeyPairRequest type exposes the following members


Public Method CreateKeyPairRequest()

Empty constructor used to set properties independently even when a simple constructor is available

Public Method CreateKeyPairRequest(string)

Instantiates CreateKeyPairRequest with the parameterized properties


Public Property KeyFormat Amazon.EC2.KeyFormat

Gets and sets the property KeyFormat.

The format of the key pair.

Default: pem

Public Property KeyName System.String

Gets and sets the property KeyName.

A unique name for the key pair.

Constraints: Up to 255 ASCII characters

Public Property KeyType Amazon.EC2.KeyType

Gets and sets the property KeyType.

The type of key pair. Note that ED25519 keys are not supported for Windows instances.

Default: rsa

Public Property TagSpecifications System.Collections.Generic.List<Amazon.EC2.Model.TagSpecification>

Gets and sets the property TagSpecifications.

The tags to apply to the new key pair.


This example creates a key pair named my-key-pair.

To create a key pair

var client = new AmazonEC2Client();
var response = client.CreateKeyPair(new CreateKeyPairRequest 
    KeyName = "my-key-pair"


Version Information

Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5