AWS Native

Pulumi Official
Package maintained by Pulumi
v0.16.1 published on Saturday, Apr 30, 2022 by Pulumi

getLifecycleHook

Resource Type definition for AWS::AutoScaling::LifecycleHook

Using getLifecycleHook

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getLifecycleHook(args: GetLifecycleHookArgs, opts?: InvokeOptions): Promise<GetLifecycleHookResult>
function getLifecycleHookOutput(args: GetLifecycleHookOutputArgs, opts?: InvokeOptions): Output<GetLifecycleHookResult>
def get_lifecycle_hook(auto_scaling_group_name: Optional[str] = None,
                       lifecycle_hook_name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetLifecycleHookResult
def get_lifecycle_hook_output(auto_scaling_group_name: Optional[pulumi.Input[str]] = None,
                       lifecycle_hook_name: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetLifecycleHookResult]
func LookupLifecycleHook(ctx *Context, args *LookupLifecycleHookArgs, opts ...InvokeOption) (*LookupLifecycleHookResult, error)
func LookupLifecycleHookOutput(ctx *Context, args *LookupLifecycleHookOutputArgs, opts ...InvokeOption) LookupLifecycleHookResultOutput

> Note: This function is named LookupLifecycleHook in the Go SDK.

public static class GetLifecycleHook 
{
    public static Task<GetLifecycleHookResult> InvokeAsync(GetLifecycleHookArgs args, InvokeOptions? opts = null)
    public static Output<GetLifecycleHookResult> Invoke(GetLifecycleHookInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetLifecycleHookResult> getLifecycleHook(GetLifecycleHookArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: aws-native:autoscaling:getLifecycleHook
  Arguments:
    # Arguments dictionary

The following arguments are supported:

AutoScalingGroupName string

The name of the Auto Scaling group for the lifecycle hook.

LifecycleHookName string

The name of the lifecycle hook.

AutoScalingGroupName string

The name of the Auto Scaling group for the lifecycle hook.

LifecycleHookName string

The name of the lifecycle hook.

autoScalingGroupName String

The name of the Auto Scaling group for the lifecycle hook.

lifecycleHookName String

The name of the lifecycle hook.

autoScalingGroupName string

The name of the Auto Scaling group for the lifecycle hook.

lifecycleHookName string

The name of the lifecycle hook.

auto_scaling_group_name str

The name of the Auto Scaling group for the lifecycle hook.

lifecycle_hook_name str

The name of the lifecycle hook.

autoScalingGroupName String

The name of the Auto Scaling group for the lifecycle hook.

lifecycleHookName String

The name of the lifecycle hook.

getLifecycleHook Result

The following output properties are available:

DefaultResult string

The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The valid values are CONTINUE and ABANDON (default).

HeartbeatTimeout int

The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 hour). If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult property.

LifecycleTransition string

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

NotificationMetadata string

Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target.

NotificationTargetARN string

The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. You can specify an Amazon SQS queue or an Amazon SNS topic. The notification message includes the following information: lifecycle action token, user account ID, Auto Scaling group name, lifecycle hook name, instance ID, lifecycle transition, and notification metadata.

RoleARN string

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.

DefaultResult string

The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The valid values are CONTINUE and ABANDON (default).

HeartbeatTimeout int

The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 hour). If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult property.

LifecycleTransition string

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

NotificationMetadata string

Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target.

NotificationTargetARN string

The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. You can specify an Amazon SQS queue or an Amazon SNS topic. The notification message includes the following information: lifecycle action token, user account ID, Auto Scaling group name, lifecycle hook name, instance ID, lifecycle transition, and notification metadata.

RoleARN string

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.

defaultResult String

The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The valid values are CONTINUE and ABANDON (default).

heartbeatTimeout Integer

The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 hour). If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult property.

lifecycleTransition String

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

notificationMetadata String

Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target.

notificationTargetARN String

The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. You can specify an Amazon SQS queue or an Amazon SNS topic. The notification message includes the following information: lifecycle action token, user account ID, Auto Scaling group name, lifecycle hook name, instance ID, lifecycle transition, and notification metadata.

roleARN String

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.

defaultResult string

The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The valid values are CONTINUE and ABANDON (default).

heartbeatTimeout number

The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 hour). If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult property.

lifecycleTransition string

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

notificationMetadata string

Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target.

notificationTargetARN string

The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. You can specify an Amazon SQS queue or an Amazon SNS topic. The notification message includes the following information: lifecycle action token, user account ID, Auto Scaling group name, lifecycle hook name, instance ID, lifecycle transition, and notification metadata.

roleARN string

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.

default_result str

The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The valid values are CONTINUE and ABANDON (default).

heartbeat_timeout int

The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 hour). If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult property.

lifecycle_transition str

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

notification_metadata str

Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target.

notification_target_arn str

The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. You can specify an Amazon SQS queue or an Amazon SNS topic. The notification message includes the following information: lifecycle action token, user account ID, Auto Scaling group name, lifecycle hook name, instance ID, lifecycle transition, and notification metadata.

role_arn str

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.

defaultResult String

The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The valid values are CONTINUE and ABANDON (default).

heartbeatTimeout Number

The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 hour). If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult property.

lifecycleTransition String

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

notificationMetadata String

Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target.

notificationTargetARN String

The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. You can specify an Amazon SQS queue or an Amazon SNS topic. The notification message includes the following information: lifecycle action token, user account ID, Auto Scaling group name, lifecycle hook name, instance ID, lifecycle transition, and notification metadata.

roleARN String

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.

Package Details

Repository
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0