Interface CfnAutoScalingGroup.LifecycleHookSpecificationProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnAutoScalingGroup.LifecycleHookSpecificationProperty.Jsii$Proxy
- Enclosing class:
CfnAutoScalingGroup
@Stability(Stable)
public static interface CfnAutoScalingGroup.LifecycleHookSpecificationProperty
extends software.amazon.jsii.JsiiSerializable
LifecycleHookSpecification
specifies a lifecycle hook for the LifecycleHookSpecificationList
property of the AWS::AutoScaling::AutoScalingGroup resource. A lifecycle hook specifies actions to perform when Amazon EC2 Auto Scaling launches or terminates instances.
For more information, see Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide . You can find a sample template snippet in the Examples section of the AWS::AutoScaling::LifecycleHook
resource.
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.*; LifecycleHookSpecificationProperty lifecycleHookSpecificationProperty = LifecycleHookSpecificationProperty.builder() .lifecycleHookName("lifecycleHookName") .lifecycleTransition("lifecycleTransition") // the properties below are optional .defaultResult("defaultResult") .heartbeatTimeout(123) .notificationMetadata("notificationMetadata") .notificationTargetArn("notificationTargetArn") .roleArn("roleArn") .build();
- See Also:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnAutoScalingGroup.LifecycleHookSpecificationProperty
static final class
An implementation forCfnAutoScalingGroup.LifecycleHookSpecificationProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default String
The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs.default Number
The maximum time, in seconds, that can elapse before the lifecycle hook times out.The name of the lifecycle hook.The lifecycle transition.default String
Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.default String
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
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
-
getLifecycleHookName
The name of the lifecycle hook.- See Also:
-
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:
- To create a lifecycle hook for scale-out events, specify
-
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:
-
getHeartbeatTimeout
The maximum time, in seconds, that can elapse before the lifecycle hook times out.The range is from
30
to7200
seconds. The default value is3600
seconds (1 hour).- See Also:
-
getNotificationMetadata
Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.- See Also:
-
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:
-
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:
-
builder
-