Updates the specified AWS cloud config's machine pool

PUT 
https://api.spectrocloud.com/v1/cloudconfigs/aws/:configUid/machinePools/:machinePoolName

Updates the specified AWS cloud config's machine pool

Request

Path Parameters

configUid stringrequired

Cluster's cloud config uid

machinePoolName stringrequired

Machine pool name

application/json

Body

cloudConfig

object

required

additionalSecurityGroups

object[]

Additional Security groups

Array [

arnstring

ARN of resource

filters

object[]

Filters is a set of key/value pairs used to identify a resource

Array [

namestring

Name of the filter. Filter names are case-sensitive

valuesstring[]

Values includes one or more filter values. Filter values are case-sensitive

]

idstring

ID of resource

]

azsstring[]

capacityTypestring

Possible values: [on-demand, spot]

Default value: on-demand

EC2 instance capacity type

instanceTypestringrequired

instance type

rootDeviceSizeint64

Possible values: >= 1 and <= 2000

rootDeviceSize in GBs

spotMarketOptions

object

SpotMarketOptions allows users to configure instances to be run using AWS Spot instances.

maxPricestring

MaxPrice defines the maximum price the user is willing to pay for Spot VM instances

subnets

undefined[]

Array [

azstring

idstring

]

poolConfig

object

Machine pool configuration for the cluster

additionalLabels

object

Additional labels to be part of the machine pool

property name*string

additionalTags

object

AdditionalTags is an optional set of tags to add to resources managed by the provider, in addition to the ones added by default. For eg., tags for EKS nodeGroup or EKS NodegroupIAMRole

property name*string

isControlPlaneboolean

Whether this pool is for control plane

labelsstring[]required

Labels for this machine pool, example: master/worker, gpu, windows

machinePoolProperties

object

Machine pool specific properties

archTypestring

Possible values: [amd64, arm64]

Default value: amd64

Architecture type of the pool. Default value is 'amd64'

maxSizeint32

Max size of the pool, for scaling

minSizeint32

Min size of the pool, for scaling

namestringrequired

nodeRepaveIntervalint32

Minimum number of seconds a node should be Ready, before the next node is selected for repave. Applicable only for workerpools in infrastructure cluster

sizeint32required

Size of the pool, number of nodes/machines

taints

object[]

Master or worker taints

Array [

effectstring

Possible values: [NoSchedule, PreferNoSchedule, NoExecute]

keystring

The taint key to be applied to a node

timeAddeddate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

valuestring

The taint value corresponding to the taint key.

]

updateStrategy

object

Rolling update strategy for this machine pool if not specified, will use ScaleOut

typestring

Possible values: [RollingUpdateScaleOut, RollingUpdateScaleIn]

update strategy, either ScaleOut or ScaleIn if empty, will default to RollingUpdateScaleOut

useControlPlaneAsWorkerboolean

If IsControlPlane==true and useControlPlaneAsWorker==true, then will remove master taint this will not be used for worker pools

Responses

204

The resource was updated successfully

• curl
• python
• go
• nodejs
• java

• CURL

curl -L -X PUT 'https://api.spectrocloud.com/v1/cloudconfigs/aws/:configUid/machinePools/:machinePoolName' \
-H 'Content-Type: application/json' \
-d '{
  "cloudConfig": {
    "additionalSecurityGroups": [
      {
        "arn": "string",
        "filters": [
          {
            "name": "string",
            "values": [
              "string"
            ]
          }
        ],
        "id": "string"
      }
    ],
    "azs": [
      "string"
    ],
    "capacityType": "on-demand",
    "instanceType": "string",
    "rootDeviceSize": 0,
    "spotMarketOptions": {
      "maxPrice": "string"
    },
    "subnets": [
      {
        "az": "string",
        "id": "string"
      }
    ]
  },
  "poolConfig": {
    "additionalLabels": {},
    "additionalTags": {},
    "isControlPlane": true,
    "labels": [
      "string"
    ],
    "machinePoolProperties": {
      "archType": "amd64"
    },
    "maxSize": 0,
    "minSize": 0,
    "name": "string",
    "nodeRepaveInterval": 0,
    "size": 0,
    "taints": [
      {
        "effect": "NoSchedule",
        "key": "string",
        "timeAdded": "2024-07-29T15:51:28.071Z",
        "value": "string"
      }
    ],
    "updateStrategy": {
      "type": "RollingUpdateScaleOut"
    },
    "useControlPlaneAsWorker": true
  }
}'

Request Collapse all

Base URL

https://api.spectrocloud.com

Parameters

configUid — pathrequired

machinePoolName — pathrequired

Body

{
  "cloudConfig": {
    "additionalSecurityGroups": [
      {
        "arn": "string",
        "filters": [
          {
            "name": "string",
            "values": [
              "string"
            ]
          }
        ],
        "id": "string"
      }
    ],
    "azs": [
      "string"
    ],
    "capacityType": "on-demand",
    "instanceType": "string",
    "rootDeviceSize": 0,
    "spotMarketOptions": {
      "maxPrice": "string"
    },
    "subnets": [
      {
        "az": "string",
        "id": "string"
      }
    ]
  },
  "poolConfig": {
    "additionalLabels": {},
    "additionalTags": {},
    "isControlPlane": true,
    "labels": [
      "string"
    ],
    "machinePoolProperties": {
      "archType": "amd64"
    },
    "maxSize": 0,
    "minSize": 0,
    "name": "string",
    "nodeRepaveInterval": 0,
    "size": 0,
    "taints": [
      {
        "effect": "NoSchedule",
        "key": "string",
        "timeAdded": "2024-07-29T15:51:28.071Z",
        "value": "string"
      }
    ],
    "updateStrategy": {
      "type": "RollingUpdateScaleOut"
    },
    "useControlPlaneAsWorker": true
  }
}