Skip to main content

S3FileResourceService

Description

Provides an Amazon Web Services (AWS) S3 file resource for other components.

Tags

AWS, Amazon, S3, file, resource

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 NameAPI NameDefault ValueAllowable ValuesDescription
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.
Region *RegionUS 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.
AWS Credentials Provider Service *AWS Credentials Provider serviceController Service:
AWSCredentialsProviderService

Implementations:
AWSCredentialsProviderControllerService
The Controller Service that is used to obtain AWS credentials provider

State Management

This component does not store state.

Restricted

This component is not restricted.

System Resource Considerations

This component does not specify system resource considerations.

See Also

FetchS3Object