Key
Specifies a key pair for use with an EC2long instance as follows:
To import an existing key pair, include the
`PublicKeyMaterial`property.To create a new key pair, omit the
`PublicKeyMaterial`property. When you import an existing key pair, you specify the public key material for the key. We assume that you have the private key material for the key. CFNlong does not create or return the private key material when you import a key pair. When you create a new key pair, the private key is saved to SYSlong Parameter Store, using a parameter with the following name:`/ec2/keypair/{key_pair_id}`. For more information about retrieving private key, and the required permissions, see Create a key pair using in the User Guide. When CFN deletes a key pair that was created or imported by a stack, it also deletes the parameter that was used to store the private key material in Parameter Store.
Example Usage
Example
No Java example available.
Example
No Java example available.
Example
No Java example available.
Example
No Java example available.
Constructors
Properties
The format of the key pair. Default: `pem`
The type of key pair. Note that ED25519 keys are not supported for Windows instances. If the `PublicKeyMaterial` property is specified, the `KeyType` property is ignored, and the key type is inferred from the `PublicKeyMaterial` value. Default: `rsa`
The public key material. The `PublicKeyMaterial` property is used to import a key pair. If this property is not specified, then a new key pair will be created.
The tags to apply to the key pair.