group.md

Group plugin API

API

Method Group.CommitGroup

Submits the configuration for a group. The Group plugin is responsible for making any changes necessary to effect the configuration.

Request

{
  "Spec": {
    "ID": "group_id",
    "Properties": {}
  },
  "Pretend": true
}

Parameters:

• Spec: A Group Spec
• Pretend: Whether to actually perform the change. If false, the request will have no side-effects.

Response

{
  "Details": "human readable text"
}

Fields:

• Details: A human-readable description of the commit action, or proposed action if Pretend was true.

Method Group.FreeGroup

Removes a Group from active management. This operation is non-destructive - it will not destroy or modify any resources associated with the Group. However, the Plugin will no longer attempt to maintain the state of the Group.

Request

{
  "ID": "group_id"
}

Parameters:

• ID: Group ID

Response

{
  "OK": true
}

Fields:

• OK: Whether the operation succeeded.

Method Group.DescribeGroup

Fetches details about the current status of a Group.

Request

{
  "ID": "group_Id"
}

Parameters:

• ID: Group ID

Response

{
  "Description": {
    "Instances": [
      {
        "ID": "instance_id",
        "LogicalID": "logical_id",
        "Tags": {
          "tag_key": "tag_value"
        }
      }
    ],
    "Converged": true
  }
}

Fields:

• Description: A Group Description

Method Group.DestroyGroup

Request

{
  "ID": "group_Id"
}

Parameters:

• ID: Group ID

Response

{
  "OK": true
}

Fields:

• OK: Whether the operation succeeded.

Method Group.InspectGroups

Fetches details about the state associated with a Group.

Request

{}

Parameters: None

Response

{
  "Groups": [
    {
      "ID": "group_id",
      "Properties": {}
    }
  ]
}

Fields:

• Groups: An array of Group Specs