GetS3ObjectMetadata 2.3.0¶
BUNDLE¶
org.apache.nifi | nifi-aws-nar
DESCRIPTION¶
Check for the existence of an Object in S3 and fetch its Metadata without attempting to download it. This processor can be used as a router for workflows that need to check on an Object in S3 before proceeding with data processing
INPUT REQUIREMENT¶
REQUIRED
Supports Sensitive Dynamic Properties¶
false
PROPERTIES¶
Property |
Description |
|---|---|
AWS Credentials Provider service |
The Controller Service that is used to obtain AWS credentials provider |
Bucket |
The S3 Bucket to interact with |
Communications Timeout |
The amount of time to wait in order to establish a connection to AWS or receive data from AWS before timing out. |
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. |
FullControl User List |
A comma-separated list of Amazon User ID’s or E-mail addresses that specifies who should have Full Control for an object |
Metadata Attribute Include Pattern |
A regular expression pattern to use for determining which object metadata entries are included as FlowFileattributes. This pattern is only applied to the ‘found’ relationship and will not be used tofilter the error attributes in the ‘failure’ relationship. |
Metadata Target |
This determines where the metadata will be written when found. |
Object Key |
The S3 Object Key to use. This is analogous to a filename for traditional file systems. |
Owner |
The Amazon ID to use for the object’s owner |
Read ACL User List |
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 |
Read Permission User List |
A comma-separated list of Amazon User ID’s or E-mail addresses that specifies who should have Read Access for an object |
Region |
The AWS Region to connect to. |
SSL Context Service |
Specifies an optional SSL Context Service that, if provided, will be used to create connections |
Signer Override |
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. |
Version |
The Version of the Object for which to retrieve Metadata |
custom-signer-class-name |
Fully qualified class name of the custom signer class. The signer must implement com.amazonaws.auth.Signer interface. |
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). |
proxy-configuration-service |
Specifies the Proxy Configuration Controller Service to proxy network requests. Supported proxies: HTTP + AuthN |
RELATIONSHIPS¶
NAME |
DESCRIPTION |
|---|---|
failure |
If the Processor is unable to process a given FlowFile, it will be routed to this Relationship. |
not found |
No object was found in the bucket the supplied key |
found |
An object was found in the bucket at the supplied key |