Show / Hide Table of Contents

Interface IBasicLifecycleHookProps

Basic properties for a lifecycle hook.

Namespace: Amazon.CDK.AWS.AutoScaling
Assembly: Amazon.CDK.AWS.AutoScaling.dll
Syntax (csharp)
public interface IBasicLifecycleHookProps
Syntax (vb)
Public Interface IBasicLifecycleHookProps

Synopsis

Properties

DefaultResult

The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs.

HeartbeatTimeout

Maximum time between calls to RecordLifecycleActionHeartbeat for the hook.

LifecycleHookName

Name of the lifecycle hook.

LifecycleTransition

The state of the Amazon EC2 instance to which you want to attach the lifecycle hook.

NotificationMetadata

Additional data to pass to the lifecycle hook target.

NotificationTarget

The target of the lifecycle hook.

Role

The role that allows publishing to the notification target.

Properties

DefaultResult

The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs.

virtual Nullable<DefaultResult> DefaultResult { get; }
Property Value

System.Nullable<DefaultResult>

Remarks

Default: Continue

HeartbeatTimeout

Maximum time between calls to RecordLifecycleActionHeartbeat for the hook.

virtual Duration HeartbeatTimeout { get; }
Property Value

Duration

Remarks

If the lifecycle hook times out, perform the action in DefaultResult.

Default: - No heartbeat timeout.

LifecycleHookName

Name of the lifecycle hook.

virtual string LifecycleHookName { get; }
Property Value

System.String

Remarks

Default: - Automatically generated name.

LifecycleTransition

The state of the Amazon EC2 instance to which you want to attach the lifecycle hook.

LifecycleTransition LifecycleTransition { get; }
Property Value

LifecycleTransition

NotificationMetadata

Additional data to pass to the lifecycle hook target.

virtual string NotificationMetadata { get; }
Property Value

System.String

Remarks

Default: - No metadata.

NotificationTarget

The target of the lifecycle hook.

ILifecycleHookTarget NotificationTarget { get; }
Property Value

ILifecycleHookTarget

Role

The role that allows publishing to the notification target.

virtual IRole Role { get; }
Property Value

IRole

Remarks

Default: - A role is automatically created.

Back to top Generated by DocFX