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.OpsWorksCM.DeleteServer

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Deletes the server and the underlying AWS CloudFormation stacks (including the server's EC2 instance). When you run this command, the server state is updated to DELETING. After the server is deleted, it is no longer returned by DescribeServer requests. If the AWS CloudFormation stack cannot be deleted, the server cannot be deleted.

This operation is asynchronous.

An InvalidStateException is thrown when a server deletion is already in progress. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

Synopsis

Creating a Request

data DeleteServer Source #

See: newDeleteServer smart constructor.

Constructors

DeleteServer'
Fields serverName :: Text The ID of the server to delete.

Instances

Instances details

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

newDeleteServer Source #

Arguments

:: Text	`DeleteServer`
-> DeleteServer

Create a value of DeleteServer 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:

DeleteServer, deleteServer_serverName - The ID of the server to delete.

Request Lenses

deleteServer_serverName :: Lens' DeleteServer Text Source #

The ID of the server to delete.

Destructuring the Response

data DeleteServerResponse Source #

See: newDeleteServerResponse smart constructor.

Constructors

DeleteServerResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DeleteServerResponse Source #
Instance details Defined in Amazonka.OpsWorksCM.DeleteServer Associated Types type Rep DeleteServerResponse :: Type -> Type # Methods from :: DeleteServerResponse -> Rep DeleteServerResponse x # to :: Rep DeleteServerResponse x -> DeleteServerResponse #
Read DeleteServerResponse Source #
Instance details Defined in Amazonka.OpsWorksCM.DeleteServer Methods readsPrec :: Int -> ReadS DeleteServerResponse # readList :: ReadS [DeleteServerResponse] # readPrec :: ReadPrec DeleteServerResponse # readListPrec :: ReadPrec [DeleteServerResponse] #
Show DeleteServerResponse Source #
Instance details Defined in Amazonka.OpsWorksCM.DeleteServer Methods showsPrec :: Int -> DeleteServerResponse -> ShowS # show :: DeleteServerResponse -> String # showList :: [DeleteServerResponse] -> ShowS #
NFData DeleteServerResponse Source #
Instance details Defined in Amazonka.OpsWorksCM.DeleteServer Methods rnf :: DeleteServerResponse -> () #
Eq DeleteServerResponse Source #
Instance details Defined in Amazonka.OpsWorksCM.DeleteServer Methods (==) :: DeleteServerResponse -> DeleteServerResponse -> Bool # (/=) :: DeleteServerResponse -> DeleteServerResponse -> Bool #
type Rep DeleteServerResponse Source #
Instance details Defined in Amazonka.OpsWorksCM.DeleteServer type Rep DeleteServerResponse = D1 ('MetaData "DeleteServerResponse" "Amazonka.OpsWorksCM.DeleteServer" "amazonka-opsworks-cm-2.0-4eRKS676FdFBzYMnhnI9o" 'False) (C1 ('MetaCons "DeleteServerResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteServerResponse Source #

Arguments

:: Int	`$sel:httpStatus:DeleteServerResponse'`
-> DeleteServerResponse

Create a value of DeleteServerResponse 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:httpStatus:DeleteServerResponse', deleteServerResponse_httpStatus - The response's http status code.

Response Lenses

deleteServerResponse_httpStatus :: Lens' DeleteServerResponse Int Source #

The response's http status code.