S3 Tasks
Properties Configuration Settings
The S3 Task provides access to Amazon's Simple Storage Service (S3).
Remarks
The S3 Task allows you to access Amazon's Simple Storage Service (S3) securely over an SSL connection. S3 allows you to store arbitrary data in buckets on Amazon's server and access them from anywhere using an Internet connection. Please refer to Amazon S3 documentation for additional details.
You will first need to sign up for the S3 service and obtain the AccessKey and SecretKey from Amazon. Once you have a valid AccessKey and SecretKey, you may begin uploading/downloading files to and from your buckets.
S3 Receive Task
The S3 Receive Task will download objects specified by the ObjectMask property contained within the Bucket. The AccessKey and SecretKey properties must be set in order to authenticate with the Amazon server. If you wish to enable SSL, you can turn it on by setting the UseSSL property to true and setting an appropriate SSLCert and SSLAcceptServerCert.
S3 Send Task
The S3 Send Task requires a Bucket and a ObjectKey to specify the location to upload to. The AccessKey and SecretKey properties must be set in order to authenticate with the Amazon server. If you wish to enable SSL, you can turn it on by setting the UseSSL property to true and setting an appropriate SSLCert and SSLAcceptServerCert.
Receiver Property List
The following is the full list of the properties of the receiver task with short descriptions. Click on the links for further details.
| AccessKey | The Access Key Id for the Amazon Web Services account. |
| Bucket | The name of the current bucket. |
| BucketList | String denoting the name of the variable which contains the last bucket listing entries. |
| EncryptionPassword | The password to use when encrypting the object. |
| Firewall | A set of properties related to firewall access. |
| HTTPProxy | A set of properties related to proxy access. |
| LocalDirectory | The directory on the local machine to write downloaded objects to. |
| LogFile | The file to write logging information to at runtime. |
| LogMode | What information gets logged during task execution. |
| ObjectList | String denoting the name of the variable which contains the last object listing entries. |
| ObjectMask | Indicates the type of files to download from the S3 server. |
| Operation | The operation which will be executed by the S3 task. |
| Other | Defines a set of configuration settings to be used by the task. |
| Overwrite | Whether or not the task should overwrite files during transfer. |
| RuntimeLicense | Specifies the task runtime license key. |
| SecretKey | The Secret Access Key for the Amazon Web Services account. |
| SSLAcceptServerCert | Instructs the task to unconditionally accept the server certificate that matches the supplied certificate. |
| SSLAcceptServerCertAcceptAny | Tells the task to accept any server certificate. |
| SSLCert | The certificate to use for client authentication during the SSL handshake. |
| Timeout | A timeout for the task. |
| UseSSL | Use SSL to access Amazon S3. |
| UseVirtualHosting | Determines which style request to use. |
Sender Property List
The following is the full list of the properties of the sender task with short descriptions. Click on the links for further details.
| AccessKey | The Access Key Id for the Amazon Web Services account. |
| AccessPolicy | The AccessPolicy are used to set permissions when an object is updated. |
| Bucket | The name of the current bucket. |
| ContentDisposition | Content disposition for the object. |
| ContentType | Content type for the object. |
| EncryptionPassword | The password to use when encrypting the object. |
| Firewall | A set of properties related to firewall access. |
| HTTPProxy | A set of properties related to proxy access. |
| LocalFile | The path to a local file for upload. |
| LogFile | The file to write logging information to at runtime. |
| LogMode | What information gets logged during task execution. |
| ObjectKey | This is the name of file being uploaded to the server. |
| Other | Defines a set of configuration settings to be used by the task. |
| RuntimeLicense | Specifies the task runtime license key. |
| SecretKey | The Secret Access Key for the Amazon Web Services account. |
| SSLAcceptServerCert | Instructs the task to unconditionally accept the server certificate that matches the supplied certificate. |
| SSLAcceptServerCertAcceptAny | Tells the task to accept any server certificate. |
| SSLCert | The certificate to use for client authentication during the SSL handshake. |
| Timeout | A timeout for the task. |
| UseSSL | Use SSL to access Amazon S3. |
| UseVirtualHosting | Determines which style request to use. |
Configuration Settings
The following is a list of configuration settings for the task with short descriptions. Click on the links for further details.
| DirDelimiter | The delimiter for subfolders on the S3 server that should not be maintained in the local directory. |
| IgnoreBucketRestrictions | Allows the user to ignore Amazon-defined bucket name restrictions. |
| IncludeObjectMD5 | Includes the MD5 digest of the object data if set. |
| LocationConstraint | The region where buckets will be created. |
| ObjectDelimiter | A delimiter that can be used to roll up a bunch of keys. |
| ObjectMarker | A marker for the object(s). |
| ObjectPrefix | A prefix for the object(s). |
| MaxObjects | The maximum number of objects for the server to return. |
| ProcessAllPages | Whether or not to continue processing if results are paged. |
| SessionToken | The session token to send in the request when using temporary credentials. |
| StorageClass | Specify the storage class to be used for the uploaded object. |
| URL | If set, the default URL will be overridden by this value. |
| UseEC2RoleCreds | If set to true, authenticate requests with credentials obtained from the IAM role attached to the EC2 instance. |
| UseServerSideEncryption | If true, use server side encryption. |
| ReuseSSLSession | Determines if the SSL session is reused. |
| SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
| SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
| SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
| SSLSecurityFlags | Flags that control certificate verification. |
| SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
| TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True. |
| TLSNamedGroups | The supported (EC)DHE groups. |
| TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| UseInternalSecurityAPI | Tells the task whether or not to use the system security libraries or an internal implementation. |