FetchS3Object

Description:

Retrieves the contents of an S3 Object and writes it to the content of a FlowFile

Tags:

Amazon, S3, AWS, Get, Fetch

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
BucketNo Description Provided.
Supports Expression Language: true
Object Key${filename}No Description Provided.
Supports Expression Language: true
Regionus-west-2
  • us-gov-west-1 us-gov-west-1
  • us-east-1 us-east-1
  • us-east-2 us-east-2
  • us-west-1 us-west-1
  • us-west-2 us-west-2
  • eu-west-1 eu-west-1
  • eu-west-2 eu-west-2
  • eu-central-1 eu-central-1
  • ap-south-1 ap-south-1
  • ap-southeast-1 ap-southeast-1
  • ap-southeast-2 ap-southeast-2
  • ap-northeast-1 ap-northeast-1
  • ap-northeast-2 ap-northeast-2
  • sa-east-1 sa-east-1
  • cn-north-1 cn-north-1
  • ca-central-1 ca-central-1
No Description Provided.
Access KeyNo Description Provided.
Sensitive Property: true
Supports Expression Language: true
Secret KeyNo Description Provided.
Sensitive Property: true
Supports Expression Language: true
Credentials FilePath to a file containing AWS access key and secret key in properties file format.
AWS Credentials Provider serviceController Service API:
AWSCredentialsProviderService
Implementation:AWSCredentialsProviderControllerService
The Controller Service that is used to obtain aws credentials provider
Communications Timeout30 secsNo Description Provided.
VersionThe Version of the Object to download
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.
Supports Expression Language: true
Signer OverrideDefault 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.
Proxy HostProxy host name or IP
Supports Expression Language: true
Proxy Host PortProxy host port
Supports Expression Language: true

Relationships:

NameDescription
successFlowFiles are routed to success relationship
failureFlowFiles are routed to failure relationship

Reads Attributes:

None specified.

Writes Attributes:

NameDescription
s3.bucketThe name of the S3 bucket
pathThe path of the file
absolute.pathThe path of the file
filenameThe name of the file
hash.valueThe MD5 sum of the file
hash.algorithmMD5
mime.typeIf S3 provides the content type/MIME type, this attribute will hold that file
s3.etagThe ETag that can be used to see if the file has changed
s3.expirationTimeIf the file has an expiration date, this attribute will be set, containing the milliseconds since epoch in UTC time
s3.expirationTimeRuleIdThe ID of the rule that dictates this object's expiration time
s3.sseAlgorithmThe server side encryption algorithm of the object
s3.versionThe version of the S3 object

State management:

This component does not store state.

Restricted:

This component is not restricted.

Input requirement:

This component requires an incoming relationship.

See Also:

PutS3Object, DeleteS3Object, ListS3