#include <src/H5FDros3.h>

Detailed Description

Configuration structure for H5Pset_fapl_ros3() / H5Pget_fapl_ros3().

H5FD_ros_fapl_t is a public structure that is used to pass configuration data to the H5FD_ROS3 driver via a File Access Property List. A pointer to an instance of this structure is a parameter to H5Pset_fapl_ros3() and H5Pget_fapl_ros3().

Data Fields
int32_t	version

hbool_t	authenticate

char	aws_region [32+1]

char	secret_id [128+1]

char	secret_key [128+1]

Field Documentation

◆ authenticate

hbool_t authenticate

A Boolean which specifies if security credentials should be used for accessing a S3 bucket. If true, aws_region, secret_id, and secret_key must be populated. If false, those three components are unused.

◆ aws_region

char aws_region[H5FD_ROS3_MAX_REGION_LEN+1]

A string which specifies the AWS region of the S3 bucket, e.g. "us-east-1".

◆ secret_id

char secret_id[H5FD_ROS3_MAX_SECRET_ID_LEN+1]

A string which specifies the security ID.

◆ secret_key

char secret_key[H5FD_ROS3_MAX_SECRET_KEY_LEN+1]

A string which specifies the security key.

◆ version

int32_t version

Version number of the H5FD_ros3_fapl_t structure. Any instance passed to H5Pset_fapl_ros3() / H5Pget_fapl_ros3() must have a recognized version number or an error will be raised. Currently, this field should be set to H5FD_CURR_ROS3_FAPL_T_VERSION.

The documentation for this struct was generated from the following file:

src/H5FDros3.h