Sign in
latestOpenAPI 3.0.02026-08-2045003.8 MB

72813baf8d47

Elastigroup AWS

Start Deployment

Deploy your Elastigroup (triggers Blue/Green Deployment that replaces the existing instances in the Elastigroup)

put/aws/ec2/group/{groupId}/roll

Query parameters

accountIdstring

ID of the account associated with your token

Parameters

#/paths/~1aws~1ec2~1group~1%7BgroupId%7D/put/parameters/0 — unresolved $ref

Request body

batchSizePercentageinteger required

Indicates (in percentage) the batch size of the deployment (meaning, how many instances to replace in each batch)

gracePeriodinteger required

Indicates (in seconds) the timeout to wait until instance become healthy based on the healthCheckType

healthCheckType'ELB' | 'ECS_CLUSTER_INSTANCE' | 'TARGET_GROUP' | 'OPSWORKS' | 'NOMAD_NODE' | 'HCS' | 'EC2' | 'NONE'

Define a health check type.
If no value is set the roll will use the group’s auto-healing health check.

drainingTimeoutinteger

Indicates (in seconds) the timeout to drain the instances. Override the group value.

Example request

{
  "batchSizePercentage": 20,
  "gracePeriod": 300,
  "healthCheckType": "EC2",
  "drainingTimeout": 60,
  "strategy": {
    "action": "REPLACE_SERVER",
    "batchMinHealthyPercentage": 25,
    "onFailure": {
      "actionType": "DETACH_NEW",
      "shouldHandleAllBatches": true,
      "drainingTimeout": 120,
      "shouldDecrementTargetCapacity": true
    }
  }
}

Response

Deploy Response

Example response

{
  "request": {
    "id": "46642c7d-bc29-417d-8ce4-79626f00c63c",
    "url": "/aws/ec2/group/sig-12345/roll?accountId=act-123456",
    "method": "PUT",
    "timestamp": "2016-01-21T17:12:51.451Z"
  },
  "response": {
    "status": {
      "code": 200,
      "message": "OK"
    },
    "kind": "spotinst:aws:ec2:group:roll",
    "items": [
      {
        "id": "sbgd-3ee19606",
        "status": "STARTING",
        "currentBatch": 1,
        "numOfBatches": 1,
        "progress": {
          "unit": "percent"
        }
      }
    ],
    "count": 1
  }
}