Retrieves the contents of an S3 Object and writes it to the content of a FlowFile
| Display Name | API Name | Default Value | Allowable Values | Description |
|---|
| Bucket | Bucket | | | The S3 Bucket to interact with
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
| Object Key | Object Key | ${filename} | | The S3 Object Key to use. This is analogous to a filename for traditional file systems.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
| Region | Region | US West (Oregon) | - 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 (Zurich)
- EU (Stockholm)
- EU (Milan)
- EU (Spain)
- Asia Pacific (Hong Kong)
- Asia Pacific (Mumbai)
- Asia Pacific (Hyderabad)
- Asia Pacific (Singapore)
- Asia Pacific (Sydney)
- Asia Pacific (Jakarta)
- Asia Pacific (Melbourne)
- Asia Pacific (Tokyo)
- Asia Pacific (Seoul)
- Asia Pacific (Osaka)
- South America (Sao Paulo)
- China (Beijing)
- China (Ningxia)
- Canada (Central)
- Canada West (Calgary)
- Middle East (UAE)
- Middle East (Bahrain)
- Africa (Cape Town)
- US ISO East
- US ISOB East (Ohio)
- US ISO West
- Israel (Tel Aviv)
- Use 's3.region' Attribute
| The AWS Region to connect to. |
| Access Key ID | Access Key | | | No Description Provided.
Sensitive Property: true
Supports Expression Language: true (will be evaluated using variable registry only) |
| Secret Access Key | Secret Key | | | No Description Provided.
Sensitive Property: true
Supports Expression Language: true (will be evaluated using variable registry only) |
| Credentials File | 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 | AWS Credentials Provider service | | Controller Service API:
AWSCredentialsProviderService
Implementation: AWSCredentialsProviderControllerService | The Controller Service that is used to obtain AWS credentials provider |
| 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. |
| Version | Version | | | The Version of the Object to download
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
| SSL Context Service | 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 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 | Signer Override | Default Signature | - Default Signature
- Signature Version 4
- Signature Version 2
- Custom 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: true (will be evaluated using variable registry only)
This Property is only considered if the [Signer Override] Property has a value of "Custom Signature". |
| 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).
This property expects a comma-separated list of resources. Each of the resources may be of any of the following types: file, directory.
Supports Expression Language: true (will be evaluated using variable registry only)
This Property is only considered if the [Signer Override] Property has a value of "Custom Signature". |
| Encryption Service | 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. |
| Proxy Configuration Service | 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 | | | Proxy host name or IP
Supports Expression Language: true (will be evaluated using variable registry only) |
| Proxy Host Port | Proxy Host Port | | | Proxy host port
Supports Expression Language: true (will be evaluated using variable registry only) |
| Proxy Username | proxy-user-name | | | Proxy username
Supports Expression Language: true (undefined scope) |
| Proxy Password | proxy-user-password | | | Proxy password
Sensitive Property: true
Supports Expression Language: true (undefined scope) |
| Requester Pays | requester-pays | False | - True
- False
| If true, indicates that the requester consents to pay any charges associated with retrieving objects from the S3 bucket. This sets the 'x-amz-request-payer' header to 'requester'. |
| Range Start | range-start | | | The byte position at which to start reading from the object. An empty value or a value of zero will start reading at the beginning of the object.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
| Range Length | range-length | | | The number of bytes to download from the object, starting from the Range Start. An empty value or a value that extends beyond the end of the object will read to the end of the object.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
| Name | Description |
|---|
| s3.bucket | The name of the S3 bucket |
| path | The path of the file |
| absolute.path | The path of the file |
| filename | The name of the file |
| hash.value | The MD5 sum of the file |
| hash.algorithm | MD5 |
| mime.type | If S3 provides the content type/MIME type, this attribute will hold that file |
| s3.etag | The ETag that can be used to see if the file has changed |
| 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.expirationTime | If the file has an expiration date, this attribute will be set, containing the milliseconds since epoch in UTC time |
| s3.expirationTimeRuleId | The ID of the rule that dictates this object's expiration time |
| s3.sseAlgorithm | The server side encryption algorithm of the object |
| s3.version | The version of the S3 object |
| s3.encryptionStrategy | The name of the encryption strategy that was used to store the S3 object (if it is encrypted) |