Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.EMR.SetTerminationProtection

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

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.

Creating a Request

data SetTerminationProtection Source #

The input argument to the TerminationProtection operation.

See: newSetTerminationProtection smart constructor.

Constructors

SetTerminationProtection'
Fields jobFlowIds :: [Text] A list of strings that uniquely identify the clusters to protect. This identifier is returned by RunJobFlow and can also be obtained from DescribeJobFlows . terminationProtected :: Bool 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.

Instances

Instances details

ToJSON SetTerminationProtection Source #
Instance details Defined in Amazonka.EMR.SetTerminationProtection Methods toJSON :: SetTerminationProtection -> Value # toEncoding :: SetTerminationProtection -> Encoding # toJSONList :: [SetTerminationProtection] -> Value # toEncodingList :: [SetTerminationProtection] -> Encoding #
ToHeaders SetTerminationProtection Source #
Instance details Defined in Amazonka.EMR.SetTerminationProtection Methods toHeaders :: SetTerminationProtection -> [Header] #
ToPath SetTerminationProtection Source #
Instance details Defined in Amazonka.EMR.SetTerminationProtection Methods toPath :: SetTerminationProtection -> ByteString #
ToQuery SetTerminationProtection Source #
Instance details Defined in Amazonka.EMR.SetTerminationProtection Methods toQuery :: SetTerminationProtection -> QueryString #
AWSRequest SetTerminationProtection Source #
Instance details Defined in Amazonka.EMR.SetTerminationProtection Associated Types type AWSResponse SetTerminationProtection # Methods request :: (Service -> Service) -> SetTerminationProtection -> Request SetTerminationProtection # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy SetTerminationProtection -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SetTerminationProtection))) #
Generic SetTerminationProtection Source #
Instance details Defined in Amazonka.EMR.SetTerminationProtection Associated Types type Rep SetTerminationProtection :: Type -> Type # Methods from :: SetTerminationProtection -> Rep SetTerminationProtection x # to :: Rep SetTerminationProtection x -> SetTerminationProtection #
Read SetTerminationProtection Source #
Instance details Defined in Amazonka.EMR.SetTerminationProtection Methods readsPrec :: Int -> ReadS SetTerminationProtection # readList :: ReadS [SetTerminationProtection] # readPrec :: ReadPrec SetTerminationProtection # readListPrec :: ReadPrec [SetTerminationProtection] #
Show SetTerminationProtection Source #
Instance details Defined in Amazonka.EMR.SetTerminationProtection Methods showsPrec :: Int -> SetTerminationProtection -> ShowS # show :: SetTerminationProtection -> String # showList :: [SetTerminationProtection] -> ShowS #
NFData SetTerminationProtection Source #
Instance details Defined in Amazonka.EMR.SetTerminationProtection Methods rnf :: SetTerminationProtection -> () #
Eq SetTerminationProtection Source #
Instance details Defined in Amazonka.EMR.SetTerminationProtection Methods (==) :: SetTerminationProtection -> SetTerminationProtection -> Bool # (/=) :: SetTerminationProtection -> SetTerminationProtection -> Bool #
Hashable SetTerminationProtection Source #
Instance details Defined in Amazonka.EMR.SetTerminationProtection Methods hashWithSalt :: Int -> SetTerminationProtection -> Int # hash :: SetTerminationProtection -> Int #
type AWSResponse SetTerminationProtection Source #
Instance details Defined in Amazonka.EMR.SetTerminationProtection type AWSResponse SetTerminationProtection = SetTerminationProtectionResponse
type Rep SetTerminationProtection Source #
Instance details Defined in Amazonka.EMR.SetTerminationProtection type Rep SetTerminationProtection = D1 ('MetaData "SetTerminationProtection" "Amazonka.EMR.SetTerminationProtection" "amazonka-emr-2.0-B3cWhP6sdymF3IBUMdPGcd" 'False) (C1 ('MetaCons "SetTerminationProtection'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobFlowIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]) :*: S1 ('MetaSel ('Just "terminationProtected") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))

newSetTerminationProtection Source #

Arguments

:: Bool	`SetTerminationProtection`
-> SetTerminationProtection

Create a value of SetTerminationProtection with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobFlowIds:SetTerminationProtection', setTerminationProtection_jobFlowIds - A list of strings that uniquely identify the clusters to protect. This identifier is returned by RunJobFlow and can also be obtained from DescribeJobFlows .

SetTerminationProtection, setTerminationProtection_terminationProtected - 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.

Request Lenses

setTerminationProtection_jobFlowIds :: 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 .

setTerminationProtection_terminationProtected :: 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

data SetTerminationProtectionResponse Source #

See: newSetTerminationProtectionResponse smart constructor.

Constructors

SetTerminationProtectionResponse'

Instances

Instances details

Generic SetTerminationProtectionResponse Source #
Instance details Defined in Amazonka.EMR.SetTerminationProtection Associated Types type Rep SetTerminationProtectionResponse :: Type -> Type # Methods from :: SetTerminationProtectionResponse -> Rep SetTerminationProtectionResponse x # to :: Rep SetTerminationProtectionResponse x -> SetTerminationProtectionResponse #
Read SetTerminationProtectionResponse Source #
Instance details Defined in Amazonka.EMR.SetTerminationProtection Methods readsPrec :: Int -> ReadS SetTerminationProtectionResponse # readList :: ReadS [SetTerminationProtectionResponse] # readPrec :: ReadPrec SetTerminationProtectionResponse # readListPrec :: ReadPrec [SetTerminationProtectionResponse] #
Show SetTerminationProtectionResponse Source #
Instance details Defined in Amazonka.EMR.SetTerminationProtection Methods showsPrec :: Int -> SetTerminationProtectionResponse -> ShowS # show :: SetTerminationProtectionResponse -> String # showList :: [SetTerminationProtectionResponse] -> ShowS #
NFData SetTerminationProtectionResponse Source #
Instance details Defined in Amazonka.EMR.SetTerminationProtection Methods rnf :: SetTerminationProtectionResponse -> () #
Eq SetTerminationProtectionResponse Source #
Instance details Defined in Amazonka.EMR.SetTerminationProtection Methods (==) :: SetTerminationProtectionResponse -> SetTerminationProtectionResponse -> Bool # (/=) :: SetTerminationProtectionResponse -> SetTerminationProtectionResponse -> Bool #
type Rep SetTerminationProtectionResponse Source #
Instance details Defined in Amazonka.EMR.SetTerminationProtection type Rep SetTerminationProtectionResponse = D1 ('MetaData "SetTerminationProtectionResponse" "Amazonka.EMR.SetTerminationProtection" "amazonka-emr-2.0-B3cWhP6sdymF3IBUMdPGcd" 'False) (C1 ('MetaCons "SetTerminationProtectionResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newSetTerminationProtectionResponse :: SetTerminationProtectionResponse Source #

Create a value of SetTerminationProtectionResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.