Description and usage of TagS3Object processor:
Sets tags on a FlowFile within an Amazon S3 Bucket.If attempting to tag a file that does not exist, FlowFile is routed to success.
Tags:
Amazon, S3, AWS, Archive, Tag
Properties:
In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values, whether a property supports the Expression Language Guide, and whether a property is considered “sensitive”, meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the nifi.properties file has an entry for the property nifi.sensitive.props.key.
|
Name |
Default Value |
Allowable Values |
Description |
|
Object Key |
${filename} |
No Description Provided. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
|
|
Bucket |
No Description Provided. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
||
| Version ID |
The Version of the Object to tag Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
||
|
Tag Key |
The key of the tag that will be set on the S3 Object Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
||
|
Tag Value |
The value of the tag that will be set on the S3 Object Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
||
|
Append Tag |
true |
* true * false |
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. |
| Access Key ID |
No Description Provided. Sensitive Property: true Supports Expression Language: true (will be evaluated using variable registry only) |
||
| Secret Access Key |
No Description Provided. Sensitive Property: true Supports Expression Language: true (will be evaluated using variable registry only) |
||
| Credentials File | Path to a file containing AWS access key and secret key in properties file format. | ||
| AWS Credentials Provider service |
Controller Service API: AWSCredentialsProviderService Implementation: AWSCredentialsProviderControllerService |
The Controller Service that is used to obtain aws credentials provider | |
|
Region |
us-west-2 |
* 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) * Asia Pacific (Mumbai) * Asia Pacific (Singapore) * Asia Pacific (Sydney) * Asia Pacific (Tokyo) * Asia Pacific (Seoul) * South America (Sao Paulo) * China (Beijing) * China (Ningxia) * Canada (Central) |
No Description Provided. |
|
Communications Timeout |
30 secs | No Description Provided. | |
| SSL Context Service |
Controller Service API: SSLContextService Implementations: StandardRestrictedSSLContextService StandardSSLContextService |
Specifies an optional SSL Context Service that, if provided, will be used to create connections | |
| 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: true (will be evaluated using variable registry only) |
||
| Signer Override | Default Signature |
* Default Signature * Signature v4 * Signature v2 |
The AWS libraries use the default signer but this property allows you to specify a custom signer to support older S3-compatible services. |
| Proxy Configuration Service |
Controller Service API: ProxyConfigurationService Implementation: StandardProxyConfigurationService |
Specifies the Proxy Configuration Controller Service to proxy network requests. If set, it supersedes proxy settings configured per component. Supported proxies: HTTP + AuthN | |
| Proxy Host |
Proxy host name or IP Supports Expression Language: true (will be evaluated using variable registry only) |
||
| Proxy Host Port |
Proxy host port Supports Expression Language: true (will be evaluated using variable registry only) |
||
| Proxy Username |
Proxy username Supports Expression Language: true (undefined scope) |
||
| Proxy Password |
Proxy password Sensitive Property: true Supports Expression Language: true (undefined scope) |
Relationships:
|
Name |
Description |
| success | FlowFiles are routed to success relationship |
| failure | FlowFiles are routed to failure relationship |
Reads Attributes:
None specified.
Writes Attributes:
|
Name |
Description |
| s3.tag.___ | The tags associated with the S3 object will be written as part of the FlowFile 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:
None specified.