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 a 2048-bit RSA key pair with the specified name. 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#8 private key. If a key with the specified name already exists, Amazon EC2 returns an error.

You can have up to five thousand key pairs per region.

The key pair returned to you is available only in the region in which you create it. To create a key pair that is available in all regions, use ImportKeyPair.

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

Note:

For PCL 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 abstract 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 response = client.CreateKeyPair(new CreateKeyPairRequest 
{
    KeyName = "my-key-pair"
});


            

Version Information

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

See Also