TagS3Object

TagS3Object 2.0.0

Bundle: org.apache.nifi | nifi-aws-nar
Description: Adds or updates a tag on an Amazon S3 Object.
Tags: AWS, Amazon, Archive, S3, Tag
Input Requirement: REQUIRED
Supports Sensitive Dynamic Properties: false

Properties

Append Tag
If set to true, the tag will be appended to the existing set of tags on the S3 object. Any existing tags with the same key as the new tag will be updated with the specified value. If set to false, the existing tags will be removed and the new tag will be set on the S3 object.
Display Name

Append Tag

Description

If set to true, the tag will be appended to the existing set of tags on the S3 object. Any existing tags with the same key as the new tag will be updated with the specified value. If set to false, the existing tags will be removed and the new tag will be set on the S3 object.

API Name

append-tag

Default Value

true

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true
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
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. 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
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
Tag Key
The key of the tag that will be set on the S3 Object

Display Name

Tag Key

Description

The key of the tag that will be set on the S3 Object

API Name

tag-key

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true
Tag Value
The value of the tag that will be set on the S3 Object

Display Name

Tag Value

Description

The value of the tag that will be set on the S3 Object

API Name

tag-value

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true
Version ID
The Version of the Object to tag

Display Name

Version ID

Description

The Version of the Object to tag

API Name

version

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false

Relationships

Name	Description
failure	If the Processor is unable to process a given FlowFile, it will be routed to this Relationship.
success	FlowFiles are routed to this Relationship after they have been successfully processed.

Writes Attributes

Name	Description
s3.tag.___	The tags associated with the S3 object will be written as part of the FlowFile attributes
s3.exception	The class name of the exception thrown during processor execution
s3.additionalDetails	The S3 supplied detail from the failed operation
s3.statusCode	The HTTP error code (if available) from the failed operation
s3.errorCode	The S3 moniker of the failed operation
s3.errorMessage	The S3 exception message from the failed operation