Data Types

AmazonStartEc2InstancesParameters Object

Description

Parameters for the Amazon Start EC2 Instances action.

Properties

credentialIds

Registered credentials to use with the action. One and only one credential must be specified.

Type: Array of string

Required: Yes

instances

List of EC2 instances that will be started. Required when instanceIdentificationMethod is by-instance-id.

Type: Array of StartEc2InstancesInstance objects

Required: Conditional

instanceNameComparison

Comparison to use when identifying EC2 instances by Name tag. Required when instanceIdentificationMethod is by-instance-name-tag. Note, currently compareType must be equals.

Type: InstanceNameComparison object.

Required: Conditional

instanceIdentificationMethod

Method of identifying the EC2 instances.

Type: string

Valid Values:

  • all-instances

  • by-instance-id

  • by-instance-name-tag

  • by-resource-tag

Required: Yes

isCheckReachability

Indicates whether to check instance reachability after starting.

Type: boolean

Required: No

Default: false

isSendEmailOnReachabilityFailure

Indicates whether to send an email if reachability fails. Ignored when isCheckReachability is not true.

Type: boolean

Required: No

Default: false

loadBalancerName

Name of the classic Elastic Load Balancer to register with when the EC2 instance is started.

Type: string

Required: No

regionNames

Regions to use with the action. Omit or specify null to include "all regions".

Type: Array of string

Required: No

resourceTagComparison

Comparison to use when identifying instances by resource tag. Required when instanceIdentificationMethod is by-resource-tag.

Type: ResourceTagComparison object.

Required: Conditional

resumeAutoScalingProcesses

Indicates whether to resume Auto Scaling processes for any Auto Scaling groups controlling the EC2 instances.

Type: string

Valid Values:

  • none

  • all

Required: No

Default: none

stopTimeInSeconds

Time (in seconds) after which the EC2 instances will be stopped.

Type: integer

Required: No

Sample JSON

{
"credentialIds": [
"cred-00000001"
],
"regionNames": [
"us-east-1"
],
"instanceIdentificationMethod": "by-instance-id",
"instances": [
{
"instanceId": "i-11111111",
"elasticIp": "1.2.3.4"
}
],
"loadBalancerName": null,
"resumeAutoScalingProcesses": "none",
"isCheckReachability": false
"isSendEmailOnReachabilityFailure": false,
"stopTimeInSeconds": 43200
}