Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
SetTerminationProtection locks a cluster (job flow) so the 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 cluster is similar to calling the Amazon EC2 DisableAPITermination
API on all EC2 instances in a cluster.
SetTerminationProtection
is used to prevent accidental termination of a cluster and to ensure that in the event of an error, the instances persist so that you can recover any data stored in their ephemeral instance storage.
To terminate a cluster 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, seeManaging Cluster Termination in the Amazon EMR Management Guide .
Synopsis
- setTerminationProtection :: Bool -> SetTerminationProtection
- data SetTerminationProtection
- stpJobFlowIds :: Lens' SetTerminationProtection [Text]
- stpTerminationProtected :: Lens' SetTerminationProtection Bool
- setTerminationProtectionResponse :: SetTerminationProtectionResponse
- data SetTerminationProtectionResponse
Creating a Request
setTerminationProtection Source #
Creates a value of SetTerminationProtection
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
stpJobFlowIds
- A list of strings that uniquely identify the clusters to protect. This identifier is returned byRunJobFlow
and can also be obtained fromDescribeJobFlows
.stpTerminationProtected
- A Boolean that indicates whether to protect the cluster and prevent the Amazon EC2 instances in the cluster from shutting down due to API calls, user intervention, or job-flow error.
data SetTerminationProtection Source #
The input argument to the TerminationProtection
operation.
See: setTerminationProtection
smart constructor.
Instances
Request Lenses
stpJobFlowIds :: Lens' SetTerminationProtection [Text] Source #
A list of strings that uniquely identify the clusters to protect. This identifier is returned by RunJobFlow
and can also be obtained from DescribeJobFlows
.
stpTerminationProtected :: Lens' SetTerminationProtection Bool Source #
A Boolean that indicates whether to protect the cluster and prevent the Amazon EC2 instances in the cluster from shutting down due to API calls, user intervention, or job-flow error.
Destructuring the Response
setTerminationProtectionResponse :: SetTerminationProtectionResponse Source #
Creates a value of SetTerminationProtectionResponse
with the minimum fields required to make a request.
data SetTerminationProtectionResponse Source #
See: setTerminationProtectionResponse
smart constructor.