software.amazon.awscdk.services.autoscaling

Interface CfnLifecycleHookProps

All Known Implementing Classes:

CfnLifecycleHookProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:33.672Z")
public interface 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 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();
 

Nested Class Summary

Nested Classes

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

Method Summary

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

Method Detail

getAutoScalingGroupName

java.lang.String getAutoScalingGroupName()

The name of the Auto Scaling group.

getLifecycleTransition

java.lang.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 .

getDefaultResult

default java.lang.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

getHeartbeatTimeout

default java.lang.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).

getLifecycleHookName

default java.lang.String getLifecycleHookName()

The name of the lifecycle hook.

getNotificationMetadata

default java.lang.String getNotificationMetadata()

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

getNotificationTargetArn

default java.lang.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.

getRoleArn

default java.lang.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 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.

builder

static CfnLifecycleHookProps.Builder builder()

Returns:

a CfnLifecycleHookProps.Builder of CfnLifecycleHookProps