AWS library S3-Compatible user-defined session parameters

The AWS library is deprecated.

Use these parameters to configure the Vertica library for all S3-compatible file systems. You use this library to export data from Vertica to S3. All parameters listed are case-sensitive.

Using ALTER SESSION to change the S3 configuration parameters described in S3 parameters also changes the corresponding parameters for this library. The reverse is not true: setting these parameters sets the values only for the library.

Parameter Description
aws_ca_bundle

The path which Vertica will use when looking for a SSL server certificate bundle. For SUSE Linux you must set a value. Setting the AWSCAFile configuration parameter for a session also sets this UDParameter.

For example:

=> ALTER SESSION SET UDPARAMETER FOR awslib aws_ca_bundle='/home/user/ssl_folder/ca_bundle';

Default: system dependent

aws_ca_path

The path which Vertica will use when looking for SSL server certificates. For SUSE Linux you must set a value. Setting the AWSCAPath configuration parameter for a session also sets this UDParameter.

For example:

=> ALTER SESSION SET UDPARAMETER FOR awslib aws_ca_path='/home/user/ssl_folder';

Default: system dependent

aws_endpoint

The endpoint to use when interpreting S3 URLs. For example:

=> ALTER SESSION SET UDPARAMETER FOR awslib aws_endpoint='localhost:8080';

Default: s3.amazonaws.com

aws_id

Your access key ID. Setting the AWSAuth configuration parameter for a session also sets this UDParameter.

For example:

=> ALTER SESSION SET UDPARAMETER FOR awslib aws_id='aws-id';

aws_max_recv_speed

The maximum transfer speed when receiving data to S3 in bytes per second. For example, to set a maximum receive speed of 100KB/S:

=> ALTER SESSION SET UDPARAMETER FOR awslib aws_max_recv_speed=102400;

aws_max_send_speed

The maximum transfer speed when sending data to S3 in bytes per second. For example, to set a maximum send speed of 1KB/S:

=> ALTER SESSION SET UDPARAMETER FOR awslib aws_max_send_speed=1024;

aws_proxy

A string value which allows you to set an HTTP/HTTPS proxy for the library.

For example:

=> ALTER SESSION SET UDPARAMETER FOR awslib aws_proxy='192.168.1.1:8080';

aws_region

The AWS region containing your S3 bucket. aws_region can only be configured with one region at a time. If you need to access buckets in multiple regions, you must re-set the parameter each time you change regions.

Setting the AWSRegion configuration parameter for a session also sets this UDParameter.

For example:

=> ALTER SESSION SET UDPARAMETER FOR awslib aws_region='region-id';

Default: us-east-1

aws_secret

Your secret access key. Setting the AWSAuth configuration parameter for a session also sets this UDParameter.

For example:

=> ALTER SESSION SET UDPARAMETER FOR awslib aws_secret='aws-key';

aws_session_token

The temporary security token generated by running the AWS STS command get-session-token. This AWS STS command generates temporary credentials you can use to implement multi-factor authentication for security purposes.

=> ALTER SESSION SET UDPARAMETER FOR awslib aws_session_token='session-token';

aws_verbose

When enabled, logs libcurl debug messages to /opt/vertica/packages/AWS/logs.

For example:

=> ALTER SESSION SET UDPARAMETER FOR awslib aws_verbose=1;

Default: false

See also