Amazon S3

Learn more about:

POST Parameters

List with common parameters for all Buddy actions

Name	Type	Description
name `Required`	String	The name of the action.
type `Required`	String	The type of the action. Should be set to `AMAZON_S3`.
bucket_name `Required`	String	The name of the Amazon S3 Bucket.
integration `Required`	Integration	The integration.
input_type	String	Defines whether the files are deployed from the repository or from the build filesystem. Can be one of `SCM_REPOSITORY` or `BUILD_ARTIFACTS`.
local_path	String	The path in the repository.
acl	String	Access control lists (ACLs) enable you to manage access to buckets and objects. It defines which AWS accounts or groups are granted access and the type of access. Can be one of `PRIVATE` , `PUBLIC_READ`, `AWS-EXEC-READ`, `AUTHENTICATED_READ`, `BUCKET_ONWER_READ`, `BUCKET_OWNER_FULL_CONTROL` or `LOG_DELIVERY_WRITE`.
remote_path	String	The absolute or relative path on the remote server.
deployment_excludes	String[]	The paths and/or files that will be left out during the deployment.
deployment_includes	String[]	The exceptions from the ignore patterns set in `deployment_excludes`.
expires_date	ISO-8601 UTC date	Specifies the expiration period for the objects (how long they stay in the cache).
cache_control	String	Specifies how long objects stay in the cache.
skip_content_type_setting	Boolean	When set to `true` all files will have their mime-types set to `application/octet-stream`.
reduced_redundancy	Boolean	Set to `true` if you want to use Reduced Redundancy Storage.
deploy_tags	Tag[]	Defines tags for files categorization as a key value pairs list.
deletion_disabled	Boolean	If set to `true`, files are not deleted if changeset indcates that.
content_encoding	String	ContentEncoding that will be set for the deployed files e.g. "gzip".

Example

Request

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

JSON

{
  "name": "Upload files to Amazon S3",
  "type": "AMAZON_S3",
  "input_type": "SCM_REPOSITORY",
  "trigger_time": "ON_EVERY_EXECUTION",
  "local_path": "/assets/",
  "remote_path": "Home/www/",
  "bucket_name": "buddy-tests",
  "acl": "PUBLIC_READ_WRITE",
  "skip_content_type_setting": false,
  "reduced_redundancy": true,
  "expires_date":"2017-01-07T00:00:00.000Z",
  "cache_control":"max-age=3600",
  "deploy_tags": [
    {
      "key": "revision",
      "value": "$BUDDY_EXECUTION_REVISION"
    },
    {
      "key": "buddy_last_modification_type",
      "value": "$BUDDY_EXECUTION_FILE_MODIFICATION_TYPE"
    }
  ],
  "deletion_disabled": true,
  "deployment_excludes": [
  "/tmp/",
  "*.log"
  ],
  "deployment_includes": [
  "/assets/style",
  "/tmp/file.txt"
  ],
  "integration": {
    "identifier": "my_integration"
  }
}

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": "Upload files to Amazon S3",
  "type": "AMAZON_S3",
  "trigger_time": "ON_EVERY_EXECUTION",
  "last_execution_status": "INITIAL",
  "input_type": "SCM_REPOSITORY",
  "local_path": "/assets/",
  "remote_path": "Home/www/",
  "bucket_name": "buddy-tests",
  "acl": "PUBLIC_READ_WRITE",
  "skip_content_type_setting": false,
  "reduced_redundancy": true,
  "expires_date":"2017-01-07T00:00:00.000Z",
  "cache_control":"max-age=3600",
  "deploy_tags": [
    {
      "key": "revision",
      "value": "$BUDDY_EXECUTION_REVISION"
    },
    {
      "key": "buddy_last_modification_type",
      "value": "$BUDDY_EXECUTION_FILE_MODIFICATION_TYPE"
    }
  ],
  "deletion_disabled": true,
  "deployment_excludes": [
  "/tmp/",
  "*.log"
  ],
  "deployment_includes": [
  "/assets/style",
  "/tmp/file.txt"
  ],
  "integration": {
    "url": "https://api.buddy.works/workspaces/buddy/user/integrations/1",
    "html_url": "https://app.buddy.works/my-id",
    "hash_id": "5ddb7c180fb38be67bd78a88a",
    "identifier": "my_integration"
  },
  "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",
    "on": "CLICK",
    "refs": [
      "refs/heads/master"
    ],
    "last_execution_status": "SUCCESSFUL",
    "last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
  }
}

Last modified on March 22, 2024

Amazon S3

Knowledge is power!