Puts FlowFiles to an Amazon S3 Bucket.
The upload uses either the PutS3Object method or the PutS3MultipartUpload method. The PutS3Object method sends the file in a single synchronous call, but it has a 5GB size limit. Larger files are sent using the PutS3MultipartUpload method. This multipart process saves state after each step so that a large upload can be resumed with minimal loss if the processor or cluster is stopped and restarted.
A multipart upload consists of three steps:
1) initiate upload,
2) upload the parts, and
3) complete the upload.
For multipart uploads, the processor saves state locally tracking the upload ID and parts uploaded, which must both be provided to complete the upload.
The AWS libraries select an endpoint URL based on the AWS region, but this can be overridden with the 'Endpoint Override URL' property for use with other S3-compatible endpoints.
The S3 API specifies that the maximum file size for a PutS3Object upload is 5GB. It also requires that parts in a multipart upload must be at least 5MB in size, except for the last part. These limits establish the bounds for the Multipart Upload Threshold and Part Size properties.
| Name | Default Value | Allowable Values | Description |
|---|
| Object Key | ${filename} | | No Description Provided.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
| Bucket | | | No Description Provided.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
| Content Type | | | Sets the Content-Type HTTP header indicating the type of content stored in the associated object. The value of this header is a standard MIME type.
AWS S3 Java client will attempt to determine the correct content type if one hasn't been set yet. Users are responsible for ensuring a suitable content type is set when uploading streams. If no content type is provided and cannot be determined by the filename, the default content type "application/octet-stream" will be used.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
| Content Disposition | | | Sets the Content-Disposition HTTP header indicating if the content is intended to be displayed inline or should be downloaded.
Possible values are 'inline' or 'attachment'. If this property is not specified, object's content-disposition will be set to filename. When 'attachment' is selected, '; filename=' plus object key are automatically appended to form final value 'attachment; filename="filename.jpg"'. |
| Cache Control | | | Sets the Cache-Control HTTP header indicating the caching directives of the associated object. Multiple directives are comma-separated.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
| Access Key ID | | | No Description Provided.
Sensitive Property: true
Supports Expression Language: true (will be evaluated using variable registry only) |
| Secret Access Key | | | No Description Provided.
Sensitive Property: true
Supports Expression Language: true (will be evaluated using variable registry only) |
| Credentials File | | | Path to a file containing AWS access key and secret key in properties file format.
This property requires exactly one file to be provided..
|
| AWS Credentials Provider Service | | Controller Service API:
AWSCredentialsProviderService
Implementation: AWSCredentialsProviderControllerService | The Controller Service that is used to obtain aws credentials provider |
| Object Tags Prefix | | | Specifies the prefix which would be scanned against the incoming FlowFile's attributes and the matching attribute's name and value would be considered as the outgoing S3 object's Tag name and Tag value respectively. For Ex: If the incoming FlowFile carries the attributes tagS3country, tagS3PII, the tag prefix to be specified would be 'tagS3'
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
| Remove Tag Prefix | false | | If set to 'True', the value provided for 'Object Tags Prefix' will be removed from the attribute(s) and then considered as the Tag name. For ex: If the incoming FlowFile carries the attributes tagS3country, tagS3PII and the prefix is set to 'tagS3' then the corresponding tag values would be 'country' and 'PII' |
| Storage Class | Standard | - DeepArchive
- Glacier
- GlacierInstantRetrieval
- IntelligentTiering
- OneZoneInfrequentAccess
- Outposts
- ReducedRedundancy
- Standard
- StandardInfrequentAccess
| No Description Provided. |
| Region | us-west-2 | - AWS GovCloud (US)
 - AWS GovCloud (US-East)
- US East (N. Virginia)
- US East (Ohio)
- US West (N. California)
- US West (Oregon)
- EU (Ireland)
- EU (London)
- EU (Paris)
- EU (Frankfurt)
- EU (Stockholm)
- EU (Milan)
- Asia Pacific (Hong Kong)
- Asia Pacific (Mumbai)
- Asia Pacific (Singapore)
- Asia Pacific (Sydney)
- Asia Pacific (Jakarta)
- Asia Pacific (Tokyo)
- Asia Pacific (Seoul)
- Asia Pacific (Osaka)
- South America (Sao Paulo)
- China (Beijing)
- China (Ningxia)
- Canada (Central)
- Middle East (Bahrain)
- Africa (Cape Town)
- US ISO East
- US ISOB East (Ohio)
- US ISO West
| No Description Provided. |
| Communications Timeout | 30 secs | | No Description Provided. |
| Expiration Time Rule | | | No Description Provided.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
| FullControl User List | ${s3.permissions.full.users} | | A comma-separated list of Amazon User ID's or E-mail addresses that specifies who should have Full Control for an object
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
| Read Permission User List | ${s3.permissions.read.users} | | A comma-separated list of Amazon User ID's or E-mail addresses that specifies who should have Read Access for an object
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
| Write Permission User List | ${s3.permissions.write.users} | | A comma-separated list of Amazon User ID's or E-mail addresses that specifies who should have Write Access for an object
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
| Read ACL User List | ${s3.permissions.readacl.users} | | A comma-separated list of Amazon User ID's or E-mail addresses that specifies who should have permissions to read the Access Control List for an object
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
| Write ACL User List | ${s3.permissions.writeacl.users} | | A comma-separated list of Amazon User ID's or E-mail addresses that specifies who should have permissions to change the Access Control List for an object
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
| Owner | ${s3.owner} | | The Amazon ID to use for the object's owner
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
| Canned ACL | ${s3.permissions.cannedacl} | | Amazon Canned ACL for an object, one of: BucketOwnerFullControl, BucketOwnerRead, LogDeliveryWrite, AuthenticatedRead, PublicReadWrite, PublicRead, Private; will be ignored if any other ACL/permission/owner property is specified
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
| SSL Context Service | | Controller Service API:
SSLContextService
Implementations: StandardSSLContextService
StandardRestrictedSSLContextService | Specifies an optional SSL Context Service that, if provided, will be used to create connections |
| Endpoint Override URL | | | Endpoint URL to use instead of the AWS default including scheme, host, port, and path. The AWS libraries select an endpoint URL based on the AWS region, but this property overrides the selected endpoint URL, allowing use with other S3-compatible endpoints.
Supports Expression Language: true (will be evaluated using variable registry only) |
| Signer Override | Default Signature | - Default Signature
- Signature v4
- Signature v2
| The AWS libraries use the default signer but this property allows you to specify a custom signer to support older S3-compatible services. |
| Multipart Threshold | 5 GB | | Specifies the file size threshold for switch from the PutS3Object API to the PutS3MultipartUpload API. Flow files bigger than this limit will be sent using the stateful multipart process.
The valid range is 50MB to 5GB. |
| Multipart Part Size | 5 GB | | Specifies the part size for use when the PutS3Multipart Upload API is used.
Flow files will be broken into chunks of this size for the upload process, but the last part sent can be smaller since it is not padded.
The valid range is 50MB to 5GB. |
| Multipart Upload AgeOff Interval | 60 min | | Specifies the interval at which existing multipart uploads in AWS S3 will be evaluated for ageoff. When processor is triggered it will initiate the ageoff evaluation if this interval has been exceeded. |
| Multipart Upload Max Age Threshold | 7 days | | Specifies the maximum age for existing multipart uploads in AWS S3. When the ageoff process occurs, any upload older than this threshold will be aborted. |
| Temporary Directory Multipart State | ${java.io.tmpdir} | | Directory in which, for multipart uploads, the processor will locally save the state tracking the upload ID and parts uploaded which must both be provided to complete the upload.
Supports Expression Language: true (will be evaluated using variable registry only) |
| Server Side Encryption | None | | Specifies the algorithm used for server side encryption. |
| Encryption Service | | Controller Service API:
AmazonS3EncryptionService
Implementation: StandardS3EncryptionService | Specifies the Encryption Service Controller used to configure requests. PutS3Object: For backward compatibility, this value is ignored when 'Server Side Encryption' is set. FetchS3Object: Only needs to be configured in case of Server-side Customer Key, Client-side KMS and Client-side Customer Key encryptions. |
| Use Chunked Encoding | true | | Enables / disables chunked encoding for upload requests. Set it to false only if your endpoint does not support chunked uploading. |
| Use Path Style Access | false | | Path-style access can be enforced by setting this property to true. Set it to true if your endpoint does not support virtual-hosted-style requests, only path-style requests. |
| Proxy Configuration Service | | Controller Service API:
ProxyConfigurationService
Implementation: StandardProxyConfigurationService | Specifies the Proxy Configuration Controller Service to proxy network requests. If set, it supersedes proxy settings configured per component. Supported proxies: HTTP + AuthN |
| Proxy Host | | | Proxy host name or IP
Supports Expression Language: true (will be evaluated using variable registry only) |
| Proxy Host Port | | | Proxy host port
Supports Expression Language: true (will be evaluated using variable registry only) |
| Proxy Username | | | Proxy username
Supports Expression Language: true (undefined scope) |
| Proxy Password | | | Proxy password
Sensitive Property: true
Supports Expression Language: true (undefined scope) |
Dynamic Properties allow the user to specify both the name and value of a property.
| Name | Description |
|---|
| s3.bucket | The S3 bucket where the Object was put in S3 |
| s3.key | The S3 key within where the Object was put in S3 |
| s3.contenttype | The S3 content type of the S3 Object that put in S3 |
| s3.version | The version of the S3 Object that was put to S3 |
| s3.exception | The class name of the exception thrown during processor execution |
| s3.additionalDetails | The S3 supplied detail from the failed operation |
| s3.statusCode | The HTTP error code (if available) from the failed operation |
| s3.errorCode | The S3 moniker of the failed operation |
| s3.errorMessage | The S3 exception message from the failed operation |
| s3.etag | The ETag of the S3 Object |
| s3.contentdisposition | The content disposition of the S3 Object that put in S3 |
| s3.cachecontrol | The cache-control header of the S3 Object |
| s3.uploadId | The uploadId used to upload the Object to S3 |
| s3.expiration | A human-readable form of the expiration date of the S3 object, if one is set |
| s3.sseAlgorithm | The server side encryption algorithm of the object |
| s3.usermetadata | A human-readable form of the User Metadata of the S3 object, if any was set |
| s3.encryptionStrategy | The name of the encryption strategy, if any was set |