com.amazonaws.services.elasticmapreduce.model

Class SetTerminationProtectionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.elasticmapreduce.model.SetTerminationProtectionRequest

All Implemented Interfaces:

Serializable, Cloneable

public class SetTerminationProtectionRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the SetTerminationProtection operation.

SetTerminationProtection locks a job flow so the Amazon EC2 instances in the cluster cannot be terminated by user intervention, an API call, or in the event of a job-flow error. The cluster still terminates upon successful completion of the job flow. Calling SetTerminationProtection on a job flow is analogous to calling the Amazon EC2 DisableAPITermination API on all of the EC2 instances in a cluster.

SetTerminationProtection is used to prevent accidental termination of a job flow and to ensure that in the event of an error, the instances will persist so you can recover any data stored in their ephemeral instance storage.

To terminate a job flow that has been locked by setting SetTerminationProtection to true , you must first unlock the job flow by a subsequent call to SetTerminationProtection in which you set the value to false .

For more information, go to Protecting a Job Flow from Termination in the Amazon Elastic MapReduce Developer's Guide.

See Also:

AmazonElasticMapReduce.setTerminationProtection(SetTerminationProtectionRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
SetTerminationProtectionRequest()

Method Summary

Methods

Modifier and Type	Method and Description
SetTerminationProtectionRequest	clone()
boolean	equals(Object obj)
List<String>	getJobFlowIds() A list of strings that uniquely identify the job flows to protect.
Boolean	getTerminationProtected() A Boolean that indicates whether to protect the job flow and prevent the Amazon EC2 instances in the cluster from shutting down due to API calls, user intervention, or job-flow error.
int	hashCode()
Boolean	isTerminationProtected() A Boolean that indicates whether to protect the job flow and prevent the Amazon EC2 instances in the cluster from shutting down due to API calls, user intervention, or job-flow error.
void	setJobFlowIds(Collection<String> jobFlowIds) A list of strings that uniquely identify the job flows to protect.
void	setTerminationProtected(Boolean terminationProtected) A Boolean that indicates whether to protect the job flow and prevent the Amazon EC2 instances in the cluster from shutting down due to API calls, user intervention, or job-flow error.
String	toString() Returns a string representation of this object; useful for testing and debugging.
SetTerminationProtectionRequest	withJobFlowIds(Collection<String> jobFlowIds) A list of strings that uniquely identify the job flows to protect.
SetTerminationProtectionRequest	withJobFlowIds(String... jobFlowIds) A list of strings that uniquely identify the job flows to protect.
SetTerminationProtectionRequest	withTerminationProtected(Boolean terminationProtected) A Boolean that indicates whether to protect the job flow and prevent the Amazon EC2 instances in the cluster from shutting down due to API calls, user intervention, or job-flow error.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SetTerminationProtectionRequest

public SetTerminationProtectionRequest()

Method Detail

getJobFlowIds

public List<String> getJobFlowIds()

A list of strings that uniquely identify the job flows to protect. This identifier is returned by RunJobFlow and can also be obtained from DescribeJobFlows .

Returns:

A list of strings that uniquely identify the job flows to protect. This identifier is returned by RunJobFlow and can also be obtained from DescribeJobFlows .

setJobFlowIds

public void setJobFlowIds(Collection<String> jobFlowIds)

A list of strings that uniquely identify the job flows to protect. This identifier is returned by RunJobFlow and can also be obtained from DescribeJobFlows .

Parameters:

jobFlowIds - A list of strings that uniquely identify the job flows to protect. This identifier is returned by RunJobFlow and can also be obtained from DescribeJobFlows .

withJobFlowIds

public SetTerminationProtectionRequest withJobFlowIds(String... jobFlowIds)

A list of strings that uniquely identify the job flows to protect. This identifier is returned by RunJobFlow and can also be obtained from DescribeJobFlows .

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

Parameters:

jobFlowIds - A list of strings that uniquely identify the job flows to protect. This identifier is returned by RunJobFlow and can also be obtained from DescribeJobFlows .

Returns:

A reference to this updated object so that method calls can be chained together.

withJobFlowIds

public SetTerminationProtectionRequest withJobFlowIds(Collection<String> jobFlowIds)

A list of strings that uniquely identify the job flows to protect. This identifier is returned by RunJobFlow and can also be obtained from DescribeJobFlows .

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

Parameters:

jobFlowIds - A list of strings that uniquely identify the job flows to protect. This identifier is returned by RunJobFlow and can also be obtained from DescribeJobFlows .

Returns:

A reference to this updated object so that method calls can be chained together.

isTerminationProtected

public Boolean isTerminationProtected()

A Boolean that indicates whether to protect the job flow and prevent the Amazon EC2 instances in the cluster from shutting down due to API calls, user intervention, or job-flow error.

Returns:

A Boolean that indicates whether to protect the job flow and prevent the Amazon EC2 instances in the cluster from shutting down due to API calls, user intervention, or job-flow error.

setTerminationProtected

public void setTerminationProtected(Boolean terminationProtected)

A Boolean that indicates whether to protect the job flow and prevent the Amazon EC2 instances in the cluster from shutting down due to API calls, user intervention, or job-flow error.

Parameters:

terminationProtected - A Boolean that indicates whether to protect the job flow and prevent the Amazon EC2 instances in the cluster from shutting down due to API calls, user intervention, or job-flow error.

withTerminationProtected

public SetTerminationProtectionRequest withTerminationProtected(Boolean terminationProtected)

A Boolean that indicates whether to protect the job flow and prevent the Amazon EC2 instances in the cluster from shutting down due to API calls, user intervention, or job-flow error.

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

Parameters:

terminationProtected - A Boolean that indicates whether to protect the job flow and prevent the Amazon EC2 instances in the cluster from shutting down due to API calls, user intervention, or job-flow error.

Returns:

A reference to this updated object so that method calls can be chained together.

getTerminationProtected

public Boolean getTerminationProtected()

A Boolean that indicates whether to protect the job flow and prevent the Amazon EC2 instances in the cluster from shutting down due to API calls, user intervention, or job-flow error.

Returns:

A Boolean that indicates whether to protect the job flow and prevent the Amazon EC2 instances in the cluster from shutting down due to API calls, user intervention, or job-flow error.

toString

public String toString()

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

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public SetTerminationProtectionRequest clone()

Overrides:

clone in class AmazonWebServiceRequest