GetS3ObjectMetadata
Description
Check for the existence of a file in S3 without attempting to download it. This processor can be used as a router for work flows that need to check on a file in S3 before proceeding with data processing
Tags
AWS, Amazon, Archive, Exists, S3
Properties
In the list below required Properties are shown with an asterisk (*). Other properties are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.
| Display Name | API Name | Default Value | Allowable Values | Description |
|---|---|---|---|---|
| Metadata Target * | Metadata Target | Attributes |
| 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, using FlowFile attributes and Environment variables. This property is only considered if:
| |
| Bucket * | Bucket | ${s3.bucket} | The S3 Bucket to interact with Supports Expression Language, using FlowFile attributes and Environment variables. | |
| Object Key * | Object Key | ${filename} | The S3 Object Key to use. This is analogous to a filename for traditional file systems. Supports Expression Language, using FlowFile attributes and Environment variables. | |
| AWS Credentials Provider Service * | AWS Credentials Provider service | Controller Service: AWSCredentialsProviderService Implementations: AWSCredentialsProviderControllerService | The Controller Service that is used to obtain AWS credentials provider | |
| Region * | Region | US West (Oregon) |
| 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, using FlowFile attributes and Environment variables. | |
| 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, using FlowFile attributes and Environment variables. | |
| 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, using FlowFile attributes and Environment variables. | |
| Owner | Owner | ${s3.owner} | The Amazon ID to use for the object's owner Supports Expression Language, using FlowFile attributes and Environment variables. | |
| SSL Context Service | SSL Context Service | Controller Service: SSLContextService Implementations: StandardRestrictedSSLContextService StandardSSLContextService | 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, using Environment variables. | ||
| Signer Override | Signer Override | Default 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, using Environment variables. This property is only considered if:
| ||
| 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). Supports Expression Language, using Environment variables. This property is only considered if:
| ||
| Proxy Configuration Service | proxy-configuration-service | Controller Service: ProxyConfigurationService Implementations: StandardProxyConfigurationService | Specifies the Proxy Configuration Controller Service to proxy network requests. Supported proxies: HTTP + AuthN |
Dynamic Properties
This component does not support dynamic properties.
Relationships
| Name | Description |
|---|---|
| failure | If the Processor is unable to process a given FlowFile, it will be routed to this Relationship. |
| found | An object was found in the bucket at the supplied key |
| not found | No object was found in the bucket the supplied key |
Reads Attributes
This processor does not read attributes.
Writes Attributes
This processor does not write attributes.
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
This component does not specify system resource considerations.
See Also
DeleteS3Object, FetchS3Object, ListS3, PutS3Object, TagS3Object