PutCDPObjectStore

Description:

Write FlowFile data to an object store.

Additional Details...

Tags:

hadoop, HCFS, HDFS, put, copy, filesystem, CDP, GCP, GCS, Google, S3, AWS, ADLS, Azure

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, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
Storage Locationcdp-storage-locationUse this property to set the storage location in use. Example: 's3a://myBucket/myDirectory'. In case the property is not specified the processor will use the value set in /etc/hadoop/conf/core-site.xml
Supports Expression Language: true (will be evaluated using variable registry only)
DirectoryDirectoryThe path (absolute or relative to the Storage Location) to the parent directory to which files should be written into. The directory will be created if it doesn't exist.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Conflict Resolution StrategyConflict Resolution Strategyfail
  • replace Replaces the existing file if any.
  • ignore Ignores the flow file and routes it to success.
  • fail Penalizes the flow file and routes it to failure.
Indicates what should happen when a file with the same name already exists in the output directory
Kerberos Credentials Servicekerberos-credentials-serviceController Service API:
KerberosCredentialsService
Implementation: KeytabCredentialsService
Specifies the Kerberos Credentials Controller Service that should be used for authenticating with Kerberos
CDP UsernameKerberos PrincipalCDP User name. Recommendation is to create a dedicated Machine User in the CDP User Management UI.
Supports Expression Language: true (will be evaluated using variable registry only)
CDP PasswordKerberos PasswordWorkload password associated to your CDP User. You can set it in the CDP User Management UI. If you don't want to use a workload password, you can use the Kerberos Credentials controller service property.
Sensitive Property: true
Writing Strategywriting-strategySimple write
  • Write and rename The processor writes FlowFile data into a temporary file and renames it after completion. This prevents other processes from reading partially written files.
  • Simple write The processor writes FlowFile data directly to the destination file. In some cases this might cause reading partially written files.
Defines the approach for writing the FlowFile data.

Dynamic Properties:

Supports Sensitive Dynamic Properties: No

Dynamic Properties allow the user to specify both the name and value of a property.

NameValueDescription
A Hadoop client configuration nameThe value to set it toSets and if already set, overwrites the Hadoop client configuration with the given name.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)

Relationships:

NameDescription
successFiles that have been successfully written to the object store are transferred to this relationship
failureFiles that could not be written to the object store for some reason are transferred to this relationship

Reads Attributes:

NameDescription
filenameThe name of the file written to the object store comes from the value of this attribute.

Writes Attributes:

NameDescription
filenameThe name of the file written to HDFS is stored in this attribute.
absolute.hdfs.pathThe absolute path to the file on HDFS is stored in this attribute.
hadoop.file.urlThe hadoop url for the file is stored in this attribute.
target.dir.createdThe result(true/false) indicates if the folder is created by the processor.
filenameThe name of the file written to object store is stored in this attribute.

State management:

This component does not store state.

Restricted:

Required PermissionExplanation
write distributed filesystemProvides operator the ability to delete any file that NiFi has access to in HDFS or the local filesystem.

Input requirement:

This component requires an incoming relationship.

System Resource Considerations:

None specified.

See Also:

FetchCDPObjectStore, DeleteCDPObjectStore, ListCDPObjectStore