AutoScalingClient Class
(QtAws::AutoScaling::AutoScalingClient)The AutoScalingClient class provides access to the Auto Scaling service. More...
| Header: | #include <AutoScalingClient> |
| Inherits: | QtAws::Core::AwsAbstractClient |
Public Functions
| AutoScalingClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0) | |
| AutoScalingClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0) |
- 12 public functions inherited from QtAws::Core::AwsAbstractClient
Public Slots
| AttachInstancesResponse * | attachInstances(const AttachInstancesRequest &request) |
| AttachLoadBalancerTargetGroupsResponse * | attachLoadBalancerTargetGroups(const AttachLoadBalancerTargetGroupsRequest &request) |
| AttachLoadBalancersResponse * | attachLoadBalancers(const AttachLoadBalancersRequest &request) |
| CompleteLifecycleActionResponse * | completeLifecycleAction(const CompleteLifecycleActionRequest &request) |
| CreateAutoScalingGroupResponse * | createAutoScalingGroup(const CreateAutoScalingGroupRequest &request) |
| CreateLaunchConfigurationResponse * | createLaunchConfiguration(const CreateLaunchConfigurationRequest &request) |
| CreateOrUpdateTagsResponse * | createOrUpdateTags(const CreateOrUpdateTagsRequest &request) |
| DeleteAutoScalingGroupResponse * | deleteAutoScalingGroup(const DeleteAutoScalingGroupRequest &request) |
| DeleteLaunchConfigurationResponse * | deleteLaunchConfiguration(const DeleteLaunchConfigurationRequest &request) |
| DeleteLifecycleHookResponse * | deleteLifecycleHook(const DeleteLifecycleHookRequest &request) |
| DeleteNotificationConfigurationResponse * | deleteNotificationConfiguration(const DeleteNotificationConfigurationRequest &request) |
| DeletePolicyResponse * | deletePolicy(const DeletePolicyRequest &request) |
| DeleteScheduledActionResponse * | deleteScheduledAction(const DeleteScheduledActionRequest &request) |
| DeleteTagsResponse * | deleteTags(const DeleteTagsRequest &request) |
| DescribeAccountLimitsResponse * | describeAccountLimits() |
| DescribeAdjustmentTypesResponse * | describeAdjustmentTypes() |
| DescribeAutoScalingGroupsResponse * | describeAutoScalingGroups(const DescribeAutoScalingGroupsRequest &request) |
| DescribeAutoScalingInstancesResponse * | describeAutoScalingInstances(const DescribeAutoScalingInstancesRequest &request) |
| DescribeAutoScalingNotificationTypesResponse * | describeAutoScalingNotificationTypes() |
| DescribeLaunchConfigurationsResponse * | describeLaunchConfigurations(const DescribeLaunchConfigurationsRequest &request) |
| DescribeLifecycleHookTypesResponse * | describeLifecycleHookTypes() |
| DescribeLifecycleHooksResponse * | describeLifecycleHooks(const DescribeLifecycleHooksRequest &request) |
| DescribeLoadBalancerTargetGroupsResponse * | describeLoadBalancerTargetGroups(const DescribeLoadBalancerTargetGroupsRequest &request) |
| DescribeLoadBalancersResponse * | describeLoadBalancers(const DescribeLoadBalancersRequest &request) |
| DescribeMetricCollectionTypesResponse * | describeMetricCollectionTypes() |
| DescribeNotificationConfigurationsResponse * | describeNotificationConfigurations(const DescribeNotificationConfigurationsRequest &request) |
| DescribePoliciesResponse * | describePolicies(const DescribePoliciesRequest &request) |
| DescribeScalingActivitiesResponse * | describeScalingActivities(const DescribeScalingActivitiesRequest &request) |
| DescribeScalingProcessTypesResponse * | describeScalingProcessTypes() |
| DescribeScheduledActionsResponse * | describeScheduledActions(const DescribeScheduledActionsRequest &request) |
| DescribeTagsResponse * | describeTags(const DescribeTagsRequest &request) |
| DescribeTerminationPolicyTypesResponse * | describeTerminationPolicyTypes() |
| DetachInstancesResponse * | detachInstances(const DetachInstancesRequest &request) |
| DetachLoadBalancerTargetGroupsResponse * | detachLoadBalancerTargetGroups(const DetachLoadBalancerTargetGroupsRequest &request) |
| DetachLoadBalancersResponse * | detachLoadBalancers(const DetachLoadBalancersRequest &request) |
| DisableMetricsCollectionResponse * | disableMetricsCollection(const DisableMetricsCollectionRequest &request) |
| EnableMetricsCollectionResponse * | enableMetricsCollection(const EnableMetricsCollectionRequest &request) |
| EnterStandbyResponse * | enterStandby(const EnterStandbyRequest &request) |
| ExecutePolicyResponse * | executePolicy(const ExecutePolicyRequest &request) |
| ExitStandbyResponse * | exitStandby(const ExitStandbyRequest &request) |
| PutLifecycleHookResponse * | putLifecycleHook(const PutLifecycleHookRequest &request) |
| PutNotificationConfigurationResponse * | putNotificationConfiguration(const PutNotificationConfigurationRequest &request) |
| PutScalingPolicyResponse * | putScalingPolicy(const PutScalingPolicyRequest &request) |
| PutScheduledUpdateGroupActionResponse * | putScheduledUpdateGroupAction(const PutScheduledUpdateGroupActionRequest &request) |
| RecordLifecycleActionHeartbeatResponse * | recordLifecycleActionHeartbeat(const RecordLifecycleActionHeartbeatRequest &request) |
| ResumeProcessesResponse * | resumeProcesses(const ResumeProcessesRequest &request) |
| SetDesiredCapacityResponse * | setDesiredCapacity(const SetDesiredCapacityRequest &request) |
| SetInstanceHealthResponse * | setInstanceHealth(const SetInstanceHealthRequest &request) |
| SetInstanceProtectionResponse * | setInstanceProtection(const SetInstanceProtectionRequest &request) |
| SuspendProcessesResponse * | suspendProcesses(const SuspendProcessesRequest &request) |
| TerminateInstanceInAutoScalingGroupResponse * | terminateInstanceInAutoScalingGroup(const TerminateInstanceInAutoScalingGroupRequest &request) |
| UpdateAutoScalingGroupResponse * | updateAutoScalingGroup(const UpdateAutoScalingGroupRequest &request) |
Additional Inherited Members
- 2 protected functions inherited from QtAws::Core::AwsAbstractClient
Detailed Description
The AutoScalingClient class provides access to the Auto Scaling service.
<fullname>Amazon EC2 Auto Scaling</fullname>
Amazon EC2 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 AWS Auto Scaling, Amazon CloudWatch, and Elastic Load Balancing
Member Function Documentation
AutoScalingClient::AutoScalingClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)
Constructs a AutoScalingClient object.
The new client object will region, credentials, and manager for network operations.
The new object will be owned by parent, if set.
AutoScalingClient::AutoScalingClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)
This function overloads AutoScalingClient().
This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).
See also QtAws::Core::AwsEndpoint::getEndpoint.
[slot] AttachInstancesResponse *AutoScalingClient::attachInstances(const AttachInstancesRequest &request)
Sends request to the AutoScalingClient service, and returns a pointer to an AttachInstancesResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Attaches one or more EC2 instances to the specified Auto Scaling
group>
When you attach instances, Auto Scaling increases the desired capacity of the group by the number of instances being attached. If the number of instances being attached plus the desired capacity of the group exceeds the maximum size of the group, the operation
fails>
If there is a Classic Load Balancer attached to your Auto Scaling group, the instances are also registered with the load balancer. If there are target groups attached to your Auto Scaling group, the instances are also registered with the target
groups>
For more information, see <a href="http://docs.aws.amazon.com/autoscaling/latest/userguide/attach-instance-asg.html">Attach EC2 Instances to Your Auto Scaling Group</a> in the <i>Auto Scaling User
[slot] AttachLoadBalancerTargetGroupsResponse *AutoScalingClient::attachLoadBalancerTargetGroups(const AttachLoadBalancerTargetGroupsRequest &request)
Sends request to the AutoScalingClient service, and returns a pointer to an AttachLoadBalancerTargetGroupsResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Attaches one or more target groups to the specified Auto Scaling
group>
To describe the target groups for an Auto Scaling group, use <a>DescribeLoadBalancerTargetGroups</a>. To detach the target group from the Auto Scaling group, use
<a>DetachLoadBalancerTargetGroups</a>>
For more information, see <a href="http://docs.aws.amazon.com/autoscaling/latest/userguide/attach-load-balancer-asg.html">Attach a Load Balancer to Your Auto Scaling Group</a> in the <i>Auto Scaling User
[slot] AttachLoadBalancersResponse *AutoScalingClient::attachLoadBalancers(const AttachLoadBalancersRequest &request)
Sends request to the AutoScalingClient service, and returns a pointer to an AttachLoadBalancersResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Attaches one or more Classic Load Balancers to the specified Auto Scaling
group>
To attach an Application Load Balancer instead, see
<a>AttachLoadBalancerTargetGroups</a>>
To describe the load balancers for an Auto Scaling group, use <a>DescribeLoadBalancers</a>. To detach the load balancer from the Auto Scaling group, use
<a>DetachLoadBalancers</a>>
For more information, see <a href="http://docs.aws.amazon.com/autoscaling/latest/userguide/attach-load-balancer-asg.html">Attach a Load Balancer to Your Auto Scaling Group</a> in the <i>Auto Scaling User
[slot] CompleteLifecycleActionResponse *AutoScalingClient::completeLifecycleAction(const CompleteLifecycleActionRequest &request)
Sends request to the AutoScalingClient service, and returns a pointer to an CompleteLifecycleActionResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Completes the lifecycle action for the specified token or instance with the specified
result>
This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling
group> <ol> <li>
(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Auto Scaling launches or terminates
instances> </li> <li>
(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Auto Scaling to publish lifecycle notifications to the
target> </li> <li>
Create the lifecycle hook. Specify whether the hook is used when the instances launch or
terminate> </li> <li>
If you need more time, record the lifecycle action heartbeat to keep the instance in a pending
state> </li> <li>
<b>If you finish before the timeout period ends, complete the lifecycle action.</b>
</p </li> </ol>
For more information, see <a href="http://docs.aws.amazon.com/autoscaling/latest/userguide/AutoScalingGroupLifecycle.html">Auto Scaling Lifecycle</a> in the <i>Auto Scaling User
[slot] CreateAutoScalingGroupResponse *AutoScalingClient::createAutoScalingGroup(const CreateAutoScalingGroupRequest &request)
Sends request to the AutoScalingClient service, and returns a pointer to an CreateAutoScalingGroupResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Creates an Auto Scaling group with the specified name and
attributes>
If you exceed your maximum limit of Auto Scaling groups, the call fails. For information about viewing this limit, see <a>DescribeAccountLimits</a>. For information about updating this limit, see <a href="http://docs.aws.amazon.com/autoscaling/latest/userguide/as-account-limits.html">Auto Scaling Limits</a> in the <i>Auto Scaling User
Guide</i>>
For more information, see <a href="http://docs.aws.amazon.com/autoscaling/latest/userguide/AutoScalingGroup.html">Auto Scaling Groups</a> in the <i>Auto Scaling User
[slot] CreateLaunchConfigurationResponse *AutoScalingClient::createLaunchConfiguration(const CreateLaunchConfigurationRequest &request)
Sends request to the AutoScalingClient service, and returns a pointer to an CreateLaunchConfigurationResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Creates a launch
configuration>
If you exceed your maximum limit of launch configurations, the call fails. For information about viewing this limit, see <a>DescribeAccountLimits</a>. For information about updating this limit, see <a href="http://docs.aws.amazon.com/autoscaling/latest/userguide/as-account-limits.html">Auto Scaling Limits</a> in the <i>Auto Scaling User
Guide</i>>
For more information, see <a href="http://docs.aws.amazon.com/autoscaling/latest/userguide/LaunchConfiguration.html">Launch Configurations</a> in the <i>Auto Scaling User
[slot] CreateOrUpdateTagsResponse *AutoScalingClient::createOrUpdateTags(const CreateOrUpdateTagsRequest &request)
Sends request to the AutoScalingClient service, and returns a pointer to an CreateOrUpdateTagsResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Creates or updates tags for the specified Auto Scaling
group>
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 <a href="http://docs.aws.amazon.com/autoscaling/latest/userguide/autoscaling-tagging.html">Tagging Auto Scaling Groups and Instances</a> in the <i>Auto Scaling User
[slot] DeleteAutoScalingGroupResponse *AutoScalingClient::deleteAutoScalingGroup(const DeleteAutoScalingGroupRequest &request)
Sends request to the AutoScalingClient service, and returns a pointer to an DeleteAutoScalingGroupResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Deletes the specified Auto Scaling
group>
If the group has instances or scaling activities in progress, you must specify the option to force the deletion in order for it to
succeed>
If the group has policies, deleting the group deletes the policies, the underlying alarm actions, and any alarm that no longer has an associated
action>
To remove instances from the Auto Scaling group before deleting it, call <a>DetachInstances</a> with the list of instances and the option to decrement the desired capacity so that Auto Scaling does not launch replacement
instances>
To terminate all instances before deleting the Auto Scaling group, call <a>UpdateAutoScalingGroup</a> and set the minimum size and desired capacity of the Auto Scaling group to
[slot] DeleteLaunchConfigurationResponse *AutoScalingClient::deleteLaunchConfiguration(const DeleteLaunchConfigurationRequest &request)
Sends request to the AutoScalingClient service, and returns a pointer to an DeleteLaunchConfigurationResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
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
[slot] DeleteLifecycleHookResponse *AutoScalingClient::deleteLifecycleHook(const DeleteLifecycleHookRequest &request)
Sends request to the AutoScalingClient service, and returns a pointer to an DeleteLifecycleHookResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Deletes the specified lifecycle
hook>
If there are any outstanding lifecycle actions, they are completed first (<code>ABANDON</code> for launching instances, <code>CONTINUE</code> for terminating
[slot] DeleteNotificationConfigurationResponse *AutoScalingClient::deleteNotificationConfiguration(const DeleteNotificationConfigurationRequest &request)
Sends request to the AutoScalingClient service, and returns a pointer to an DeleteNotificationConfigurationResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Deletes the specified
[slot] DeletePolicyResponse *AutoScalingClient::deletePolicy(const DeletePolicyRequest &request)
Sends request to the AutoScalingClient service, and returns a pointer to an DeletePolicyResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Deletes the specified Auto Scaling
policy>
Deleting a policy deletes the underlying alarm action, but does not delete the alarm, even if it no longer has an associated
[slot] DeleteScheduledActionResponse *AutoScalingClient::deleteScheduledAction(const DeleteScheduledActionRequest &request)
Sends request to the AutoScalingClient service, and returns a pointer to an DeleteScheduledActionResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Deletes the specified scheduled
[slot] DeleteTagsResponse *AutoScalingClient::deleteTags(const DeleteTagsRequest &request)
Sends request to the AutoScalingClient service, and returns a pointer to an DeleteTagsResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Deletes the specified
[slot] DescribeAccountLimitsResponse *AutoScalingClient::describeAccountLimits()
Sends a DescribeAccountLimits request to the AutoScalingClient service, and returns a pointer to an DescribeAccountLimitsResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Describes the current Auto Scaling resource limits for your AWS
account>
For information about requesting an increase in these limits, see <a href="http://docs.aws.amazon.com/autoscaling/latest/userguide/as-account-limits.html">Auto Scaling Limits</a> in the <i>Auto Scaling User
[slot] DescribeAdjustmentTypesResponse *AutoScalingClient::describeAdjustmentTypes()
Sends a DescribeAdjustmentTypes request to the AutoScalingClient service, and returns a pointer to an DescribeAdjustmentTypesResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Describes the policy adjustment types for use with
[slot] DescribeAutoScalingGroupsResponse *AutoScalingClient::describeAutoScalingGroups(const DescribeAutoScalingGroupsRequest &request)
Sends request to the AutoScalingClient service, and returns a pointer to an DescribeAutoScalingGroupsResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Describes one or more Auto Scaling
[slot] DescribeAutoScalingInstancesResponse *AutoScalingClient::describeAutoScalingInstances(const DescribeAutoScalingInstancesRequest &request)
Sends request to the AutoScalingClient service, and returns a pointer to an DescribeAutoScalingInstancesResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Describes one or more Auto Scaling
[slot] DescribeAutoScalingNotificationTypesResponse *AutoScalingClient::describeAutoScalingNotificationTypes()
Sends a DescribeAutoScalingNotificationTypes request to the AutoScalingClient service, and returns a pointer to an DescribeAutoScalingNotificationTypesResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Describes the notification types that are supported by Auto
[slot] DescribeLaunchConfigurationsResponse *AutoScalingClient::describeLaunchConfigurations(const DescribeLaunchConfigurationsRequest &request)
Sends request to the AutoScalingClient service, and returns a pointer to an DescribeLaunchConfigurationsResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Describes one or more launch
[slot] DescribeLifecycleHookTypesResponse *AutoScalingClient::describeLifecycleHookTypes()
Sends a DescribeLifecycleHookTypes request to the AutoScalingClient service, and returns a pointer to an DescribeLifecycleHookTypesResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Describes the available types of lifecycle
[slot] DescribeLifecycleHooksResponse *AutoScalingClient::describeLifecycleHooks(const DescribeLifecycleHooksRequest &request)
Sends request to the AutoScalingClient service, and returns a pointer to an DescribeLifecycleHooksResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Describes the lifecycle hooks for the specified Auto Scaling
[slot] DescribeLoadBalancerTargetGroupsResponse *AutoScalingClient::describeLoadBalancerTargetGroups(const DescribeLoadBalancerTargetGroupsRequest &request)
Sends request to the AutoScalingClient service, and returns a pointer to an DescribeLoadBalancerTargetGroupsResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Describes the target groups for the specified Auto Scaling
[slot] DescribeLoadBalancersResponse *AutoScalingClient::describeLoadBalancers(const DescribeLoadBalancersRequest &request)
Sends request to the AutoScalingClient service, and returns a pointer to an DescribeLoadBalancersResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Describes the load balancers for the specified Auto Scaling
group>
Note that this operation describes only Classic Load Balancers. If you have Application Load Balancers, use <a>DescribeLoadBalancerTargetGroups</a>
[slot] DescribeMetricCollectionTypesResponse *AutoScalingClient::describeMetricCollectionTypes()
Sends a DescribeMetricCollectionTypes request to the AutoScalingClient service, and returns a pointer to an DescribeMetricCollectionTypesResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Describes the available CloudWatch metrics for Auto
Scaling>
Note that the <code>GroupStandbyInstances</code> metric is not returned by default. You must explicitly request this metric when calling
[slot] DescribeNotificationConfigurationsResponse *AutoScalingClient::describeNotificationConfigurations(const DescribeNotificationConfigurationsRequest &request)
Sends request to the AutoScalingClient service, and returns a pointer to an DescribeNotificationConfigurationsResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Describes the notification actions associated with the specified Auto Scaling
[slot] DescribePoliciesResponse *AutoScalingClient::describePolicies(const DescribePoliciesRequest &request)
Sends request to the AutoScalingClient service, and returns a pointer to an DescribePoliciesResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Describes the policies for the specified Auto Scaling
[slot] DescribeScalingActivitiesResponse *AutoScalingClient::describeScalingActivities(const DescribeScalingActivitiesRequest &request)
Sends request to the AutoScalingClient service, and returns a pointer to an DescribeScalingActivitiesResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Describes one or more scaling activities for the specified Auto Scaling
[slot] DescribeScalingProcessTypesResponse *AutoScalingClient::describeScalingProcessTypes()
Sends a DescribeScalingProcessTypes request to the AutoScalingClient service, and returns a pointer to an DescribeScalingProcessTypesResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Describes the scaling process types for use with <a>ResumeProcesses</a> and
[slot] DescribeScheduledActionsResponse *AutoScalingClient::describeScheduledActions(const DescribeScheduledActionsRequest &request)
Sends request to the AutoScalingClient service, and returns a pointer to an DescribeScheduledActionsResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Describes the actions scheduled for your Auto Scaling group that haven't run. To describe the actions that have already run, use
[slot] DescribeTagsResponse *AutoScalingClient::describeTags(const DescribeTagsRequest &request)
Sends request to the AutoScalingClient service, and returns a pointer to an DescribeTagsResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
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
[slot] DescribeTerminationPolicyTypesResponse *AutoScalingClient::describeTerminationPolicyTypes()
Sends a DescribeTerminationPolicyTypes request to the AutoScalingClient service, and returns a pointer to an DescribeTerminationPolicyTypesResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Describes the termination policies supported by Auto
[slot] DetachInstancesResponse *AutoScalingClient::detachInstances(const DetachInstancesRequest &request)
Sends request to the AutoScalingClient service, and returns a pointer to an DetachInstancesResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Removes one or more instances from the specified Auto Scaling
group>
After the instances are detached, you can manage them independent of the Auto Scaling
group>
If you do not specify the option to decrement the desired capacity, Auto Scaling launches instances to replace the ones that are
detached>
If there is a Classic Load Balancer attached to the Auto Scaling group, the instances are deregistered from the load balancer. If there are target groups attached to the Auto Scaling group, the instances are deregistered from the target
groups>
For more information, see <a href="http://docs.aws.amazon.com/autoscaling/latest/userguide/detach-instance-asg.html">Detach EC2 Instances from Your Auto Scaling Group</a> in the <i>Auto Scaling User
[slot] DetachLoadBalancerTargetGroupsResponse *AutoScalingClient::detachLoadBalancerTargetGroups(const DetachLoadBalancerTargetGroupsRequest &request)
Sends request to the AutoScalingClient service, and returns a pointer to an DetachLoadBalancerTargetGroupsResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Detaches one or more target groups from the specified Auto Scaling
[slot] DetachLoadBalancersResponse *AutoScalingClient::detachLoadBalancers(const DetachLoadBalancersRequest &request)
Sends request to the AutoScalingClient service, and returns a pointer to an DetachLoadBalancersResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Detaches one or more Classic Load Balancers from the specified Auto Scaling
group>
Note that this operation detaches only Classic Load Balancers. If you have Application Load Balancers, use <a>DetachLoadBalancerTargetGroups</a>
instead>
When you detach a load balancer, it enters the <code>Removing</code> state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the load balancer using <a>DescribeLoadBalancers</a>. Note that the instances remain
[slot] DisableMetricsCollectionResponse *AutoScalingClient::disableMetricsCollection(const DisableMetricsCollectionRequest &request)
Sends request to the AutoScalingClient service, and returns a pointer to an DisableMetricsCollectionResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Disables group metrics for the specified Auto Scaling
[slot] EnableMetricsCollectionResponse *AutoScalingClient::enableMetricsCollection(const EnableMetricsCollectionRequest &request)
Sends request to the AutoScalingClient service, and returns a pointer to an EnableMetricsCollectionResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Enables group metrics for the specified Auto Scaling group. For more information, see <a href="http://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-monitoring.html">Monitoring Your Auto Scaling Groups and Instances</a> in the <i>Auto Scaling User
[slot] EnterStandbyResponse *AutoScalingClient::enterStandby(const EnterStandbyRequest &request)
Sends request to the AutoScalingClient service, and returns a pointer to an EnterStandbyResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Moves the specified instances into the standby
state>
For more information, see <a href="http://docs.aws.amazon.com/autoscaling/latest/userguide/as-enter-exit-standby.html">Temporarily Removing Instances from Your Auto Scaling Group</a> in the <i>Auto Scaling User
[slot] ExecutePolicyResponse *AutoScalingClient::executePolicy(const ExecutePolicyRequest &request)
Sends request to the AutoScalingClient service, and returns a pointer to an ExecutePolicyResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Executes the specified
[slot] ExitStandbyResponse *AutoScalingClient::exitStandby(const ExitStandbyRequest &request)
Sends request to the AutoScalingClient service, and returns a pointer to an ExitStandbyResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Moves the specified instances out of the standby
state>
For more information, see <a href="http://docs.aws.amazon.com/autoscaling/latest/userguide/as-enter-exit-standby.html">Temporarily Removing Instances from Your Auto Scaling Group</a> in the <i>Auto Scaling User
[slot] PutLifecycleHookResponse *AutoScalingClient::putLifecycleHook(const PutLifecycleHookRequest &request)
Sends request to the AutoScalingClient service, and returns a pointer to an PutLifecycleHookResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
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 step is a part of the procedure for adding a lifecycle hook to an Auto Scaling
group> <ol> <li>
(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Auto Scaling launches or terminates
instances> </li> <li>
(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Auto Scaling to publish lifecycle notifications to the
target> </li> <li>
<b>Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.</b>
</p </li> <li>
If you need more time, record the lifecycle action heartbeat to keep the instance in a pending
state> </li> <li>
If you finish before the timeout period ends, complete the lifecycle
action> </li> </ol>
For more information, see <a href="http://docs.aws.amazon.com/autoscaling/latest/userguide/lifecycle-hooks.html">Auto Scaling Lifecycle Hooks</a> in the <i>Auto Scaling User
Guide</i>>
If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling group, the call fails. For information about updating this limit, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html">AWS Service Limits</a> in the <i>Amazon Web Services General
[slot] PutNotificationConfigurationResponse *AutoScalingClient::putNotificationConfiguration(const PutNotificationConfigurationRequest &request)
Sends request to the AutoScalingClient service, and returns a pointer to an PutNotificationConfigurationResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to the specified topic can have messages delivered to an endpoint such as a web server or an email
address>
This configuration overwrites any existing
configuration>
For more information see <a href="http://docs.aws.amazon.com/autoscaling/latest/userguide/ASGettingNotifications.html">Getting SNS Notifications When Your Auto Scaling Group Scales</a> in the <i>Auto Scaling User
[slot] PutScalingPolicyResponse *AutoScalingClient::putScalingPolicy(const PutScalingPolicyRequest &request)
Sends request to the AutoScalingClient service, and returns a pointer to an PutScalingPolicyResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
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 <a href="http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html">AWS Service Limits</a> in the <i>Amazon Web Services General
[slot] PutScheduledUpdateGroupActionResponse *AutoScalingClient::putScheduledUpdateGroupAction(const PutScheduledUpdateGroupActionRequest &request)
Sends request to the AutoScalingClient service, and returns a pointer to an PutScheduledUpdateGroupActionResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
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>
For more information, see <a href="http://docs.aws.amazon.com/autoscaling/latest/userguide/schedule_time.html">Scheduled Scaling</a> in the <i>Auto Scaling User
[slot] RecordLifecycleActionHeartbeatResponse *AutoScalingClient::recordLifecycleActionHeartbeat(const RecordLifecycleActionHeartbeatRequest &request)
Sends request to the AutoScalingClient service, and returns a pointer to an RecordLifecycleActionHeartbeatResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Records a heartbeat for the lifecycle action associated with the specified token or instance. This extends the timeout by the length of time defined using
<a>PutLifecycleHook</a>>
This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling
group> <ol> <li>
(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Auto Scaling launches or terminates
instances> </li> <li>
(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Auto Scaling to publish lifecycle notifications to the
target> </li> <li>
Create the lifecycle hook. Specify whether the hook is used when the instances launch or
terminate> </li> <li>
<b>If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.</b>
</p </li> <li>
If you finish before the timeout period ends, complete the lifecycle
action> </li> </ol>
For more information, see <a href="http://docs.aws.amazon.com/autoscaling/latest/userguide/AutoScalingGroupLifecycle.html">Auto Scaling Lifecycle</a> in the <i>Auto Scaling User
[slot] ResumeProcessesResponse *AutoScalingClient::resumeProcesses(const ResumeProcessesRequest &request)
Sends request to the AutoScalingClient service, and returns a pointer to an ResumeProcessesResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Resumes the specified suspended Auto Scaling processes, or all suspended process, for the specified Auto Scaling
group>
For more information, see <a href="http://docs.aws.amazon.com/autoscaling/latest/userguide/as-suspend-resume-processes.html">Suspending and Resuming Auto Scaling Processes</a> in the <i>Auto Scaling User
[slot] SetDesiredCapacityResponse *AutoScalingClient::setDesiredCapacity(const SetDesiredCapacityRequest &request)
Sends request to the AutoScalingClient service, and returns a pointer to an SetDesiredCapacityResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Sets the size of the specified Auto Scaling
group>
For more information about desired capacity, see <a href="http://docs.aws.amazon.com/autoscaling/latest/userguide/WhatIsAutoScaling.html">What Is Auto Scaling?</a> in the <i>Auto Scaling User
[slot] SetInstanceHealthResponse *AutoScalingClient::setInstanceHealth(const SetInstanceHealthRequest &request)
Sends request to the AutoScalingClient service, and returns a pointer to an SetInstanceHealthResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Sets the health status of the specified
instance>
For more information, see <a href="http://docs.aws.amazon.com/autoscaling/latest/userguide/healthcheck.html">Health Checks</a> in the <i>Auto Scaling User
[slot] SetInstanceProtectionResponse *AutoScalingClient::setInstanceProtection(const SetInstanceProtectionRequest &request)
Sends request to the AutoScalingClient service, and returns a pointer to an SetInstanceProtectionResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Updates the instance protection settings of the specified
instances>
For more information, see <a href="http://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-termination.html#instance-protection">Instance Protection</a> in the <i>Auto Scaling User
[slot] SuspendProcessesResponse *AutoScalingClient::suspendProcesses(const SuspendProcessesRequest &request)
Sends request to the AutoScalingClient service, and returns a pointer to an SuspendProcessesResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Suspends the specified Auto Scaling processes, or all processes, for the specified Auto Scaling
group>
Note that if you suspend either the <code>Launch</code> or <code>Terminate</code> process types, it can prevent other process types from functioning
properly>
To resume processes that have been suspended, use
<a>ResumeProcesses</a>>
For more information, see <a href="http://docs.aws.amazon.com/autoscaling/latest/userguide/as-suspend-resume-processes.html">Suspending and Resuming Auto Scaling Processes</a> in the <i>Auto Scaling User
[slot] TerminateInstanceInAutoScalingGroupResponse *AutoScalingClient::terminateInstanceInAutoScalingGroup(const TerminateInstanceInAutoScalingGroupRequest &request)
Sends request to the AutoScalingClient service, and returns a pointer to an TerminateInstanceInAutoScalingGroupResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Terminates the specified instance and optionally adjusts the desired group
size>
This call simply makes a termination request. The instance is not terminated
[slot] UpdateAutoScalingGroupResponse *AutoScalingClient::updateAutoScalingGroup(const UpdateAutoScalingGroupRequest &request)
Sends request to the AutoScalingClient service, and returns a pointer to an UpdateAutoScalingGroupResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Updates the configuration for the specified Auto Scaling
group>
The new settings take effect on any scaling activities after this call returns. Scaling activities that are currently in progress aren't
affected>
To update an Auto Scaling group with a launch configuration with <code>InstanceMonitoring</code> set to <code>false</code>, 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
<a>DisableMetricsCollection</a>>
Note the
following> <ul> <li>
If you specify a new value for <code>MinSize</code> without specifying a value for <code>DesiredCapacity</code>, and the new <code>MinSize</code> is larger than the current size of the group, we implicitly call <a>SetDesiredCapacity</a> to set the size of the group to the new value of
<code>MinSize</code>> </li> <li>
If you specify a new value for <code>MaxSize</code> without specifying a value for <code>DesiredCapacity</code>, and the new <code>MaxSize</code> is smaller than the current size of the group, we implicitly call <a>SetDesiredCapacity</a> to set the size of the group to the new value of
<code>MaxSize</code>> </li> <li>
All other optional parameters are left unchanged if not
© 2018 Paul Colby Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.