The File System Profile is used for making file system-specific configurations, currently used by the Amazon S3 collection and forwarding agents.
Configuration
To create a new File System profile, click the New Configuration button in the upper left part of the Build View, and then select File System Profile from the menu. The configurations will vary depending on the selected file system, and each file system will be described separately below.
Menus
The contents of the menus in the menu bar may change depending on which configuration type has been opened in the currently displayed tab. The File System profile uses the standard menu items and buttons that are visible for all configurations, and these are described in Common Configuration Buttons.
| Item | Description |
|---|---|
External References | Select this menu item to enable the use of External References in the File System profile configuration. This can be used to configure the following fields: Amazon S3 file systems
HDFS file systems
For further information, see Using External Reference in Agent Profile Fields and External Reference Profile. |
Amazon S3
When selecting Amazon S3 as a file system, you will see two tabs – General and Advanced.
File System profile - Amazon S3 - General tab
The following settings are available in the General tab in the File System profile:
| Setting | Description |
|---|---|
File System Type | Select which file system type this profile should be applied for. Currently, only Amazon S3 is available. |
| Credentials | |
| Credentials from Environment | Select this check box in order to pick up the credentials from the environment instead of entering them in this profile. If this check box is selected, the Access Key and Secret Key fields will be disabled. |
Access Key | Enter the access key for the user who owns the Amazon S3 account in this field. |
Secret Key | Enter the secret key for the stated access key in this field. |
| Location | |
| Region from Environment | Select this check box in order to pick up the region from the environment instead of entering the region in this profile. If this check box is selected, the Region field will be disabled. |
| Region | Enter the name of the Amazon S3 region in this field. |
Bucket | Enter the name of the Amazon S3 bucket in this field. |
| Use Amazon Profile | Select this check box if you already have an Amazon Profile set up, this will disable the fields above and allow you to utilize the credentials that you have defined in your chosen Amazon Profile. |
The advanced tab allows for advanced properties to be configured in the profile.
File System profile - Amazon S3 - Advanced tab
GCP Storage
When selecting GCP Storage as a file system, you will see only one tab called General.