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.OpsWorks.StopInstance

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Stops a specified instance. When you stop a standard instance, the data disappears and must be reinstalled when you restart the instance. You can stop an Amazon EBS-backed instance without losing data. For more information, see Starting, Stopping, and Rebooting Instances.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Synopsis

data StopInstance = StopInstance' {
- force :: Maybe Bool
- instanceId :: Text
}
newStopInstance :: Text -> StopInstance
stopInstance_force :: Lens' StopInstance (Maybe Bool)
stopInstance_instanceId :: Lens' StopInstance Text
data StopInstanceResponse = StopInstanceResponse' {
}
newStopInstanceResponse :: StopInstanceResponse

Creating a Request

data StopInstance Source #

See: newStopInstance smart constructor.

Constructors

StopInstance'

Fields

force :: Maybe Bool
Specifies whether to force an instance to stop. If the instance's root device type is ebs, or EBS-backed, adding the Force parameter to the StopInstances API call disassociates the AWS OpsWorks Stacks instance from EC2, and forces deletion of only the OpsWorks Stacks instance. You must also delete the formerly-associated instance in EC2 after troubleshooting and replacing the AWS OpsWorks Stacks instance with a new one.
instanceId :: Text
The instance ID.

Instances

Instances details

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

newStopInstance Source #

Arguments

:: Text	`StopInstance`
-> StopInstance

Create a value of StopInstance 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:force:StopInstance', stopInstance_force - Specifies whether to force an instance to stop. If the instance's root device type is ebs, or EBS-backed, adding the Force parameter to the StopInstances API call disassociates the AWS OpsWorks Stacks instance from EC2, and forces deletion of only the OpsWorks Stacks instance. You must also delete the formerly-associated instance in EC2 after troubleshooting and replacing the AWS OpsWorks Stacks instance with a new one.

StopInstance, stopInstance_instanceId - The instance ID.

Request Lenses

stopInstance_force :: Lens' StopInstance (Maybe Bool) Source #

Specifies whether to force an instance to stop. If the instance's root device type is ebs, or EBS-backed, adding the Force parameter to the StopInstances API call disassociates the AWS OpsWorks Stacks instance from EC2, and forces deletion of only the OpsWorks Stacks instance. You must also delete the formerly-associated instance in EC2 after troubleshooting and replacing the AWS OpsWorks Stacks instance with a new one.

stopInstance_instanceId :: Lens' StopInstance Text Source #

The instance ID.

Destructuring the Response

data StopInstanceResponse Source #

See: newStopInstanceResponse smart constructor.

Constructors

StopInstanceResponse'

Instances

Instances details

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

newStopInstanceResponse :: StopInstanceResponse Source #

Create a value of StopInstanceResponse with all optional fields omitted.

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