| CARVIEW |
Select Language
HTTP/1.1 301 Moved Permanently
Content-Type: text/html; charset=iso-8859-1
Content-Length: 288
Connection: keep-alive
Date: Thu, 24 Jul 2025 05:27:29 GMT
Server: Server
Cache-Control: max-age=600
X-Frame-Options: SAMEORIGIN
Strict-Transport-Security: max-age=47304000; includeSubDomains
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: upgrade-insecure-requests; script-src 'self' 'unsafe-inline' *.awsstatic.com *.cdn.uis.awsstatic.com *.cdn.console.awsstatic.com d2c.aws.amazon.com a0.awsstatic.com *.feedback.console.aws.dev insights.docs.aws.com wss://insights.docs.aws.com/prod; object-src 'none';
Location: https://docs.aws.amazon.com/powershell/v5/reference/items/Import-EC2KeyPair.html
X-Cache: Miss from cloudfront
Via: 1.1 4d72934ee8dc6e546ce338ca9bb0d62e.cloudfront.net (CloudFront)
X-Amz-Cf-Pop: BOM78-P5
X-Amz-Cf-Id: 7Xk5FeWC7Q0W1ftwDzlXfJPPSjoRdwRsowAwxP2I1g9K6elLdNc7uQ==
HTTP/1.1 200 OK
Content-Type: text/html
Content-Length: 5215
Connection: keep-alive
Date: Thu, 24 Jul 2025 05:27:29 GMT
Server: Server
Cache-Control: no-store, no-cache, must-revalidate
Expires: Thu, 01 Jan 1970 00:00:00 GMT
X-Frame-Options: SAMEORIGIN
Strict-Transport-Security: max-age=47304000; includeSubDomains
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: upgrade-insecure-requests; script-src 'self' 'unsafe-inline' *.awsstatic.com *.cdn.uis.awsstatic.com *.cdn.console.awsstatic.com d2c.aws.amazon.com a0.awsstatic.com *.feedback.console.aws.dev insights.docs.aws.com wss://insights.docs.aws.com/prod; object-src 'none';
Last-Modified: Wed, 23 Jul 2025 20:57:44 GMT
ETag: "VCA5lLe5mtfsW/EJyKtj978n4k8=-gzip"
Accept-Ranges: bytes
Content-Encoding: gzip
X-Content-Type-Options: nosniff
Vary: Accept-Encoding
X-Cache: Miss from cloudfront
Via: 1.1 4d72934ee8dc6e546ce338ca9bb0d62e.cloudfront.net (CloudFront)
X-Amz-Cf-Pop: BOM78-P5
X-Amz-Cf-Id: uE0RLOyEstObalhIUTnzy35ewoxZJlQiatRMnot0VkJ3jUuz_R_Adg==
EC2: Import-EC2KeyPair Cmdlet | AWS Tools for PowerShell
AWS Tools for Windows PowerShell
Command 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.
Import-EC2KeyPair Cmdlet
Amazon Elastic Compute Cloud (EC2)Available in AWS.Tools.EC2, AWSPowerShell.NetCore and AWSPowerShell
Synopsis
Calls the Amazon Elastic Compute Cloud (EC2) ImportKeyPair API operation.
Syntax
PreEncodedToBase64 (Default)
Import-EC2KeyPair-KeyName <String>-PublicKeyMaterial <String>-DryRun <Boolean>-TagSpecification <TagSpecification[]>-Select <String>-Force <SwitchParameter>-ClientConfig <AmazonEC2Config>AutoEncodedToBase64
Import-EC2KeyPair-KeyName <String>-DryRun <Boolean>-PublicKey <String>-TagSpecification <TagSpecification[]>-Select <String>-Force <SwitchParameter>-ClientConfig <AmazonEC2Config>
Description
Imports the public key from an RSA or ED25519 key pair that you created using a third-party tool. You give Amazon Web Services only the public key. The private key is never transferred between you and Amazon Web Services.
For more information about the requirements for importing a key pair, see Create a key pair and import the public key to Amazon EC2 in the Amazon EC2 User Guide.
Parameters
-ClientConfig <AmazonEC2Config>
Amazon.PowerShell.Cmdlets.EC2.AmazonEC2ClientCmdlet.ClientConfig
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
-DryRun <Boolean>
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 DryRunOperation . Otherwise, it is UnauthorizedOperation .
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
-KeyName <String>
A unique name for the key pair.
| Required? | True |
| Position? | 1 |
| Accept pipeline input? | True (ByValue, ByPropertyName) |
-PublicKey <String>
The public key.The cmdlet will automatically convert the supplied parameter to Base64 before supplying to the service.
| Required? | True |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
-PublicKeyMaterial <String>
This parameter is obsolete and will be removed in a future version. Use 'PublicKey' instead. The public key. For API calls, the text must be base64-encoded.
| Required? | True |
| Position? | 2 |
| Accept pipeline input? | True (ByPropertyName) |
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EC2.Model.ImportKeyPairResponse). Specifying the name of a property of type Amazon.EC2.Model.ImportKeyPairResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
-TagSpecification <TagSpecification[]>
The tags to apply to the imported 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.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
| Aliases | TagSpecifications |
Common Credential and Region Parameters
-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
| Aliases | AK |
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByValue, ByPropertyName) |
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByValue, ByPropertyName) |
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
| Aliases | AWSProfilesLocation, ProfilesLocation |
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
| Aliases | StoredCredentials, AWSProfileName |
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
| Aliases | RegionToCall |
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
| Aliases | SK, SecretAccessKey |
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
| Aliases | ST |
Outputs
This cmdlet returns an Amazon.EC2.Model.ImportKeyPairResponse object containing multiple properties.
Examples
Example 1
$publickey=[Io.File]::ReadAllText("C:\Users\TestUser\.ssh\id_rsa.pub")
$pkbase64 = [System.Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes($publickey))
Import-EC2KeyPair -KeyName Example-user-key -PublicKey $pkbase64
KeyFingerprint KeyName
-------------- -------
do:d0:15:8f:79:97:12:be:00:fd:df:31:z3:b1:42:z1 Example-user-keyThis example imports a public key to EC2. The first line stores the contents of the public key file (*.pub) in the variable$publickey. Next, the example converts the UTF8 format of the public key file to a Base64-encoded string, and stores the converted string in the variable$pkbase64. In the last line, the converted public key is imported to EC2. The cmdlet returns the key fingerprint and name as results.
Related Links
Supported Version
AWS Tools for PowerShell: 2.x.y.z