key_pair

Gets or updates an individual key_pair resource, use key_pairs to retrieve a list of resources or to create or delete a resource.

Overview

Name	key_pair
Type	Resource
Description	The AWS::EC2::KeyPair creates an SSH key pair
Id	aws.ec2.key_pair

Fields

Name	Datatype	Description
key_name	string	The name of the SSH key pair
key_type	string	The crypto-system used to generate a key pair.
key_format	string	The format of the private key
public_key_material	string	Plain text public key to import
key_fingerprint	string	A short sequence of bytes used for public key verification
key_pair_id	string	An AWS generated ID for the key pair
tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
get_resource	SELECT	data__Identifier, region

SELECT Example

SELECT
region,
key_name,
key_type,
key_format,
public_key_material,
key_fingerprint,
key_pair_id,
tags
FROM aws.ec2.key_pair
WHERE region = 'us-east-1' AND data__Identifier = '<KeyName>';

Permissions

To operate on the key_pair resource, the following permissions are required:

Read

ec2:DescribeKeyPairs