GetS3ObjectMetadata

GetS3ObjectMetadata 2.7.0

Bundle: org.apache.nifi | nifi-aws-nar
Description: Check for the existence of an Object in S3 and fetch its Metadata without attempting to download it. This processor can be used as a router for workflows that need to check on an Object 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.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

Display Name

Communications Timeout

Description

API Name

Communications Timeout

Default Value

30 secs

Expression Language Scope

Not Supported

Sensitive

false

Required

true
Custom Region
Custom region, e.g. a region of an AWS compatible service provider
Display Name

Custom Region

Description

Custom region, e.g. a region of an AWS compatible service provider

API Name

Custom Region

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true

Dependencies
- Region is set to any of [use-custom-region]
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
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
Proxy Configuration Service
Specifies the Proxy Configuration Controller Service to proxy network requests.

Display Name

Proxy Configuration Service

Description

Specifies the Proxy Configuration Controller Service to proxy network requests.

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
Region
AWS Region in which the service is located
Display Name

Region

Description

AWS Region in which the service is located

API Name

Region

Default Value

us-west-2

Allowable Values
- AWS GovCloud (US-East)
- AWS GovCloud (US-West)
- Africa (Cape Town)
- Asia Pacific (Hong Kong)
- Asia Pacific (Hyderabad)
- Asia Pacific (Jakarta)
- Asia Pacific (Malaysia)
- Asia Pacific (Melbourne)
- Asia Pacific (Mumbai)
- Asia Pacific (New Zealand)
- Asia Pacific (Osaka)
- Asia Pacific (Seoul)
- Asia Pacific (Singapore)
- Asia Pacific (Sydney)
- Asia Pacific (Taipei)
- Asia Pacific (Thailand)
- Asia Pacific (Tokyo)
- Canada (Central)
- Canada West (Calgary)
- China (Beijing)
- China (Ningxia)
- EU (Germany)
- EU ISOE West
- Europe (Frankfurt)
- Europe (Ireland)
- Europe (London)
- Europe (Milan)
- Europe (Paris)
- Europe (Spain)
- Europe (Stockholm)
- Europe (Zurich)
- Israel (Tel Aviv)
- Mexico (Central)
- Middle East (Bahrain)
- Middle East (UAE)
- South America (Sao Paulo)
- US East (N. Virginia)
- US East (Ohio)
- US ISO East
- US ISO WEST
- US ISOB East (Ohio)
- US ISOB West
- US ISOF EAST
- US ISOF SOUTH
- US West (N. California)
- US West (Oregon)
- aws global region
- aws-cn global region
- aws-iso global region
- aws-iso-b global region
- aws-iso-e global region
- aws-iso-f global region
- aws-us-gov global region
- Use Custom Region
Expression Language Scope

Not Supported

Sensitive

false

Required

true
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.SSLContextProvider

Service Implementations

org.apache.nifi.ssl.PEMEncodedSSLContextProvider

org.apache.nifi.ssl.StandardRestrictedSSLContextService

org.apache.nifi.ssl.StandardSSLContextService

Expression Language Scope

Not Supported

Sensitive

false

Required

false
Version
The Version of the Object for which to retrieve Metadata

Display Name

Version

Description

The Version of the Object for which to retrieve Metadata

API Name

Version

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false

Relationships

Name	Description
failure	FlowFiles are routed to failure 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