Description:

Puts FlowFiles to an Amazon S3 Bucket

Tags:

Amazon, S3, AWS, Archive, Put

Properties:

In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values, whether a property supports the NiFi Expression Language, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the nifi.properties file has an entry for the property nifi.sensitive.props.key.

NameDefault ValueAllowable ValuesDescription
Object Key${filename}No Description Provided.
Supports Expression Language: true
BucketNo Description Provided.
Supports Expression Language: true
Access KeyNo Description Provided.
Sensitive Property: true
Secret KeyNo Description Provided.
Sensitive Property: true
Credentials FileNo Description Provided.
Storage ClassStandard
  • Standard
  • ReducedRedundancy
No Description Provided.
Regionus-west-2
  • us-gov-west-1 us-gov-west-1
  • us-east-1 us-east-1
  • us-west-1 us-west-1
  • us-west-2 us-west-2
  • eu-west-1 eu-west-1
  • eu-central-1 eu-central-1
  • ap-southeast-1 ap-southeast-1
  • ap-southeast-2 ap-southeast-2
  • ap-northeast-1 ap-northeast-1
  • sa-east-1 sa-east-1
  • cn-north-1 cn-north-1
No Description Provided.
Communications Timeout30 secsNo Description Provided.
Expiration Time RuleNo Description Provided.
Supports Expression Language: true
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
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
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
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
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
Owner${s3.owner}The Amazon ID to use for the object's owner
Supports Expression Language: true
SSL Context ServiceController Service API:
SSLContextService
Implementation:
StandardSSLContextService
Specifies an optional SSL Context Service that, if provided, will be used to create connections
Endpoint Override URLEndpoint 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.

Dynamic Properties:

Dynamic Properties allow the user to specify both the name and value of a property.

NameValueDescription
The name of a User-Defined Metadata field to add to the S3 ObjectThe value of a User-Defined Metadata field to add to the S3 ObjectAllows user-defined metadata to be added to the S3 object as key/value pairs
Supports Expression Language: true

Relationships:

NameDescription
failureFlowFiles are routed to failure if unable to be copied to Amazon S3
successFlowFiles are routed to success after being successfully copied to Amazon S3

Reads Attributes:

NameDescription
filenameUses the FlowFile's filename as the filename for the S3 object

Writes Attributes:

NameDescription
s3.bucketThe S3 bucket where the Object was put in S3
s3.keyThe S3 key within where the Object was put in S3
s3.versionThe version of the S3 Object that was put to S3
s3.etagThe ETag of the S3 Object
s3.expirationA human-readable form of the expiration date of the S3 object, if one is set
s3.uploadIdThe uploadId used to upload the Object to S3
s3.usermetadataA human-readable form of the User Metadata of the S3 object, if any was set

See Also:

FetchS3Object, DeleteS3Object