GetS3ObjectMetadata

GetS3ObjectMetadata 2.0.0

Bundle: org.apache.nifi | nifi-aws-nar
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
Input Requirement: REQUIRED
Supports Sensitive Dynamic Properties: false

Properties

AWS Credentials Provider Service
The Controller Service that is used to obtain AWS credentials provider

Display Name

AWS Credentials Provider Service

Description

The Controller Service that is used to obtain AWS credentials provider

API Name

AWS Credentials Provider service

Service Interface

org.apache.nifi.processors.aws.credentials.provider.service.AWSCredentialsProviderService

Service Implementations

org.apache.nifi.processors.aws.credentials.provider.service.AWSCredentialsProviderControllerService

Expression Language Scope

Not Supported

Sensitive

false

Required

true
Bucket
The S3 Bucket to interact with

Display Name

Bucket

Description

The S3 Bucket to interact with

API Name

Bucket

Default Value

${s3.bucket}

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true
Communications Timeout
The amount of time to wait in order to establish a connection to AWS or receive data from AWS before timing out.

Display Name

Communications Timeout

Description

The amount of time to wait in order to establish a connection to AWS or receive data from AWS before timing out.

API Name

Communications Timeout

Default Value

30 secs

Expression Language Scope

Not Supported

Sensitive

false

Required

true
Custom Signer Class Name
Fully qualified class name of the custom signer class. The signer must implement com.amazonaws.auth.Signer interface.
Display Name

Custom Signer Class Name

Description

Fully qualified class name of the custom signer class. The signer must implement com.amazonaws.auth.Signer interface.

API Name

custom-signer-class-name

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

true

Dependencies
- Signer Override is set to any of [CustomSignerType]
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).
Display Name

Custom Signer Module Location

Description

Comma-separated list of paths to files and/or directories which contain the custom signer's JAR file and its dependencies (if any).

API Name

custom-signer-module-location

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false

Dependencies
- Signer Override is set to any of [CustomSignerType]
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.

Display Name

Endpoint Override URL

Description

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.

API Name

Endpoint Override URL

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false
FullControl User List
A comma-separated list of Amazon User ID's or E-mail addresses that specifies who should have Full Control for an object

Display Name

FullControl User List

Description

A comma-separated list of Amazon User ID's or E-mail addresses that specifies who should have Full Control for an object

API Name

FullControl User List

Default Value

${s3.permissions.full.users}

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false
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.
Display Name

Metadata Attribute Include Pattern

Description

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.

API Name

Metadata Attribute Include Pattern

Default Value

.*

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false

Dependencies
- Metadata Target is set to any of [ATTRIBUTES]
Metadata Target
This determines where the metadata will be written when found.
Display Name

Metadata Target

Description

This determines where the metadata will be written when found.

API Name

Metadata Target

Default Value

ATTRIBUTES

Allowable Values
- Attributes
- FlowFile Body
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Object Key
The S3 Object Key to use. This is analogous to a filename for traditional file systems.

Display Name

Object Key

Description

The S3 Object Key to use. This is analogous to a filename for traditional file systems.

API Name

Object Key

Default Value

${filename}

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true
Owner
The Amazon ID to use for the object's owner

Display Name

Owner

Description

The Amazon ID to use for the object's owner

API Name

Owner

Default Value

${s3.owner}

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false
Proxy Configuration Service
Specifies the Proxy Configuration Controller Service to proxy network requests. Supported proxies: HTTP + AuthN

Display Name

Proxy Configuration Service

Description

Specifies the Proxy Configuration Controller Service to proxy network requests. Supported proxies: HTTP + AuthN

API Name

proxy-configuration-service

Service Interface

org.apache.nifi.proxy.ProxyConfigurationService

Service Implementations

org.apache.nifi.proxy.StandardProxyConfigurationService

Expression Language Scope

Not Supported

Sensitive

false

Required

false
Read ACL User List
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

Display Name

Read ACL User List

Description

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

API Name

Read ACL User List

Default Value

${s3.permissions.readacl.users}

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false
Read Permission User List
A comma-separated list of Amazon User ID's or E-mail addresses that specifies who should have Read Access for an object

Display Name

Read Permission User List

Description

A comma-separated list of Amazon User ID's or E-mail addresses that specifies who should have Read Access for an object

API Name

Read Permission User List

Default Value

${s3.permissions.read.users}

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false
Region
The AWS Region to connect to.
Display Name

Region

Description

The AWS Region to connect to.

API Name

Region

Default Value

us-west-2

Allowable Values
- 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
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Signer Override
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.
Display Name

Signer Override

Description

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.

API Name

Signer Override

Default Value

Default Signature

Allowable Values
- Default Signature
- Signature Version 4
- Signature Version 2
- Custom Signature
Expression Language Scope

Not Supported

Sensitive

false

Required

false
SSL Context Service
Specifies an optional SSL Context Service that, if provided, will be used to create connections

Display Name

SSL Context Service

Description

Specifies an optional SSL Context Service that, if provided, will be used to create connections

API Name

SSL Context Service

Service Interface

org.apache.nifi.ssl.SSLContextService

Service Implementations

org.apache.nifi.ssl.StandardRestrictedSSLContextService

org.apache.nifi.ssl.StandardSSLContextService

Expression Language Scope

Not Supported

Sensitive

false

Required

false

Relationships

Name	Description
not found	No object was found in the bucket the supplied key
found	An object was found in the bucket at the supplied key
failure	If the Processor is unable to process a given FlowFile, it will be routed to this Relationship.