1.204.0

interface CfnLifecycleHookProps

LanguageType name
.NETAmazon.CDK.AWS.AutoScaling.CfnLifecycleHookProps
Javasoftware.amazon.awscdk.services.autoscaling.CfnLifecycleHookProps
Pythonaws_cdk.aws_autoscaling.CfnLifecycleHookProps
TypeScript @aws-cdk/aws-autoscaling » CfnLifecycleHookProps

Properties for defining a CfnLifecycleHook.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as autoscaling from '@aws-cdk/aws-autoscaling';
const cfnLifecycleHookProps: autoscaling.CfnLifecycleHookProps = {
  autoScalingGroupName: 'autoScalingGroupName',
  lifecycleTransition: 'lifecycleTransition',

  // the properties below are optional
  defaultResult: 'defaultResult',
  heartbeatTimeout: 123,
  lifecycleHookName: 'lifecycleHookName',
  notificationMetadata: 'notificationMetadata',
  notificationTargetArn: 'notificationTargetArn',
  roleArn: 'roleArn',
};

Properties

NameTypeDescription
autoScalingGroupNamestringThe name of the Auto Scaling group.
lifecycleTransitionstringThe lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions.
defaultResult?stringThe action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs.
heartbeatTimeout?numberThe maximum time, in seconds, that can elapse before the lifecycle hook times out.
lifecycleHookName?stringThe name of the lifecycle hook.
notificationMetadata?stringAdditional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
notificationTargetArn?stringThe Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a wait state for the lifecycle hook.
roleArn?stringThe ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.

autoScalingGroupName

Type: string

The name of the Auto Scaling group.

lifecycleTransition

Type: string

The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions.

  • To create a lifecycle hook for scale-out events, specify autoscaling:EC2_INSTANCE_LAUNCHING .
  • To create a lifecycle hook for scale-in events, specify autoscaling:EC2_INSTANCE_TERMINATING .

defaultResult?

Type: string (optional)

The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs.

The default value is ABANDON .

Valid values: CONTINUE | ABANDON

heartbeatTimeout?

Type: number (optional)

The maximum time, in seconds, that can elapse before the lifecycle hook times out.

The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 hour).

lifecycleHookName?

Type: string (optional)

The name of the lifecycle hook.

notificationMetadata?

Type: string (optional)

Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.

notificationTargetArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a wait state for the lifecycle hook.

You can specify an Amazon SNS topic or an Amazon SQS queue.

roleArn?

Type: string (optional)

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

For information about creating this role, see Configure a notification target for a lifecycle hook in the Amazon EC2 Auto Scaling User Guide .

Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue.

← PreviousNext →