terminate-target-instances¶
Description¶
Starts a job that terminates specific launched EC2 Test and Cutover instances. This command will not work for any Source Server with a lifecycle.state of TESTING, CUTTING_OVER, or CUTOVER.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
terminate-target-instances
--source-server-ids <value>
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--source-server-ids (list)
Terminate Target instance by Source Server IDs.
(string)
Syntax:
"string" "string" ...
--tags (map)
Terminate Target instance by Tags.
key -> (string)
value -> (string)
Shorthand Syntax:
KeyName1=string,KeyName2=string
JSON Syntax:
{"string": "string"
...}
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
Output¶
job -> (structure)
Terminate Target instance Job response.
arn -> (string)
the ARN of the specific Job.
creationDateTime -> (string)
Job creation time.
endDateTime -> (string)
Job end time.
initiatedBy -> (string)
Job initiated by field.
jobID -> (string)
Job ID.
participatingServers -> (list)
Servers participating in a specific Job.
(structure)
Server participating in Job.
launchStatus -> (string)
Participating server launch status.
launchedEc2InstanceID -> (string)
Participating server Source Server ID.
postLaunchActionsStatus -> (structure)
Participating server Source Server ID.
postLaunchActionsLaunchStatusList -> (list)
Server participating in Job.
(structure)
Job type.
executionID -> (string)
Job type.
executionStatus -> (string)
Job type.
failureReason -> (string)
Job type.
ssmDocument -> (structure)
Job type.
actionName -> (string)
Source server replication type.
mustSucceedForCutover -> (boolean)
Source server replication type.
parameters -> (map)
Source server replication type.
key -> (string)
value -> (list)
(structure)
Source server replication type.
parameterName -> (string)
Source server replication type.
parameterType -> (string)
Source server replication type.
ssmDocumentName -> (string)
Source server replication type.
timeoutSeconds -> (integer)
Source server replication type.
ssmDocumentType -> (string)
Job type.
ssmAgentDiscoveryDatetime -> (string)
Server participating in Job.
sourceServerID -> (string)
Participating server Source Server ID.
status -> (string)
Job status.
tags -> (map)
Tags associated with specific Job.
key -> (string)
value -> (string)
type -> (string)
Job type.