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 Region Code : us-gov-west-1 AWS Region Code : us-gov-west-1](../../../../../html/images/iconInfo.png) - AWS GovCloud (US-East)
![AWS Region Code : us-gov-east-1 AWS Region Code : us-gov-east-1](../../../../../html/images/iconInfo.png) - US East (N. Virginia)
![AWS Region Code : us-east-1 AWS Region Code : us-east-1](../../../../../html/images/iconInfo.png) - US East (Ohio)
![AWS Region Code : us-east-2 AWS Region Code : us-east-2](../../../../../html/images/iconInfo.png) - US West (N. California)
![AWS Region Code : us-west-1 AWS Region Code : us-west-1](../../../../../html/images/iconInfo.png) - US West (Oregon)
![AWS Region Code : us-west-2 AWS Region Code : us-west-2](../../../../../html/images/iconInfo.png) - EU (Ireland)
![AWS Region Code : eu-west-1 AWS Region Code : eu-west-1](../../../../../html/images/iconInfo.png) - EU (London)
![AWS Region Code : eu-west-2 AWS Region Code : eu-west-2](../../../../../html/images/iconInfo.png) - EU (Paris)
![AWS Region Code : eu-west-3 AWS Region Code : eu-west-3](../../../../../html/images/iconInfo.png) - EU (Frankfurt)
![AWS Region Code : eu-central-1 AWS Region Code : eu-central-1](../../../../../html/images/iconInfo.png) - EU (Zurich)
![AWS Region Code : eu-central-2 AWS Region Code : eu-central-2](../../../../../html/images/iconInfo.png) - EU (Stockholm)
![AWS Region Code : eu-north-1 AWS Region Code : eu-north-1](../../../../../html/images/iconInfo.png) - EU (Milan)
![AWS Region Code : eu-south-1 AWS Region Code : eu-south-1](../../../../../html/images/iconInfo.png) - EU (Spain)
![AWS Region Code : eu-south-2 AWS Region Code : eu-south-2](../../../../../html/images/iconInfo.png) - Asia Pacific (Hong Kong)
![AWS Region Code : ap-east-1 AWS Region Code : ap-east-1](../../../../../html/images/iconInfo.png) - Asia Pacific (Mumbai)
![AWS Region Code : ap-south-1 AWS Region Code : ap-south-1](../../../../../html/images/iconInfo.png) - Asia Pacific (Hyderabad)
![AWS Region Code : ap-south-2 AWS Region Code : ap-south-2](../../../../../html/images/iconInfo.png) - Asia Pacific (Singapore)
![AWS Region Code : ap-southeast-1 AWS Region Code : ap-southeast-1](../../../../../html/images/iconInfo.png) - Asia Pacific (Sydney)
![AWS Region Code : ap-southeast-2 AWS Region Code : ap-southeast-2](../../../../../html/images/iconInfo.png) - Asia Pacific (Jakarta)
![AWS Region Code : ap-southeast-3 AWS Region Code : ap-southeast-3](../../../../../html/images/iconInfo.png) - Asia Pacific (Melbourne)
![AWS Region Code : ap-southeast-4 AWS Region Code : ap-southeast-4](../../../../../html/images/iconInfo.png) - Asia Pacific (Tokyo)
![AWS Region Code : ap-northeast-1 AWS Region Code : ap-northeast-1](../../../../../html/images/iconInfo.png) - Asia Pacific (Seoul)
![AWS Region Code : ap-northeast-2 AWS Region Code : ap-northeast-2](../../../../../html/images/iconInfo.png) - Asia Pacific (Osaka)
![AWS Region Code : ap-northeast-3 AWS Region Code : ap-northeast-3](../../../../../html/images/iconInfo.png) - South America (Sao Paulo)
![AWS Region Code : sa-east-1 AWS Region Code : sa-east-1](../../../../../html/images/iconInfo.png) - China (Beijing)
![AWS Region Code : cn-north-1 AWS Region Code : cn-north-1](../../../../../html/images/iconInfo.png) - China (Ningxia)
![AWS Region Code : cn-northwest-1 AWS Region Code : cn-northwest-1](../../../../../html/images/iconInfo.png) - Canada (Central)
![AWS Region Code : ca-central-1 AWS Region Code : ca-central-1](../../../../../html/images/iconInfo.png) - Canada West (Calgary)
![AWS Region Code : ca-west-1 AWS Region Code : ca-west-1](../../../../../html/images/iconInfo.png) - Middle East (UAE)
![AWS Region Code : me-central-1 AWS Region Code : me-central-1](../../../../../html/images/iconInfo.png) - Middle East (Bahrain)
![AWS Region Code : me-south-1 AWS Region Code : me-south-1](../../../../../html/images/iconInfo.png) - Africa (Cape Town)
![AWS Region Code : af-south-1 AWS Region Code : af-south-1](../../../../../html/images/iconInfo.png) - US ISO East
![AWS Region Code : us-iso-east-1 AWS Region Code : us-iso-east-1](../../../../../html/images/iconInfo.png) - US ISOB East (Ohio)
![AWS Region Code : us-isob-east-1 AWS Region Code : us-isob-east-1](../../../../../html/images/iconInfo.png) - US ISO West
![AWS Region Code : us-iso-west-1 AWS Region Code : us-iso-west-1](../../../../../html/images/iconInfo.png) - Israel (Tel Aviv)
![AWS Region Code : il-central-1 AWS Region Code : il-central-1](../../../../../html/images/iconInfo.png) - Use 's3.region' Attribute
![Uses 's3.region' FlowFile attribute as region. Uses 's3.region' FlowFile attribute as region.](../../../../../html/images/iconInfo.png)
| 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 |
Relationships:
Name | Description |
---|
not found | No object was found in the bucket the supplied key |
failure | FlowFiles are routed to failure relationship |
found | An object was found in the bucket at the supplied key |
Reads Attributes:
None specified.Writes Attributes:
None specified.State management:
This component does not store state.Restricted:
This component is not restricted.Input requirement:
This component requires an incoming relationship.System Resource Considerations:
None specified.See Also:
PutS3Object, DeleteS3Object, ListS3, TagS3Object, DeleteS3Object, FetchS3Object