Package software.amazon.awssdk.services.autoscaling.model

Interface LifecycleHook.Builder

    • Method Detail

      • lifecycleHookName

        LifecycleHook.Builder lifecycleHookName​(String lifecycleHookName)

        The name of the lifecycle hook.

        Parameters:
        lifecycleHookName - The name of the lifecycle hook.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • autoScalingGroupName

        LifecycleHook.Builder autoScalingGroupName​(String autoScalingGroupName)

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

        Parameters:
        autoScalingGroupName - The name of the Auto Scaling group for the lifecycle hook.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • lifecycleTransition

        LifecycleHook.Builder lifecycleTransition​(String lifecycleTransition)

        The lifecycle transition.

        Valid values: autoscaling:EC2_INSTANCE_LAUNCHING | autoscaling:EC2_INSTANCE_TERMINATING

        Parameters:
        lifecycleTransition - The lifecycle transition.

        Valid values: autoscaling:EC2_INSTANCE_LAUNCHING | autoscaling:EC2_INSTANCE_TERMINATING

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • notificationTargetARN

        LifecycleHook.Builder notificationTargetARN​(String notificationTargetARN)

        The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a wait state for the lifecycle hook.

        Parameters:
        notificationTargetARN - The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a wait state for the lifecycle hook.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • roleARN

        LifecycleHook.Builder roleARN​(String roleARN)

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

        Parameters:
        roleARN - The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target (an Amazon SNS topic or an Amazon SQS queue).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • notificationMetadata

        LifecycleHook.Builder notificationMetadata​(String notificationMetadata)

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

        Parameters:
        notificationMetadata - Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • heartbeatTimeout

        LifecycleHook.Builder heartbeatTimeout​(Integer heartbeatTimeout)

        The maximum time, in seconds, that can elapse before the lifecycle hook times out. If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult property.

        Parameters:
        heartbeatTimeout - The maximum time, in seconds, that can elapse before the lifecycle hook times out. If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult property.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • globalTimeout

        LifecycleHook.Builder globalTimeout​(Integer globalTimeout)

        The maximum time, in seconds, that an instance can remain in a wait state. The maximum is 172800 seconds (48 hours) or 100 times HeartbeatTimeout, whichever is smaller.

        Parameters:
        globalTimeout - The maximum time, in seconds, that an instance can remain in a wait state. The maximum is 172800 seconds (48 hours) or 100 times HeartbeatTimeout, whichever is smaller.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • defaultResult

        LifecycleHook.Builder defaultResult​(String defaultResult)

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

        Valid values: CONTINUE | ABANDON

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

        Valid values: CONTINUE | ABANDON

        Returns:
        Returns a reference to this object so that method calls can be chained together.