OLD | NEW |
1 # Copyright (c) 2006-2008 Mitch Garnaat http://garnaat.org/ | 1 # Copyright (c) 2010-2011 Mitch Garnaat http://garnaat.org/ |
| 2 # Copyright (c) 2010-2011, Eucalyptus Systems, Inc. |
2 # | 3 # |
3 # Permission is hereby granted, free of charge, to any person obtaining a | 4 # Permission is hereby granted, free of charge, to any person obtaining a |
4 # copy of this software and associated documentation files (the | 5 # copy of this software and associated documentation files (the |
5 # "Software"), to deal in the Software without restriction, including | 6 # "Software"), to deal in the Software without restriction, including |
6 # without limitation the rights to use, copy, modify, merge, publish, dis- | 7 # without limitation the rights to use, copy, modify, merge, publish, dis- |
7 # tribute, sublicense, and/or sell copies of the Software, and to permit | 8 # tribute, sublicense, and/or sell copies of the Software, and to permit |
8 # persons to whom the Software is furnished to do so, subject to the fol- | 9 # persons to whom the Software is furnished to do so, subject to the fol- |
9 # lowing conditions: | 10 # lowing conditions: |
10 # | 11 # |
11 # The above copyright notice and this permission notice shall be included | 12 # The above copyright notice and this permission notice shall be included |
12 # in all copies or substantial portions of the Software. | 13 # in all copies or substantial portions of the Software. |
13 # | 14 # |
14 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS | 15 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS |
15 # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABIL- | 16 # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABIL- |
16 # ITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT | 17 # ITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT |
17 # SHALL THE AUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, | 18 # SHALL THE AUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, |
18 # WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | 19 # WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
19 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS | 20 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS |
20 # IN THE SOFTWARE. | 21 # IN THE SOFTWARE. |
21 # | |
22 """ | |
23 This module provides an interface to the Elastic Compute Cloud (EC2) | |
24 service from AWS. | |
25 """ | |
26 from boto.ec2.connection import EC2Connection | |
27 | 22 |
28 def regions(**kw_params): | 23 from connection import STSConnection |
| 24 from boto.regioninfo import RegionInfo |
| 25 |
| 26 def regions(): |
29 """ | 27 """ |
30 Get all available regions for the EC2 service. | 28 Get all available regions for the STS service. |
31 You may pass any of the arguments accepted by the EC2Connection | 29 |
32 object's constructor as keyword arguments and they will be | |
33 passed along to the EC2Connection object. | |
34 | |
35 :rtype: list | 30 :rtype: list |
36 :return: A list of :class:`boto.ec2.regioninfo.RegionInfo` | 31 :return: A list of :class:`boto.regioninfo.RegionInfo` instances |
37 """ | 32 """ |
38 c = EC2Connection(**kw_params) | 33 return [RegionInfo(name='us-east-1', |
39 return c.get_all_regions() | 34 endpoint='sts.amazonaws.com', |
| 35 connection_cls=STSConnection) |
| 36 ] |
40 | 37 |
41 def connect_to_region(region_name, **kw_params): | 38 def connect_to_region(region_name, **kw_params): |
42 for region in regions(**kw_params): | 39 """ |
| 40 Given a valid region name, return a |
| 41 :class:`boto.sts.connection.STSConnection`. |
| 42 |
| 43 :type: str |
| 44 :param region_name: The name of the region to connect to. |
| 45 |
| 46 :rtype: :class:`boto.sts.connection.STSConnection` or ``None`` |
| 47 :return: A connection to the given region, or None if an invalid region |
| 48 name is given |
| 49 """ |
| 50 for region in regions(): |
43 if region.name == region_name: | 51 if region.name == region_name: |
44 return region.connect(**kw_params) | 52 return region.connect(**kw_params) |
45 return None | 53 return None |
46 | 54 |
47 def get_region(region_name, **kw_params): | 55 def get_region(region_name, **kw_params): |
| 56 """ |
| 57 Find and return a :class:`boto.regioninfo.RegionInfo` object |
| 58 given a region name. |
| 59 |
| 60 :type: str |
| 61 :param: The name of the region. |
| 62 |
| 63 :rtype: :class:`boto.regioninfo.RegionInfo` |
| 64 :return: The RegionInfo object for the given region or None if |
| 65 an invalid region name is provided. |
| 66 """ |
48 for region in regions(**kw_params): | 67 for region in regions(**kw_params): |
49 if region.name == region_name: | 68 if region.name == region_name: |
50 return region | 69 return region |
51 return None | 70 return None |
52 | |
OLD | NEW |