AWS ECS

POST Parameters

You can find the list with common parameters for all Buddy actions here.

NameTypeDescription
name
Required
StringThe name of the action.
type
Required
StringThe type of the action. Should be set to AWS_ECS.
integration
Required
IntegrationThe integration.
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.

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",
"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"
}
}