Package software.amazon.awscdk.services.autoscaling

Interface CfnLifecycleHookProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLifecycleHookProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-06T23:25:04.651Z")
@Stability(Stable)
public interface CfnLifecycleHookProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.autoscaling.*;
 CfnLifecycleHookProps cfnLifecycleHookProps = CfnLifecycleHookProps.builder()
         .autoScalingGroupName("autoScalingGroupName")
         .lifecycleTransition("lifecycleTransition")
         // the properties below are optional
         .defaultResult("defaultResult")
         .heartbeatTimeout(123)
         .lifecycleHookName("lifecycleHookName")
         .notificationMetadata("notificationMetadata")
         .notificationTargetArn("notificationTargetArn")
         .roleArn("roleArn")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-lifecyclehook.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnLifecycleHookProps.Builder	A builder for CfnLifecycleHookProps
static final class	CfnLifecycleHookProps.Jsii$Proxy	An implementation for CfnLifecycleHookProps

Method Summary

Modifier and Type	Method	Description
static CfnLifecycleHookProps.Builder	builder()
String	getAutoScalingGroupName()	The name of the Auto Scaling group.
default String	getDefaultResult()	The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs.
default Number	getHeartbeatTimeout()	The maximum time, in seconds, that can elapse before the lifecycle hook times out.
default String	getLifecycleHookName()	The name of the lifecycle hook.
String	getLifecycleTransition()	The lifecycle transition.
default String	getNotificationMetadata()	Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
default String	getNotificationTargetArn()	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.
default String	getRoleArn()	The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAutoScalingGroupName

@Stability(Stable)
@NotNull
String getAutoScalingGroupName()

The name of the Auto Scaling group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-lifecyclehook.html#cfn-autoscaling-lifecyclehook-autoscalinggroupname

getLifecycleTransition

@Stability(Stable)
@NotNull
String getLifecycleTransition()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-lifecyclehook.html#cfn-autoscaling-lifecyclehook-lifecycletransition

getDefaultResult

@Stability(Stable)
@Nullable
default String getDefaultResult()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-lifecyclehook.html#cfn-autoscaling-lifecyclehook-defaultresult

getHeartbeatTimeout

@Stability(Stable)
@Nullable
default Number getHeartbeatTimeout()

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).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-lifecyclehook.html#cfn-autoscaling-lifecyclehook-heartbeattimeout

getLifecycleHookName

@Stability(Stable)
@Nullable
default String getLifecycleHookName()

The name of the lifecycle hook.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-lifecyclehook.html#cfn-autoscaling-lifecyclehook-lifecyclehookname

getNotificationMetadata

@Stability(Stable)
@Nullable
default String getNotificationMetadata()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-lifecyclehook.html#cfn-autoscaling-lifecyclehook-notificationmetadata

getNotificationTargetArn

@Stability(Stable)
@Nullable
default String getNotificationTargetArn()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-lifecyclehook.html#cfn-autoscaling-lifecyclehook-notificationtargetarn

getRoleArn

@Stability(Stable)
@Nullable
default String getRoleArn()

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 Prepare to add a lifecycle hook to your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide .

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-lifecyclehook.html#cfn-autoscaling-lifecyclehook-rolearn

builder

@Stability(Stable)
static CfnLifecycleHookProps.Builder builder()

Returns:

a CfnLifecycleHookProps.Builder of CfnLifecycleHookProps