stopInstance (EC2)

Stops an EC2 instance running on a specified AWS Region.

Target Properties

Property Name

Property Code

Required

Description

Property Name

Property Code

Required

Description

AWS Endpoint

FDAWS_ENDPOINT

No

The AWS endpoint to use.

AWS Access Key

FDAWS_ACCOUNT_CODE

Yes

The Cloud Account Code of the AWS.

AWS Secret Key

FDAWS_SECRET_KEY

Yes

The path to the directory where AWS CLI is installed. Optional if set as classpath.

AWS Region

FDAWS_REGION

No

The AWS region to operate on. To find the endpoint code for your region, see Amazon's Documentation.

Number of Iterations

FDAWS_EC2_STATUS_CHECK_COUNT

Yes

The number of Iterations to perform the EC2 Instance status check. Defaults to 6.

Interval between status check

FDAWS_EC2_STATUS_INTERVAL_DURATION

Yes

The duration of time to wait for each EC2 Instance status check iteration. Defaults to 30secs.

Inputs

Input Name

Input Code

Required

Description

Input Name

Input Code

Required

Description

Instance IDs

FDAWS_EC2_INP_INSTANCE_IDS

Yes

The ID of the instance to stop.

Force Stop

FDAWS_EC2_WITH_FORCE

No

Force stop the selected instance.

Outputs

Output Name

Description

Output Name

Description

FDAWS_EC2_OUT_EC2_INSTANCE_STATUS

Captures the EC2 Instance Status Code.

FDAWS_EC2_OUT_EC2_INSTANCE_RESP

Captures the EC2 Instance Response Payload

FDAWS_EC2_OUT_EC2_INSTANCE_ERR

Captures the EC2 Instance Error Message.

Artifacts

This operation does not produce or consume artifacts. 

Endpoint Selection

This operation will select all available endpoints associated to the target. 

Endpoint Execution

This operation will execute on any one of the selected endpoints and will be random in the determination of which one.

The following macros are not currently supported in the footer:
  • style