| Display Name | API Name | Default Value | Allowable Values | Description |
|---|
| Metadata Target | Metadata Target | Attributes | - Attributes
 - FlowFile Body
| This determines where the metadata will be written when found. |
| Metadata Attribute Include Pattern | Metadata Attribute Include Pattern | .* | | A regular expression pattern to use for determining which object metadata entries are included as FlowFile attributes. This pattern is only applied to the 'found' relationship and will not be used to filter the error attributes in the 'failure' relationship.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
This Property is only considered if the [Metadata Target] Property has a value of "Attributes". |
| 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) |
| 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 |
| 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. |
| 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. |
| 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: true (will be evaluated using flow file attributes and variable registry) |
| 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: true (will be evaluated using flow file attributes and variable registry) |
| 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: true (will be evaluated using flow file attributes and variable registry) |
| Owner | Owner | ${s3.owner} | | The Amazon ID to use for the object's owner
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". |
| 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 |