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.50.0 (build d1830a4)",
           date="2022-01-04T15:39:03.326Z")
 @Stability(value=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();
 

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()
String	getAutoScalingGroupName() The name of the Auto Scaling group for the lifecycle hook.
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 instance state to which you want to attach the lifecycle hook.
default String	getNotificationMetadata() Additional information that is included 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 uses to notify you when an instance is in the transition 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, for example, an Amazon SNS topic or an Amazon SQS queue.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAutoScalingGroupName

@Stability(value=Stable)
 @NotNull
String getAutoScalingGroupName()

The name of the Auto Scaling group for the lifecycle hook.

getLifecycleTransition

@Stability(value=Stable)
 @NotNull
String getLifecycleTransition()

The instance state to which you want to attach the lifecycle hook. The valid values are:.

• autoscaling:EC2_INSTANCE_LAUNCHING
• autoscaling:EC2_INSTANCE_TERMINATING

getDefaultResult

@Stability(value=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 valid values are CONTINUE and ABANDON (default).

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

getHeartbeatTimeout

@Stability(value=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). If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult property.

getLifecycleHookName

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

The name of the lifecycle hook.

getNotificationMetadata

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

Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target.

getNotificationTargetArn

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

The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook.

You can specify an Amazon SQS queue or an Amazon SNS topic. The notification message includes the following information: lifecycle action token, user account ID, Auto Scaling group name, lifecycle hook name, instance ID, lifecycle transition, and notification metadata.

getRoleArn

@Stability(value=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 example, an Amazon SNS topic or an Amazon SQS queue.

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

builder

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

Returns:

a CfnLifecycleHookProps.Builder of CfnLifecycleHookProps