as-terminate-instance-in-auto-scaling-group

NAME

as-terminate-instance-in-auto-scaling-group - Terminates a given instance.

SYNOPSIS

as-terminate-instance-in-auto-scaling-group
InstanceId --decrement-desired-capacity/no-decrement-desired-capacity
[General Options]

Terminates a given instance. If specified with --decrement-desired-capacity,
the value of desired capacity will be reduced by 1 when the instance
is terminated. If specified with --no-decrement-desired-capacity, the value
of desired capacity will not change and Auto Scaling will launch a
replacement instance.

ARGUMENTS

InstanceId
ID of the instance to be terminated. You can also set this value using
" --instance". Required.

SPECIFIC OPTIONS

-d, --decrement-desired-capacity, -D, --no-decrement-desired-capacity
Specify only one of the two flags. If set, desired capacity is
decremented by 1 when we terminate this instance. Otherwise, a new
instance will be launched to compensate for the termination of this
instance. Required.

-f, --force
Forces the terminate action to go through without prompting. By default,
the terminate command will prompt.

GENERAL OPTIONS

--aws-credential-file VALUE
Location of the file with your AWS credentials. This value can be set by
using the environment variable 'AWS_CREDENTIAL_FILE'.

-C, --ec2-cert-file-path VALUE
Path to the file holding the X.509 certificate. This value can be set by
using the environment variable 'EC2_CERT'.

--connection-timeout VALUE
Connection timeout (in seconds). The default value is '30'.

--delimiter VALUE
The delimiter to use when displaying delimited (long) results.

-H, --headers
For displaying tabular or delimited results, it includes the column
headers. For displaying XML results, it returns the HTTP headers from the
service request, if applicable. This is off by default.

-I, --access-key-id VALUE
The AWS access ID to use.

-K, --ec2-private-key-file-path VALUE
Path to the file holding the X.509 private key. This value can be set by
using the environment variable 'EC2_PRIVATE_KEY'.

--region VALUE
Amazon EC2 region to use. This value can be set by using the environment
variable 'EC2_REGION'.

-S, --secret-key VALUE
The AWS Secret Key to use.

--show-empty-fields
Shows empty fields and rows, using a (nil) value. The default is to not
show empty fields or columns.

--show-request
Displays the URL the tools used to call the AWS Service. The default
value is 'false'.

--show-table, --show-long, --show-xml, --quiet
The way in which the results are displayed: tabular, delimited (long),
XML or no output (quiet). Tabular shows a subset of the data in fixed
column-width form, while long shows all of the returned values delimited
by a character, XML is the raw return from the service and quiet
suppresses all standard output. The default is tabular, or 'show-table'.

-U, --url VALUE
This option will override the URL for the service call with VALUE. This
value can be set by using the environment variable
'AWS_AUTO_SCALING_URL'.

INPUT EXAMPLES

Terminates instance 'i-1' and decrements group size.

$PROMPT> as-terminate-instance-in-auto-scaling-group i-1 --decrement-desired-capacity

Terminates instance 'i-2' but does not decrement the group size.

$PROMPT> as-terminate-instance-in-auto-scaling-group i-2 --no-decrement-desired-capacity

OUTPUT

This command returns a table that contains the following:
* ACTIVITY-ID - Id of the scaling activity.
* UPDATED-TIME - Last update time of this activity's status.
* CODE - Status code of the activity.
* CAUSE - Activity cause.
* MESSAGE - Message associated with the acitivity's latest event (long).
This column appears only in the --show-long view.
* PROGRESS - Progress rate of the activity (long). This column appears only
in the --show-long view.
* DESCRIPTION - Activity description (long). This column appears only in the
--show-long view.
* START-TIME - Activity's start time (long). This column appears only in the
--show-long view.

OUTPUT EXAMPLES

This is an example of the output of this command.