Ocean AWS

Initiate EKS AMI Auto Update

Update the Ocean EKS cluster's VNGs with the latest image or the image matching the control plane's version after upgrading, by specifying ‘patch' or 'minorVersion’. Performing this request will update the VNGs with new AMI if available, and run a cluster roll if set. If the response is successful, the old and new AMIs will be included in the response along with the updated VNGs. If a cluster roll is set in the request, the first response for a successful request will indicate the start of a roll. In order to check the status of the roll, you can use the GET Roll API.

put/ocean/aws/eks/cluster/{oceanClusterId}/amiAutoUpdate

Request

Base URL
https://api.spotinst.io
URL
https://api.spotinst.io/ocean/aws/eks/cluster/{oceanClusterId}/amiAutoUpdate
Auth
HTTP bearer

Parameters

#/paths/~1ocean~1aws~1ecs~1cluster~1%7BoceanClusterId%7D/get/parameters/1 (unresolved $ref)

#/paths/~1azure~1costs/get/parameters/0 (unresolved $ref)

Request body

Example request

{
  "amiAutoUpdate": {
    "patch": true,
    "minorVersion": true,
    "applyRoll": true,
    "clusterRoll": {
      "batchSizePercentage": 20,
      "batchMinHealthyPercentage": 100,
      "comment": "This is why I rolled my cluster.",
      "respectPdb": true
    }
  }
}

Changes

No recorded changes to this operation across all 12 revisions of this API.