The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Paws-0.14
River stage two • 9 direct dependents • 11 total dependents
57 ++
/ Paws::AutoScaling::PutLifecycleHook

NAME

Paws::AutoScaling::PutLifecycleHook - Arguments for method PutLifecycleHook on Paws::AutoScaling

DESCRIPTION

This class represents the parameters used for calling the method PutLifecycleHook on the Auto Scaling service. Use the attributes of this class as arguments to method PutLifecycleHook.

You shouln't make instances of this class. Each attribute should be used as a named argument in the call to PutLifecycleHook.

As an example:

  $service_obj->PutLifecycleHook(Att1 => $value1, Att2 => $value2, ...);

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.

ATTRIBUTES

REQUIRED AutoScalingGroupName => Str

The name of the Auto Scaling group to which you want to assign the lifecycle hook.

DefaultResult => Str

Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The value for this parameter can be either CONTINUE or ABANDON. The default value for this parameter is ABANDON.

HeartbeatTimeout => Int

Defines the amount of time, in seconds, that can elapse before the lifecycle hook times out. When the lifecycle hook times out, Auto Scaling performs the action defined in the DefaultResult parameter. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat. The default value for this parameter is 3600 seconds (1 hour).

REQUIRED LifecycleHookName => Str

The name of the lifecycle hook.

LifecycleTransition => Str

The instance state to which you want to attach the lifecycle hook. For a list of lifecycle hook types, see DescribeLifecycleHookTypes.

This parameter is required for new lifecycle hooks, but optional when updating existing hooks.

NotificationMetadata => Str

Contains additional information that you want to include any time Auto Scaling sends a message to the notification target.

NotificationTargetARN => Str

The ARN of the notification target that Auto Scaling will use to notify you when an instance is in the transition state for the lifecycle hook. This ARN target can be either an SQS queue or an SNS topic.

This parameter is required for new lifecycle hooks, but optional when updating existing hooks.

The notification message sent to the target will include:

  • LifecycleActionToken. The Lifecycle action token.

  • AccountId. The user account ID.

  • AutoScalingGroupName. The name of the Auto Scaling group.

  • LifecycleHookName. The lifecycle hook name.

  • EC2InstanceId. The EC2 instance ID.

  • LifecycleTransition. The lifecycle transition.

  • NotificationMetadata. The notification metadata.

This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key/value pair format when sending notifications to an Amazon SNS topic.

When you call this operation, a test message is sent to the notification target. This test message contains an additional key/value pair: Event:autoscaling:TEST_NOTIFICATION.

RoleARN => Str

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.

This parameter is required for new lifecycle hooks, but optional when updating existing hooks.

SEE ALSO

This class forms part of Paws, documenting arguments for method PutLifecycleHook in Paws::AutoScaling

BUGS and CONTRIBUTIONS

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