Class PutLifecycleHookRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
The name of the Auto Scaling group to which you want to assign the lifecycle hook.Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs.The amount of time, in seconds, that can elapse before the lifecycle hook times out.The name of the lifecycle hook.The instance state to which you want to attach the lifecycle hook.Contains additional information that you want to include any time Auto Scaling sends a message to the notification target.The ARN of the notification target that Auto Scaling will use to notify you when an instance is in the transition state for the lifecycle hook.The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.int
hashCode()
void
setAutoScalingGroupName
(String autoScalingGroupName) The name of the Auto Scaling group to which you want to assign the lifecycle hook.void
setDefaultResult
(String defaultResult) Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs.void
setHeartbeatTimeout
(Integer heartbeatTimeout) The amount of time, in seconds, that can elapse before the lifecycle hook times out.void
setLifecycleHookName
(String lifecycleHookName) The name of the lifecycle hook.void
setLifecycleTransition
(String lifecycleTransition) The instance state to which you want to attach the lifecycle hook.void
setNotificationMetadata
(String notificationMetadata) Contains additional information that you want to include any time Auto Scaling sends a message to the notification target.void
setNotificationTargetARN
(String notificationTargetARN) The ARN of the notification target that Auto Scaling will use to notify you when an instance is in the transition state for the lifecycle hook.void
setRoleARN
(String roleARN) The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.toString()
Returns a string representation of this object; useful for testing and debugging.withAutoScalingGroupName
(String autoScalingGroupName) The name of the Auto Scaling group to which you want to assign the lifecycle hook.withDefaultResult
(String defaultResult) Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs.withHeartbeatTimeout
(Integer heartbeatTimeout) The amount of time, in seconds, that can elapse before the lifecycle hook times out.withLifecycleHookName
(String lifecycleHookName) The name of the lifecycle hook.withLifecycleTransition
(String lifecycleTransition) The instance state to which you want to attach the lifecycle hook.withNotificationMetadata
(String notificationMetadata) Contains additional information that you want to include any time Auto Scaling sends a message to the notification target.withNotificationTargetARN
(String notificationTargetARN) The ARN of the notification target that Auto Scaling will use to notify you when an instance is in the transition state for the lifecycle hook.withRoleARN
(String roleARN) The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
PutLifecycleHookRequest
public PutLifecycleHookRequest()
-
-
Method Details
-
setLifecycleHookName
The name of the lifecycle hook.
- Parameters:
lifecycleHookName
- The name of the lifecycle hook.
-
getLifecycleHookName
The name of the lifecycle hook.
- Returns:
- The name of the lifecycle hook.
-
withLifecycleHookName
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.
-
setAutoScalingGroupName
The name of the Auto Scaling group to which you want to assign the lifecycle hook.
- Parameters:
autoScalingGroupName
- The name of the Auto Scaling group to which you want to assign the lifecycle hook.
-
getAutoScalingGroupName
The name of the Auto Scaling group to which you want to assign the lifecycle hook.
- Returns:
- The name of the Auto Scaling group to which you want to assign the lifecycle hook.
-
withAutoScalingGroupName
The name of the Auto Scaling group to which you want to assign the lifecycle hook.
- Parameters:
autoScalingGroupName
- The name of the Auto Scaling group to which you want to assign the lifecycle hook.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setLifecycleTransition
The instance state to which you want to attach the lifecycle hook. For a list of lifecycle hook types, see DescribeLifecycleHookTypes.
This parameter is required for new lifecycle hooks, but optional when updating existing hooks.
- Parameters:
lifecycleTransition
- The instance state to which you want to attach the lifecycle hook. For a list of lifecycle hook types, see DescribeLifecycleHookTypes.This parameter is required for new lifecycle hooks, but optional when updating existing hooks.
-
getLifecycleTransition
The instance state to which you want to attach the lifecycle hook. For a list of lifecycle hook types, see DescribeLifecycleHookTypes.
This parameter is required for new lifecycle hooks, but optional when updating existing hooks.
- Returns:
- The instance state to which you want to attach the lifecycle
hook. For a list of lifecycle hook types, see
DescribeLifecycleHookTypes.
This parameter is required for new lifecycle hooks, but optional when updating existing hooks.
-
withLifecycleTransition
The instance state to which you want to attach the lifecycle hook. For a list of lifecycle hook types, see DescribeLifecycleHookTypes.
This parameter is required for new lifecycle hooks, but optional when updating existing hooks.
- Parameters:
lifecycleTransition
- The instance state to which you want to attach the lifecycle hook. For a list of lifecycle hook types, see DescribeLifecycleHookTypes.This parameter is required for new lifecycle hooks, but optional when updating existing hooks.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setRoleARN
The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.
This parameter is required for new lifecycle hooks, but optional when updating existing hooks.
- Parameters:
roleARN
- The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.This parameter is required for new lifecycle hooks, but optional when updating existing hooks.
-
getRoleARN
The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.
This parameter is required for new lifecycle hooks, but optional when updating existing hooks.
- Returns:
- The ARN of the IAM role that allows the Auto Scaling group to
publish to the specified notification target.
This parameter is required for new lifecycle hooks, but optional when updating existing hooks.
-
withRoleARN
The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.
This parameter is required for new lifecycle hooks, but optional when updating existing hooks.
- Parameters:
roleARN
- The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.This parameter is required for new lifecycle hooks, but optional when updating existing hooks.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setNotificationTargetARN
The ARN of the notification target that Auto Scaling will use to notify you when an instance is in the transition state for the lifecycle hook. This target can be either an SQS queue or an SNS topic. If you specify an empty string, this overrides the current ARN.
The notification messages sent to the target include the following information:
- AutoScalingGroupName. The name of the Auto Scaling group.
- AccountId. The AWS account ID.
- LifecycleTransition. The lifecycle hook type.
- LifecycleActionToken. The lifecycle action token.
- EC2InstanceId. The EC2 instance ID.
- LifecycleHookName. The name of the lifecycle hook.
- NotificationMetadata. User-defined information.
This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key/value pair format when sending notifications to an Amazon SNS topic.
When you specify a notification target, Auto Scaling sends it a test message. Test messages contains the following additional key/value pair:
"Event": "autoscaling:TEST_NOTIFICATION"
.- Parameters:
notificationTargetARN
- The ARN of the notification target that Auto Scaling will use to notify you when an instance is in the transition state for the lifecycle hook. This target can be either an SQS queue or an SNS topic. If you specify an empty string, this overrides the current ARN.The notification messages sent to the target include the following information:
- AutoScalingGroupName. The name of the Auto Scaling group.
- AccountId. The AWS account ID.
- LifecycleTransition. The lifecycle hook type.
- LifecycleActionToken. The lifecycle action token.
- EC2InstanceId. The EC2 instance ID.
- LifecycleHookName. The name of the lifecycle hook.
- NotificationMetadata. User-defined information.
This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key/value pair format when sending notifications to an Amazon SNS topic.
When you specify a notification target, Auto Scaling sends it a test message. Test messages contains the following additional key/value pair:
"Event": "autoscaling:TEST_NOTIFICATION"
.
-
getNotificationTargetARN
The ARN of the notification target that Auto Scaling will use to notify you when an instance is in the transition state for the lifecycle hook. This target can be either an SQS queue or an SNS topic. If you specify an empty string, this overrides the current ARN.
The notification messages sent to the target include the following information:
- AutoScalingGroupName. The name of the Auto Scaling group.
- AccountId. The AWS account ID.
- LifecycleTransition. The lifecycle hook type.
- LifecycleActionToken. The lifecycle action token.
- EC2InstanceId. The EC2 instance ID.
- LifecycleHookName. The name of the lifecycle hook.
- NotificationMetadata. User-defined information.
This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key/value pair format when sending notifications to an Amazon SNS topic.
When you specify a notification target, Auto Scaling sends it a test message. Test messages contains the following additional key/value pair:
"Event": "autoscaling:TEST_NOTIFICATION"
.- Returns:
- The ARN of the notification target that Auto Scaling will use to
notify you when an instance is in the transition state for the
lifecycle hook. This target can be either an SQS queue or an SNS
topic. If you specify an empty string, this overrides the current
ARN.
The notification messages sent to the target include the following information:
- AutoScalingGroupName. The name of the Auto Scaling group.
- AccountId. The AWS account ID.
- LifecycleTransition. The lifecycle hook type.
- LifecycleActionToken. The lifecycle action token.
- EC2InstanceId. The EC2 instance ID.
- LifecycleHookName. The name of the lifecycle hook.
- NotificationMetadata. User-defined information.
This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key/value pair format when sending notifications to an Amazon SNS topic.
When you specify a notification target, Auto Scaling sends it a test message. Test messages contains the following additional key/value pair:
"Event": "autoscaling:TEST_NOTIFICATION"
.
-
withNotificationTargetARN
The ARN of the notification target that Auto Scaling will use to notify you when an instance is in the transition state for the lifecycle hook. This target can be either an SQS queue or an SNS topic. If you specify an empty string, this overrides the current ARN.
The notification messages sent to the target include the following information:
- AutoScalingGroupName. The name of the Auto Scaling group.
- AccountId. The AWS account ID.
- LifecycleTransition. The lifecycle hook type.
- LifecycleActionToken. The lifecycle action token.
- EC2InstanceId. The EC2 instance ID.
- LifecycleHookName. The name of the lifecycle hook.
- NotificationMetadata. User-defined information.
This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key/value pair format when sending notifications to an Amazon SNS topic.
When you specify a notification target, Auto Scaling sends it a test message. Test messages contains the following additional key/value pair:
"Event": "autoscaling:TEST_NOTIFICATION"
.- Parameters:
notificationTargetARN
- The ARN of the notification target that Auto Scaling will use to notify you when an instance is in the transition state for the lifecycle hook. This target can be either an SQS queue or an SNS topic. If you specify an empty string, this overrides the current ARN.The notification messages sent to the target include the following information:
- AutoScalingGroupName. The name of the Auto Scaling group.
- AccountId. The AWS account ID.
- LifecycleTransition. The lifecycle hook type.
- LifecycleActionToken. The lifecycle action token.
- EC2InstanceId. The EC2 instance ID.
- LifecycleHookName. The name of the lifecycle hook.
- NotificationMetadata. User-defined information.
This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key/value pair format when sending notifications to an Amazon SNS topic.
When you specify a notification target, Auto Scaling sends it a test message. Test messages contains the following additional key/value pair:
"Event": "autoscaling:TEST_NOTIFICATION"
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setNotificationMetadata
Contains additional information that you want to include any time Auto Scaling sends a message to the notification target.
- Parameters:
notificationMetadata
- Contains additional information that you want to include any time Auto Scaling sends a message to the notification target.
-
getNotificationMetadata
Contains additional information that you want to include any time Auto Scaling sends a message to the notification target.
- Returns:
- Contains additional information that you want to include any time Auto Scaling sends a message to the notification target.
-
withNotificationMetadata
Contains additional information that you want to include any time Auto Scaling sends a message to the notification target.
- Parameters:
notificationMetadata
- Contains additional information that you want to include any time Auto Scaling sends a message to the notification target.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setHeartbeatTimeout
The amount of time, in seconds, that can elapse before the lifecycle hook times out. When the lifecycle hook times out, Auto Scaling performs the default action. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat. The default is 3600 seconds (1 hour).
- Parameters:
heartbeatTimeout
- The amount of time, in seconds, that can elapse before the lifecycle hook times out. When the lifecycle hook times out, Auto Scaling performs the default action. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat. The default is 3600 seconds (1 hour).
-
getHeartbeatTimeout
The amount of time, in seconds, that can elapse before the lifecycle hook times out. When the lifecycle hook times out, Auto Scaling performs the default action. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat. The default is 3600 seconds (1 hour).
- Returns:
- The amount of time, in seconds, that can elapse before the lifecycle hook times out. When the lifecycle hook times out, Auto Scaling performs the default action. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat. The default is 3600 seconds (1 hour).
-
withHeartbeatTimeout
The amount of time, in seconds, that can elapse before the lifecycle hook times out. When the lifecycle hook times out, Auto Scaling performs the default action. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat. The default is 3600 seconds (1 hour).
- Parameters:
heartbeatTimeout
- The amount of time, in seconds, that can elapse before the lifecycle hook times out. When the lifecycle hook times out, Auto Scaling performs the default action. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat. The default is 3600 seconds (1 hour).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDefaultResult
Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. This parameter can be either
CONTINUE
orABANDON
. The default value isABANDON
.- Parameters:
defaultResult
- Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. This parameter can be eitherCONTINUE
orABANDON
. The default value isABANDON
.
-
getDefaultResult
Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. This parameter can be either
CONTINUE
orABANDON
. The default value isABANDON
.- Returns:
- Defines the action the Auto Scaling group should take when the
lifecycle hook timeout elapses or if an unexpected failure
occurs. This parameter can be either
CONTINUE
orABANDON
. The default value isABANDON
.
-
withDefaultResult
Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. This parameter can be either
CONTINUE
orABANDON
. The default value isABANDON
.- Parameters:
defaultResult
- Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. This parameter can be eitherCONTINUE
orABANDON
. The default value isABANDON
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-