key_pair_tags

Expands all tag keys and values for key_pairs in a region

Overview

Name	key_pair_tags
Type	Resource
Description	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](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/create-key-pairs.html#create-key-pair-cloudformation) 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.
Id	aws.ec2.key_pair_tags

Fields

Name	Datatype	Description
key_name	string	A unique name for the key pair. Constraints: Up to 255 ASCII characters
key_type	string	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
key_format	string	The format of the key pair. Default: pem
public_key_material	string	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.
key_fingerprint	string
key_pair_id	string
tag_key	string	Tag key.
tag_value	string	Tag value.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
list_resources	SELECT	region

SELECT examples

Expands tags for all key_pairs in a region.

SELECT
region,
key_name,
key_type,
key_format,
public_key_material,
key_fingerprint,
key_pair_id,
tag_key,
tag_value
FROM aws.ec2.key_pair_tags
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the key_pair_tags resource, see key_pairs