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 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 EC2 User Guide.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.EC2.AmazonEC2Request
Amazon.EC2.Model.CreateKeyPairRequest
Namespace: Amazon.EC2.Model
Assembly: AWSSDK.EC2.dll
Version: 3.x.y.z
Syntax
public class CreateKeyPairRequest : AmazonEC2Request IAmazonWebServiceRequest
The CreateKeyPairRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
CreateKeyPairRequest() |
Empty constructor used to set properties independently even when a simple constructor is available |
|
|
CreateKeyPairRequest(string) |
Instantiates CreateKeyPairRequest with the parameterized properties |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
DryRun | System.Nullable<System.Boolean> |
Gets and sets the property DryRun.
Checks whether you have the required permissions for the action, without actually
making the request, and provides an error response. If you have the required permissions,
the error response is |
|
|
KeyFormat | Amazon.EC2.KeyFormat |
Gets and sets the property KeyFormat. The format of the key pair.
Default: |
|
|
KeyName | System.String |
Gets and sets the property KeyName. A unique name for the key pair. Constraints: Up to 255 ASCII characters |
|
|
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: |
|
|
TagSpecifications | System.Collections.Generic.List<Amazon.EC2.Model.TagSpecification> |
Gets and sets the property TagSpecifications. The tags to apply to the new key pair. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. |
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:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.7.2 and newer