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 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.EC2.AmazonEC2Request
      Amazon.EC2.Model.CreateKeyPairRequest

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

Syntax

C#
public class CreateKeyPairRequest : AmazonEC2Request
         IAmazonWebServiceRequest

The CreateKeyPairRequest type exposes the following members

Constructors

NameDescription
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

Properties

NameTypeDescription
Public Property KeyName System.String

Gets and sets the property KeyName.

A unique name for the key pair.

Constraints: Up to 255 ASCII characters

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 Standard:
Supported in: 1.3

.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