Interface ICfnLifecycleHookProps

Properties for defining a CfnLifecycleHook.

Namespace: Amazon.CDK.AWS.AutoScaling

Assembly: Amazon.CDK.AWS.AutoScaling.dll

Syntax (csharp)

public interface ICfnLifecycleHookProps

Syntax (vb)

Public Interface ICfnLifecycleHookProps

Remarks

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

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

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

Synopsis

Properties

AutoScalingGroupName	The name of the Auto Scaling group.
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

AutoScalingGroupName

The name of the Auto Scaling group.

string AutoScalingGroupName { get; }

Property Value

System.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.

virtual string DefaultResult { get; }

Property Value

System.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.

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).

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.

virtual string LifecycleHookName { get; }

Property Value

System.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.

string LifecycleTransition { get; }

Property Value

System.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.

virtual string NotificationMetadata { get; }

Property Value

System.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.

virtual string NotificationTargetArn { get; }

Property Value

System.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.

virtual string RoleArn { get; }

Property Value

System.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