.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{ . if \nF \{ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "VM::EC2::REST::autoscaling 3pm" .TH VM::EC2::REST::autoscaling 3pm "2016-06-04" "perl v5.22.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME VM::EC2::REST::autoscaling \- Autoscaling groups and launch configurations" .IX Header "NAME VM::EC2::REST::autoscaling - Autoscaling groups and launch configurations" .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use VM::EC2 \*(Aq:autoscaling\*(Aq; .Ve .SH "METHODS" .IX Header "METHODS" This module provides \s-1VM::EC2\s0 methods for autoscaling groups and launch configurations. Not all of the Amazon \s-1API\s0 is implemented, but the most common functions are available. .PP Implemented: CreateAutoScalingGroup CreateLaunchConfiguration DeleteAutoScalingGroup DeleteLaunchConfiguration DeletePolicy DescribeAutoScalingGroups DescribeLaunchConfigurations DescribePolicies ExecutePolicy PutScalingPolicy ResumeProcesses SuspendProcesses UpdateAutoScalingGroup .PP Unimplemented: CreateOrUpdateTags DeleteNotificationConfiguration DeleteScheduledAction DeleteTags DescribeAdjustmentTypes DescribeAutoScalingInstances DescribeAutoScalingNotificationTypes DescribeMetricCollectionTypes DescribeNotificationConfigurations DescribeScalingActivities DescribeScalingProcessTypes DescribeScheduledActions DescribeTags DescribeTerminationPolicyTypes DisableMetricsCollection EnableMetricsCollection PutNotificationConfiguration PutScheduledUpdateGroupAction SetDesiredCapacity SetInstanceHealth TerminateInstanceInAutoScalingGroup .ie n .SS "@lc = $ec2\->describe_launch_configurations(\-names => \e@names);" .el .SS "\f(CW@lc\fP = \f(CW$ec2\fP\->describe_launch_configurations(\-names => \e@names);" .IX Subsection "@lc = $ec2->describe_launch_configurations(-names => @names);" .ie n .SS "@lc = $ec\->describe_launch_configurations(@names);" .el .SS "\f(CW@lc\fP = \f(CW$ec\fP\->describe_launch_configurations(@names);" .IX Subsection "@lc = $ec->describe_launch_configurations(@names);" Provides detailed information for the specified launch configuration(s). .PP Optional parameters are: .PP .Vb 2 \& \-launch_configuration_names Name of the Launch config. \& This can be a string scalar or an arrayref. \& \& \-name Alias for \-launch_configuration_names .Ve .PP Returns a series of VM::EC2::LaunchConfiguration objects. .ie n .SS "$success = $ec2\->create_launch_configuration(%args);" .el .SS "\f(CW$success\fP = \f(CW$ec2\fP\->create_launch_configuration(%args);" .IX Subsection "$success = $ec2->create_launch_configuration(%args);" Creates a new launch configuration. .PP Required arguments: .PP .Vb 3 \& \-name \-\- scalar, name for the Launch config. \& \-image_id \-\- scalar, AMI id which this launch config will use \& \-instance_type \-\- scalar, instance type of the Amazon EC2 instance. .Ve .PP Optional arguments: .PP .Vb 10 \& \-block_device_mappings \-\- list of hashref \& \-ebs_optimized \-\- scalar (boolean). false by default \& \-iam_instance_profile \-\- scalar \& \-instance_monitoring \-\- scalar (boolean). true by default \& \-kernel_id \-\- scalar \& \-key_name \-\- scalar \& \-ramdisk \-\- scalar \& \-security_groups \-\- list of scalars \& \-spot_price \-\- scalar \& \-user_data \-\- scalar .Ve .PP Returns true on successful execution. .ie n .SS "$success = $ec2\->delete_launch_configuration(\-name => $name);" .el .SS "\f(CW$success\fP = \f(CW$ec2\fP\->delete_launch_configuration(\-name => \f(CW$name\fP);" .IX Subsection "$success = $ec2->delete_launch_configuration(-name => $name);" Deletes a launch config. .PP .Vb 1 \& \-name Required. Name of the launch config to delete .Ve .PP Returns true on success. .ie n .SS "@asg = $ec2\->describe_autoscaling_groups(\-auto_scaling_group_names => \e@names);" .el .SS "\f(CW@asg\fP = \f(CW$ec2\fP\->describe_autoscaling_groups(\-auto_scaling_group_names => \e@names);" .IX Subsection "@asg = $ec2->describe_autoscaling_groups(-auto_scaling_group_names => @names);" Returns information about autoscaling groups .PP .Vb 2 \& \-auto_scaling_group_names List of auto scaling groups to describe \& \-names Alias of \-auto_scaling_group_names .Ve .PP Returns a list of \s-1VM::EC2::ASG\s0. .ie n .SS "$success = $ec2\->create_autoscaling_group(\-name => $name, \-launch_config => $lc, \-max_size => $max_size, \-min_size => $min_size);" .el .SS "\f(CW$success\fP = \f(CW$ec2\fP\->create_autoscaling_group(\-name => \f(CW$name\fP, \-launch_config => \f(CW$lc\fP, \-max_size => \f(CW$max_size\fP, \-min_size => \f(CW$min_size\fP);" .IX Subsection "$success = $ec2->create_autoscaling_group(-name => $name, -launch_config => $lc, -max_size => $max_size, -min_size => $min_size);" Creates a new autoscaling group. .PP Required arguments: .PP .Vb 4 \& \-name Name for the autoscaling group \& \-launch_config Name of the launch configuration to be used \& \-max_size Max number of instances to be run at once \& \-min_size Min number of instances .Ve .PP Optional arguments: .PP .Vb 10 \& \-availability_zones List of availability zone names \& \-load_balancer_names List of ELB names \& \-tags List of tags to apply to the instances run \& \-termination_policies List of policy names \& \-default_cooldown Time in seconds between autoscaling activities \& \-desired_capacity Number of instances to be run after creation \& \-health_check_type One of "ELB" or "EC2" \& \-health_check_grace_period Mandatory for health check type ELB. Number of \& seconds between an instance is started and the \& autoscaling group starts checking its health \& \-placement_group Physical location of your cluster placement group \& \-vpc_zone_identifier Strinc containing a comma\-separated list of subnet \& identifiers .Ve .PP Returns true on success. .ie n .SS "$success = $ec2\->delete_autoscaling_group(\-name => $name)" .el .SS "\f(CW$success\fP = \f(CW$ec2\fP\->delete_autoscaling_group(\-name => \f(CW$name\fP)" .IX Subsection "$success = $ec2->delete_autoscaling_group(-name => $name)" Deletes an autoscaling group. .PP .Vb 1 \& \-name Name of the autoscaling group to delete .Ve .PP Returns true on success. .ie n .SS "$success = $ec2\->update_autoscaling_group(\-name => $name);" .el .SS "\f(CW$success\fP = \f(CW$ec2\fP\->update_autoscaling_group(\-name => \f(CW$name\fP);" .IX Subsection "$success = $ec2->update_autoscaling_group(-name => $name);" Updates an autoscaling group. Only required parameter is \f(CW\*(C`\-name\*(C'\fR .PP Optional arguments: .PP .Vb 11 \& \-availability_zones List of AZ\*(Aqs \& \-termination_policies List of policy names \& \-default_cooldown \& \-desired_capacity \& \-health_check_type \& \-health_check_grace_period \& \-launch_configuration_name \& \-placement_group \& \-vpc_zone_identifier \& \-max_size \& \-min_size .Ve .PP Returns true on success; .ie n .SS "$success = $ec2\->suspend_processes(\-name => $asg_name, \-scaling_processes => \e@procs);" .el .SS "\f(CW$success\fP = \f(CW$ec2\fP\->suspend_processes(\-name => \f(CW$asg_name\fP, \-scaling_processes => \e@procs);" .IX Subsection "$success = $ec2->suspend_processes(-name => $asg_name, -scaling_processes => @procs);" Suspend the requested autoscaling processes. .PP .Vb 10 \& \-name Name of the autoscaling group \& \-scaling_processes List of process names to suspend. Valid processes are: \& Launch \& Terminate \& HealthCheck \& ReplaceUnhealty \& AZRebalance \& AlarmNotification \& ScheduledActions \& AddToLoadBalancer .Ve .PP Returns true on success. .ie n .SS "$success = $ec2\->resume_processes(\-name => $asg_name, \-scaling_processes => \e@procs);" .el .SS "\f(CW$success\fP = \f(CW$ec2\fP\->resume_processes(\-name => \f(CW$asg_name\fP, \-scaling_processes => \e@procs);" .IX Subsection "$success = $ec2->resume_processes(-name => $asg_name, -scaling_processes => @procs);" Resumes the requested autoscaling processes. It accepts the same arguments than \&\f(CW\*(C`suspend_processes\*(C'\fR. .PP Returns true on success. .ie n .SS "@arguments = $ec2\->autoscaling_tags($argname, \e%args)" .el .SS "\f(CW@arguments\fP = \f(CW$ec2\fP\->autoscaling_tags($argname, \e%args)" .IX Subsection "@arguments = $ec2->autoscaling_tags($argname, %args)" .ie n .SS "@asg = $ec2\->describe_policies(\-auto_scaling_group_name => $name);" .el .SS "\f(CW@asg\fP = \f(CW$ec2\fP\->describe_policies(\-auto_scaling_group_name => \f(CW$name\fP);" .IX Subsection "@asg = $ec2->describe_policies(-auto_scaling_group_name => $name);" Returns information about autoscaling policies .PP .Vb 3 \& \-auto_scaling_group_name The name of the Auto Scaling group \& \-policy_names An array of policy names or policy ARNs to be described. If this list is omitted, all policy names are described. If an auto scaling group name is provided, the results are limited to that group. The list of requested policy names cannot contain more than 50 items. If unknown policy names are requested, they are ignored with no error. \& \-names Alias of \-auto_scaling_group_names .Ve .PP Returns a list of VM::EC2::ScalingPolicy. .ie n .SS "$success = $ec2\->put_scaling_policy" .el .SS "\f(CW$success\fP = \f(CW$ec2\fP\->put_scaling_policy" .IX Subsection "$success = $ec2->put_scaling_policy" Creates or updates a policy for an Auto Scaling group. .PP Required arguments: .PP .Vb 10 \& \-policy_name The name of the policy to update or create. \& \-name Alias for \-policy_name \& \-auto_scaling_group_name The name or ARN of the Auto Scaling group. \& \-scaling_adjustment Number of instances by which to scale. \& \-adjustment_type Specifies whether \-scaling_adjustment is an absolute \& number or a percentage of the current capacity. \& Valid values are: \& ChangeInCapacity \& ExactCapacity \& PercentChangeInCapacity .Ve .PP Optional arguments: .PP .Vb 4 \& \-cooldown The amount of time, in seconds, after a scaling \& activity completes and before the next scaling acitvity \& can start. \& \-min_adjustment_step Used with PercentChangeInCapacity as \-adjustment_type. .Ve .PP Returns true on success .ie n .SS "$success = $ec2\->delete_policy(\-policy_name => $name)" .el .SS "\f(CW$success\fP = \f(CW$ec2\fP\->delete_policy(\-policy_name => \f(CW$name\fP)" .IX Subsection "$success = $ec2->delete_policy(-policy_name => $name)" Deletes a policy .PP Required arguments: .PP .Vb 4 \& \-policy_name Name or ARN of the policy \& \-name Alias for \-policy_name \& \-auto_scaling_group_name Name of the Auto Scaling Group, required when \& specifying policy by name (not by ARN) .Ve .PP Returns true on success .ie n .SS "$success = $ec2\->execute_policy(\-policy_name => $name)" .el .SS "\f(CW$success\fP = \f(CW$ec2\fP\->execute_policy(\-policy_name => \f(CW$name\fP)" .IX Subsection "$success = $ec2->execute_policy(-policy_name => $name)" Runs a policy .PP Required arguments: .PP .Vb 4 \& \-policy_name Name or ARN of the policy \& \-name Alias for \-policy_name \& \-auto_scaling_group_name Name of the Auto Scaling Group, required when \& specifying policy by name (not by ARN) .Ve .PP Optional arguments: .PP .Vb 2 \& \-honor_cooldown Set to true if you want AutoScaling to reject \& the request when it is in cooldown .Ve .PP Returns true on success .SH "SEE ALSO" .IX Header "SEE ALSO" \&\s-1VM::EC2\s0 .SH "AUTHOR" .IX Header "AUTHOR" Lincoln Stein . .PP Copyright (c) 2011 Ontario Institute for Cancer Research .PP This package and its accompanying libraries is free software; you can redistribute it and/or modify it under the terms of the \s-1GPL \s0(either version 1, or at your option, any later version) or the Artistic License 2.0. Refer to \s-1LICENSE\s0 for the full license text. In addition, please see \s-1DISCLAIMER\s0.txt for disclaimers of warranty.