commonMain.aws.sdk.kotlin.services.autoscaling.model.LifecycleHookSpecification.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of autoscaling-jvm Show documentation
Show all versions of autoscaling-jvm Show documentation
The AWS SDK for Kotlin client for Auto Scaling
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!
package aws.sdk.kotlin.services.autoscaling.model
import aws.smithy.kotlin.runtime.SdkDsl
/**
* Describes information used to specify a lifecycle hook for an Auto Scaling group.
*
* For more information, see [Amazon EC2 Auto Scaling lifecycle hooks](https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html) in the *Amazon EC2 Auto Scaling User Guide*.
*/
public class LifecycleHookSpecification private constructor(builder: Builder) {
/**
* The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The default value is `ABANDON`.
*
* Valid values: `CONTINUE` | `ABANDON`
*/
public val defaultResult: kotlin.String? = builder.defaultResult
/**
* 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).
*/
public val heartbeatTimeout: kotlin.Int? = builder.heartbeatTimeout
/**
* The name of the lifecycle hook.
*/
public val lifecycleHookName: kotlin.String? = builder.lifecycleHookName
/**
* The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions.
* + To create a lifecycle hook for scale-out events, specify `autoscaling:EC2_INSTANCE_LAUNCHING`.
* + To create a lifecycle hook for scale-in events, specify `autoscaling:EC2_INSTANCE_TERMINATING`.
*/
public val lifecycleTransition: kotlin.String? = builder.lifecycleTransition
/**
* Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
*/
public val notificationMetadata: kotlin.String? = builder.notificationMetadata
/**
* 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. You can specify an Amazon SNS topic or an Amazon SQS queue.
*/
public val notificationTargetArn: kotlin.String? = builder.notificationTargetArn
/**
* The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. For information about creating this role, see [Prepare to add a lifecycle hook to your Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/prepare-for-lifecycle-notifications.html) in the *Amazon EC2 Auto Scaling User Guide*.
*
* Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue.
*/
public val roleArn: kotlin.String? = builder.roleArn
public companion object {
public operator fun invoke(block: Builder.() -> kotlin.Unit): aws.sdk.kotlin.services.autoscaling.model.LifecycleHookSpecification = Builder().apply(block).build()
}
override fun toString(): kotlin.String = buildString {
append("LifecycleHookSpecification(")
append("defaultResult=$defaultResult,")
append("heartbeatTimeout=$heartbeatTimeout,")
append("lifecycleHookName=$lifecycleHookName,")
append("lifecycleTransition=$lifecycleTransition,")
append("notificationMetadata=$notificationMetadata,")
append("notificationTargetArn=$notificationTargetArn,")
append("roleArn=$roleArn")
append(")")
}
override fun hashCode(): kotlin.Int {
var result = defaultResult?.hashCode() ?: 0
result = 31 * result + (heartbeatTimeout ?: 0)
result = 31 * result + (lifecycleHookName?.hashCode() ?: 0)
result = 31 * result + (lifecycleTransition?.hashCode() ?: 0)
result = 31 * result + (notificationMetadata?.hashCode() ?: 0)
result = 31 * result + (notificationTargetArn?.hashCode() ?: 0)
result = 31 * result + (roleArn?.hashCode() ?: 0)
return result
}
override fun equals(other: kotlin.Any?): kotlin.Boolean {
if (this === other) return true
if (other == null || this::class != other::class) return false
other as LifecycleHookSpecification
if (defaultResult != other.defaultResult) return false
if (heartbeatTimeout != other.heartbeatTimeout) return false
if (lifecycleHookName != other.lifecycleHookName) return false
if (lifecycleTransition != other.lifecycleTransition) return false
if (notificationMetadata != other.notificationMetadata) return false
if (notificationTargetArn != other.notificationTargetArn) return false
if (roleArn != other.roleArn) return false
return true
}
public inline fun copy(block: Builder.() -> kotlin.Unit = {}): aws.sdk.kotlin.services.autoscaling.model.LifecycleHookSpecification = Builder(this).apply(block).build()
@SdkDsl
public class Builder {
/**
* The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The default value is `ABANDON`.
*
* Valid values: `CONTINUE` | `ABANDON`
*/
public var defaultResult: kotlin.String? = null
/**
* 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).
*/
public var heartbeatTimeout: kotlin.Int? = null
/**
* The name of the lifecycle hook.
*/
public var lifecycleHookName: kotlin.String? = null
/**
* The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions.
* + To create a lifecycle hook for scale-out events, specify `autoscaling:EC2_INSTANCE_LAUNCHING`.
* + To create a lifecycle hook for scale-in events, specify `autoscaling:EC2_INSTANCE_TERMINATING`.
*/
public var lifecycleTransition: kotlin.String? = null
/**
* Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
*/
public var notificationMetadata: kotlin.String? = null
/**
* 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. You can specify an Amazon SNS topic or an Amazon SQS queue.
*/
public var notificationTargetArn: kotlin.String? = null
/**
* The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. For information about creating this role, see [Prepare to add a lifecycle hook to your Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/prepare-for-lifecycle-notifications.html) in the *Amazon EC2 Auto Scaling User Guide*.
*
* Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue.
*/
public var roleArn: kotlin.String? = null
@PublishedApi
internal constructor()
@PublishedApi
internal constructor(x: aws.sdk.kotlin.services.autoscaling.model.LifecycleHookSpecification) : this() {
this.defaultResult = x.defaultResult
this.heartbeatTimeout = x.heartbeatTimeout
this.lifecycleHookName = x.lifecycleHookName
this.lifecycleTransition = x.lifecycleTransition
this.notificationMetadata = x.notificationMetadata
this.notificationTargetArn = x.notificationTargetArn
this.roleArn = x.roleArn
}
@PublishedApi
internal fun build(): aws.sdk.kotlin.services.autoscaling.model.LifecycleHookSpecification = LifecycleHookSpecification(this)
internal fun correctErrors(): Builder {
return this
}
}
}