libZSservicesZSamazonka-opsworks-cmZSamazonka-opsworks-cm
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.OpsWorksCM.DisassociateNode

Description

Disassociates a node from an AWS OpsWorks CM server, and removes the node from the server's managed nodes. After a node is disassociated, the node key pair is no longer valid for accessing the configuration manager's API. For more information about how to associate a node, see AssociateNode.

A node can can only be disassociated from a server that is in a HEALTHY state. Otherwise, an InvalidStateException is thrown. 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 DisassociateNode Source #

See: newDisassociateNode smart constructor.

Constructors

DisassociateNode' 

Fields

  • engineAttributes :: Maybe [EngineAttribute]

    Engine attributes that are used for disassociating the node. No attributes are required for Puppet.

    Attributes required in a DisassociateNode request for Chef

    • CHEF_ORGANIZATION: The Chef organization with which the node was associated. By default only one organization named default can exist.
  • serverName :: Text

    The name of the server from which to disassociate the node.

  • nodeName :: Text

    The name of the client node.

Instances

Instances details
Eq DisassociateNode Source # 
Instance details

Defined in Amazonka.OpsWorksCM.DisassociateNode

Methods

(==) :: DisassociateNode -> DisassociateNode -> Bool #

(/=) :: DisassociateNode -> DisassociateNode -> Bool #

Show DisassociateNode Source # 
Instance details

Defined in Amazonka.OpsWorksCM.DisassociateNode

Methods

showsPrec :: Int -> DisassociateNode -> ShowS #

show :: DisassociateNode -> String #

showList :: [DisassociateNode] -> ShowS #

Generic DisassociateNode Source # 
Instance details

Defined in Amazonka.OpsWorksCM.DisassociateNode

Associated Types

type Rep DisassociateNode :: Type -> Type #

Methods

from :: DisassociateNode -> Rep DisassociateNode x #

to :: Rep DisassociateNode x -> DisassociateNode #

NFData DisassociateNode Source # 
Instance details

Defined in Amazonka.OpsWorksCM.DisassociateNode

Methods

rnf :: DisassociateNode -> () #

Hashable DisassociateNode Source # 
Instance details

Defined in Amazonka.OpsWorksCM.DisassociateNode

Methods

hashWithSalt :: Int -> DisassociateNode -> Int #

hash :: DisassociateNode -> Int #

ToJSON DisassociateNode Source # 
Instance details

Defined in Amazonka.OpsWorksCM.DisassociateNode

Methods

toJSON :: DisassociateNode -> Value #

toEncoding :: DisassociateNode -> Encoding #

toJSONList :: [DisassociateNode] -> Value #

toEncodingList :: [DisassociateNode] -> Encoding #

AWSRequest DisassociateNode Source # 
Instance details

Defined in Amazonka.OpsWorksCM.DisassociateNode

Associated Types

type AWSResponse DisassociateNode #

Methods

request :: DisassociateNode -> Request DisassociateNode #

response :: MonadResource m => Logger -> Service -> Proxy DisassociateNode -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DisassociateNode))) #

ToHeaders DisassociateNode Source # 
Instance details

Defined in Amazonka.OpsWorksCM.DisassociateNode

Methods

toHeaders :: DisassociateNode -> [Header] #

ToPath DisassociateNode Source # 
Instance details

Defined in Amazonka.OpsWorksCM.DisassociateNode

Methods

toPath :: DisassociateNode -> ByteString #

ToQuery DisassociateNode Source # 
Instance details

Defined in Amazonka.OpsWorksCM.DisassociateNode

Methods

toQuery :: DisassociateNode -> QueryString #

type Rep DisassociateNode Source # 
Instance details

Defined in Amazonka.OpsWorksCM.DisassociateNode

type Rep DisassociateNode = D1 ('MetaData "DisassociateNode" "Amazonka.OpsWorksCM.DisassociateNode" "libZSservicesZSamazonka-opsworks-cmZSamazonka-opsworks-cm" 'False) (C1 ('MetaCons "DisassociateNode'" 'PrefixI 'True) (S1 ('MetaSel ('Just "engineAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EngineAttribute])) :*: (S1 ('MetaSel ('Just "serverName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "nodeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse DisassociateNode Source # 
Instance details

Defined in Amazonka.OpsWorksCM.DisassociateNode

type AWSResponse DisassociateNode = DisassociateNodeResponse

newDisassociateNode Source #

Arguments

:: Text

$sel:serverName:DisassociateNode'

-> Text

$sel:nodeName:DisassociateNode'

-> DisassociateNode 

Create a value of DisassociateNode 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:engineAttributes:DisassociateNode', disassociateNode_engineAttributes - Engine attributes that are used for disassociating the node. No attributes are required for Puppet.

Attributes required in a DisassociateNode request for Chef

  • CHEF_ORGANIZATION: The Chef organization with which the node was associated. By default only one organization named default can exist.

$sel:serverName:DisassociateNode', disassociateNode_serverName - The name of the server from which to disassociate the node.

$sel:nodeName:DisassociateNode', disassociateNode_nodeName - The name of the client node.

Request Lenses

disassociateNode_engineAttributes :: Lens' DisassociateNode (Maybe [EngineAttribute]) Source #

Engine attributes that are used for disassociating the node. No attributes are required for Puppet.

Attributes required in a DisassociateNode request for Chef

  • CHEF_ORGANIZATION: The Chef organization with which the node was associated. By default only one organization named default can exist.

disassociateNode_serverName :: Lens' DisassociateNode Text Source #

The name of the server from which to disassociate the node.

disassociateNode_nodeName :: Lens' DisassociateNode Text Source #

The name of the client node.

Destructuring the Response

data DisassociateNodeResponse Source #

See: newDisassociateNodeResponse smart constructor.

Constructors

DisassociateNodeResponse' 

Fields

Instances

Instances details
Eq DisassociateNodeResponse Source # 
Instance details

Defined in Amazonka.OpsWorksCM.DisassociateNode

Methods

(==) :: DisassociateNodeResponse -> DisassociateNodeResponse -> Bool #

(/=) :: DisassociateNodeResponse -> DisassociateNodeResponse -> Bool #

Read DisassociateNodeResponse Source # 
Instance details

Defined in Amazonka.OpsWorksCM.DisassociateNode

Methods

readsPrec :: Int -> ReadS DisassociateNodeResponse #

readList :: ReadS [DisassociateNodeResponse] #

readPrec :: ReadPrec DisassociateNodeResponse #

readListPrec :: ReadPrec [DisassociateNodeResponse] #

Show DisassociateNodeResponse Source # 
Instance details

Defined in Amazonka.OpsWorksCM.DisassociateNode

Methods

showsPrec :: Int -> DisassociateNodeResponse -> ShowS #

show :: DisassociateNodeResponse -> String #

showList :: [DisassociateNodeResponse] -> ShowS #

Generic DisassociateNodeResponse Source # 
Instance details

Defined in Amazonka.OpsWorksCM.DisassociateNode

Associated Types

type Rep DisassociateNodeResponse :: Type -> Type #

Methods

from :: DisassociateNodeResponse -> Rep DisassociateNodeResponse x #

to :: Rep DisassociateNodeResponse x -> DisassociateNodeResponse #

NFData DisassociateNodeResponse Source # 
Instance details

Defined in Amazonka.OpsWorksCM.DisassociateNode

Methods

rnf :: DisassociateNodeResponse -> () #

type Rep DisassociateNodeResponse Source # 
Instance details

Defined in Amazonka.OpsWorksCM.DisassociateNode

type Rep DisassociateNodeResponse = D1 ('MetaData "DisassociateNodeResponse" "Amazonka.OpsWorksCM.DisassociateNode" "libZSservicesZSamazonka-opsworks-cmZSamazonka-opsworks-cm" 'False) (C1 ('MetaCons "DisassociateNodeResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nodeAssociationStatusToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDisassociateNodeResponse Source #

Arguments

:: Int

$sel:httpStatus:DisassociateNodeResponse'

-> DisassociateNodeResponse 

Create a value of DisassociateNodeResponse 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:nodeAssociationStatusToken:DisassociateNodeResponse', disassociateNodeResponse_nodeAssociationStatusToken - Contains a token which can be passed to the DescribeNodeAssociationStatus API call to get the status of the disassociation request.

$sel:httpStatus:DisassociateNodeResponse', disassociateNodeResponse_httpStatus - The response's http status code.

Response Lenses

disassociateNodeResponse_nodeAssociationStatusToken :: Lens' DisassociateNodeResponse (Maybe Text) Source #

Contains a token which can be passed to the DescribeNodeAssociationStatus API call to get the status of the disassociation request.

disassociateNodeResponse_httpStatus :: Lens' DisassociateNodeResponse Int Source #

The response's http status code.