completeLifecycleAction method

Future<void> completeLifecycleAction({ required String autoScalingGroupName, required String lifecycleActionResult, required String lifecycleHookName, String? instanceId, String? lifecycleActionToken, })

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:

1. (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.
2. (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 Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.
3. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.
4. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.
5. If you finish before the timeout period ends, complete the lifecycle action.

For more information, see Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide.

May throw ResourceContentionFault.

Parameter autoScalingGroupName : The name of the Auto Scaling group.

Parameter lifecycleActionResult : The action for the group to take. This parameter can be either CONTINUE or ABANDON.

Parameter lifecycleHookName : The name of the lifecycle hook.

Parameter instanceId : The ID of the instance.

Parameter lifecycleActionToken : A universally unique identifier (UUID) that identifies a specific lifecycle action associated with an instance. Amazon EC2 Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook.

Implementation

Future<void> completeLifecycleAction({
  required String autoScalingGroupName,
  required String lifecycleActionResult,
  required String lifecycleHookName,
  String? instanceId,
  String? lifecycleActionToken,
}) async {
  ArgumentError.checkNotNull(autoScalingGroupName, 'autoScalingGroupName');
  _s.validateStringLength(
    'autoScalingGroupName',
    autoScalingGroupName,
    1,
    1600,
    isRequired: true,
  );
  ArgumentError.checkNotNull(lifecycleActionResult, 'lifecycleActionResult');
  ArgumentError.checkNotNull(lifecycleHookName, 'lifecycleHookName');
  _s.validateStringLength(
    'lifecycleHookName',
    lifecycleHookName,
    1,
    255,
    isRequired: true,
  );
  _s.validateStringLength(
    'instanceId',
    instanceId,
    1,
    19,
  );
  _s.validateStringLength(
    'lifecycleActionToken',
    lifecycleActionToken,
    36,
    36,
  );
  final $request = <String, dynamic>{};
  $request['AutoScalingGroupName'] = autoScalingGroupName;
  $request['LifecycleActionResult'] = lifecycleActionResult;
  $request['LifecycleHookName'] = lifecycleHookName;
  instanceId?.also((arg) => $request['InstanceId'] = arg);
  lifecycleActionToken?.also((arg) => $request['LifecycleActionToken'] = arg);
  await _protocol.send(
    $request,
    action: 'CompleteLifecycleAction',
    version: '2011-01-01',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['CompleteLifecycleActionType'],
    shapes: shapes,
    resultWrapper: 'CompleteLifecycleActionResult',
  );
}