This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Class EC2InstanceConnect

Amazon EC2 Instance Connect enables system administrators to publish one-time use SSH public keys to EC2, providing users a simple and secure way to connect to their instances.

Index

Constructors

constructor

Properties

config

Methods

destroy sendSSHPublicKey sendSerialConsoleSSHPublicKey

Constructors

constructor

new EC2InstanceConnect(...__namedParameters: [] | [EC2InstanceConnectClientConfig]): EC2InstanceConnect
Parameters
- Rest ...__namedParameters: [] | [EC2InstanceConnectClientConfig]
Returns EC2InstanceConnect
- Defined in ../../../../../clients/client-ec2-instance-connect/src/EC2InstanceConnectClient.ts:264

Properties

`Readonly` config

config: EC2InstanceConnectClientResolvedConfig

The resolved configuration of EC2InstanceConnectClient class. This is resolved and normalized from the constructor configuration interface.

Methods

destroy

destroy(): void
Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

Returns void
- Defined in ../../../../../clients/client-ec2-instance-connect/src/EC2InstanceConnectClient.ts:290

sendSSHPublicKey

sendSSHPublicKey(args: SendSSHPublicKeyCommandInput, options?: HttpHandlerOptions): Promise<SendSSHPublicKeyCommandOutput>
See
SendSSHPublicKeyCommand
Parameters
- args: SendSSHPublicKeyCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<SendSSHPublicKeyCommandOutput>
- Defined in ../../../../../clients/client-ec2-instance-connect/src/EC2InstanceConnect.ts:43
sendSSHPublicKey(args: SendSSHPublicKeyCommandInput, cb: ((err: any, data?: SendSSHPublicKeyCommandOutput) => void)): void
Parameters
- args: SendSSHPublicKeyCommandInput
- cb: ((err: any, data?: SendSSHPublicKeyCommandOutput) => void)
  - - (err: any, data?: SendSSHPublicKeyCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: SendSSHPublicKeyCommandOutput
      
      Returns void
Returns void
- Defined in ../../../../../clients/client-ec2-instance-connect/src/EC2InstanceConnect.ts:47
sendSSHPublicKey(args: SendSSHPublicKeyCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: SendSSHPublicKeyCommandOutput) => void)): void
Parameters
- args: SendSSHPublicKeyCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: SendSSHPublicKeyCommandOutput) => void)
  - - (err: any, data?: SendSSHPublicKeyCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: SendSSHPublicKeyCommandOutput
      
      Returns void
Returns void
- Defined in ../../../../../clients/client-ec2-instance-connect/src/EC2InstanceConnect.ts:51

sendSerialConsoleSSHPublicKey

sendSerialConsoleSSHPublicKey(args: SendSerialConsoleSSHPublicKeyCommandInput, options?: HttpHandlerOptions): Promise<SendSerialConsoleSSHPublicKeyCommandOutput>
See
SendSerialConsoleSSHPublicKeyCommand
Parameters
- args: SendSerialConsoleSSHPublicKeyCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<SendSerialConsoleSSHPublicKeyCommandOutput>
- Defined in ../../../../../clients/client-ec2-instance-connect/src/EC2InstanceConnect.ts:26
sendSerialConsoleSSHPublicKey(args: SendSerialConsoleSSHPublicKeyCommandInput, cb: ((err: any, data?: SendSerialConsoleSSHPublicKeyCommandOutput) => void)): void
Parameters
- args: SendSerialConsoleSSHPublicKeyCommandInput
- cb: ((err: any, data?: SendSerialConsoleSSHPublicKeyCommandOutput) => void)
  - - (err: any, data?: SendSerialConsoleSSHPublicKeyCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: SendSerialConsoleSSHPublicKeyCommandOutput
      
      Returns void
Returns void
- Defined in ../../../../../clients/client-ec2-instance-connect/src/EC2InstanceConnect.ts:30
sendSerialConsoleSSHPublicKey(args: SendSerialConsoleSSHPublicKeyCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: SendSerialConsoleSSHPublicKeyCommandOutput) => void)): void
Parameters
- args: SendSerialConsoleSSHPublicKeyCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: SendSerialConsoleSSHPublicKeyCommandOutput) => void)
  - - (err: any, data?: SendSerialConsoleSSHPublicKeyCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: SendSerialConsoleSSHPublicKeyCommandOutput
      
      Returns void
Returns void
- Defined in ../../../../../clients/client-ec2-instance-connect/src/EC2InstanceConnect.ts:34

This API Documentation is now deprecated

Class EC2InstanceConnect

Hierarchy

Implements

Implemented by

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Rest ...__namedParameters: [] | [EC2InstanceConnectClientConfig]

Returns EC2InstanceConnect

Properties

Readonly config

Methods

destroy

Returns void

sendSSHPublicKey

See

Parameters

args: SendSSHPublicKeyCommandInput

Optional options: HttpHandlerOptions

Returns Promise<SendSSHPublicKeyCommandOutput>

Parameters

args: SendSSHPublicKeyCommandInput

cb: ((err: any, data?: SendSSHPublicKeyCommandOutput) => void)

Parameters

err: any

Optional data: SendSSHPublicKeyCommandOutput

Returns void

Returns void

Parameters

args: SendSSHPublicKeyCommandInput

options: HttpHandlerOptions

cb: ((err: any, data?: SendSSHPublicKeyCommandOutput) => void)

Parameters

err: any

Optional data: SendSSHPublicKeyCommandOutput

Returns void

Returns void

sendSerialConsoleSSHPublicKey

See

Parameters

args: SendSerialConsoleSSHPublicKeyCommandInput

Optional options: HttpHandlerOptions

Returns Promise<SendSerialConsoleSSHPublicKeyCommandOutput>

Parameters

args: SendSerialConsoleSSHPublicKeyCommandInput

cb: ((err: any, data?: SendSerialConsoleSSHPublicKeyCommandOutput) => void)

Parameters

err: any

Optional data: SendSerialConsoleSSHPublicKeyCommandOutput

Returns void

Returns void

Parameters

args: SendSerialConsoleSSHPublicKeyCommandInput

options: HttpHandlerOptions

cb: ((err: any, data?: SendSerialConsoleSSHPublicKeyCommandOutput) => void)

Parameters

err: any

Optional data: SendSerialConsoleSSHPublicKeyCommandOutput

Returns void

Returns void

Settings

Member Visibility

Theme

`Rest` ...__namedParameters: [] | [EC2InstanceConnectClientConfig]

`Readonly` config

`Optional` options: HttpHandlerOptions

`Optional` data: SendSSHPublicKeyCommandOutput

`Optional` data: SendSSHPublicKeyCommandOutput

`Optional` options: HttpHandlerOptions

`Optional` data: SendSerialConsoleSSHPublicKeyCommandOutput

`Optional` data: SendSerialConsoleSSHPublicKeyCommandOutput