opsworkscm_disassociate_node: Disassociates a node from an AWS OpsWorks CM server, and...

Description Usage Arguments Value Request syntax

View source: R/opsworkscm_operations.R

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

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.

Usage

1
opsworkscm_disassociate_node(ServerName, NodeName, EngineAttributes)

Arguments

ServerName

[required] The name of the server from which to disassociate the node.

NodeName

[required] The name of the client node.

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.

Value

A list with the following syntax:

1
2
3
list(
  NodeAssociationStatusToken = "string"
)

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
svc$disassociate_node(
  ServerName = "string",
  NodeName = "string",
  EngineAttributes = list(
    list(
      Name = "string",
      Value = "string"
    )
  )
)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.