Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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#1 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. If you prefer, you can create your own key pair using a third-party tool and upload it to any region using ImportKeyPair
.
For more information, see Key Pairs in the Amazon Elastic Compute Cloud User Guide .
Synopsis
- createKeyPair :: Text -> CreateKeyPair
- data CreateKeyPair
- ckpDryRun :: Lens' CreateKeyPair (Maybe Bool)
- ckpKeyName :: Lens' CreateKeyPair Text
- createKeyPairResponse :: Int -> Text -> Text -> Text -> CreateKeyPairResponse
- data CreateKeyPairResponse
- ckprsResponseStatus :: Lens' CreateKeyPairResponse Int
- ckprsKeyName :: Lens' CreateKeyPairResponse Text
- ckprsKeyFingerprint :: Lens' CreateKeyPairResponse Text
- ckprsKeyMaterial :: Lens' CreateKeyPairResponse Text
Creating a Request
Creates a value of CreateKeyPair
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ckpDryRun
- 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 isDryRunOperation
. Otherwise, it isUnauthorizedOperation
.ckpKeyName
- A unique name for the key pair. Constraints: Up to 255 ASCII characters
data CreateKeyPair Source #
Contains the parameters for CreateKeyPair.
See: createKeyPair
smart constructor.
Instances
Request Lenses
ckpDryRun :: Lens' CreateKeyPair (Maybe Bool) Source #
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
.
ckpKeyName :: Lens' CreateKeyPair Text Source #
A unique name for the key pair. Constraints: Up to 255 ASCII characters
Destructuring the Response
createKeyPairResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> Text | |
-> CreateKeyPairResponse |
Creates a value of CreateKeyPairResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ckprsResponseStatus
- -- | The response status code.ckprsKeyName
- The name of the key pair.ckprsKeyFingerprint
- The SHA-1 digest of the DER encoded private key.ckprsKeyMaterial
- An unencrypted PEM encoded RSA private key.
data CreateKeyPairResponse Source #
Describes a key pair.
See: createKeyPairResponse
smart constructor.
Instances
Response Lenses
ckprsResponseStatus :: Lens' CreateKeyPairResponse Int Source #
- - | The response status code.
ckprsKeyName :: Lens' CreateKeyPairResponse Text Source #
The name of the key pair.
ckprsKeyFingerprint :: Lens' CreateKeyPairResponse Text Source #
The SHA-1 digest of the DER encoded private key.
ckprsKeyMaterial :: Lens' CreateKeyPairResponse Text Source #
An unencrypted PEM encoded RSA private key.