Interface CfnAutoScalingGroup.ILifecycleHookSpecificationProperty
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.
Namespace: Amazon.CDK.AWS.AutoScaling
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ILifecycleHookSpecificationProperty
Syntax (vb)
Public Interface ILifecycleHookSpecificationProperty
Remarks
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.
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AutoScaling;
var lifecycleHookSpecificationProperty = new LifecycleHookSpecificationProperty {
LifecycleHookName = "lifecycleHookName",
LifecycleTransition = "lifecycleTransition",
// the properties below are optional
DefaultResult = "defaultResult",
HeartbeatTimeout = 123,
NotificationMetadata = "notificationMetadata",
NotificationTargetArn = "notificationTargetArn",
RoleArn = "roleArn"
};
Synopsis
Properties
DefaultResult | The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. |
HeartbeatTimeout | The maximum time, in seconds, that can elapse before the lifecycle hook times out. |
LifecycleHookName | The name of the lifecycle hook. |
LifecycleTransition | The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions. |
NotificationMetadata | Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target. |
NotificationTargetArn | 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. |
RoleArn | The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. |
Properties
DefaultResult
The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs.
virtual string DefaultResult { get; }
Property Value
System.String
Remarks
The default value is ABANDON
.
Valid values: CONTINUE
| ABANDON
HeartbeatTimeout
The maximum time, in seconds, that can elapse before the lifecycle hook times out.
virtual Nullable<double> HeartbeatTimeout { get; }
Property Value
System.Nullable<System.Double>
Remarks
The range is from 30
to 7200
seconds. The default value is 3600
seconds (1 hour).
LifecycleHookName
The name of the lifecycle hook.
string LifecycleHookName { get; }
Property Value
System.String
Remarks
LifecycleTransition
The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions.
string LifecycleTransition { get; }
Property Value
System.String
Remarks
NotificationMetadata
Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
virtual string NotificationMetadata { get; }
Property Value
System.String
Remarks
NotificationTargetArn
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.
virtual string NotificationTargetArn { get; }
Property Value
System.String
Remarks
You can specify an Amazon SNS topic or an Amazon SQS queue.
RoleArn
The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.
virtual string RoleArn { get; }
Property Value
System.String
Remarks
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.