PutS3Object
Description
Writes the contents of a FlowFile as an S3 Object to an Amazon S3 Bucket.
Tags
AWS, Amazon, Archive, Put, S3
Properties
In the list below required Properties are shown with an asterisk (*). Other properties are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.
| Display Name | API Name | Default Value | Allowable Values | Description |
|---|---|---|---|---|
| Bucket * | Bucket | ${s3.bucket} | The S3 Bucket to interact with Supports Expression Language, using FlowFile attributes and Environment variables. | |
| Object Key * | Object Key | ${filename} | The S3 Object Key to use. This is analogous to a filename for traditional file systems. Supports Expression Language, using FlowFile attributes and Environment variables. | |
| Region * | Region | US West (Oregon) |
| The AWS Region to connect to. |
| AWS Credentials Provider Service * | AWS Credentials Provider service | Controller Service: AWSCredentialsProviderService Implementations: AWSCredentialsProviderControllerService | The Controller Service that is used to obtain AWS credentials provider | |
| Resource Transfer Source * | Resource Transfer Source | FlowFile Content |
| The source of the content to be transferred |
| File Resource Service * | File Resource Service | Controller Service: FileResourceService Implementations: AzureBlobStorageFileResourceService AzureDataLakeStorageFileResourceService GCSFileResourceService S3FileResourceService StandardFileResourceService | File Resource Service providing access to the local resource to be transferred This property is only considered if:
| |
| Storage Class * | Storage Class | Standard |
| |
| Encryption Service | encryption-service | Controller Service: AmazonS3EncryptionService Implementations: 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. | |
| Server Side Encryption * | server-side-encryption | None |
| Specifies the algorithm used for server side encryption. |
| Content Type | 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, using FlowFile attributes and Environment variables. | ||
| Content Disposition | 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 | Cache Control | Sets the Cache-Control HTTP header indicating the caching directives of the associated object. Multiple directives are comma-separated. Supports Expression Language, using FlowFile attributes and Environment variables. | ||
| Object Tags Prefix | s3-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, using FlowFile attributes and Environment variables. | ||
| Remove Tag Prefix | s3-object-remove-tags-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' |
| Communications Timeout * | Communications Timeout | 30 secs | The amount of time to wait in order to establish a connection to AWS or receive data from AWS before timing out. | |
| Expiration Time Rule | Expiration Time Rule | Supports Expression Language, using FlowFile attributes and Environment variables. | ||
| FullControl User List | 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, using FlowFile attributes and Environment variables. | |
| Read Permission User List | 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, using FlowFile attributes and Environment variables. | |
| Write Permission User List | 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, using FlowFile attributes and Environment variables. | |
| Read ACL User List | 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, using FlowFile attributes and Environment variables. | |
| Write ACL User List | 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, using FlowFile attributes and Environment variables. | |
| Owner | Owner | ${s3.owner} | The Amazon ID to use for the object's owner Supports Expression Language, using FlowFile attributes and Environment variables. | |
| Canned ACL | 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, using FlowFile attributes and Environment variables. | |
| SSL Context Service | SSL Context Service | Controller Service: SSLContextService Implementations: StandardRestrictedSSLContextService StandardSSLContextService | Specifies an optional SSL Context Service that, if provided, will be used to create connections | |
| Endpoint Override URL | 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, using Environment variables. | ||
| Signer Override | Signer Override | Default Signature |
| The AWS S3 library uses Signature Version 4 by default but this property allows you to specify the Version 2 signer to support older S3-compatible services or even to plug in your own custom signer implementation. |
| Custom Signer Class Name * | custom-signer-class-name | Fully qualified class name of the custom signer class. The signer must implement com.amazonaws.auth.Signer interface. Supports Expression Language, using Environment variables. This property is only considered if:
| ||
| Custom Signer Module Location | custom-signer-module-location | Comma-separated list of paths to files and/or directories which contain the custom signer's JAR file and its dependencies (if any). Supports Expression Language, using Environment variables. This property is only considered if:
| ||
| Multipart Threshold * | 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 * | 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 * | 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 * | 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 * | s3-temporary-directory-multipart | ${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, using Environment variables. | |
| Use Chunked Encoding | 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 | 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 | proxy-configuration-service | Controller Service: ProxyConfigurationService Implementations: StandardProxyConfigurationService | Specifies the Proxy Configuration Controller Service to proxy network requests. Supported proxies: HTTP + AuthN |
Dynamic Properties
| Name | Value | Description |
|---|---|---|
| The name of a User-Defined Metadata field to add to the S3 Object | The value of a User-Defined Metadata field to add to the S3 Object | Allows user-defined metadata to be added to the S3 object as key/value pairs Supports Expression Language: Yes, evaluated using FlowFile Attributes and Environment variables. |
Relationships
| Name | Description |
|---|---|
| failure | If the Processor is unable to process a given FlowFile, it will be routed to this Relationship. |
| success | FlowFiles are routed to this Relationship after they have been successfully processed. |
Reads Attributes
| Name | Description |
|---|---|
| filename | Uses the FlowFile's filename as the filename for the S3 object |
Writes Attributes
| Name | Description |
|---|---|
| s3.additionalDetails | The S3 supplied detail from the failed operation |
| s3.bucket | The S3 bucket where the Object was put in S3 |
| s3.cachecontrol | The cache-control header of the S3 Object |
| s3.contentdisposition | The content disposition of the S3 Object that put in S3 |
| s3.contenttype | The S3 content type of the S3 Object that put in S3 |
| s3.encryptionStrategy | The name of the encryption strategy, if any was set |
| 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.exception | The class name of the exception thrown during processor execution |
| s3.expiration | A human-readable form of the expiration date of the S3 object, if one is set |
| s3.key | The S3 key within where the Object was put in S3 |
| s3.sseAlgorithm | The server side encryption algorithm of the object |
| s3.statusCode | The HTTP error code (if available) from the failed operation |
| s3.uploadId | The uploadId used to upload the Object to S3 |
| s3.url | The URL that can be used to access the S3 object |
| s3.usermetadata | A human-readable form of the User Metadata of the S3 object, if any was set |
| s3.version | The version of the S3 Object that was put to S3 |
State Management
This component does not store state.
Restricted
This component is not restricted.
Input Requirement
This component requires an incoming relationship.
System Resource Considerations
This component does not specify system resource considerations.
See Also
CopyS3Object, DeleteS3Object, FetchS3Object, GetS3ObjectMetadata, ListS3, TagS3Object