startInstance: Starts a stopped instance

View source: R/instances.R

startInstanceR Documentation

Starts a stopped instance

Description

Starts a stopped instance and waits for the instance to start running and for ssh access to be available.

Usage

startInstance(instanceId, throttle = 1, username = "ec2-user", sshTimeout = 10)

Arguments

instanceId

The Instance ID for the stopped instance to start.

throttle

The amount of time to wait (in seconds) before repeating requests to the AWS API. The account-wide limit is 10,000 r/s, so this default is extremely conservative.

username

The administrator username to use when logging in over ssh. The user must have sudo privileges. Default is set for Amazon Linux AMIs.

sshTimeout

How many times to re-test connecting over ssh after recieving a timeout or connection refused error. This function waits the duraction of 'throttle' between attempts.

Value

An instance object that can be used with the other functions in this package.


whitwort/AWSTools documentation built on July 9, 2023, 2:56 a.m.