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.AssociateNode

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 (Puppet): 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

data AssociateNode Source #

See: newAssociateNode smart constructor.

Constructors

AssociateNode' 

Fields

  • serverName :: Text

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

  • nodeName :: Text

    The name of the node.

  • engineAttributes :: [EngineAttribute]

    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.

Instances

Instances details
Eq AssociateNode Source # 
Instance details

Defined in Amazonka.OpsWorksCM.AssociateNode

Methods

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

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

Show AssociateNode Source # 
Instance details

Defined in Amazonka.OpsWorksCM.AssociateNode

Methods

showsPrec :: Int -> AssociateNode -> ShowS #

show :: AssociateNode -> String #

showList :: [AssociateNode] -> ShowS #

Generic AssociateNode Source # 
Instance details

Defined in Amazonka.OpsWorksCM.AssociateNode

Associated Types

type Rep AssociateNode :: Type -> Type #

Methods

from :: AssociateNode -> Rep AssociateNode x #

to :: Rep AssociateNode x -> AssociateNode #

NFData AssociateNode Source # 
Instance details

Defined in Amazonka.OpsWorksCM.AssociateNode

Methods

rnf :: AssociateNode -> () #

Hashable AssociateNode Source # 
Instance details

Defined in Amazonka.OpsWorksCM.AssociateNode

Methods

hashWithSalt :: Int -> AssociateNode -> Int #

hash :: AssociateNode -> Int #

ToJSON AssociateNode Source # 
Instance details

Defined in Amazonka.OpsWorksCM.AssociateNode

Methods

toJSON :: AssociateNode -> Value #

toEncoding :: AssociateNode -> Encoding #

toJSONList :: [AssociateNode] -> Value #

toEncodingList :: [AssociateNode] -> Encoding #

AWSRequest AssociateNode Source # 
Instance details

Defined in Amazonka.OpsWorksCM.AssociateNode

Associated Types

type AWSResponse AssociateNode #

Methods

request :: AssociateNode -> Request AssociateNode #

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

ToHeaders AssociateNode Source # 
Instance details

Defined in Amazonka.OpsWorksCM.AssociateNode

Methods

toHeaders :: AssociateNode -> [Header] #

ToPath AssociateNode Source # 
Instance details

Defined in Amazonka.OpsWorksCM.AssociateNode

Methods

toPath :: AssociateNode -> ByteString #

ToQuery AssociateNode Source # 
Instance details

Defined in Amazonka.OpsWorksCM.AssociateNode

Methods

toQuery :: AssociateNode -> QueryString #

type Rep AssociateNode Source # 
Instance details

Defined in Amazonka.OpsWorksCM.AssociateNode

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

Defined in Amazonka.OpsWorksCM.AssociateNode

type AWSResponse AssociateNode = AssociateNodeResponse

newAssociateNode Source #

Arguments

:: Text

$sel:serverName:AssociateNode'

-> Text

$sel:nodeName:AssociateNode'

-> AssociateNode 

Create a value of AssociateNode 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:serverName:AssociateNode', associateNode_serverName - The name of the server with which to associate the node.

$sel:nodeName:AssociateNode', associateNode_nodeName - The name of the node.

$sel:engineAttributes:AssociateNode', associateNode_engineAttributes - 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.

Request Lenses

associateNode_serverName :: Lens' AssociateNode Text Source #

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

associateNode_nodeName :: Lens' AssociateNode Text Source #

The name of the node.

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

data AssociateNodeResponse Source #

See: newAssociateNodeResponse smart constructor.

Constructors

AssociateNodeResponse' 

Fields

Instances

Instances details
Eq AssociateNodeResponse Source # 
Instance details

Defined in Amazonka.OpsWorksCM.AssociateNode

Methods

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

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

Read AssociateNodeResponse Source # 
Instance details

Defined in Amazonka.OpsWorksCM.AssociateNode

Methods

readsPrec :: Int -> ReadS AssociateNodeResponse #

readList :: ReadS [AssociateNodeResponse] #

readPrec :: ReadPrec AssociateNodeResponse #

readListPrec :: ReadPrec [AssociateNodeResponse] #

Show AssociateNodeResponse Source # 
Instance details

Defined in Amazonka.OpsWorksCM.AssociateNode

Methods

showsPrec :: Int -> AssociateNodeResponse -> ShowS #

show :: AssociateNodeResponse -> String #

showList :: [AssociateNodeResponse] -> ShowS #

Generic AssociateNodeResponse Source # 
Instance details

Defined in Amazonka.OpsWorksCM.AssociateNode

Associated Types

type Rep AssociateNodeResponse :: Type -> Type #

Methods

from :: AssociateNodeResponse -> Rep AssociateNodeResponse x #

to :: Rep AssociateNodeResponse x -> AssociateNodeResponse #

NFData AssociateNodeResponse Source # 
Instance details

Defined in Amazonka.OpsWorksCM.AssociateNode

Methods

rnf :: AssociateNodeResponse -> () #

type Rep AssociateNodeResponse Source # 
Instance details

Defined in Amazonka.OpsWorksCM.AssociateNode

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

newAssociateNodeResponse Source #

Arguments

:: Int

$sel:httpStatus:AssociateNodeResponse'

-> AssociateNodeResponse 

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

$sel:httpStatus:AssociateNodeResponse', associateNodeResponse_httpStatus - The response's http status code.

Response Lenses

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

associateNodeResponse_httpStatus :: Lens' AssociateNodeResponse Int Source #

The response's http status code.