AWS ECS

POST Parameters

NameTypeDescription
integration
Required
IntegrationThe integration.
name
Required
StringThe name of the action.
type
Required
StringThe type of the action. Should be set to AWS_ECS.
region
Required
StringThe Amazon region.
local_path
Required
StringThe path to the JSON file with task definition.
cluster
Required
StringThe paths and/or files that will be left out during the deployment.
service
Required
StringThe ID of the ECS service.
after_action_idIntegerThe numerical ID of the action, after which this action should be added.
trigger_timeStringSpecifies when the action should be executed. Can be one of ON_EVERY_EXECUTION, ON_FAILURE or ON_BACK_TO_SUCCESS.
trigger_conditionStringDefines when the build action should be run. Can be one of ALWAYS, ON_CHANGE, ON_CHANGE_AT_PATH, VAR_IS, VAR_IS_NOT or VAR_CONTAINS or VAR_NOT_CONTAINS.

Example

Request

POST https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions

JSON

{
"name": "ECS by API",
"type": "AWS_ECS",
"trigger_time": "ON_EVERY_EXECUTION",
"trigger_condition": "ALWAYS",
"integration": {
"id": 1
},
"service": "sample-app-service",
"cluster": "buddy-testing-cluster",
"local_path": "taskDefinition.json",
"region": "us-east-1"
}

Sample Response

HTTP

Status: 201 Created
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999

JSON

{
"url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions/2",
"html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/2/action/2/edit",
"id": 2,
"name": "ECS by API",
"type": "AWS_ECS",
"trigger_time": "ON_EVERY_EXECUTION",
"trigger_condition": "ALWAYS",
"run_only_on_first_failure": false,
"last_execution_status": "INITIAL",
"service": "sample-app-service",
"cluster": "buddy-testing-cluster",
"local_path": "taskDefinition.json",
"region": "us-east-1",
"integration": {
"url": "https://api.buddy.works/workspaces/buddy/user/integrations/1",
"html_url": "https://app.buddy.works/my-id",
"id": 1
},
"pipeline": {
"url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2",
"html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/2",
"id": 2,
"name": "test server",
"trigger_mode": "MANUAL",
"ref_name": "master",
"last_execution_status": "SUCCESSFUL",
"last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
}
}