Boto Config — boto v2.49.0 (original) (raw)

Note

You are viewing the documentation for an older version of boto (boto2).

Boto3, the next version of Boto, is now stable and recommended for general use. It can be used side-by-side with Boto in the same project, so it is easy to start using Boto3 in your existing projects as well as new projects. Going forward, API updates and all new feature work will be focused on Boto3.

For more information, see the documentation for boto3.

Introduction¶

There is a growing list of configuration options for the boto library. Many of these options can be passed into the constructors for top-level objects such as connections. Some options, such as credentials, can also be read from environment variables (e.g. AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY,AWS_SECURITY_TOKEN and AWS_PROFILE). It is also possible to manage these options in a central place through the use of boto config files.

Details¶

A boto config file is a text file formatted like an .ini configuration file that specifies values for options that control the behavior of the boto library. In Unix/Linux systems, on startup, the boto library looks for configuration files in the following locations and in the following order:

• /etc/boto.cfg - for site-wide settings that all users on this machine will use
• (if profile is given) ~/.aws/credentials - for credentials shared between SDKs
• (if profile is given) ~/.boto - for user-specific settings
• ~/.aws/credentials - for credentials shared between SDKs
• ~/.boto - for user-specific settings

CommentsYou can comment out a line by putting a ‘#’ at the beginning of the line, just like in Python code.

In Windows, create a text file that has any name (e.g. boto.config). It’s recommended that you put this file in your user folder. Then set a user environment variable named BOTO_CONFIG to the full path of that file.

The options in the config file are merged into a single, in-memory configuration that is available as boto.config. The boto.pyami.config.Configclass is a subclass of the standard PythonConfigParser.SafeConfigParser object and inherits all of the methods of that object. In addition, the botoConfig class defines additional methods that are described on the PyamiConfigMethods page.

An example boto config file might look like:

[Credentials] aws_access_key_id = aws_secret_access_key =

Sections¶

The following sections and options are currently recognized within the boto config file.

Credentials¶

The Credentials section is used to specify the AWS credentials used for all boto requests. The order of precedence for authentication credentials is:

• Credentials passed into the Connection class constructor.
• Credentials specified by environment variables
• Credentials specified as named profiles in the shared credential file.
• Credentials specified by default in the shared credential file.
• Credentials specified as named profiles in the config file.
• Credentials specified by default in the config file.

This section defines the following options: aws_access_key_id andaws_secret_access_key. The former being your AWS key id and the latter being the secret key.

For example:

[profile name_goes_here] aws_access_key_id = aws_secret_access_key =

[Credentials] aws_access_key_id = aws_secret_access_key =

Please notice that quote characters are not used to either side of the ‘=’ operator even when both your AWS access key ID and secret key are strings.

If you have multiple AWS keypairs that you use for different purposes, use the profile style shown above. You can set an arbitrary number of profiles within your configuration files and then reference them by name when you instantiate your connection. If you specify a profile that does not exist in the configuration, the keys used under the [Credentials] heading will be applied by default.

The shared credentials file in ~/.aws/credentials uses a slightly different format. For example:

[default] aws_access_key_id = aws_secret_access_key =

[name_goes_here] aws_access_key_id = aws_secret_access_key =

[another_profile] aws_access_key_id = aws_secret_access_key = aws_security_token =

For greater security, the secret key can be stored in a keyring and retrieved via the keyring package. To use a keyring, use keyring, rather than aws_secret_access_key:

[Credentials] aws_access_key_id = keyring =

To use a keyring, you must have the Python keyring package installed and in the Python path. To learn about setting up keyrings, see the keyring documentation

Credentials can also be supplied for a Eucalyptus service:

[Credentials] euca_access_key_id = euca_secret_access_key =

Finally, this section is also be used to provide credentials for the Internet Archive API:

[Credentials] ia_access_key_id = ia_secret_access_key =

Boto¶

The Boto section is used to specify options that control the operation of boto itself. This section defines the following options:

For example:

[Boto] debug = 0 num_retries = 10

proxy = myproxy.com proxy_port = 8080 proxy_user = foo proxy_pass = bar

These settings will default to:

[Boto] connection_stale_duration = 180 is_secure = True https_validate_certificates = True ca_certificates_file = cacerts.txt http_socket_timeout = 60 send_crlf_after_proxy_auth_headers = False endpoints_path = /path/to/my/boto/endpoints.json use_endpoint_heuristics = False

You can control the timeouts and number of retries used when retrieving information from the Metadata Service (this is used for retrieving credentials for IAM roles on EC2 instances):

These settings will default to:

[Boto] metadata_service_timeout = 1.0 metadata_service_num_attempts = 1

This section is also used for specifying endpoints for non-AWS services such as Eucalyptus and Walrus.

For example:

[Boto] eucalyptus_host = somehost.example.com walrus_host = somehost.example.com

Finally, the Boto section is used to set defaults versions for many AWS services

AutoScale settings:

options: :autoscale_version: Set the API version :autoscale_endpoint: Endpoint to use :autoscale_region_name: Default region to use

For example:

[Boto] autoscale_version = 2011-01-01 autoscale_endpoint = autoscaling.us-west-2.amazonaws.com autoscale_region_name = us-west-2

Cloudformation settings can also be defined:

For example:

[Boto] cfn_version = 2010-05-15 cfn_region_name = us-west-2 cfn_region_endpoint = cloudformation.us-west-2.amazonaws.com

Cloudsearch settings:

For example:

[Boto] cs_region_name = us-west-2 cs_region_endpoint = cloudsearch.us-west-2.amazonaws.com

Cloudwatch settings:

For example:

[Boto] cloudwatch_version = 2010-08-01 cloudwatch_region_name = us-west-2 cloudwatch_region_endpoint = monitoring.us-west-2.amazonaws.com

EC2 settings:

For example:

[Boto] ec2_version = 2012-12-01 ec2_region_name = us-west-2 ec2_region_endpoint = ec2.us-west-2.amazonaws.com

ELB settings:

For example:

[Boto] elb_version = 2012-06-01 elb_region_name = us-west-2 elb_region_endpoint = elasticloadbalancing.us-west-2.amazonaws.com

EMR settings:

For example:

[Boto] emr_version = 2009-03-31 emr_region_name = us-west-2 emr_region_endpoint = elasticmapreduce.us-west-2.amazonaws.com

Precedence¶

Even if you have your boto config setup, you can also have credentials and options stored in environmental variables or you can explicitly pass them to method calls i.e.:

boto.ec2.connect_to_region( ... 'us-west-2', ... aws_access_key_id='foo', ... aws_secret_access_key='bar')

In these cases where these options can be found in more than one place boto will first use the explicitly supplied arguments, if none found it will then look for them amidst environment variables and if that fails it will use the ones in boto config.

Notification¶

If you are using notifications for boto.pyami, you can specify the email details through the following variables.

Default values are:

[notification] smtp_from = boto smtp_to = None smtp_host = localhost smtp_port = 25 smtp_tls = True smtp_user = john smtp_pass = hunter2

SWF¶

The SWF section allows you to configure the default region to be used for the Amazon Simple Workflow service.

Example:

Pyami¶

The Pyami section is used to configure the working directory for PyAMI.

Example:

[Pyami] working_dir = /home/foo/

DB¶

The DB section is used to configure access to databases through theboto.sdb.db.manager.get_manager() function.

More examples:

[DB] db_type = SimpleDB db_user = db_passwd = db_name = my_domain db_table = table db_host = sdb.amazonaws.com enable_ssl = True debug = True

[DB_TestBasic] db_type = SimpleDB db_user = db_passwd = db_name = basic_domain db_port = 1111

SDB¶

This section is used to configure SimpleDB

Example:

DynamoDB¶

This section is used to configure DynamoDB

Example:

[DynamoDB] region = us-west-2 validate_checksums = True