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 custom SSH key pair that you can use with an Amazon Lightsail instance.
Use the DownloadDefaultKeyPair
action to create a Lightsail default key pair in an Amazon Web Services Region where
a default key pair does not currently exist.
The create key pair
operation supports tag-based access control via request
tags. For more information, see the Amazon
Lightsail Developer Guide.
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginCreateKeyPair and EndCreateKeyPair.
Namespace: Amazon.Lightsail
Assembly: AWSSDK.Lightsail.dll
Version: 3.x.y.z
public abstract Task<CreateKeyPairResponse> CreateKeyPairAsync( CreateKeyPairRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the CreateKeyPair service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Exception | Condition |
---|---|
AccessDeniedException | Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. |
AccountSetupInProgressException | Lightsail throws this exception when an account is still in the setup in progress state. |
InvalidInputException | Lightsail throws this exception when user input does not conform to the validation rules of an input field. Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources. |
NotFoundException | Lightsail throws this exception when it cannot find a resource. |
OperationFailureException | Lightsail throws this exception when an operation fails to execute. |
ServiceException | A general service exception. |
UnauthenticatedException | Lightsail throws this exception when the user has not been authenticated. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer