.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "VM::EC2::REST::keys 3pm"
.TH VM::EC2::REST::keys 3pm "2016-06-04" "perl v5.22.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME VM::EC2::REST::keys \- Manipulate ssh key pairs"
.IX Header "NAME VM::EC2::REST::keys - Manipulate ssh key pairs"
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use VM::EC2 \*(Aq:standard\*(Aq;
.Ve
.SH "METHODS"
.IX Header "METHODS"
Implemented:
 DescribeKeyPairs
 CreateKeyPair
 ImportKeyPair
 DeleteKeyPair
.PP
Unimplemented:
 (none)
.PP
These methods let you manipulate ssh key pairs.
.ie n .SS "@keys = $ec2\->describe_key_pairs(@names);"
.el .SS "\f(CW@keys\fP = \f(CW$ec2\fP\->describe_key_pairs(@names);"
.IX Subsection "@keys = $ec2->describe_key_pairs(@names);"
.ie n .SS "@keys = $ec2\->describe_key_pairs(\e%filters);"
.el .SS "\f(CW@keys\fP = \f(CW$ec2\fP\->describe_key_pairs(\e%filters);"
.IX Subsection "@keys = $ec2->describe_key_pairs(%filters);"
.ie n .SS "@keys = $ec2\->describe_key_pairs(\-key_name => \e@names, \-filter    => \e%filters);"
.el .SS "\f(CW@keys\fP = \f(CW$ec2\fP\->describe_key_pairs(\-key_name => \e@names, \-filter    => \e%filters);"
.IX Subsection "@keys = $ec2->describe_key_pairs(-key_name => @names, -filter => %filters);"
Searches for ssh key pairs matching the provided filters and return
a series of VM::EC2::KeyPair objects.
.PP
Optional arguments:
.PP
.Vb 2
\& \-key_name      A single key name or an arrayref containing a list
\&                   of names
\&
\& \-filter          Filter on tags and other attributes.
.Ve
.PP
The full list of key filters can be found at:
http://docs.amazonwebservices.com/AWSEC2/latest/APIReference/ApiReference\-query\-DescribeKeyPairs.html
.ie n .SS "$key = $ec2\->create_key_pair($name)"
.el .SS "\f(CW$key\fP = \f(CW$ec2\fP\->create_key_pair($name)"
.IX Subsection "$key = $ec2->create_key_pair($name)"
Create a new key pair with the specified name (required). If the key
pair already exists, returns undef. The contents of the new keypair,
including the PEM-encoded private key, is contained in the returned
VM::EC2::KeyPair object:
.PP
.Vb 5
\&  my $key = $ec2\->create_key_pair(\*(AqMy Keypair\*(Aq);
\&  if ($key) {
\&    print $key\->fingerprint,"\en";
\&    print $key\->privateKey,"\en";
\&  }
.Ve
.ie n .SS "$key = $ec2\->import_key_pair($name,$public_key)"
.el .SS "\f(CW$key\fP = \f(CW$ec2\fP\->import_key_pair($name,$public_key)"
.IX Subsection "$key = $ec2->import_key_pair($name,$public_key)"
.ie n .SS "$key = $ec2\->import_key_pair(\-key_name            => $name, \-public_key_material => $public_key)"
.el .SS "\f(CW$key\fP = \f(CW$ec2\fP\->import_key_pair(\-key_name            => \f(CW$name\fP, \-public_key_material => \f(CW$public_key\fP)"
.IX Subsection "$key = $ec2->import_key_pair(-key_name => $name, -public_key_material => $public_key)"
Imports a preexisting public key into \s-1AWS\s0 under the specified name.
If successful, returns a VM::EC2::KeyPair. The public key must be an
\&\s-1RSA\s0 key of length 1024, 2048 or 4096. The method can be called with
two unnamed arguments consisting of the key name and the public key
material, or in a named argument form with the following argument
names:
.PP
.Vb 2
\&  \-key_name     \-\- desired name for the imported key pair (required)
\&  \-name         \-\- shorter version of \-key_name
\&
\&  \-public_key_material \-\- public key data (required)
\&  \-public_key   \-\- shorter version of the above
.Ve
.PP
This example uses Net::SSH::Perl::Key to generate a new keypair, and
then uploads the public key to Amazon.
.PP
.Vb 1
\&  use Net::SSH::Perl::Key;
\&
\&  my $newkey = Net::SSH::Perl::Key\->keygen(\*(AqRSA\*(Aq,1024);
\&  $newkey\->write_private(\*(Aq.ssh/MyKeypair.rsa\*(Aq);  # save private parts
\&
\&  my $key = $ec2\->import_key_pair(\*(AqMy Keypair\*(Aq => $newkey\->dump_public)
\&      or die $ec2\->error;
\&  print "My Keypair added with fingerprint ",$key\->fingerprint,"\en";
.Ve
.PP
Several different formats are accepted for the key, including \s-1SSH
\&\s0\*(L"authorized_keys\*(R" format (generated by ssh-keygen and
Net::SSH::Perl::Key), the \s-1SSH\s0 public keys format, and \s-1DER\s0 format. You
do not need to base64\-encode the key or perform any other
pre-processing.
.PP
Note that the algorithm used by Amazon to calculate its key
fingerprints differs from the one used by the ssh library, so don't
try to compare the key fingerprints returned by Amazon to the ones
produced by ssh-keygen or Net::SSH::Perl::Key.
.ie n .SS "$result = $ec2\->delete_key_pair($name)"
.el .SS "\f(CW$result\fP = \f(CW$ec2\fP\->delete_key_pair($name)"
.IX Subsection "$result = $ec2->delete_key_pair($name)"
Deletes the key pair with the specified name (required). Returns true
if successful.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\s-1VM::EC2\s0
.SH "AUTHOR"
.IX Header "AUTHOR"
Lincoln Stein <lincoln.stein@gmail.com>.
.PP
Copyright (c) 2011 Ontario Institute for Cancer Research
.PP
This package and its accompanying libraries is free software; you can
redistribute it and/or modify it under the terms of the \s-1GPL \s0(either
version 1, or at your option, any later version) or the Artistic
License 2.0.  Refer to \s-1LICENSE\s0 for the full license text. In addition,
please see \s-1DISCLAIMER\s0.txt for disclaimers of warranty.