AWS Library User-Defined Session Parameters

Use these parameters to configure the Vertica Library for Amazon Web Services (AWS). You use this library to export data from Vertica to S3. All parameters listed are case-sensitive.

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

Parameter Description
aws_id

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

Example: 

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

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

Example: 

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

The AWS 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='FQoDYXdzEBcaDKM1mWpeu88nDTTFICKsAbaiIDTWe4BTh33tnUvo9F/8mZicKKLLy7WIcpT4FLfr6ltIm242/U2CI9G/XdC6eoysUi3UGH7cxdhjxAW4fjgCKKYu
NL764N2xn0issmIuJOku3GTDyc4U4iNlWyEng3SlshdiqVlk1It2Mk0isEQXKtxF9VgfncDQBxjZUCkYIzseZw5pULa9YQcJOzl+Q2JrdUCWu0iFspSUJPhOguH+wTq
iM2XdHL5hcUcomqm41gU=';
aws_region

The 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.

Default value: us-east-1

You can find more information about AWS regions in the Amazon Documentation.

Example: 

=> ALTER SESSION SET UDPARAMETER FOR awslib aws_region='region-id';
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.

Default value: system dependent

Example:

=> ALTER SESSION SET UDPARAMETER FOR awslib aws_ca_path='/home/user/ssl_folder';
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.

Default value: system dependent

Example:

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

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

Example:

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

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

Default value: false

Example:

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

The maximum transfer speed when sending data to AWS S3 in bytes per second.

Example:

The following example sets a maximum send speed of 1KB/S:

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

The maximum transfer speed when receiving data to AWS S3 in bytes per second.

Example:

The following example sets a maximum receive speed of 100KB/S:

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

The AWS endpoint to use when interpreting S3 URLs.

To set the endpoint in AWS, do not include http(s)://. Include only the hostname or the IP address:port number

Default value: s3.amazonaws.com

Examples: 

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

See Also