Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . ec2-instance-connect ]

send-ssh-public-key

Description

Pushes an SSH public key to a particular OS user on a given EC2 instance for 60 seconds.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  send-ssh-public-key
--instance-id <value>
--instance-os-user <value>
--ssh-public-key <value>
--availability-zone <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--instance-id (string)

The EC2 instance you wish to publish the SSH key to.

--instance-os-user (string)

The OS user on the EC2 instance whom the key may be used to authenticate as.

--ssh-public-key (string)

The public key to be published to the instance. To use it after publication you must have the matching private key.

--availability-zone (string)

The availability zone the EC2 instance was launched in.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To send a an SSH public key to an instance

The following send-ssh-public-key example sends the specified SSH public key to the specified instance. The key is used to authenticate the specified user.

aws ec2-instance-connect send-ssh-public-key \
    --instance-id i-1234567890abcdef0 \
    --instance-os-user ec2-user \
    --availability-zone us-east-2b \
    --ssh-public-key file://path/my-rsa-key.pub

This command produces no output.

Output

RequestId -> (string)

The request ID as logged by EC2 Connect. Please provide this when contacting AWS Support.

Success -> (boolean)

Indicates request success.