amazonka-opsworks-cm-1.6.0: Amazon OpsWorks for Chef Automate SDK.

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

Network.AWS.OpsWorksCM.AssociateNode

Contents

Description

Associates a new node with the server. For more information about how to disassociate a node, see DisassociateNode .

On a Chef server: This command is an alternative to knife bootstrap .

Example (Chef): aws opsworks-cm associate-node --server-name MyServer --node-name MyManagedNode --engine-attributes "Name=CHEF_ORGANIZATION ,Value=default" "Name=CHEF_NODE_PUBLIC_KEY ,Value=public-key-pem "

On a Puppet server, this command is an alternative to the puppet cert sign command that signs a Puppet node CSR.

Example (Chef): aws opsworks-cm associate-node --server-name MyServer --node-name MyManagedNode --engine-attributes "Name=PUPPET_NODE_CSR ,Value=csr-pem "

A node can can only be associated with servers that are 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. The AssociateNode API call can be integrated into Auto Scaling configurations, AWS Cloudformation templates, or the user data of a server's instance.

Synopsis

Creating a Request

associateNode Source #

Creates a value of AssociateNode with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • anServerName - The name of the server with which to associate the node.
  • anNodeName - The name of the node.
  • anEngineAttributes - Engine attributes used for associating the node. Attributes accepted in a AssociateNode request for Chef * CHEF_ORGANIZATION : The Chef organization with which the node is associated. By default only one organization named default can exist. * CHEF_NODE_PUBLIC_KEY : A PEM-formatted public key. This key is required for the chef-client agent to access the Chef API. Attributes accepted in a AssociateNode request for Puppet * PUPPET_NODE_CSR : A PEM-formatted certificate-signing request (CSR) that is created by the node.

data AssociateNode Source #

See: associateNode smart constructor.

Instances

Eq AssociateNode Source # 
Data AssociateNode Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AssociateNode -> c AssociateNode #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AssociateNode #

toConstr :: AssociateNode -> Constr #

dataTypeOf :: AssociateNode -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c AssociateNode) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AssociateNode) #

gmapT :: (forall b. Data b => b -> b) -> AssociateNode -> AssociateNode #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AssociateNode -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AssociateNode -> r #

gmapQ :: (forall d. Data d => d -> u) -> AssociateNode -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> AssociateNode -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> AssociateNode -> m AssociateNode #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AssociateNode -> m AssociateNode #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AssociateNode -> m AssociateNode #

Show AssociateNode Source # 
Generic AssociateNode Source # 

Associated Types

type Rep AssociateNode :: * -> * #

Hashable AssociateNode Source # 
ToJSON AssociateNode Source # 
NFData AssociateNode Source # 

Methods

rnf :: AssociateNode -> () #

AWSRequest AssociateNode Source # 
ToHeaders AssociateNode Source # 
ToPath AssociateNode Source # 
ToQuery AssociateNode Source # 
type Rep AssociateNode Source # 
type Rep AssociateNode = D1 * (MetaData "AssociateNode" "Network.AWS.OpsWorksCM.AssociateNode" "amazonka-opsworks-cm-1.6.0-D1lLq3cpj5Y52sT2PvyDqA" False) (C1 * (MetaCons "AssociateNode'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_anServerName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) ((:*:) * (S1 * (MetaSel (Just Symbol "_anNodeName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_anEngineAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * [EngineAttribute])))))
type Rs AssociateNode Source # 

Request Lenses

anServerName :: Lens' AssociateNode Text Source #

The name of the server with which to associate the node.

anNodeName :: Lens' AssociateNode Text Source #

The name of the node.

anEngineAttributes :: Lens' AssociateNode [EngineAttribute] Source #

Engine attributes used for associating the node. Attributes accepted in a AssociateNode request for Chef * CHEF_ORGANIZATION : The Chef organization with which the node is associated. By default only one organization named default can exist. * CHEF_NODE_PUBLIC_KEY : A PEM-formatted public key. This key is required for the chef-client agent to access the Chef API. Attributes accepted in a AssociateNode request for Puppet * PUPPET_NODE_CSR : A PEM-formatted certificate-signing request (CSR) that is created by the node.

Destructuring the Response

associateNodeResponse Source #

Creates a value of AssociateNodeResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data AssociateNodeResponse Source #

See: associateNodeResponse smart constructor.

Instances

Eq AssociateNodeResponse Source # 
Data AssociateNodeResponse Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AssociateNodeResponse -> c AssociateNodeResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AssociateNodeResponse #

toConstr :: AssociateNodeResponse -> Constr #

dataTypeOf :: AssociateNodeResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c AssociateNodeResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AssociateNodeResponse) #

gmapT :: (forall b. Data b => b -> b) -> AssociateNodeResponse -> AssociateNodeResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AssociateNodeResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AssociateNodeResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> AssociateNodeResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> AssociateNodeResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> AssociateNodeResponse -> m AssociateNodeResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AssociateNodeResponse -> m AssociateNodeResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AssociateNodeResponse -> m AssociateNodeResponse #

Read AssociateNodeResponse Source # 
Show AssociateNodeResponse Source # 
Generic AssociateNodeResponse Source # 
NFData AssociateNodeResponse Source # 

Methods

rnf :: AssociateNodeResponse -> () #

type Rep AssociateNodeResponse Source # 
type Rep AssociateNodeResponse = D1 * (MetaData "AssociateNodeResponse" "Network.AWS.OpsWorksCM.AssociateNode" "amazonka-opsworks-cm-1.6.0-D1lLq3cpj5Y52sT2PvyDqA" False) (C1 * (MetaCons "AssociateNodeResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_anrsNodeAssociationStatusToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_anrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

anrsNodeAssociationStatusToken :: Lens' AssociateNodeResponse (Maybe Text) Source #

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

anrsResponseStatus :: Lens' AssociateNodeResponse Int Source #

  • - | The response status code.