GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Paws::AutoScaling(3) User Contributed Perl Documentation Paws::AutoScaling(3)

Paws::AutoScaling - Perl Interface to AWS Auto Scaling

  use Paws;

  my $obj = Paws->service('AutoScaling')->new;
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

Auto Scaling

Auto Scaling is designed to automatically launch or terminate EC2 instances based on user-defined policies, schedules, and health checks. Use this service in conjunction with the Amazon CloudWatch and Elastic Load Balancing services.

Each argument is described in detail in: Paws::AutoScaling::AttachInstances

Returns: nothing

Attaches one or more EC2 instances to the specified Auto Scaling group.

For more information, see Attach EC2 Instances to Your Auto Scaling Group in the Auto Scaling Developer Guide.

Each argument is described in detail in: Paws::AutoScaling::AttachLoadBalancers

Returns: a Paws::AutoScaling::AttachLoadBalancersResultType instance

Attaches one or more load balancers to the specified Auto Scaling group.

To describe the load balancers for an Auto Scaling group, use DescribeLoadBalancers. To detach the load balancer from the Auto Scaling group, use DetachLoadBalancers.

For more information, see Attach a Load Balancer to Your Auto Scaling Group in the Auto Scaling Developer Guide.

Each argument is described in detail in: Paws::AutoScaling::CompleteLifecycleAction

Returns: a Paws::AutoScaling::CompleteLifecycleActionAnswer instance

Completes the lifecycle action for the associated token initiated under the given lifecycle hook with the specified result.

This operation is a part of the basic sequence for adding a lifecycle hook to an Auto Scaling group:

1. Create a notification target. A target can be either an Amazon SQS queue or an Amazon SNS topic.
2. Create an IAM role. This role allows Auto Scaling to publish lifecycle notifications to the designated SQS queue or SNS topic.
3. Create the lifecycle hook. You can create a hook that acts when instances launch or when instances terminate.
4. If necessary, record the lifecycle action heartbeat to keep the instance in a pending state.
5. Complete the lifecycle action.

For more information, see Auto Scaling Pending State and Auto Scaling Terminating State in the Auto Scaling Developer Guide.

Each argument is described in detail in: Paws::AutoScaling::CreateAutoScalingGroup

Returns: nothing

Creates an Auto Scaling group with the specified name and attributes.

If you exceed your maximum limit of Auto Scaling groups, which by default is 20 per region, the call fails. For information about viewing and updating this limit, see DescribeAccountLimits.

For more information, see Auto Scaling Groups in the Auto Scaling Developer Guide.

Each argument is described in detail in: Paws::AutoScaling::CreateLaunchConfiguration

Returns: nothing

Creates a launch configuration.

If you exceed your maximum limit of launch configurations, which by default is 100 per region, the call fails. For information about viewing and updating this limit, see DescribeAccountLimits.

For more information, see Launch Configurations in the Auto Scaling Developer Guide.

Each argument is described in detail in: Paws::AutoScaling::CreateOrUpdateTags

Returns: nothing

Creates or updates tags for the specified Auto Scaling group.

A tag is defined by its resource ID, resource type, key, value, and propagate flag. The value and the propagate flag are optional parameters. The only supported resource type is "auto-scaling-group", and the resource ID must be the name of the group. The "PropagateAtLaunch" flag determines whether the tag is added to instances launched in the group. Valid values are "true" or "false".

When you specify a tag with a key that already exists, the operation overwrites the previous tag definition, and you do not get an error message.

For more information, see Tagging Auto Scaling Groups and Instances in the Auto Scaling Developer Guide.

Each argument is described in detail in: Paws::AutoScaling::DeleteAutoScalingGroup

Returns: nothing

Deletes the specified Auto Scaling group.

The group must have no instances and no scaling activities in progress.

To remove all instances before calling "DeleteAutoScalingGroup", call UpdateAutoScalingGroup to set the minimum and maximum size of the Auto Scaling group to zero.

Each argument is described in detail in: Paws::AutoScaling::DeleteLaunchConfiguration

Returns: nothing

Deletes the specified launch configuration.

The launch configuration must not be attached to an Auto Scaling group. When this call completes, the launch configuration is no longer available for use.

Each argument is described in detail in: Paws::AutoScaling::DeleteLifecycleHook

Returns: a Paws::AutoScaling::DeleteLifecycleHookAnswer instance

Deletes the specified lifecycle hook.

If there are any outstanding lifecycle actions, they are completed first ("ABANDON" for launching instances, "CONTINUE" for terminating instances).

Each argument is described in detail in: Paws::AutoScaling::DeleteNotificationConfiguration

Returns: nothing

Deletes the specified notification.

Each argument is described in detail in: Paws::AutoScaling::DeletePolicy

Returns: nothing

Deletes the specified Auto Scaling policy.

Each argument is described in detail in: Paws::AutoScaling::DeleteScheduledAction

Returns: nothing

Deletes the specified scheduled action.

Each argument is described in detail in: Paws::AutoScaling::DeleteTags

Returns: nothing

Deletes the specified tags.

Each argument is described in detail in: Paws::AutoScaling::DescribeAccountLimits

Returns: a Paws::AutoScaling::DescribeAccountLimitsAnswer instance

Describes the current Auto Scaling resource limits for your AWS account.

For information about requesting an increase in these limits, see AWS Service Limits in the Amazon Web Services General Reference.

Each argument is described in detail in: Paws::AutoScaling::DescribeAdjustmentTypes

Returns: a Paws::AutoScaling::DescribeAdjustmentTypesAnswer instance

Describes the policy adjustment types for use with PutScalingPolicy.

Each argument is described in detail in: Paws::AutoScaling::DescribeAutoScalingGroups

Returns: a Paws::AutoScaling::AutoScalingGroupsType instance

Describes one or more Auto Scaling groups. If a list of names is not provided, the call describes all Auto Scaling groups.

Each argument is described in detail in: Paws::AutoScaling::DescribeAutoScalingInstances

Returns: a Paws::AutoScaling::AutoScalingInstancesType instance

Describes one or more Auto Scaling instances. If a list is not provided, the call describes all instances.

Each argument is described in detail in: Paws::AutoScaling::DescribeAutoScalingNotificationTypes

Returns: a Paws::AutoScaling::DescribeAutoScalingNotificationTypesAnswer instance

Describes the notification types that are supported by Auto Scaling.

Each argument is described in detail in: Paws::AutoScaling::DescribeLaunchConfigurations

Returns: a Paws::AutoScaling::LaunchConfigurationsType instance

Describes one or more launch configurations. If you omit the list of names, then the call describes all launch configurations.

Each argument is described in detail in: Paws::AutoScaling::DescribeLifecycleHooks

Returns: a Paws::AutoScaling::DescribeLifecycleHooksAnswer instance

Describes the lifecycle hooks for the specified Auto Scaling group.

Each argument is described in detail in: Paws::AutoScaling::DescribeLifecycleHookTypes

Returns: a Paws::AutoScaling::DescribeLifecycleHookTypesAnswer instance

Describes the available types of lifecycle hooks.

Each argument is described in detail in: Paws::AutoScaling::DescribeLoadBalancers

Returns: a Paws::AutoScaling::DescribeLoadBalancersResponse instance

Describes the load balancers for the specified Auto Scaling group.

Each argument is described in detail in: Paws::AutoScaling::DescribeMetricCollectionTypes

Returns: a Paws::AutoScaling::DescribeMetricCollectionTypesAnswer instance

Describes the available CloudWatch metrics for Auto Scaling.

Note that the "GroupStandbyInstances" metric is not returned by default. You must explicitly request this metric when calling EnableMetricsCollection.

Each argument is described in detail in: Paws::AutoScaling::DescribeNotificationConfigurations

Returns: a Paws::AutoScaling::DescribeNotificationConfigurationsAnswer instance

Describes the notification actions associated with the specified Auto Scaling group.

Each argument is described in detail in: Paws::AutoScaling::DescribePolicies

Returns: a Paws::AutoScaling::PoliciesType instance

Describes the policies for the specified Auto Scaling group.

Each argument is described in detail in: Paws::AutoScaling::DescribeScalingActivities

Returns: a Paws::AutoScaling::ActivitiesType instance

Describes one or more scaling activities for the specified Auto Scaling group. If you omit the "ActivityIds", the call returns all activities from the past six weeks. Activities are sorted by the start time. Activities still in progress appear first on the list.

Each argument is described in detail in: Paws::AutoScaling::DescribeScalingProcessTypes

Returns: a Paws::AutoScaling::ProcessesType instance

Describes the scaling process types for use with ResumeProcesses and SuspendProcesses.

Each argument is described in detail in: Paws::AutoScaling::DescribeScheduledActions

Returns: a Paws::AutoScaling::ScheduledActionsType instance

Describes the actions scheduled for your Auto Scaling group that haven't run. To describe the actions that have already run, use DescribeScalingActivities.

Each argument is described in detail in: Paws::AutoScaling::DescribeTags

Returns: a Paws::AutoScaling::TagsType instance

Describes the specified tags.

You can use filters to limit the results. For example, you can query for the tags for a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at least one of the specified values for it to be included in the results.

You can also specify multiple filters. The result includes information for a particular tag only if it matches all the filters. If there's no match, no special message is returned.

Each argument is described in detail in: Paws::AutoScaling::DescribeTerminationPolicyTypes

Returns: a Paws::AutoScaling::DescribeTerminationPolicyTypesAnswer instance

Describes the termination policies supported by Auto Scaling.

Each argument is described in detail in: Paws::AutoScaling::DetachInstances

Returns: a Paws::AutoScaling::DetachInstancesAnswer instance

Removes one or more instances from the specified Auto Scaling group. After the instances are detached, you can manage them independently from the rest of the Auto Scaling group.

For more information, see Detach EC2 Instances from Your Auto Scaling Group in the Auto Scaling Developer Guide.

Each argument is described in detail in: Paws::AutoScaling::DetachLoadBalancers

Returns: a Paws::AutoScaling::DetachLoadBalancersResultType instance

Removes one or more load balancers from the specified Auto Scaling group.

When you detach a load balancer, it enters the "Removing" state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the load balancer using DescribeLoadBalancers. Note that the instances remain running.

Each argument is described in detail in: Paws::AutoScaling::DisableMetricsCollection

Returns: nothing

Disables monitoring of the specified metrics for the specified Auto Scaling group.

Each argument is described in detail in: Paws::AutoScaling::EnableMetricsCollection

Returns: nothing

Enables monitoring of the specified metrics for the specified Auto Scaling group.

You can only enable metrics collection if "InstanceMonitoring" in the launch configuration for the group is set to "True".

Each argument is described in detail in: Paws::AutoScaling::EnterStandby

Returns: a Paws::AutoScaling::EnterStandbyAnswer instance

Moves the specified instances into "Standby" mode.

For more information, see Auto Scaling InService State in the Auto Scaling Developer Guide.

Each argument is described in detail in: Paws::AutoScaling::ExecutePolicy

Returns: nothing

Executes the specified policy.

Each argument is described in detail in: Paws::AutoScaling::ExitStandby

Returns: a Paws::AutoScaling::ExitStandbyAnswer instance

Moves the specified instances out of "Standby" mode.

For more information, see Auto Scaling InService State in the Auto Scaling Developer Guide.

Each argument is described in detail in: Paws::AutoScaling::PutLifecycleHook

Returns: a Paws::AutoScaling::PutLifecycleHookAnswer instance

Creates or updates a lifecycle hook for the specified Auto Scaling Group.

A lifecycle hook tells Auto Scaling that you want to perform an action on an instance that is not actively in service; for example, either when the instance launches or before the instance terminates.

This operation is a part of the basic sequence for adding a lifecycle hook to an Auto Scaling group:

1. Create a notification target. A target can be either an Amazon SQS queue or an Amazon SNS topic.
2. Create an IAM role. This role allows Auto Scaling to publish lifecycle notifications to the designated SQS queue or SNS topic.
3. Create the lifecycle hook. You can create a hook that acts when instances launch or when instances terminate.
4. If necessary, record the lifecycle action heartbeat to keep the instance in a pending state.
5. Complete the lifecycle action.

For more information, see Auto Scaling Pending State and Auto Scaling Terminating State in the Auto Scaling Developer Guide.

If you exceed your maximum limit of lifecycle hooks, which by default is 50 per region, the call fails. For information about updating this limit, see AWS Service Limits in the Amazon Web Services General Reference.

Each argument is described in detail in: Paws::AutoScaling::PutNotificationConfiguration

Returns: nothing

Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to this topic can have messages for events delivered to an endpoint such as a web server or email address.

For more information see Getting Notifications When Your Auto Scaling Group Changes in the Auto Scaling Developer Guide.

This configuration overwrites an existing configuration.

Each argument is described in detail in: Paws::AutoScaling::PutScalingPolicy

Returns: a Paws::AutoScaling::PolicyARNType instance

Creates or updates a policy for an Auto Scaling group. To update an existing policy, use the existing policy name and set the parameters you want to change. Any existing parameter not changed in an update to an existing policy is not changed in this update request.

If you exceed your maximum limit of step adjustments, which by default is 20 per region, the call fails. For information about updating this limit, see AWS Service Limits in the Amazon Web Services General Reference.

Each argument is described in detail in: Paws::AutoScaling::PutScheduledUpdateGroupAction

Returns: nothing

Creates or updates a scheduled scaling action for an Auto Scaling group. When updating a scheduled scaling action, if you leave a parameter unspecified, the corresponding value remains unchanged in the affected Auto Scaling group.

For more information, see Scheduled Scaling in the Auto Scaling Developer Guide.

Each argument is described in detail in: Paws::AutoScaling::RecordLifecycleActionHeartbeat

Returns: a Paws::AutoScaling::RecordLifecycleActionHeartbeatAnswer instance

Records a heartbeat for the lifecycle action associated with a specific token. This extends the timeout by the length of time defined by the "HeartbeatTimeout" parameter of PutLifecycleHook.

This operation is a part of the basic sequence for adding a lifecycle hook to an Auto Scaling group:

1. Create a notification target. A target can be either an Amazon SQS queue or an Amazon SNS topic.
2. Create an IAM role. This role allows Auto Scaling to publish lifecycle notifications to the designated SQS queue or SNS topic.
3. Create the lifecycle hook. You can create a hook that acts when instances launch or when instances terminate.
4. If necessary, record the lifecycle action heartbeat to keep the instance in a pending state.
5. Complete the lifecycle action.

For more information, see Auto Scaling Pending State and Auto Scaling Terminating State in the Auto Scaling Developer Guide.

Each argument is described in detail in: Paws::AutoScaling::ResumeProcesses

Returns: nothing

Resumes the specified suspended Auto Scaling processes for the specified Auto Scaling group. To resume specific processes, use the "ScalingProcesses" parameter. To resume all processes, omit the "ScalingProcesses" parameter. For more information, see Suspend and Resume Auto Scaling Processes in the Auto Scaling Developer Guide.

Each argument is described in detail in: Paws::AutoScaling::SetDesiredCapacity

Returns: nothing

Sets the size of the specified Auto Scaling group.

For more information about desired capacity, see What Is Auto Scaling? in the Auto Scaling Developer Guide.

Each argument is described in detail in: Paws::AutoScaling::SetInstanceHealth

Returns: nothing

Sets the health status of the specified instance.

For more information, see Health Checks in the Auto Scaling Developer Guide.

Each argument is described in detail in: Paws::AutoScaling::SuspendProcesses

Returns: nothing

Suspends the specified Auto Scaling processes for the specified Auto Scaling group. To suspend specific processes, use the "ScalingProcesses" parameter. To suspend all processes, omit the "ScalingProcesses" parameter.

Note that if you suspend either the "Launch" or "Terminate" process types, it can prevent other process types from functioning properly.

To resume processes that have been suspended, use ResumeProcesses.

For more information, see Suspend and Resume Auto Scaling Processes in the Auto Scaling Developer Guide.

Each argument is described in detail in: Paws::AutoScaling::TerminateInstanceInAutoScalingGroup

Returns: a Paws::AutoScaling::ActivityType instance

Terminates the specified instance and optionally adjusts the desired group size.

This call simply makes a termination request. The instances is not terminated immediately.

Each argument is described in detail in: Paws::AutoScaling::UpdateAutoScalingGroup

Returns: nothing

Updates the configuration for the specified Auto Scaling group.

To update an Auto Scaling group with a launch configuration with "InstanceMonitoring" set to "False", you must first disable the collection of group metrics. Otherwise, you will get an error. If you have previously enabled the collection of group metrics, you can disable it using DisableMetricsCollection.

The new settings are registered upon the completion of this call. Any launch configuration settings take effect on any triggers after this call returns. Scaling activities that are currently in progress aren't affected.

Note the following:

  • If you specify a new value for "MinSize" without specifying a value for "DesiredCapacity", and the new "MinSize" is larger than the current size of the group, we implicitly call SetDesiredCapacity to set the size of the group to the new value of "MinSize".
  • If you specify a new value for "MaxSize" without specifying a value for "DesiredCapacity", and the new "MaxSize" is smaller than the current size of the group, we implicitly call SetDesiredCapacity to set the size of the group to the new value of "MaxSize".
  • All other optional parameters are left unchanged if not specified.

This service class forms part of Paws

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues

2015-08-06 perl v5.32.1

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.