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.

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.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to CreateKeyPairAsync.

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

Syntax

C#
public virtual CreateKeyPairResponse CreateKeyPair(
         CreateKeyPairRequest request
)

Parameters

request
Type: Amazon.EC2.Model.CreateKeyPairRequest

Container for the necessary parameters to execute the CreateKeyPair service method.

Return Value


The response from the CreateKeyPair service method, as returned by EC2.

Examples

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

.NET Framework:
Supported in: 4.5, 4.0, 3.5

See Also