Class: AWS.EC2InstanceConnect
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.EC2InstanceConnect
- Identifier:
- ec2instanceconnect
- API Version:
- 2018-04-02
- Defined in:
- (unknown)
Overview
Constructs a service interface object. Each API operation is exposed as a function on service.
Service Description
AWS EC2 Connect Service is a service that enables system administrators to publish temporary SSH keys to their EC2 instances in order to establish connections to their instances without leaving a permanent authentication option.
Sending a Request Using EC2InstanceConnect
var ec2instanceconnect = new AWS.EC2InstanceConnect();
ec2instanceconnect.sendSSHPublicKey(params, function (err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Locking the API Version
In order to ensure that the EC2InstanceConnect object uses this specific API, you can
construct the object by passing the apiVersion
option to the constructor:
var ec2instanceconnect = new AWS.EC2InstanceConnect({apiVersion: '2018-04-02'});
You can also set the API version globally in AWS.config.apiVersions
using
the ec2instanceconnect service identifier:
AWS.config.apiVersions = {
ec2instanceconnect: '2018-04-02',
// other service API versions
};
var ec2instanceconnect = new AWS.EC2InstanceConnect();
Constructor Summary collapse
-
new AWS.EC2InstanceConnect(options = {}) ⇒ Object
constructor
Constructs a service object.
Property Summary collapse
-
endpoint ⇒ AWS.Endpoint
readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summary collapse
-
sendSSHPublicKey(params = {}, callback) ⇒ AWS.Request
Pushes an SSH public key to a particular OS user on a given EC2 instance for 60 seconds.
Methods inherited from AWS.Service
makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService
Constructor Details
new AWS.EC2InstanceConnect(options = {}) ⇒ Object
Constructs a service object. This object has one method for each API operation.