Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
   * 
   * Licensed under the Apache License, Version 2.0 (the "License").
   * You may not use this file except in compliance with the License.
   * A copy of the License is located at
   * 
   *  http://aws.amazon.com/apache2.0
   * 
  * or in the "license" file accompanying this file. This file is distributed
  * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
  * express or implied. See the License for the specific language governing
  * permissions and limitations under the License.
  */
 package com.amazonaws.services.autoscaling.model;
 
 
Container for the parameters to the RecordLifecycleActionHeartbeat operation.

Records a heartbeat for the lifecycle action associated with a specific token. This extends the timeout by the length of time defined by the HeartbeatTimeout parameter of PutLifecycleHook.

This operation is a part of the basic sequence for adding a lifecycle hook to an Auto Scaling group:

  1. Create a notification target. A target can be either an Amazon SQS queue or an Amazon SNS topic.
  2. Create an IAM role. This role allows Auto Scaling to publish lifecycle notifications to the designated SQS queue or SNS topic.
  3. Create the lifecycle hook. You can create a hook that acts when instances launch or when instances terminate.
  4. If necessary, record the lifecycle action heartbeat to keep the instance in a pending state.
  5. Complete the lifecycle action.

For more information, see Auto Scaling Pending State and Auto Scaling Terminating State in the Auto Scaling Developer Guide .

 
 public class RecordLifecycleActionHeartbeatRequest extends AmazonWebServiceRequest implements SerializableCloneable {

    
The name of the lifecycle hook.

Constraints:
Length: 1 - 255
Pattern: [A-Za-z0-9\-_\/]+

 
     private String lifecycleHookName;

    
The name of the Auto Scaling group for the hook.

Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

 
     private String autoScalingGroupName;

    
A token that uniquely identifies a specific lifecycle action associated with an instance. Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook.

Constraints:
Length: 36 - 36

 
     private String lifecycleActionToken;

    
The name of the lifecycle hook.

Constraints:
Length: 1 - 255
Pattern: [A-Za-z0-9\-_\/]+

Returns:
The name of the lifecycle hook.
 
     public String getLifecycleHookName() {
         return ;
     }
    
    
The name of the lifecycle hook.

Constraints:
Length: 1 - 255
Pattern: [A-Za-z0-9\-_\/]+

Parameters:
lifecycleHookName The name of the lifecycle hook.
    public void setLifecycleHookName(String lifecycleHookName) {
        this. = lifecycleHookName;
    }
    
    
The name of the lifecycle hook.

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

Constraints:
Length: 1 - 255
Pattern: [A-Za-z0-9\-_\/]+

Parameters:
lifecycleHookName The name of the lifecycle hook.
Returns:
A reference to this updated object so that method calls can be chained together.
        this. = lifecycleHookName;
        return this;
    }

    
The name of the Auto Scaling group for the hook.

Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Returns:
The name of the Auto Scaling group for the hook.
    public String getAutoScalingGroupName() {
        return ;
    }
    
    
The name of the Auto Scaling group for the hook.

Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:
autoScalingGroupName The name of the Auto Scaling group for the hook.
    public void setAutoScalingGroupName(String autoScalingGroupName) {
        this. = autoScalingGroupName;
    }
    
    
The name of the Auto Scaling group for the hook.

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

Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:
autoScalingGroupName The name of the Auto Scaling group for the hook.
Returns:
A reference to this updated object so that method calls can be chained together.
        this. = autoScalingGroupName;
        return this;
    }

    
A token that uniquely identifies a specific lifecycle action associated with an instance. Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook.

Constraints:
Length: 36 - 36

Returns:
A token that uniquely identifies a specific lifecycle action associated with an instance. Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook.
    public String getLifecycleActionToken() {
        return ;
    }
    
    
A token that uniquely identifies a specific lifecycle action associated with an instance. Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook.

Constraints:
Length: 36 - 36

Parameters:
lifecycleActionToken A token that uniquely identifies a specific lifecycle action associated with an instance. Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook.
    public void setLifecycleActionToken(String lifecycleActionToken) {
        this. = lifecycleActionToken;
    }
    
    
A token that uniquely identifies a specific lifecycle action associated with an instance. Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook.

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

Constraints:
Length: 36 - 36

Parameters:
lifecycleActionToken A token that uniquely identifies a specific lifecycle action associated with an instance. Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook.
Returns:
A reference to this updated object so that method calls can be chained together.
        this. = lifecycleActionToken;
        return this;
    }

    
Returns a string representation of this object; useful for testing and debugging.

Returns:
A string representation of this object.
See also:
java.lang.Object.toString()
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("{");
        if (getLifecycleHookName() != nullsb.append("LifecycleHookName: " + getLifecycleHookName() + ",");
        if (getAutoScalingGroupName() != nullsb.append("AutoScalingGroupName: " + getAutoScalingGroupName() + ",");
        if (getLifecycleActionToken() != nullsb.append("LifecycleActionToken: " + getLifecycleActionToken() );
        sb.append("}");
        return sb.toString();
    }
    
    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;
        
        hashCode = prime * hashCode + ((getLifecycleHookName() == null) ? 0 : getLifecycleHookName().hashCode()); 
        hashCode = prime * hashCode + ((getAutoScalingGroupName() == null) ? 0 : getAutoScalingGroupName().hashCode()); 
        hashCode = prime * hashCode + ((getLifecycleActionToken() == null) ? 0 : getLifecycleActionToken().hashCode()); 
        return hashCode;
    }
    
    @Override
    public boolean equals(Object obj) {
        if (this == objreturn true;
        if (obj == nullreturn false;
        if (obj instanceof RecordLifecycleActionHeartbeatRequest == falsereturn false;
        
        if (other.getLifecycleHookName() == null ^ this.getLifecycleHookName() == nullreturn false;
        if (other.getLifecycleHookName() != null && other.getLifecycleHookName().equals(this.getLifecycleHookName()) == falsereturn false
        if (other.getAutoScalingGroupName() == null ^ this.getAutoScalingGroupName() == nullreturn false;
        if (other.getAutoScalingGroupName() != null && other.getAutoScalingGroupName().equals(this.getAutoScalingGroupName()) == falsereturn false
        if (other.getLifecycleActionToken() == null ^ this.getLifecycleActionToken() == nullreturn false;
        if (other.getLifecycleActionToken() != null && other.getLifecycleActionToken().equals(this.getLifecycleActionToken()) == falsereturn false
        return true;
    }
    
    @Override
        
            return (RecordLifecycleActionHeartbeatRequestsuper.clone();
    }
}
    
New to GrepCode? Check out our FAQ X