Amazon Auto Scaling Help Pages

Auto Scaling brings true pay per use flexibility to the EC2 stack replacing the technology of companies like Scalr and RightScale. Amazon describes the service on their site as:

Auto Scaling allows you to automatically scale your Amazon EC2 capacity up or down according to conditions you define. With Auto Scaling, you can ensure that the number of Amazon EC2 instances you're using scales up seamlessly during demand spikes to maintain performance, and scales down automatically during demand lulls to minimize costs. Auto Scaling is particularly well suited for applications that experience hourly, daily, or weekly variability in usage. Auto Scaling is enabled by Amazon CloudWatch and available at no additional charge beyond Amazon CloudWatch fees. Amazon

Service List

Table of Contents

as-create-auto-scaling-group

Service List | Table of Contents


SYNOPSIS
   as-create-auto-scaling-group
        AutoScalingGroupName  --availability-zones  value[,value...]
        --launch-configuration  value  --max-size  value  --min-size  value
       [--cooldown  value ] [--load-balancers  value[,value...] ]
        [General Options]

DESCRIPTION
       Create a new auto scaling group with specified name and other attributes

ARGUMENTS
   AutoScalingGroupName
       User-supplied auto scaling group identifier which will uniquely identify
       the auto scaling group. You can also set this value using
       "--auto-scaling-group". Required.

SPECIFIC OPTIONS
   --cooldown VALUE
       Time (in seconds) between a successful scaling activity and succeeding
       scaling activity.

   -l, --launch-configuration VALUE
       Name of existing launch configuration to use to launch new instances.
       Required.

   --load-balancers VALUE1,VALUE2,VALUE3...
       List of existing load balancers. Load balancers must exist in Elastic
       Load Balancing service, within the scope of the caller's AWS account.

   -m, --min-size VALUE
       Minimum group size (0 <= minimum-size <= maximum-size). Required.

   -M, --max-size VALUE
       Maximum group size (minimum-size <= maximum-size < 10000). Required.

   -z, --availability-zones VALUE1,VALUE2,VALUE3...
       Availability zones in which new instances will be launched. Currently
       restricted to one availability zone. Required.


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'.

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

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

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

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

   -H, --headers
       If you are displaying tabular or delimited results, it includes the
       column headers. If you are showing xml results, it returns the HTTP
       headers from the service request, if applicable. This is off by default.

   -I, --access-key-id VALUE
       Specify VALUE as the AWS Access Id to use.

   --region VALUE
       Specify region VALUE as the web service region to use. This value can be
       set by using the environment variable 'EC2_REGION'.

   -S, --secret-key VALUE
       Specify VALUE as the AWS Secret Key to use.

   --show-empty-fields
       Show 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
       Specify how 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

    Create group 'test-group-1' with required parameters (will have 1 instance
    launched with config 'test-config-1')

    $PROMPT> as-create-auto-scaling-group test-group-1 --launch-configuration test-config-1 --availability-zones us-east-1a --min-size 1 --max-size 1 
                

    Create group 'test-group-2' with all parameters

    $PROMPT2> as-create-auto-scaling-group test-group-2 --launch-configuration test-config-2 --availablity-zones us-east-1a --min-size 0 --max-size 1 --cooldown 180 --loadbalancers  test-lb-2 
                


as-create-launch-config

Service List | Table of Contents


SYNOPSIS
   as-create-launch-config
        LaunchConfigurationName  --image-id  value  --instance-type  value
       [--block-device-mapping  "key1=value1,key2=value2..." ] [--kernel  value
       ] [--key  value ] [--ramdisk  value ] [--group  value[,value...] ]
       [--user-data  value ] [--user-data-file  value ]  [General Options]

DESCRIPTION
       Create a new launch config with specified attributes.

ARGUMENTS
   LaunchConfigurationName
       User-supplied launch configuration identifier which will uniquely
       identify the config. You can also set this value using "--launch-config".
       Required.

SPECIFIC OPTIONS
   --block-device-mapping "key1=value1,key2=value2..." 
       List of block device mapping specifications. Each block device mapping
       has two items - a virtualName and a deviceName.

   --group VALUE1,VALUE2,VALUE3...
       Security groups with which to associate the EC2 instances.

   -i, --image-id VALUE
       Unique ID of the Amazon Machine Image (AMI) assigned during registration.
       Required.

   --kernel VALUE
       ID of the kernel associated with the EC2 AMI.

   --key VALUE
       Name of the EC2 key pair.

   --ramdisk VALUE
       ID of the RAM disk associated with the EC2 AMI.

   -t, --instance-type VALUE
       EC2 instance type to launch. Required.

   --user-data VALUE
       The data to make available to the instance.  The data must be specified
       as a string on the command line.  To upload data from a file see the 
       '--user-data-file' option.

   --user-data-file VALUE
       The name of the file containing user data for the instance.


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'.

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

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

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

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

   -H, --headers
       If you are displaying tabular or delimited results, it includes the
       column headers. If you are showing xml results, it returns the HTTP
       headers from the service request, if applicable. This is off by default.

   -I, --access-key-id VALUE
       Specify VALUE as the AWS Access Id to use.

   --region VALUE
       Specify region VALUE as the web service region to use. This value can be
       set by using the environment variable 'EC2_REGION'.

   -S, --secret-key VALUE
       Specify VALUE as the AWS Secret Key to use.

   --show-empty-fields
       Show 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
       Specify how 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

    Create a launch configuration with name 'lc' to launch 'm1.small' type
    instances with imageId 'ami-f7c5219e'.

    $PROMPT> as-create-launch-config lc --image-id ami-f7c5219e --instance-type m1.small       
                

    Create a launch configuration with name 'lc' and other attributes.

    $PROMPT2> as-create-launch-config lc --image-id ami-f7c5219e --instance-type m1.small --key key-name --group group --user-data userdata --kernel kernel --ramdisk ramdisk --block-device-mapping "virtual1=device1" 
                


as-create-or-update-trigger

Service List | Table of Contents


SYNOPSIS
   as-create-or-update-trigger
        TriggerName  --auto-scaling-group  value  --breach-duration  value
        --dimensions  "key1=value1,key2=value2..."  --lower-breach-increment 
       value  --lower-threshold  value  --measure  value  --period  value
        --statistic  value  --upper-breach-increment  value  --upper-threshold 
       value [--namespace  value ] [--unit  value ]  [General Options]

DESCRIPTION
       Creates a new trigger or updates an existing trigger.

ARGUMENTS
   TriggerName
       Name of the trigger. You can also set this value using "--trigger".
       Required.

SPECIFIC OPTIONS
   -b, --breach-duration VALUE
       The period of time for which the value of the metric needs to stay above
       or below threshold for the trigger to fire. Required.

   -d, --dimensions "key1=value1,key2=value2..." 
       Dimensions of the metric on which to trigger: used to describe the
       monitoring metric. Required.

   -g, --auto-scaling-group VALUE
       Name of the auto scaling group. Required.

   -i, --upper-breach-increment VALUE
       The amount to scale when the metric breaches the upper threshold.  For
       negative numeric values specify this option like
       --upper-breach-increment=-10 for Unix, and 
       "--upper-breach-increment=-10" (quotes required)  for Windows.

   -j, --lower-breach-increment VALUE
       The amount to scale when the metric breaches lower threshold.  For
       negative numeric values specify this option like
       --lower-breach-increment=-10 for Unix, and 
       "--lower-breach-increment=-10" (quotes required) for Windows.

   -l, --lower-threshold VALUE
       Numeric value for metric below which the trigger will fire.  For negative
       numeric values specify this option like --lower-threshold=-10 for Unix,
       and  "--lower-threshold=-10" (quotes required) for Windows.

   -m, --measure VALUE
       The measure name for the metric on which to trigger: used to describe the
       monitoring metric. Required.

   --namespace VALUE
       Namespace of the metric on which to trigger: used to describe the
       monitoring metric.

   -p, --period VALUE
       Period of metric  on which to trigger: used to describe the monitoring
       metric. Required.

   -s, --statistic VALUE
       The statistic of the metric on which to trigger: used to describe the
       monitoring metric.    Possible values are Average, Sum, Minimum or
       Maximum. Required.

   -u, --upper-threshold VALUE
       Numeric value for metric above which the trigger will fire.  For negative
       numeric values specify this option like --upper-threshold=-10 for Unix,
       and  "--upper-threshold=-10" (quotes required) for Windows.

   --unit VALUE
       The unit of the metric: used to describe the monitoring metric. 
       Optional.


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'.

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

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

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

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

   -H, --headers
       If you are displaying tabular or delimited results, it includes the
       column headers. If you are showing xml results, it returns the HTTP
       headers from the service request, if applicable. This is off by default.

   -I, --access-key-id VALUE
       Specify VALUE as the AWS Access Id to use.

   --region VALUE
       Specify region VALUE as the web service region to use. This value can be
       set by using the environment variable 'EC2_REGION'.

   -S, --secret-key VALUE
       Specify VALUE as the AWS Secret Key to use.

   --show-empty-fields
       Show 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
       Specify how 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

    Create a trigger with a minimal set of parameters
$PROMPT> as-create-or-update-trigger  test-trigger --auto-scaling-group test-group --namespace "AWS/EC2" --measure CPUUtilization --statistic Average --dimensions "AutoScalingGroupName=test-group" --period 60 --lower-threshold 20 --upper-threshold 80 --lower-breach-increment=-1 --upper-breach-increment 1 --breach-duration 120 
        


as-delete-auto-scaling-group

Service List | Table of Contents


SYNOPSIS
   as-delete-auto-scaling-group
        AutoScalingGroupName  [General Options]

DESCRIPTION
       Delete the specified auto scaling group if the group has no instances and no
    scaling activities in progress.

ARGUMENTS
   AutoScalingGroupName
       User-supplied auto scaling group identifier which will uniquely identify
       the auto scaling group to be deleted. Group will be deleted only if the
       group does not have any instances or any scaling activities in progress.
       You can also set this value using "--auto-scaling-group". Required.

SPECIFIC OPTIONS
   -f, --force
       Forces the delete to go through without prompting. By default, the delete
       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'.

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

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

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

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

   -H, --headers
       If you are displaying tabular or delimited results, it includes the
       column headers. If you are showing xml results, it returns the HTTP
       headers from the service request, if applicable. This is off by default.

   -I, --access-key-id VALUE
       Specify VALUE as the AWS Access Id to use.

   --region VALUE
       Specify region VALUE as the web service region to use. This value can be
       set by using the environment variable 'EC2_REGION'.

   -S, --secret-key VALUE
       Specify VALUE as the AWS Secret Key to use.

   --show-empty-fields
       Show 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
       Specify how 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

    Deletes the group 'test-group-1' if it exists.

    $PROMPT> as-delete-auto-scaling-group test-group-1 
                


as-delete-launch-config

Service List | Table of Contents


SYNOPSIS
   as-delete-launch-config
        LaunchConfigurationName  [General Options]

DESCRIPTION
       Delete the specified launch configuration.

ARGUMENTS
   LaunchConfigurationName
       Name of launch configuration to be deleted. You can also set this value
       using "--launch-config". Required.

SPECIFIC OPTIONS
   -f, --force
       Forces the delete to go through without prompting. By default, the delete
       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'.

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

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

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

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

   -H, --headers
       If you are displaying tabular or delimited results, it includes the
       column headers. If you are showing xml results, it returns the HTTP
       headers from the service request, if applicable. This is off by default.

   -I, --access-key-id VALUE
       Specify VALUE as the AWS Access Id to use.

   --region VALUE
       Specify region VALUE as the web service region to use. This value can be
       set by using the environment variable 'EC2_REGION'.

   -S, --secret-key VALUE
       Specify VALUE as the AWS Secret Key to use.

   --show-empty-fields
       Show 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
       Specify how 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

    Deletes the launch config 'test-config-1' if it exists.

    $PROMPT> as-delete-launch-config test-config-1 
                


as-delete-trigger

Service List | Table of Contents


SYNOPSIS
   as-delete-trigger
        TriggerName  --auto-scaling-group  value  [General Options]

DESCRIPTION
       Delete a trigger.

ARGUMENTS
   TriggerName
       Name of the trigger. You can also set this value using "--trigger".
       Required.

SPECIFIC OPTIONS
   -f, --force
       Forces the delete to go through without prompting. By default, the delete
       command will prompt.

   -g, --auto-scaling-group VALUE
       Name of the auto scaling group. Required.


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'.

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

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

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

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

   -H, --headers
       If you are displaying tabular or delimited results, it includes the
       column headers. If you are showing xml results, it returns the HTTP
       headers from the service request, if applicable. This is off by default.

   -I, --access-key-id VALUE
       Specify VALUE as the AWS Access Id to use.

   --region VALUE
       Specify region VALUE as the web service region to use. This value can be
       set by using the environment variable 'EC2_REGION'.

   -S, --secret-key VALUE
       Specify VALUE as the AWS Secret Key to use.

   --show-empty-fields
       Show 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
       Specify how 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

    Deletes the trigger 'test-trigger-1' associated with auto scaling group
    'test-group-1' if the trigger exists.

    $PROMPT> as-delete-trigger test-trigger-1 --auto-scaling-group test-group-1
                


as-describe-auto-scaling-groups

Service List | Table of Contents


SYNOPSIS
   as-describe-auto-scaling-groups
       [AutoScalingGroupNames [AutoScalingGroupNames ...] ]  [General Options]

DESCRIPTION
       Describes the specified auto scaling group(s) if the group(s) exists.

ARGUMENTS
   AutoScalingGroupNames
       Names of auto scaling groups to be described. If no names are provided,
       all current groups of the user will be described.

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'.

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

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

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

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

   -H, --headers
       If you are displaying tabular or delimited results, it includes the
       column headers. If you are showing xml results, it returns the HTTP
       headers from the service request, if applicable. This is off by default.

   -I, --access-key-id VALUE
       Specify VALUE as the AWS Access Id to use.

   --region VALUE
       Specify region VALUE as the web service region to use. This value can be
       set by using the environment variable 'EC2_REGION'.

   -S, --secret-key VALUE
       Specify VALUE as the AWS Secret Key to use.

   --show-empty-fields
       Show 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
       Specify how 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

    Describes all of the user's groups if any exist.

    $PROMPT> as-describe-auto-scaling-groups
                

    Describes user's groups 'test-group-1' and 'test-group-2' if they exist.

    $PROMPT> as-describe-auto-scaling-groups test-group-1 test-group-2
                

OUTPUT
    This command returns a table that contains the following:
    * GROUP-NAME - Name of the auto scaling group.
    * LAUNCH-CONFIG - Associated launch config.
    * AVAILABILITY-ZONES - Availability zone(s) associated with the group.
    * CREATED - Group created time. This column appears only in the --show-long
    view.
    * LOAD-BALANCERS - No description available for this column.
    * MIN-SIZE - Minimum group size (long).
    * MAX-SIZE - Maximum group size (long).
    * DESIRED-CAPACITY - Current desired capacity of the group (long).
    * COOLDOWN - Cooldown period of the group (long). This column appears only
    in the --show-long view.
    * INSTANCE-ID - Id of the instance belong to this group.
    * AUTO-SCALING-GROUP - Name of the auto scaling group.
    * AVAILABILITY-ZONE - Availability zone where this instance belongs.
    * STATE - Instance state (Pending/InService/Terminating).

OUTPUT EXAMPLES

    This is an example output for an Auto Scaling group

GROUP-NAME  LAUNCH-CONFIG  AVAILABILITY-ZONES  CREATED             
test-cg         test-lc        test-az-1           2009-03-25T12:04:57Z
INSTANCE        AUTO_SCALING-GROUP AVAILABILITY_ZONE    STATE
i-123456        test-cg            us-east-1a           InService



as-describe-launch-configs

Service List | Table of Contents


SYNOPSIS
   as-describe-launch-configs
       [LaunchConfigurationNames [LaunchConfigurationNames ...] ]
       [--max-records  value ]  [General Options]

DESCRIPTION
       Describe the specified launch configurations if they exist.

ARGUMENTS
   LaunchConfigurationNames
       Names of launch configurations to be described. If no names are provided,
       all current configurations of the user will be described.

SPECIFIC OPTIONS
   --max-records VALUE
       Maximum number of launch configurations that will be described with each
       call. The default value is '50'.


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'.

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

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

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

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

   -H, --headers
       If you are displaying tabular or delimited results, it includes the
       column headers. If you are showing xml results, it returns the HTTP
       headers from the service request, if applicable. This is off by default.

   -I, --access-key-id VALUE
       Specify VALUE as the AWS Access Id to use.

   --region VALUE
       Specify region VALUE as the web service region to use. This value can be
       set by using the environment variable 'EC2_REGION'.

   -S, --secret-key VALUE
       Specify VALUE as the AWS Secret Key to use.

   --show-empty-fields
       Show 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
       Specify how 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

    Describe all of the user's configurations if any exist.

    $PROMPT> as-describe-launch-configs 
                

    Describe user's launch configurations 'test-lc-1' and 'test-lc-2' if they
    exist.

    $PROMPT2> as-describe-launch-configs test-lc-1 test-lc-2
                

OUTPUT
    This command returns a table that contains the following:
    * NAME - Name of the launch config (short).
    * IMAGE-ID - Id of the associated amazon machine image (AMI) (short).
    * TYPE - EC2 instance type that will be launched (short).
    * KEY - EC2 key pair (long). This column appears only in the --show-long
    view.
    * KERNEL-ID - Id of kernel associated with the AMI (long). This column
    appears only in the --show-long view.
    * RAMDISK-ID - No description available for this column. This column appears
    only in the --show-long view.
    * DEVICE-MAP - Block device mapping specifications (long). This column
    appears only in the --show-long view.
    * SG - Security group associated with instances that are launched with this
    configuration (long). This column appears only in the --show-long view.
    * CREATED - Launch configuration created time (long). This column appears
    only in the --show-long view.

OUTPUT EXAMPLES

    This is an example output of this command

NAME       IMAGE-ID      TYPE    
test-lc-1  ami-1         m1.small
test-lc-2  ami-2         m1.small



as-describe-scaling-activities

Service List | Table of Contents


SYNOPSIS
   as-describe-scaling-activities
        AutoScalingGroupName [--activity-ids  value[,value...] ] [--max-records 
       value ]  [General Options]

DESCRIPTION
       Describe a set of activities or all activities belonging to a group,
    describing at most max-activities at a time.

ARGUMENTS
   AutoScalingGroupName
       Name of Auto Scaling group that the activities belong to. You can also
       set this value using "--auto-scaling-group". Required.

SPECIFIC OPTIONS
   --activity-ids VALUE1,VALUE2,VALUE3...
       List of ids of scaling activities that belong to the group and that are
       to be described.

   --max-records VALUE
       Maximum number of activities that will be described with each call. The
       default value is '50'.


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'.

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

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

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

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

   -H, --headers
       If you are displaying tabular or delimited results, it includes the
       column headers. If you are showing xml results, it returns the HTTP
       headers from the service request, if applicable. This is off by default.

   -I, --access-key-id VALUE
       Specify VALUE as the AWS Access Id to use.

   --region VALUE
       Specify region VALUE as the web service region to use. This value can be
       set by using the environment variable 'EC2_REGION'.

   -S, --secret-key VALUE
       Specify VALUE as the AWS Secret Key to use.

   --show-empty-fields
       Show 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
       Specify how 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

    Describe activities of the group 'test-group-1'.

    $PROMPT> as-describe-scaling-activities test-group-1 --max-records 50 --token token-1 
                

OUTPUT
    This command returns a table that contains the following:
    * ACTIVITY-ID - Id of the scaling activity.
    * END-TIME - No description available for this column.
    * CODE - Status code of the activity.
    * MESSAGE - Message associated with the acitivity's latest event (long).
    * CAUSE - Activity cause.
    * PROGRESS - Progress rate of the activtity (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.


ACTIVITY  ACTIVITY-ID           END-TIME             CODE        CAUSE
ACTIVITY  74758a33-bfd5-4df...  2009-05-11T16:27:36Z Successful  "At 1970-01-01 00:00:00Z an instance was started in response to a difference between desired and actual capacity, increasing the capacity from 0 to 1."



as-describe-triggers

Service List | Table of Contents


SYNOPSIS
   as-describe-triggers
        AutoScalingGroupName  [General Options]

DESCRIPTION
       Describes a trigger including its internal state.

ARGUMENTS
   AutoScalingGroupName
       Name of the auto scaling group to which the trigger is associated. You
       can also set this value using "--auto-scaling-group". Required.

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'.

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

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

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

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

   -H, --headers
       If you are displaying tabular or delimited results, it includes the
       column headers. If you are showing xml results, it returns the HTTP
       headers from the service request, if applicable. This is off by default.

   -I, --access-key-id VALUE
       Specify VALUE as the AWS Access Id to use.

   --region VALUE
       Specify region VALUE as the web service region to use. This value can be
       set by using the environment variable 'EC2_REGION'.

   -S, --secret-key VALUE
       Specify VALUE as the AWS Secret Key to use.

   --show-empty-fields
       Show 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
       Specify how 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

    Describe the trigger associated with this auto scaling group.

    $PROMPT> as-describe-triggers group-name
                

OUTPUT
    This command returns a table that contains the following:
    * TRIGGER-NAME - Trigger name.
    * GROUP - auto scaling group name.
    * STATUS - Trigger status (e.g. Not Breaching, High Breaching etc.
    * NAMESPACE - Namespace for metric.
    * MEASURE - Measure name.
    * STATISTIC - Statistic.
    * PERIOD - Period.
    * LOWER-TH - Lower threshold. This column appears only in the --show-long
    view.
    * UPPER-TH - Upper threshold. This column appears only in the --show-long
    view.
    * LOW-BR-INCR - Lower breach scale increment. This column appears only in
    the --show-long view.
    * UP-BR-INCR - Upper breach scale increment. This column appears only in the
    --show-long view.
    * BR-DURATION - Breach duration. This column appears only in the --show-long
    view.
    * DIMENSIONS - Dimensions. This column appears only in the --show-long view.
    * UNIT - Unit. This column appears only in the --show-long view.

OUTPUT EXAMPLES

    This is an example output of this command.

TRIGGER-NAME GROUP      STATUS  MEASURE         STATISTIC  PERIOD
trigger-name group-name NoData  CPUUtilization  Average    60




as-set-desired-capacity

Service List | Table of Contents


SYNOPSIS
   as-set-desired-capacity
        AutoScalingGroupName  --desired-capacity  value  [General Options]

DESCRIPTION
       Set the desired capacity of the specified auto scaling group (within the
    range of group's minimum and maximum size).

ARGUMENTS
   AutoScalingGroupName
       Name of auto scaling group. You can also set this value using
       "--auto-scaling-group". Required.

SPECIFIC OPTIONS
   -c, --desired-capacity VALUE
       New capacity setting for the group. Required.


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'.

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

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

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

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

   -H, --headers
       If you are displaying tabular or delimited results, it includes the
       column headers. If you are showing xml results, it returns the HTTP
       headers from the service request, if applicable. This is off by default.

   -I, --access-key-id VALUE
       Specify VALUE as the AWS Access Id to use.

   --region VALUE
       Specify region VALUE as the web service region to use. This value can be
       set by using the environment variable 'EC2_REGION'.

   -S, --secret-key VALUE
       Specify VALUE as the AWS Secret Key to use.

   --show-empty-fields
       Show 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
       Specify how 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

    Sets the desired capacity of the group 'test-group-1'.

    $PROMPT> as-set-desired-capacity test-group-1 --desired-capacity 5 
                


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

Service List | Table of Contents


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

DESCRIPTION
       Terminate a given instance with/without reducing the group's capacity.

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 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'.

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

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

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

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

   -H, --headers
       If you are displaying tabular or delimited results, it includes the
       column headers. If you are showing xml results, it returns the HTTP
       headers from the service request, if applicable. This is off by default.

   -I, --access-key-id VALUE
       Specify VALUE as the AWS Access Id to use.

   --region VALUE
       Specify region VALUE as the web service region to use. This value can be
       set by using the environment variable 'EC2_REGION'.

   -S, --secret-key VALUE
       Specify VALUE as the AWS Secret Key to use.

   --show-empty-fields
       Show 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
       Specify how 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 activtity (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.


ACTIVITY  ACTIVITY-ID           END-TIME             CODE        CAUSE
ACTIVITY  74758a33-bfd5-4df...  2009-05-11T16:27:36Z Successful  "At 1970-01-01 00:00:00Z an instance was started in response to a difference between desired and actual capacity, increasing the capacity from 0 to 1."



as-update-auto-scaling-group

Service List | Table of Contents


SYNOPSIS
   as-update-auto-scaling-group
        AutoScalingGroupName [--cooldown  value ] [--launch-configuration  value
       ] [--max-size  value ] [--min-size  value ]  [General Options]

DESCRIPTION
       Update specified auto scaling group with attributes

ARGUMENTS
   AutoScalingGroupName
       User-supplied auto scaling group identifier which will uniquely identify
       the auto scaling group. You can also set this value using "--name".
       Required.

SPECIFIC OPTIONS
   --cooldown VALUE
       Time (in seconds) between a successful scaling activity and succeeding
       scaling activity.

   --launch-configuration VALUE
       Name of existing launch configuration to use to launch new instances.

   --max-size VALUE
       Maximum group size (minimum-size <= maximum-size < 10000).

   --min-size VALUE
       Minimum group size (0 <= minimum-size <= maximum-size).


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'.

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

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

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

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

   -H, --headers
       If you are displaying tabular or delimited results, it includes the
       column headers. If you are showing xml results, it returns the HTTP
       headers from the service request, if applicable. This is off by default.

   -I, --access-key-id VALUE
       Specify VALUE as the AWS Access Id to use.

   --region VALUE
       Specify region VALUE as the web service region to use. This value can be
       set by using the environment variable 'EC2_REGION'.

   -S, --secret-key VALUE
       Specify VALUE as the AWS Secret Key to use.

   --show-empty-fields
       Show 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
       Specify how 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

    Update group 'test-group-1' with minimum size 0

    $PROMPT> as-update-auto-scaling-group test-group-1 --min-size 0 
                


as-version

Service List | Table of Contents



Amazon AutoScaling CLI version 1.0.4.4 (API 2009-05-15)