@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
98 lines (97 loc) • 5.4 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Resource Type definition for AWS::AutoScaling::LifecycleHook
*/
export declare class LifecycleHook extends pulumi.CustomResource {
/**
* Get an existing LifecycleHook resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): LifecycleHook;
/**
* Returns true if the given object is an instance of LifecycleHook. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is LifecycleHook;
/**
* The name of the Auto Scaling group for the lifecycle hook.
*/
readonly autoScalingGroupName: pulumi.Output<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).
*/
readonly defaultResult: pulumi.Output<string | undefined>;
/**
* 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.
*/
readonly heartbeatTimeout: pulumi.Output<number | undefined>;
/**
* The name of the lifecycle hook.
*/
readonly lifecycleHookName: pulumi.Output<string | undefined>;
/**
* The instance state to which you want to attach the lifecycle hook.
*/
readonly lifecycleTransition: pulumi.Output<string>;
/**
* Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target.
*/
readonly notificationMetadata: pulumi.Output<string | undefined>;
/**
* 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.
*/
readonly notificationTargetArn: pulumi.Output<string | undefined>;
/**
* 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.
*/
readonly roleArn: pulumi.Output<string | undefined>;
/**
* Create a LifecycleHook resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: LifecycleHookArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a LifecycleHook resource.
*/
export interface LifecycleHookArgs {
/**
* The name of the Auto Scaling group for the lifecycle hook.
*/
autoScalingGroupName: pulumi.Input<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).
*/
defaultResult?: pulumi.Input<string>;
/**
* 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.
*/
heartbeatTimeout?: pulumi.Input<number>;
/**
* The name of the lifecycle hook.
*/
lifecycleHookName?: pulumi.Input<string>;
/**
* The instance state to which you want to attach the lifecycle hook.
*/
lifecycleTransition: pulumi.Input<string>;
/**
* Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target.
*/
notificationMetadata?: pulumi.Input<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.
*/
notificationTargetArn?: pulumi.Input<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.
*/
roleArn?: pulumi.Input<string>;
}