component.json

{
  "title": "AWS S3",
  "version": "1.6.1",
  "description": "Integration component that can read and write to AWS S3",
  "docsUrl": "https://github.com/elasticio/amazon-s3-component",
  "credentials": {
    "fields": {
      "accessKeyId": {
        "label": "Access Key Id",
        "required": true,
        "viewClass": "TextFieldView"
      },
      "accessKeySecret": {
        "label": "Secret Access Key",
        "required": true,
        "viewClass": "PasswordFieldView"
      },
      "region": {
        "label": "Region",
        "required": true,
        "viewClass": "TextFieldView"
      },
      "endpoint": {
        "label": "Custom Endpoint (optional)",
        "required": false,
        "viewClass": "TextFieldView",
        "note": "Set for S3-compatible providers (e.g. https://s3.eu-central-003.backblazeb2.com)"
      },
      "s3ForcePathStyle": {
        "label": "Force Path Style",
        "required": false,
        "viewClass": "CheckBoxView",
        "note": "Enable for most S3-compatible providers (MinIO, Wasabi, etc.)"
      }
    }
  },
  "triggers": {
    "pollingTrigger": {
      "title": "Get New and Updated S3 Objects",
      "type": "polling",
      "help": {
        "description": "Get New and Updated S3 Objects by provided time limits",
        "link": "/components/aws-s3/index.html#get-new-and-updated-s3-objects"
      },
      "main": "./lib/triggers/pollingTrigger.js",
      "fields": {
        "bucketName": {
          "viewClass": "TextFieldView",
          "label": "Bucket Name and Folder",
          "placeholder": "my-bucket/my-folder",
          "required": true
        },
        "emitBehaviour": {
          "label": "Emit Behaviour",
          "viewClass": "SelectView",
          "required": false,
          "prompt": "Default Emit Individually",
          "model": {
            "emitIndividually": "Emit Individually",
            "fetchAll": "Fetch All"
          }
        },
        "startTime": {
          "label": "Start Time",
          "viewClass": "TextFieldView",
          "required": false,
          "note": "Input format: ISO 8601. Default: minimum time",
          "placeholder": "2020-01-01T01:01:01Z"
        },
        "endTime": {
          "label": "End Time",
          "viewClass": "TextFieldView",
          "required": false,
          "note": "Input format: ISO 8601. Default: maximum time",
          "placeholder": "2020-01-01T01:01:01Z"
        },
        "enableFileAttachments": {
          "viewClass": "CheckBoxView",
          "label": "Enable File Attachments"
        },
        "usePreSignedUrls": {
          "viewClass": "CheckBoxView",
          "label": "Use Pre-signed URLs",
          "note": "Generate pre-signed URLs instead of attachments.. Works with files of any size. URLs expire after specified time."
        },
        "preSignedUrlExpiration": {
          "viewClass": "TextFieldView",
          "label": "Pre-signed URL Expiration (seconds)",
          "placeholder": "3600",
          "note": "URL expiration time in seconds. Default: 3600 (1 hour), Max: 604800 (7 days)",
          "required": false
        }
      },
      "dynamicMetadata": true
    }
  },
  "actions": {
    "streamToFile": {
      "title": "Write file",
      "deprecated": true,
      "help": {
        "description": "Put stream as file into S3 bucket. Deprecated in favor of \"Write File to S3 From a Provided Attachment\"",
        "link": "/components/aws-s3/index.html#write-file"
      },
      "main": "./lib/actions/streamToFile.js",
      "fields": {
        "bucketName": {
          "viewClass": "TextFieldView",
          "label": "Default Bucket Name and folder",
          "placeholder": "my-fancy-bucket",
          "note": "Default Bucket Name and folder will override if 'Bucket Name and folder' field is set in metadata",
          "required": false
        }
      },
      "metadata": {
        "in": {
          "type": "object",
          "properties": {
            "filename": {
              "type": "string",
              "required": false
            },
            "bucketName": {
              "type": "string",
              "title": "Bucket Name and folder",
              "required": false
            }
          }
        },
        "out": {
          "type": "object",
          "properties": {
            "ETag": {
              "type": "string",
              "required": true
            },
            "Location": {
              "type": "string",
              "required": false
            },
            "Key": {
              "type": "string",
              "required": true
            },
            "Bucket": {
              "type": "string",
              "required": true
            }
          }
        }
      }
    },
    "readFile": {
      "deprecated": true,
      "title": "Read file",
      "help": {
        "description": "Action is deprecated do to incorrect output metadata. Use main 'Read file' action instead",
        "link": "/components/aws-s3/index.html#read-file"
      },
      "main": "./lib/actions/readFile.js",
      "fields": {
        "bucketName": {
          "viewClass": "TextFieldView",
          "label": "Default Bucket Name and folder",
          "placeholder": "my-fancy-bucket",
          "note": "Default Bucket Name and folder will override if 'Bucket Name and folder' field is set in metadata",
          "required": false
        }
      },
      "metadata": {
        "in": {
          "type": "object",
          "properties": {
            "filename": {
              "type": "string",
              "required": true
            },
            "bucketName": {
              "title": "Bucket Name and folder",
              "type": "string",
              "required": false
            }
          }
        },
        "out": {
          "type": "object",
          "properties": {
            "filename": {
              "type": "string",
              "required": true
            }
          }
        }
      }
    },
    "readFile2": {
      "title": "Read file",
      "help": {
        "description": "Read file from S3 bucket",
        "link": "/components/aws-s3/index.html#read-file"
      },
      "main": "./lib/actions/readFile2.js",
      "fields": {
        "bucketName": {
          "viewClass": "TextFieldView",
          "label": "Default Bucket Name and folder",
          "placeholder": "my-fancy-bucket",
          "note": "Default Bucket Name and folder will override if 'Bucket Name and folder' field is set in metadata",
          "required": false
        },
        "usePreSignedUrls": {
          "viewClass": "CheckBoxView",
          "required": false,
          "label": "Use Pre-signed URLs",
          "note": "Generate pre-signed URLs instead of attachments. Works with files of any size. URLs expire after specified time."
        },
        "preSignedUrlExpiration": {
          "viewClass": "TextFieldView",
          "label": "Pre-signed URL Expiration (seconds)",
          "placeholder": "3600",
          "note": "URL expiration time in seconds. Default: 3600 (1 hour), Max: 604800 (7 days)",
          "required": false
        }
      },
      "metadata": {
        "in": {
          "type": "object",
          "properties": {
            "filename": {
              "type": "string",
              "required": true
            },
            "bucketName": {
              "title": "Bucket Name and folder",
              "type": "string",
              "required": false
            }
          }
        },
        "out": {
          "type": "object",
          "properties": {
            "filename": {
              "type": "string",
              "required": true
            },
            "attachmentUrl": {
              "type": "string",
              "required": false
            },
            "preSignedUrl": {
              "type": "string",
              "required": false
            },
            "size": {
              "type": "number",
              "required": true
            }
          }
        }
      }
    },
    "getAllFilesInBucket": {
      "title": "Get filenames",
      "help": {
        "description": "Emit individually all filenames from S3 bucket",
        "link": "/components/aws-s3/index.html#get-filenames"
      },
      "main": "./lib/actions/getAllFilesInBucket.js",
      "fields": {
        "bucketName": {
          "viewClass": "TextFieldView",
          "label": "Default Bucket Name and folder",
          "placeholder": "my-fancy-bucket",
          "note": "Default Bucket Name and folder will override if 'Bucket Name and folder' field is set in metadata",
          "required": false
        }
      },
      "metadata": {
        "in": {
          "type": "object",
          "properties": {
            "bucketName": {
              "title": "Bucket Name and folder",
              "type": "string",
              "required": false
            }
          }
        },
        "out": {
          "type": "object",
          "properties": {
            "filename": {
              "type": "string",
              "required": true
            }
          }
        }
      }
    },
    "deleteFile": {
      "title": "Delete file",
      "help": {
        "description": "Delete file from S3 bucket",
        "link": "/components/aws-s3/index.html#delete-file"
      },
      "main": "./lib/actions/deleteObject.js",
      "fields": {
        "bucketName": {
          "viewClass": "TextFieldView",
          "label": "Default Bucket Name and Folder",
          "placeholder": "my-fancy-bucket",
          "note": "Default Bucket Name and Folder will override if 'Bucket Name and Folder' field is set in metadata",
          "required": false
        }
      },
      "metadata": {
        "in": {
          "type": "object",
          "properties": {
            "filename": {
              "type": "string",
              "required": true
            },
            "bucketName": {
              "title": "Bucket Name and Folder",
              "type": "string",
              "required": false
            }
          }
        },
        "out": {
          "type": "object",
          "properties": {
            "filename": {
              "type": "string",
              "required": true
            }
          }
        }
      }
    },
    "renameFile": {
      "title": "Rename file",
      "help": {
        "description": "Rename file in S3 bucket",
        "link": "/components/aws-s3/index.html#rename-file"
      },
      "main": "./lib/actions/renameObject.js",
      "metadata": {
        "in": {
          "type": "object",
          "properties": {
            "bucketName": {
              "title": "Bucket Name",
              "type": "string",
              "required": true
            },
            "folder": {
              "type": "string",
              "required": false
            },
            "oldFileName": {
              "type": "string",
              "required": true
            },
            "newFileName": {
              "type": "string",
              "required": true
            }
          }
        },
        "out": {
          "type": "object",
          "properties": {
            "Key": {
              "type": "string",
              "required": true
            },
            "LastModified": {
              "type": "string",
              "required": true
            },
            "ETag": {
              "type": "string",
              "required": true
            },
            "Size": {
              "type": "number",
              "required": true
            },
            "StorageClass": {
              "type": "string",
              "required": true
            },
            "Owner": {
              "type": "object",
              "required": true,
              "properties": {
                "ID": {
                  "type": "string",
                  "required": true
                }
              }
            }
          }
        }
      }
    },
    "streamToCsv": {
      "deprecated": true,
      "title": "Stream to CSV",
      "help": {
        "description": "Action is deprecated. Use 'Write file' action instead",
        "link": "/components/aws-s3/index.html#stream-to-csv"
      },
      "main": "./lib/actions/streamToCsv.js",
      "fields": {
        "bucketName": {
          "viewClass": "TextFieldView",
          "label": "Bucket Name",
          "placeholder": "my-fancy-bucket",
          "required": true
        },
        "keyName": {
          "viewClass": "TextFieldView",
          "label": "Key Name",
          "placeholder": "/foo/file.csv",
          "required": true
        },
        "csv": {
          "viewClass": "CSVWriteView",
          "label": "CSV Header",
          "placeholder": "Copy and paste here first (header) line of your CSV file here",
          "required": true
        }
      },
      "metadata": {
        "in": {}
      }
    },
    "upsertFile": {
      "main": "./lib/actions/upsertFile.js",
      "title": "Write File to S3 From a Provided Attachment",
      "help": {
        "description": "Given a filename and a URL to an attachment stored in the platform, transfers the contents of the attachment to AWS S3. The component returns a summary of the written file. AWS S3 always overwrites the contents of the file if it already exists.",
        "link": "/components/aws-s3/index.html#write-file-to-s3-from-a-provided-attachment"
      },
      "fields": {},
      "dynamicMetadata": true
    },
    "listObjects": {
      "title": "Get New and Updated S3 Objects",
      "type": "polling",
      "help": {
        "description": "List S3 Objects",
        "link": "/components/aws-s3/index.html#get-new-and-updated-s3-objects"
      },
      "main": "./lib/actions/listObjects.js",
      "fields": {
        "bucketName": {
          "viewClass": "TextFieldView",
          "label": "Bucket Name and Folder",
          "placeholder": "my-bucket/my-folder",
          "required": true
        }
      },
      "metadata": {
        "in": {
          "type": "object",
          "properties": {
            "keyRegex": {
              "title": "Search pattern",
              "type": "string",
              "required": true
            }
          }
        },
        "out": {
          "type": "object",
          "properties": {
            "Key": {
              "type": "string",
              "required": true
            },
            "SignedUrl": {
              "type": "string",
              "required": true
            }
          }
        }
      }
    }
  }
}