Class CfnLifecycleHookProps

Namespace

Amazon.CDK.AWS.AutoScaling

Assembly

Amazon.CDK.AWS.AutoScaling.dll

Properties for defining a CfnLifecycleHook.

public class CfnLifecycleHookProps : ICfnLifecycleHookProps

Inheritance

object

CfnLifecycleHookProps

Implements

ICfnLifecycleHookProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

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 cfnLifecycleHookProps = new CfnLifecycleHookProps {
                 AutoScalingGroupName = "autoScalingGroupName",
                 LifecycleTransition = "lifecycleTransition",

                 // the properties below are optional
                 DefaultResult = "defaultResult",
                 HeartbeatTimeout = 123,
                 LifecycleHookName = "lifecycleHookName",
                 NotificationMetadata = "notificationMetadata",
                 NotificationTargetArn = "notificationTargetArn",
                 RoleArn = "roleArn"
             };

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-lifecyclehook.html

ExampleMetadata: fixture=_generated

Constructors

CfnLifecycleHookProps()

public CfnLifecycleHookProps()

Properties

AutoScalingGroupName

The name of the Auto Scaling group.

public string AutoScalingGroupName { get; set; }

Property Value

string

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-lifecyclehook.html#cfn-autoscaling-lifecyclehook-autoscalinggroupname

DefaultResult

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

public string? DefaultResult { get; set; }

Property Value

string

Remarks

The default value is ABANDON .

Valid values: CONTINUE | ABANDON

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-lifecyclehook.html#cfn-autoscaling-lifecyclehook-defaultresult

HeartbeatTimeout

The maximum time, in seconds, that can elapse before the lifecycle hook times out.

public double? HeartbeatTimeout { get; set; }

Property Value

double?

Remarks

The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 hour).

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-lifecyclehook.html#cfn-autoscaling-lifecyclehook-heartbeattimeout

LifecycleHookName

The name of the lifecycle hook.

public string? LifecycleHookName { get; set; }

Property Value

string

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-lifecyclehook.html#cfn-autoscaling-lifecyclehook-lifecyclehookname

LifecycleTransition

The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions.

public string LifecycleTransition { get; set; }

Property Value

string

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-lifecyclehook.html#cfn-autoscaling-lifecyclehook-lifecycletransition

NotificationMetadata

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

public string? NotificationMetadata { get; set; }

Property Value

string

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-lifecyclehook.html#cfn-autoscaling-lifecyclehook-notificationmetadata

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.

public string? NotificationTargetArn { get; set; }

Property Value

string

Remarks

You can specify an Amazon SNS topic or an Amazon SQS queue.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-lifecyclehook.html#cfn-autoscaling-lifecyclehook-notificationtargetarn

RoleArn

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.

public string? RoleArn { get; set; }

Property Value

string

Remarks

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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-lifecyclehook.html#cfn-autoscaling-lifecyclehook-rolearn