Current File : //usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyc
�
���^c # @@ sp d Z d d l m Z m Z m Z d d l Z d d l Z d d l Z d d l Z d d l
Z d d l Z d d l m
Z
d d l m Z d d l m Z m Z yN d d l Z d d l Z d d l m Z m Z d d l m Z m Z e Z Wn e k
re Z n Xe j e � Z! d � Z" d
� Z# d d d d d d d � Z% d d d d d d d � Z& d
d d d d d � Z' d d d d d d d � Z( d d d d d d � Z) d d d d d d d � Z* d d d d d d d e d d d d d � Z+ d d d d d d d � Z, d d d d e d d d d d � Z- d d d d d d d d � Z. d d d d d � Z/ d d d d d d d e d d d �
Z0 d d d d d d d d e e d d � Z1 d d d d d d d d d e d �
Z2 d d d d d d d d � Z3 d d d d d d d d d � Z4 d d d d d d � Z5 d d d d d d d d d d � Z6 d � Z7 d d d d d d d d d d d d d d d d d d d d d d d d d d d d d d d d d d d �" Z8 d d d d d! � Z9 d d d d d" � Z: d d d d d# � Z; d d d d d$ � Z< d d d d d d d% � Z= d d d d d d d d& � Z> d d d d d d d d' � Z? d d d d d( � Z@ d d d d d d d) � ZA d d d* � ZB d+ � ZC d d d d d d d d d d, � ZD d d d d d d d- � ZE d d d d d d d d d. � ZF d d d e d d d d d/ � ZG d d d d d d d d d0 � ZH d d e d d d d d1 � ZI e e d d d d d2 � ZJ d d d d d d3 � ZK d d d d d4 � ZL d d d d d5 � ZM d d e e d d d d d6 � ZN d d e d d d d d7 � ZO d8 d8 d9 � ZP d d d d d: � ZQ d d d d e d e d d d d d; � ZR d S(< u}
Connection module for Amazon EC2
.. versionadded:: 2015.8.0
:configuration: This module accepts explicit EC2 credentials but can also
utilize IAM roles assigned to the instance through Instance Profiles.
Dynamic credentials are then automatically obtained from AWS API and no
further configuration is necessary. More Information available here__.
.. __: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html
If IAM roles are not used you need to specify them either in a pillar or
in the minion's config file:
.. code-block:: yaml
ec2.keyid: GKTADJGHEIQSXMKKRBJ08H
ec2.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
A region may also be specified in the configuration:
.. code-block:: yaml
ec2.region: us-east-1
If a region is not specified, the default is us-east-1.
It's also possible to specify key, keyid, and region via a profile, either
as a passed in dict, or as a string to pull from pillars or minion config:
.. code-block:: yaml
myprofile:
keyid: GKTADJGHEIQSXMKKRBJ08H
key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
region: us-east-1
:depends: boto
i ( t absolute_importt print_functiont unicode_literalsN( t six( t map( t SaltInvocationErrort CommandExecutionError( t BlockDeviceMappingt BlockDeviceType( t NetworkInterfaceSpecificationt NetworkInterfaceCollectionc C@ sH t j j j d d d t � } | t k rD t d t d d t �n | S( ug
Only load if boto libraries exist and if boto libraries are greater than
a given version.
t boto_veru 2.8.0t check_boto3u boto.assign_funcsu ec2t pack( t saltt utilst versionst check_boto_reqst Falset Truet __utils__t __name__t __salt__( t
has_boto_reqs( ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyt __virtual__L s c C@ s1 t j j j t � t r- t d t d � n d S( Nu boto.assign_funcsu ec2( R R t compatt pack_dunderR t HAS_BOTOR ( t opts( ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyt __init__] s c C@ si t d | d | d | d | � } y | j d | d | � SWn' t j j k
rd } t j | � g SXd S( u�
Get all EIP's associated with the current credentials.
addresses
(list) - Optional list of addresses. If provided, only those those in the
list will be returned.
allocation_ids
(list) - Optional list of allocation IDs. If provided, only the
addresses associated with the given allocation IDs will be returned.
returns
(list) - The requested Addresses as a list of :class:`boto.ec2.address.Address`
t regiont keyt keyidt profilet addressest allocation_idsN( t _get_connt get_all_addressest botot exceptiont BotoServerErrort logt error( R" R# R R R R! t connt e( ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyt _get_all_eip_addressesc s !
c C@ s/ g t | | | | | | � D] } | j ^ q S( u\
Get public addresses of some, or all EIPs associated with the current account.
addresses
(list) - Optional list of addresses. If provided, only the addresses
associated with those in the list will be returned.
allocation_ids
(list) - Optional list of allocation IDs. If provided, only the
addresses associated with the given allocation IDs will be returned.
returns
(list) - A list of the requested EIP addresses
CLI Example:
.. code-block:: bash
salt-call boto_ec2.get_all_eip_addresses
.. versionadded:: 2016.3.0
( R- t public_ip( R" R# R R R R! t x( ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyt get_all_eip_addresses{ s u standardc C@ s� d } x� t d | d | d | d | � D]� } t d | d | d | d | d | � d } | d r� t j d | | d � q( n | d r� t j d
| | d � q( n | d | k r( t j d | | � | } Pq( q( W| s� t j d
� n | S( u
Return the first unassociated EIP
domain
Indicates whether the address is an EC2 address or a VPC address
(standard|vpc).
CLI Example:
.. code-block:: bash
salt-call boto_ec2.get_unassociated_eip_address
.. versionadded:: 2016.3.0
R R R R! R" i u instance_idu- %s is already associated with the instance %su network_interface_idu6 %s is already associated with the network interface %su domainu; The first unassociated EIP address in the domain '%s' is %su! No unassociated Elastic IP found!N( t NoneR0 t get_eip_address_infoR) t debug( t domainR R R R! t eipt addresst address_info( ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyt get_unassociated_eip_address� s.
c
C@ s� t | � t d � k r$ | g } n t | � t d � k rH | g } n t d | d | d | d | d | d | � } d d d
d d d
d d g } g | D]4 } t g | D] } | t | | � f ^ q� � ^ q� S( u�
Get 'interesting' info about some, or all EIPs associated with the current account.
addresses
(list) - Optional list of addresses. If provided, only the addresses
associated with those in the list will be returned.
allocation_ids
(list) - Optional list of allocation IDs. If provided, only the
addresses associated with the given allocation IDs will be returned.
returns
(list of dicts) - A list of dicts, each containing the info for one of the requested EIPs.
CLI Example:
.. code-block:: bash
salt-call boto_ec2.get_eip_address_info addresses=52.4.2.15
.. versionadded:: 2016.3.0
u stringR" R# R R R R! u
allocation_idu association_idu domainu instance_idu network_interface_idu network_interface_owner_idu public_ipu private_ip_address( t typeR- t dictt getattr(
R" R# R R R R! t rett interestingR6 R/ ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyR2 � s c
C@ s� | r! | d k r! t d � � n t d | d | d | d | � } y | j d | � } Wn' t j j k
r� } t j | � t SXd d d
d d d
d d g } t g | D] } | t
| | � f ^ q� � S( um
Allocate a new Elastic IP address and associate it with your account.
domain
(string) Optional param - if set to exactly 'vpc', the address will be
allocated to the VPC. The default simply maps the EIP to your
account container.
returns
(dict) dict of 'interesting' information about the newly allocated EIP,
with probably the most interesting keys being 'public_ip'; and
'allocation_id' iff 'domain=vpc' was passed.
CLI Example:
.. code-block:: bash
salt-call boto_ec2.allocate_eip_address domain=vpc
.. versionadded:: 2016.3.0
u vpcu9 The only permitted value for the 'domain' param is 'vpc'.R R R R! R4 u
allocation_idu association_idu domainu instance_idu network_interface_idu network_interface_owner_idu public_ipu private_ip_address( R R$ t allocate_addressR& R' R( R) R* R R: R; (
R4 R R R R! R+ R6 R, R= R/ ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyt allocate_eip_address� s !
c C@ s� t j j j | | f � s* t d � � n t d | d | d | d | � } y | j | | � SWn' t j j k
r� } t
j | � t SXd S( u
Free an Elastic IP address. Pass either a public IP address to release an
EC2 Classic EIP, or an AllocationId to release a VPC EIP.
public_ip
(string) - The public IP address - for EC2 elastic IPs.
allocation_id
(string) - The Allocation ID - for VPC elastic IPs.
returns
(bool) - True on success, False on failure
CLI Example:
.. code-block:: bash
salt myminion boto_ec2.release_eip_address allocation_id=eipalloc-ef382c8a
.. versionadded:: 2016.3.0
u> Exactly one of 'public_ip' OR 'allocation_id' must be providedR R R R! N(
R R t datat exactly_oneR R$ t release_addressR& R' R( R) R* R ( R. t
allocation_idR R R R! R+ R, ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyt release_eip_address s !
c
C@ s� t j j j | | | | f � s0 t d � � n t d | d | d |
d | � } | r� y+ t d | d | d | d |
d | � } Wn' t j j k
r� }
t
j |
� t SX| s� t
j d | � t Sn | r>y( t
| d | d | d |
d | �} Wn' t j j k
r }
t
j |
� t SX| s>t
j d | � t Sn y2 | j d | d
| d | d | d
| d | � SWn' t j j k
r�}
t
j |
� t SXd S( uP
Associate an Elastic IP address with a currently running instance or a network interface.
This requires exactly one of either 'public_ip' or 'allocation_id', depending
on whether you’re associating a VPC address or a plain EC2 address.
instance_id
(string) – ID of the instance to associate with (exclusive with 'instance_name')
instance_name
(string) – Name tag of the instance to associate with (exclusive with 'instance_id')
public_ip
(string) – Public IP address, for standard EC2 based allocations.
allocation_id
(string) – Allocation ID for a VPC-based EIP.
network_interface_id
(string) - ID of the network interface to associate the EIP with
network_interface_name
(string) - Name of the network interface to associate the EIP with
private_ip_address
(string) – The primary or secondary private IP address to associate with the Elastic IP address.
allow_reassociation
(bool) – Allow a currently associated EIP to be re-associated with the new instance or interface.
returns
(bool) - True on success, False on failure.
CLI Example:
.. code-block:: bash
salt myminion boto_ec2.associate_eip_address instance_name=bubba.ho.tep allocation_id=eipalloc-ef382c8a
.. versionadded:: 2016.3.0
up Exactly one of 'instance_id', 'instance_name', 'network_interface_id', 'network_interface_name' must be providedR R R R! t nameu; Given instance_name '%s' cannot be mapped to an instance_iduM Given network_interface_name '%s' cannot be mapped to an network_interface_idt instance_idR. RC t network_interface_idt private_ip_addresst allow_reassociationN( R R R@ RA R R$ t get_idR& R' R( R) R* R t get_network_interface_idt associate_address( RF t
instance_nameR. RC RG t network_interface_nameRH RI R R R R! R+ R, ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyt associate_eip_address6 sN & !
c C@ sc t d | d | d | d | � } y | j | | � SWn' t j j k
r^ } t j | � t SXd S( un
Disassociate an Elastic IP address from a currently running instance. This
requires exactly one of either 'association_id' or 'public_ip', depending
on whether you’re dealing with a VPC or EC2 Classic address.
public_ip
(string) – Public IP address, for EC2 Classic allocations.
association_id
(string) – Association ID for a VPC-bound EIP.
returns
(bool) - True on success, False on failure.
CLI Example:
.. code-block:: bash
salt myminion boto_ec2.disassociate_eip_address association_id=eipassoc-e3ba2d16
.. versionadded:: 2016.3.0
R R R R! N( R$ t disassociate_addressR& R' R( R) R* R ( R. t association_idR R R R! R+ R, ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyt disassociate_eip_address� s !
c
C@ s t j j j | | f � s* t d � � n t d | d | d | d | � } | r� y( t | d | d | d | d | �} Wn' t j j k
r� }
t
j |
� t SX| s� t
j d | � t Sn y& | j
d | d | d | d
| � SWn' t j j k
r}
t
j |
� t SXd S( u�
Assigns one or more secondary private IP addresses to a network interface.
network_interface_id
(string) - ID of the network interface to associate the IP with (exclusive with 'network_interface_name')
network_interface_name
(string) - Name of the network interface to associate the IP with (exclusive with 'network_interface_id')
private_ip_addresses
(list) - Assigns the specified IP addresses as secondary IP addresses to the network interface (exclusive with 'secondary_private_ip_address_count')
secondary_private_ip_address_count
(int) - The number of secondary IP addresses to assign to the network interface. (exclusive with 'private_ip_addresses')
allow_reassociation
(bool) – Allow a currently associated EIP to be re-associated with the new instance or interface.
returns
(bool) - True on success, False on failure.
CLI Example:
.. code-block:: bash
salt myminion boto_ec2.assign_private_ip_addresses network_interface_name=my_eni private_ip_addresses=private_ip
salt myminion boto_ec2.assign_private_ip_addresses network_interface_name=my_eni secondary_private_ip_address_count=2
.. versionadded:: 2017.7.0
uP Exactly one of 'network_interface_name', 'network_interface_id' must be providedR R R R! uM Given network_interface_name '%s' cannot be mapped to an network_interface_idRG t private_ip_addressest" secondary_private_ip_address_countt allow_reassignmentN( R R R@ RA R R$ RK R& R' R( R) R* R t assign_private_ip_addresses( RN RG RS RT RU R R R R! R+ R, ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyRV � s0 !
c
C@ s t j j j | | f � s* t d � � n t d | d | d | d | � } | r� y( t | d | d | d | d | �} Wn' t j j k
r� } t
j | � t SX| s� t
j d | � t Sn y | j
d | d | � SWn' t j j k
r} t
j | � t SXd S(
u�
Unassigns one or more secondary private IP addresses from a network interface
network_interface_id
(string) - ID of the network interface to associate the IP with (exclusive with 'network_interface_name')
network_interface_name
(string) - Name of the network interface to associate the IP with (exclusive with 'network_interface_id')
private_ip_addresses
(list) - Assigns the specified IP addresses as secondary IP addresses to the network interface.
returns
(bool) - True on success, False on failure.
CLI Example:
.. code-block:: bash
salt myminion boto_ec2.unassign_private_ip_addresses network_interface_name=my_eni private_ip_addresses=private_ip
.. versionadded:: 2017.7.0
uP Exactly one of 'network_interface_name', 'network_interface_id' must be providedR R R R! uM Given network_interface_name '%s' cannot be mapped to an network_interface_idRG RS N( R R R@ RA R R$ RK R& R' R( R) R* R t unassign_private_ip_addresses( RN RG RS R R R R! R+ R, ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyRW � s, !
c C@ sA t d | d | d | d | � } g | j � D] } | j ^ q. S( u�
Get a list of AZs for the configured region.
CLI Example:
.. code-block:: bash
salt myminion boto_ec2.get_zones
R R R R! ( R$ t
get_all_zonesRE ( R R R R! R+ t z( ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyt get_zones s
!c
C@ s� t d | d | d | d | � }
yRi i d 6} | rG | g | d <n | r^ | | d d <n | r� x7 t j | � D]# \ } }
|
| d d j | � <qt Wn | r� | d j | � n |
j | � } g | D] } | j D] } | ^ q� q� } t j d | | � | rDg | D] } | j | k r| ^ q} t j d
| � n | rn| rT| Sg | D] } | j
^ q[Sg SWn' t j j
k
r�} t j | � g SXd S( u�
Given instance properties, find and return matching instance ids
CLI Examples:
.. code-block:: bash
salt myminion boto_ec2.find_instances # Lists all instances
salt myminion boto_ec2.find_instances name=myinstance
salt myminion boto_ec2.find_instances tags='{"mytag": "value"}'
salt myminion boto_ec2.find_instances filters='{"vpc-id": "vpc-12345678"}'
R R R R! u filtersu instance_idsu tag:Nameu tag:{0}u: The filters criteria %s matched the following instances:%su> Limiting instance matches to those in the requested states: %sN( R$ R t iteritemst formatt updatet get_all_reservationst instancesR) R3 t statet idR& R' R( R* ( RF RE t tagsR R R R! t return_objst in_statest filtersR+ t filter_parameterst tag_namet tag_valuet reservationst rt iR_ t instancet exc( ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyt find_instances+ s: !
)
(
c C@ s� t d | d | d | d | d | d | d | d t d | � } | sV t j d
� t St | � d k ry t j d � t S| d
}
y# |
j | d | d | d |
�SWn' t j j k
r� } t j | � t SXd S( uT
Given instance properties that define exactly one instance, create AMI and return AMI-id.
CLI Examples:
.. code-block:: bash
salt myminion boto_ec2.create_image ami_name instance_name=myinstance
salt myminion boto_ec2.create_image another_ami_name tags='{"mytag": "value"}' description='this is my ami'
RF RE Rb R R R R! Rc Re u Source instance not foundi uV Multiple instances found, must match exactly only one instance to create an image fromi t descriptiont no_reboott dry_runN(
Rn R R) R* R t lent create_imageR& R' R( ( t ami_nameRF RM Rb R R R R! Ro Rp Rq Re R_ Rl Rm ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyRs d s
c
C@ s� d }
t d | d | d | d | � } xm|
r�y� i i d 6} | rV | g | d <n | rl | g | d <n | r� | g | d <n | r� | | d d
<n | r� x7 t j | � D]# \ }
} | | d d j |
� <q� Wn | j | � } t j d | | � | r%| r | Sg | D] } | j ^ qSt SWq* t j
j k
r�} | j d
k r{t j d � t
j d � |
d 8}
q* n t j d | | � t SXq* Wt S( u�
Given image properties, find and return matching AMI ids
CLI Examples:
.. code-block:: bash
salt myminion boto_ec2.find_images tags='{"mytag": "value"}'
i R R R R! u filtersu image_idsu
executable_byu ownersu nameu tag:{0}u7 The filters criteria %s matched the following images:%su
Throttlingu0 Throttled by AWS API, will retry in 5 seconds...i i u0 Failed to convert AMI name `%s` to an AMI ID: %s( R$ R R[ R\ t get_all_imagesR) R3 Ra R R& R' R( t
error_codet timet sleepR* ( Rt t
executable_byt ownerst image_idsRb R R R R! Rc t retriesR+ Rf Rg Rh t imagest imageRm ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyt find_images� sB
!
c C@ s� t d | d | d | d | d | d | d t d | � } | t d g f k rR | St | � d k rv | d
j � t St j d � t Sd S(
u�
Terminate the instance described by instance_id or name.
CLI Example:
.. code-block:: bash
salt myminion boto_ec2.terminate name=myinstance
salt myminion boto_ec2.terminate instance_id=i-a46b9f
RF RE R R R R! Rc Re i i u0 Refusing to terminate multiple instances at onceN( Rn R R R1 Rr t terminateR) t warning( RF RE R R R R! Re R_ ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyR� � s
c C@ s� t d | d | d | d | d | d | d | d | � } | r� t j d d
j | � � t | � d k rr | d St d
� � n t j d � d Sd S( u�
Given instance properties, return the instance id if it exists.
CLI Example:
.. code-block:: bash
salt myminion boto_ec2.get_id myinstance
RE Rb R R R R! Rd Re u Instance ids: %su i i u3 Found more than one instance matching the criteria.u Could not find instance.N( Rn R) t infot joinRr R R� R1 ( RE Rb R R R R! Rd Re t instance_ids( ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyRJ � s
c C@ s� g } t d | d | d | d | � } | j d i | d 6� } t | � d k r� x; | D] } | j i | j | j 6� qY Wn t j d | � | S( u�
Given an instance_id, return a list of tags associated with that instance.
returns
(list) - list of tags as key/value pairs
CLI Example:
.. code-block:: bash
salt myminion boto_ec2.get_tags instance_id
R R R! R Re u resource-idi u No tags found for instance_id %s( R$ t get_all_tagsRr t appendt valueRE R) R� ( RF R R R! R Rb t clientt resultt tag( ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyt get_tags� s !
!c
C@ sk t d | d | d | d | d | d | d | d | d | � } | rV t j d
� t St j d � t Sd S(
u
Given an instance id, check to see if the given instance id exists.
Returns True if the given instance with the given id, name, or tags
exists; otherwise, False is returned.
CLI Example:
.. code-block:: bash
salt myminion boto_ec2.exists myinstance
RF RE Rb R R R R! Rd Re u Instance exists.u Instance does not exist.N( Rn R) R� R R� R (
RF RE Rb R R R R! Rd Re R_ ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyt exists s
c C@ s^ | s
d St | t � r | St | t j � rG t j j j | � } n t | t � ss t
j d | t | � � d St � } x� t j
| � D]� \ } } t d | j d � d | j d t � d | j d � d | j d � d
| j d � d | j d
� d | j d t � d | j d � d | j d � d | j d � d | j d � � } | | | <q� W| S( u�
Convert a string, or a json payload, or a dict in the right
format, into a boto.ec2.blockdevicemapping.BlockDeviceMapping as
needed by instance_present(). The following YAML is a direct
representation of what is expected by the underlying boto EC2 code.
YAML example:
.. code-block:: yaml
device-maps:
/dev/sdb:
ephemeral_name: ephemeral0
/dev/sdc:
ephemeral_name: ephemeral1
/dev/sdd:
ephemeral_name: ephemeral2
/dev/sde:
ephemeral_name: ephemeral3
/dev/sdf:
size: 20
volume_type: gp2
uQ Can't convert '%s' of type %s to a boto.ec2.blockdevicemapping.BlockDeviceMappingt ephemeral_nameu ephemeral_namet no_deviceu no_devicet volume_idu volume_idt snapshot_idu snapshot_idt statusu statust attach_timeu attach_timet delete_on_terminationu delete_on_terminationt sizeu sizet volume_typeu volume_typet iopsu iopst encryptedu encryptedN( R1 t
isinstanceR R t string_typesR R t jsont loadsR: R) R* R9 R[ R t getR ( t thingt bdmt dt tt bdt( ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyt _to_blockdev_map! s2 u m1.smallc# / * C@ s� t |
| f � r! t d � � n | r t d d | d | d | d | d |! �}# d |# k rr t j d | � t S|# d }
n t | | f � r� t d
� � n | rg } xf | D][ }$ t d |$ d | d | d | d | d |! �}# |# st j d
|$ � t S| |# g 7} q� Wn t t t | d2 k | d2 k |" d2 k g � � }% t
|% � d k rft d � � n | r�t | d | d | d | d |! �}& |& d } | s�t j d | � q�n | r�t d | d d � }' n t d |
d | d d � }' |" r#g |" D] }( t |( � ^ q�}) t
|) � }* n t
|' � }* t d | d | d | d |! � }+ |+ j | d | d | d | d | d | d | d | d |
d | d t | � d! | d" | d# | d$ | d% | d& | d' | d( | d) | d* |* �}, |, s�t j d+ � t S|, j d }- d, }. x) |. d, k r2t j d- � |- j � }. q
W|. d. k r|| rX|- j d/ | � n | rn|- j | � n i |- j d0 6St j d1 |. � d2 S(3 u�
Create and start an EC2 instance.
Returns True if the instance was created; otherwise False.
CLI Example:
.. code-block:: bash
salt myminion boto_ec2.run ami-b80c2b87 name=myinstance
image_id
(string) – The ID of the image to run.
name
(string) - The name of the instance.
tags
(dict of key: value pairs) - tags to apply to the instance.
key_name
(string) – The name of the key pair with which to launch instances.
security_groups
(list of strings) – The names of the EC2 classic security groups with
which to associate instances
user_data
(string) – The Base64-encoded MIME user data to be made available to the
instance(s) in this reservation.
instance_type
(string) – The type of instance to run. Note that some image types
(e.g. hvm) only run on some instance types.
placement
(string) – The Availability Zone to launch the instance into.
kernel_id
(string) – The ID of the kernel with which to launch the instances.
ramdisk_id
(string) – The ID of the RAM disk with which to launch the instances.
monitoring_enabled
(bool) – Enable detailed CloudWatch monitoring on the instance.
vpc_id
(string) - ID of a VPC to bind the instance to. Exclusive with vpc_name.
vpc_name
(string) - Name of a VPC to bind the instance to. Exclusive with vpc_id.
subnet_id
(string) – The subnet ID within which to launch the instances for VPC.
subnet_name
(string) – The name of a subnet within which to launch the instances for VPC.
private_ip_address
(string) – If you’re using VPC, you can optionally use this parameter to
assign the instance a specific available IP address from the subnet
(e.g. 10.0.0.25).
block_device_map
(boto.ec2.blockdevicemapping.BlockDeviceMapping) – A BlockDeviceMapping
data structure describing the EBS volumes associated with the Image.
(string) - A string representation of a BlockDeviceMapping structure
(dict) - A dict describing a BlockDeviceMapping structure
YAML example:
.. code-block:: yaml
device-maps:
/dev/sdb:
ephemeral_name: ephemeral0
/dev/sdc:
ephemeral_name: ephemeral1
/dev/sdd:
ephemeral_name: ephemeral2
/dev/sde:
ephemeral_name: ephemeral3
/dev/sdf:
size: 20
volume_type: gp2
disable_api_termination
(bool) – If True, the instances will be locked and will not be able to
be terminated via the API.
instance_initiated_shutdown_behavior
(string) – Specifies whether the instance stops or terminates on
instance-initiated shutdown. Valid values are: stop, terminate
placement_group
(string) – If specified, this is the name of the placement group in
which the instance(s) will be launched.
client_token
(string) – Unique, case-sensitive identifier you provide to ensure
idempotency of the request. Maximum 64 ASCII characters.
security_group_ids
(list of strings) – The ID(s) of the VPC security groups with which to
associate instances.
security_group_names
(list of strings) – The name(s) of the VPC security groups with which to
associate instances.
additional_info
(string) – Specifies additional information to make available to the
instance(s).
tenancy
(string) – The tenancy of the instance you want to launch. An instance
with a tenancy of ‘dedicated’ runs on single-tenant hardware and can
only be launched into a VPC. Valid values are:”default” or “dedicated”.
NOTE: To use dedicated tenancy you MUST specify a VPC subnet-ID as well.
instance_profile_arn
(string) – The Amazon resource name (ARN) of the IAM Instance Profile
(IIP) to associate with the instances.
instance_profile_name
(string) – The name of the IAM Instance Profile (IIP) to associate with
the instances.
ebs_optimized
(bool) – Whether the instance is optimized for EBS I/O. This
optimization provides dedicated throughput to Amazon EBS and an
optimized configuration stack to provide optimal EBS I/O performance.
This optimization isn’t available with all instance types.
network_interfaces
(boto.ec2.networkinterface.NetworkInterfaceCollection) – A
NetworkInterfaceCollection data structure containing the ENI
specifications for the instance.
network_interface_id
(string) - ID of the network interface to attach to the instance
network_interface_name
(string) - Name of the network interface to attach to the instance
u5 Only one of subnet_name or subnet_id may be provided.u boto_vpc.get_resource_idu subnetR R R R! u idu Couldn't resolve subnet name %s.uG Only one of security_group_ids or security_group_names may be provided.u boto_secgroup.get_group_idt vpc_nameu' Couldn't resolve security group name %si u_ Only one of network_interface_id, network_interface_name or network_interfaces may be provided.u resultuM Given network_interface_name '%s' cannot be mapped to an network_interface_idRG t device_indexi t subnet_idt groupst key_namet security_groupst user_datat
instance_typet placementt kernel_idt
ramdisk_idt monitoring_enabledRH t block_device_mapt disable_api_terminationt$ instance_initiated_shutdown_behaviort placement_groupt client_tokent additional_infot tenancyt instance_profile_arnt instance_profile_namet
ebs_optimizedt network_interfacesu Instance could not be reservedu pendingi u runningu Nameu instance_idu/ Instance could not be started -- status is "%s"N( t allR R R) R� R t listR t intR1 t sumRK R R
R$ t
run_instancesR� R_ Rw Rx R] t add_tagt add_tagsRa (/ t image_idRE Rb R� R� R� R� R� R� R� R� t vpc_idR� R� t subnet_nameRH R� R� R� R� R� t security_group_idst security_group_namesR� R� R� R� R� RG RN R R R R! R� Rj t sgnt network_interface_argsR� t interfaceR/ t interfaces_specst
interfacesR+ t reservationRl R� ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyt runV s� �
!
c C@ s� t d | d | d | d | � } yC | j | � } t j d | � | d k rS t S| j | j f SWn' t j j
k
r� } t j | � t SXd S( u�
Check to see if a key exists. Returns fingerprint and name if
it does and False if it doesn't
CLI Example:
.. code-block:: bash
salt myminion boto_ec2.get_key mykey
R R R R! u the key to return is : %sN( R$ t get_key_pairR) R3 R1 R RE t fingerprintR& R' R( ( R� R R R R! R+ R, ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyt get_key< s
!
c C@ s� t d | d | d | d | � } y7 | j | � } t j d | � | j | � | j SWn' t j j k
r� } t j | � t SXd S( u�
Creates a key and saves it to a given path.
Returns the private key.
CLI Example:
.. code-block:: bash
salt myminion boto_ec2.create_key mykey /root/
R R R R! u the key to return is : %sN(
R$ t create_key_pairR) R3 t savet materialR& R' R( R ( R� t save_pathR R R R! R+ R, ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyt
create_keyS s !
c C@ s| t d | d | d | d | � } y- | j | | � } t j d | � | j SWn' t j j k
rw } t j | � t SXd S( u
Imports the public key from an RSA key pair that you created with a third-party tool.
Supported formats:
- OpenSSH public key format (e.g., the format in ~/.ssh/authorized_keys)
- Base64 encoded DER format
- SSH public key file format as specified in RFC4716
- DSA keys are not supported. Make sure your key generator is set up to create RSA keys.
Supported lengths: 1024, 2048, and 4096.
CLI Example:
.. code-block:: bash
salt myminion boto_ec2.import mykey publickey
R R R R! u the key to return is : %sN( R$ t import_key_pairR) R3 R� R& R' R( R ( R� t public_key_materialR R R R! R+ R, ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyt
import_keyk s !
c C@ sv t d | d | d | d | � } y' | j | � } t j d | � | SWn' t j j k
rq } t j | � t SXd S( u�
Deletes a key. Always returns True
CLI Example:
.. code-block:: bash
salt myminion boto_ec2.delete_key mykey
R R R R! u the key to return is : %sN( R$ t delete_key_pairR) R3 R& R' R( R ( R� R R R R! R+ R, ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyt
delete_key� s
!
c
C@ s� t d | d | d | d | � } yZ | j | | � } t j d | � g } | rv x! | D] } | j | j � qY Wn | SWn' t j j k
r� } t j | � t SXd S( ui
Gets all keys or filters them by name and returns a list.
keynames (list):: A list of the names of keypairs to retrieve.
If not provided, all key pairs will be returned.
filters (dict) :: Optional filters that can be used to limit the
results returned. Filters are provided in the form of a dictionary
consisting of filter names as the key and filter values as the
value. The set of allowable filter names/values is dependent on
the request being performed. Check the EC2 API guide for details.
CLI Example:
.. code-block:: bash
salt myminion boto_ec2.get_keys
R R R R! u the key to return is : %sN(
R$ t get_all_key_pairsR) R3 R� RE R& R' R( R (
t keynamesRe R R R R! R+ t keyst
key_valuesR, ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyt get_keys� s !
c
C@ s� t d | d | d | d | � } d d d d d d
d d d
d d d d g
} t | | f � so t d � � n | r� | r� t d � � n | | k r� t d j | � � � n y� | r7t d | d | d | d | d | d | � }
t |
� d k rt j d � t St |
� d k r*t j d � t S|
d } n | j | | � } | sSt Si | | | 6SWn' t
j j k
r�} t j | � t SXd S( u
Get an EC2 instance attribute.
CLI Example:
.. code-block:: bash
salt myminion boto_ec2.get_attribute sourceDestCheck instance_name=my_instance
Available attributes:
* instanceType
* kernel
* ramdisk
* userData
* disableApiTermination
* instanceInitiatedShutdownBehavior
* rootDeviceName
* blockDeviceMapping
* productCodes
* sourceDestCheck
* groupSet
* ebsOptimized
* sriovNetSupport
R R R R! u instanceTypeu kernelu ramdisku userDatau disableApiTerminationu! instanceInitiatedShutdownBehavioru rootDeviceNameu blockDeviceMappingu productCodesu sourceDestChecku groupSetu ebsOptimizedu sriovNetSupportuN At least one of the following must be specified: instance_name or instance_id.uL Both instance_name and instance_id can not be specified in the same command.u Attribute must be one of: {0}.RE Re i u7 Found more than one EC2 instance matching the criteria.u, Found no EC2 instance matching the criteria.i N(
R$ t anyR R\ Rn Rr R) R* R t get_instance_attributeR& R' R( (
t attributeRM RF R R R R! Re R+ t attribute_listR_ t instance_attributeRm ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyt
get_attribute� s8 ! $
c
C@ sd t d | d | d | d | � } d d d d d d
d d d
d d d d g
}
t | | f � so t d � � n | r� | r� t d � � n | |
k r� t d j |
� � � n y� | rt d | d | d | d | d | d | � } t | � d k rt d � � n | d } n | j | | | � } | s1t S| SWn' t j
j k
r_} t j
| � t SXd S( uE
Set an EC2 instance attribute.
Returns whether the operation succeeded or not.
CLI Example:
.. code-block:: bash
salt myminion boto_ec2.set_attribute sourceDestCheck False instance_name=my_instance
Available attributes:
* instanceType
* kernel
* ramdisk
* userData
* disableApiTermination
* instanceInitiatedShutdownBehavior
* rootDeviceName
* blockDeviceMapping
* productCodes
* sourceDestCheck
* groupSet
* ebsOptimized
* sriovNetSupport
R R R R! u instanceTypeu kernelu ramdisku userDatau disableApiTerminationu! instanceInitiatedShutdownBehavioru rootDeviceNameu blockDeviceMappingu productCodesu sourceDestChecku groupSetu ebsOptimizedu sriovNetSupportuN At least one of the following must be specified: instance_name or instance_id.uL Both instance_name and instance_id can not be specified in the same command.u Attribute must be one of: {0}.RE Re i u7 Found more than one EC2 instance matching the criteria.i N( R$ R� R R\ Rn Rr R t modify_instance_attributeR R& R' R( R) R* (
R� t attribute_valueRM RF R R R R! Re R+ R� R_ Rm ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyt
set_attribute� s0 ! $
c
C@ s� t d | d | d | d | � } i } yt | j d i | d 6� } | s] i d d 6| d <n= t | � d
k r� i d d 6| d <n | d } | j | d
<Wn- t j j k
r� } t d | � | d <n X| S( u�
Get an Elastic Network Interface id from its name tag.
.. versionadded:: 2016.3.0
CLI Example:
.. code-block:: bash
salt myminion boto_ec2.get_network_interface_id name=my_eni
R R R R! Re u tag:Nameu No ENIs found.u messageu errori u* Name specified is tagged on multiple ENIs.i u resultu boto.get_error( R$ t get_all_network_interfacesRr Ra R& R' t EC2ResponseErrorR (
RE R R R R! R+ Rj t enist eniR, ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyRK - s
!
c
C@ s� t d | d | d | d | � } i } t | | | � } d | k rk | d d d k rg d | d <| S| S| d } t | � | d <| S(
u�
Get an Elastic Network Interface.
.. versionadded:: 2016.3.0
CLI Example:
.. code-block:: bash
salt myminion boto_ec2.get_network_interface name=my_eni
R R R R! u erroru messageu No ENIs found.u resultN( R$ t _get_network_interfaceR1 t _describe_network_interface(
RE RG R R R R! R+ Rj R� R� ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyt get_network_interfaceJ s
!
c C@ s� i } | p | s! t d � � n y� | r? | j | g � } n | j d i | d 6� } | sr i d d 6| d <n: t | � d k r� i d d 6| d <n | d } | | d
<Wn- t j j k
r� } t d | � | d <n X| S( Nu5 Either name or network_interface_id must be provided.Re u tag:Nameu No ENIs found.u messageu errori u* Name specified is tagged on multiple ENIs.i u resultu boto.get_error( R R� Rr R& R' R� R ( R+ RE RG Rj R� R� R, ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyR� d s"
c C@ sn i } xl d d d d d d d d d d
d d d
d d d d d d g D]+ } t | | � rF t | | � | | <qF qF W| j j | d <g | d <x6 | j D]+ } | d j i | j d 6| j d 6� q� Wg | d <x6 | j D]+ } | d j i | j d 6| j d 6� q� Wi | d <xR d d d d d d d g D]5 } t | j
| � r1t | j
| � | d | <q1q1W| S( Nu statusu descriptionu availability_zoneu requesterIdu requester_managedu mac_addressu private_ip_addressu vpc_idu idu source_dest_checku owner_idu tagsu subnet_idu
associationIdu
publicDnsNameu ipOwnerIdu publicIpu allocationIdu regionu groupsu nameu private_ip_addressesu primaryu
attachmentu attach_timeu device_indexu delete_on_terminationu instance_idu instance_owner_id( t hasattrR; R RE R� R� Ra RS RH t primaryt
attachment( R� Rj t attrt groupR6 ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyR� | s0
)
!c
C@ s� t j j j | | f � s* t d � � n | r� t d d | d | d | d | d | �}
d |
k r{ t j d | � t S|
d } n t d | d | d | d | � } i } t
| | � }
d
|
k r� i d d 6| d
<| St d | g d | d | d | d | �} | j d � } | sCd j | � } i | d 6| d
<| St d | d | d | d | d | d | �} y5 | j
| d | d | d | �} | j d | � Wn. t j j k
r�} t d | � | d
<| SXt | � | d
<| S( u�
Create an Elastic Network Interface.
.. versionadded:: 2016.3.0
CLI Example:
.. code-block:: bash
salt myminion boto_ec2.create_network_interface my_eni subnet-12345 description=my_eni groups=['my_group']
u@ One (but not both) of subnet_id or subnet_name must be provided.u boto_vpc.get_resource_idu subnetR R R R! u idu Couldn't resolve subnet name %s.u resultu) An ENI with this Name tag already exists.u messageu erroru boto_vpc.get_subnet_associationu vpc_idu- subnet_id {0} does not map to a valid vpc id.u" boto_secgroup.convert_to_group_idsR� RH Ro R� u Nameu boto.get_error( R R R@ RA R R R) R� R R$ R� R� R\ t create_network_interfaceR� R& R' R� R R� ( RE R� R� RH Ro R� R R R R! t resourceR+ Rj R� R� t msgt _groupsR� R, ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyR� � sN
! $ c
C@ s� | p | s t d � � n t d | d | d | d | � } i } t | | | � } d | k rd | S| d } y t | � }
|
d } Wn# t k
r� i d d
6| d <| SXy | j | � | d <Wn- t j j k
r� } t d | � | d <n X| S( u�
Create an Elastic Network Interface.
.. versionadded:: 2016.3.0
CLI Example:
.. code-block:: bash
salt myminion boto_ec2.create_network_interface my_eni subnet-12345 description=my_eni groups=['my_group']
u5 Either name or network_interface_id must be provided.R R R R! u erroru resultu idu( ID not found for this network interface.u messageu boto.get_error(
R R$ R� R� t KeyErrort delete_network_interfaceR& R' R� R ( RE RG R R R R! R+ Rj R� R� R� R, ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyR� � s( !
c C@ s� t j j j | | f � s* t d � � n t j j j | | f � sT t d � � n t d | d | d | d | � } i }
t | | | � } d | k r� | S| d } y t | � }
|
d } Wn# t k
r� i d
d 6|
d <|
SX| rEy+ t d | d | d | d | d | � } WqEt
j j k
rA} t
j | � t SXn y | j | | | � |
d <Wn- t
j j k
r�} t d
| � |
d <n X|
S( u�
Attach an Elastic Network Interface.
.. versionadded:: 2016.3.0
CLI Example:
.. code-block:: bash
salt myminion boto_ec2.attach_network_interface my_eni instance_name=salt-master device_index=0
uP Exactly one (but not both) of 'name' or 'network_interface_id' must be provided.uP Exactly one (but not both) of 'instance_name' or 'instance_id' must be provided.R R R R! u erroru resultu idu( ID not found for this network interface.u messageRE u boto.get_error( R R R@ RA R R$ R� R� R� RJ R& R' R( R) R* R t attach_network_interfaceR� R ( R� RE RG RM RF R R R R! R+ Rj R� R� R� R, ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyR� � s> !
c C@ s | p | p | s! t d � � n t d | d | d | d | � } i } | s� t | | | � }
d |
k rp |
S|
d } t | � } y | d d } Wq� t k
r� i d
d 6| d <| SXn y | j | | � | d <Wn- t j j k
r
}
t d |
� | d <n X| S(
u�
Detach an Elastic Network Interface.
.. versionadded:: 2016.3.0
CLI Example:
.. code-block:: bash
salt myminion boto_ec2.detach_network_interface my_eni
uF Either name or network_interface_id or attachment_id must be provided.R R R R! u erroru resultu
attachmentu idu% Attachment id not found for this ENI.u messageu boto.get_error(
R R$ R� R� R� t detach_network_interfaceR& R' R� R ( RE RG t
attachment_idt forceR R R R! R+ Rj R� R� R� R, ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyR� 3 s* !
c C@ s
| p | s t d � � n | d k rB | d k rB t d � � n i } t d | d | d | d | � } t | | | � }
d |
k r� |
S|
d } t | � } | d } | d
k r� d }
n0 | d k r� d
}
n | d k r� d }
n | }
| } | j d � rf|
d k rft d | d | j d � d | d | d | d | �} | sfi d d 6| d <| Sn d } |
d k r�y | d d } Wq�t k
r�i d d 6| d <| SXn y# | j | |
| d | �| d <Wn- t j
j k
r} t d | � | d <n X| S( u
Modify an attribute of an Elastic Network Interface.
.. versionadded:: 2016.3.0
CLI Example:
.. code-block:: bash
salt myminion boto_ec2.modify_network_interface_attribute my_eni attr=description value='example description'
u5 Either name or network_interface_id must be provided.u attr and value must be provided.R R R R! u erroru resultu idu groupsu groupSetu source_dest_checku sourceDestChecku delete_on_terminationu deleteOnTerminationu vpc_idu" boto_secgroup.convert_to_group_idsR� u6 Security groups do not map to valid security group idsu messageu
attachmentuj No attachment id found for this ENI. The ENI must be attached before delete_on_termination can be modifiedR� u boto.get_errorN(
R R1 R$ R� R� R� R R� t" modify_network_interface_attributeR& R' R� R ( RE RG R� R� R R R R! Rj R+ R� R� R� t _attrt _valuet _attachment_idR, ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyR� Z sX !
!
c C@ s� t d | d | d | d | � } y@ | j d | d | � } | rF | Sg | D] } | j ^ qM SWn' t j j k
r� }
t j |
� g SXd S( u�
Get a list of all EBS volumes, optionally filtered by provided 'filters' param
.. versionadded:: 2016.11.0
volume_ids
(list) - Optional list of volume_ids. If provided, only the volumes
associated with those in the list will be returned.
filters
(dict) - Additional constraints on which volumes to return. Valid filters are:
- attachment.attach-time - The time stamp when the attachment initiated.
- attachment.delete-on-termination - Whether the volume is deleted on instance termination.
- attachment.device - The device name that is exposed to the instance (for example, /dev/sda1).
- attachment.instance-id - The ID of the instance the volume is attached to.
- attachment.status - The attachment state (attaching | attached | detaching | detached).
- availability-zone - The Availability Zone in which the volume was created.
- create-time - The time stamp when the volume was created.
- encrypted - The encryption status of the volume.
- size - The size of the volume, in GiB.
- snapshot-id - The snapshot from which the volume was created.
- status - The status of the volume (creating | available | in-use | deleting | deleted | error).
- tag:key=value - The key/value combination of a tag assigned to the resource.
- volume-id - The volume ID.
- volume-type - The Amazon EBS volume type. This can be ``gp2`` for General
Purpose SSD, ``io1`` for Provisioned IOPS SSD, ``st1`` for Throughput
Optimized HDD, ``sc1`` for Cold HDD, or ``standard`` for Magnetic volumes.
return_objs
(bool) - Changes the return type from list of volume IDs to list of
boto.ec2.volume.Volume objects
returns
(list) - A list of the requested values: Either the volume IDs or, if
return_objs is ``True``, boto.ec2.volume.Volume objects.
CLI Example:
.. code-block:: bash
salt-call boto_ec2.get_all_volumes filters='{"tag:Name": "myVolume01"}'
R R R R! t
volume_idsRe N( R$ t get_all_volumesRa R& R' R( R) R* ( R Re Rc R R R R! R+ R< Rj R, ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyR � s -!(
c @ s i t d 6d d 6i d 6} d. } i } x�| D]�}
t |
j d
i � � } t |
j d i � � � i t d 6| d
6| d 6| d 6| d 6} i }
t j d | � d/ } |
j d | � } y� x� | j � D]� \ } } | d k r� | | d <q� | d k rZt d | d | d | d | d | d | � } | sMd j | � } t | � � n | |
d <q� | |
| <q� WWn# t k
r�} t j
| � q. n X|
| d
<t | � } t j d | � xT | D]L } | j | j
j d d � i | d 6� j � d 6� d j � j � � q�Wq. Wt j d! | � i i d" 6i d# 6} x�| j � D]�} | d | d } � t j d$ | j
t t | d i � � � t t t | d i � � j � � } t j d% | j
� � t � j � � } t | | � } g | | @D]# } | j | � | k r�| ^ q�} t | | � } | s<| s<| rs| rst t | d i � � | d" | j
<� | d# | j
<n t j d& | j
� t | � r�t � f d' � | D� � } t j d( | j
| � n t | � rt � f d) � | D� � } t j d* | j
| � n | sAt | j
� d | d | d | d | �s_t | d <d+ j | j
� � | d <| S| r�t | � r�t j d, | j
| � t | j
| d | d | d | d | �s�t | d <d- j | j
| � | d <| Sq�q�qAqAW| d" s�| d# r | d j | � n d/ | S(0 u�
.. versionadded:: 2016.11.0
tag_maps (list)
List of dicts of filters and tags, where 'filters' is a dict suitable for passing to the
'filters' argument of get_all_volumes() above, and 'tags' is a dict of tags to be set on
volumes (via create_tags/delete_tags) as matched by the given filters. The filter syntax
is extended to permit passing either a list of volume_ids or an instance_name (with
instance_name being the Name tag of the instance to which the desired volumes are mapped).
Each mapping in the list is applied separately, so multiple sets of volumes can be all
tagged differently with one call to this function. If filtering by instance Name, You may
additionally limit the instances matched by passing in a list of desired instance states.
The default set of states is ('pending', 'rebooting', 'running', 'stopping', 'stopped').
YAML example fragment:
.. code-block:: yaml
- filters:
attachment.instance_id: i-abcdef12
tags:
Name: dev-int-abcdef12.aws-foo.com
- filters:
attachment.device: /dev/sdf
tags:
ManagedSnapshots: true
BillingGroup: bubba.hotep@aws-foo.com
in_states:
- stopped
- terminated
- filters:
instance_name: prd-foo-01.aws-foo.com
tags:
Name: prd-foo-01.aws-foo.com
BillingGroup: infra-team@aws-foo.com
- filters:
volume_ids: [ vol-12345689, vol-abcdef12 ]
tags:
BillingGroup: infra-team@aws-foo.com
authoritative (bool)
If true, any existing tags on the matched volumes, and not explicitly requested here, will
be removed.
dry_run (bool)
If true, don't change anything, just return a dictionary describing any changes which
would have been applied.
returns (dict)
A dict describing status and any changes.
u successu u commentu changesu pendingu rebootingu runningu stoppingu stoppedu filtersu tagsu return_objsu regionu keyu keyidu profileu got filters: %su in_statesu
volume_idsu
instance_nameRE Rd R R R R! u, Couldn't resolve instance Name {0} to an ID.u attachment.instance_idu got volume list: %su -u _u volu tag_sets after munging: %su oldu newu current tags on vol.id %s: %su requested tags on vol.id %s: %su No changes needed for vol.id %sc 3@ s | ] } | � | f Vq d S( N( ( t .0t k( Rb ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pys <genexpr>B s u New tags for vol.id %s: %sc 3@ s | ] } | � | f Vq d S( N( ( R R ( Rb ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pys <genexpr>E s u Updated tags for vol.id %s: %su% Failed to set tags on vol.id {0}: {1}u Removed tags for vol.id %s: %su( Failed to remove tags on vol.id {0}: {1}( u pendingu rebootingu runningu stoppingu stoppedN( R R: R� R) R3 R1 t itemsRJ R\ R R� R t
setdefaultRa t replacet copyR] t valuesR; t setR� R� Rb Rr t create_tagsR t delete_tags( t tag_mapst
authoritativeRq R R R R! R< t running_statest tag_setst tmRe t argst new_filtersRF Rd R t vR� R, t volumest volt changest volumet currt reqt addRj R] t removeR� ( ( Rb s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyt set_volumes_tags� s� 6
)
N($4# *
*
+c
C@ s� t d | d | d | d | � } yd | j | � } i } xD | D]< } | j | k re i | | j <n | j | | j | j <q@ W| SWn' t j j k
r� } t j | � i SXd S( u�
Describe all tags matching the filter criteria, or all tags in the account otherwise.
.. versionadded:: 2018.3.0
filters
(dict) - Additional constraints on which volumes to return. Note that valid filters vary
extensively depending on the resource type. When in doubt, search first without a filter
and then use the returned data to help fine-tune your search. You can generally garner the
resource type from its ID (e.g. `vol-XXXXX` is a volume, `i-XXXXX` is an instance, etc.
CLI Example:
.. code-block:: bash
salt-call boto_ec2.get_all_tags '{"tag:Name": myInstanceNameTag, resource-type: instance}'
R R R R! N(
R$ R� t res_idR� RE R& R' R( R) R* (
Re R R R R! R+ R< Rb R� R, ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyR� W s !
c C@ s� t | t � s | g } n t d | d | d | d | � } y | j | | � t SWn' t j j k
r} } t j | � t
SXd S( u
Create new metadata tags for the specified resource ids.
.. versionadded:: 2016.11.0
resource_ids
(string) or (list) – List of resource IDs. A plain string will be converted to a list of one element.
tags
(dict) – Dictionary of name/value pairs. To create only a tag name, pass '' as the value.
returns
(bool) - True on success, False on failure.
CLI Example:
.. code-block:: bash
salt-call boto_ec2.create_tags vol-12345678 '{"Name": "myVolume01"}'
R R R R! N( R� R� R$ R R R& R' R( R) R* R ( t resource_idsRb R R R R! R+ R, ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyR x s !
c C@ s� t | t � s | g } n t d | d | d | d | � } y | j | | � t SWn' t j j k
r} } t j | � t
SXd S( uz
Delete metadata tags for the specified resource ids.
.. versionadded:: 2016.11.0
resource_ids
(string) or (list) – List of resource IDs. A plain string will be converted to a list of one element.
tags
(dict) or (list) – Either a dictionary containing name/value pairs or a list containing just tag names.
If you pass in a dictionary, the values must match the actual tag values or the tag
will not be deleted. If you pass in a value of None for the tag value, all tags with
that name will be deleted.
returns
(bool) - True on success, False on failure.
CLI Example:
.. code-block:: bash
salt-call boto_ec2.delete_tags vol-12345678 '{"Name": "myVolume01"}'
salt-call boto_ec2.delete_tags vol-12345678 '["Name","MountPoint"]'
R R R R! N( R� R� R$ R
R R& R' R( R) R* R ( R Rb R R R R! R+ R, ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyR
� s !
c
C@ s� t d | d | d | d | � } yS | j | | | | � }
|
ro | ro t | | � ro d } t j | � t S|
SWn' t j j k
r� } t j | � t SXd S( uu
Detach an EBS volume from an EC2 instance.
.. versionadded:: 2016.11.0
volume_id
(string) – The ID of the EBS volume to be detached.
instance_id
(string) – The ID of the EC2 instance from which it will be detached.
device
(string) – The device on the instance through which the volume is exposted (e.g. /dev/sdh)
force
(bool) – Forces detachment if the previous detachment attempt did not occur cleanly.
This option can lead to data loss or a corrupted file system. Use this option
only as a last resort to detach a volume from a failed instance. The instance
will not have an opportunity to flush file system caches nor file system meta data.
If you use this option, you must perform file system check and repair procedures.
wait_for_detachement
(bool) - Whether or not to wait for volume detachement to complete.
returns
(bool) - True on success, False on failure.
CLI Example:
.. code-block:: bash
salt-call boto_ec2.detach_volume vol-12345678 i-87654321
R R R R! u4 Timed out waiting for the volume status "available".N( R$ t
detach_volumet _wait_for_volume_availableR) R* R R& R' R( (
R� RF t deviceR� t wait_for_detachementR R R R! R+ R< t timeout_msgR, ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyR! � s !
c
C@ s� t d | d | d | d | � } y | j | � SWn0 t j j k
rd } | se t j | � t Sn Xy$ | j | d | �| j | � SWn' t j j k
r� } t j | � t SXd S( u�
Detach an EBS volume from an EC2 instance.
.. versionadded:: 2016.11.0
volume_id
(string) – The ID of the EBS volume to be deleted.
force
(bool) – Forces deletion even if the device has not yet been detached from its instance.
returns
(bool) - True on success, False on failure.
CLI Example:
.. code-block:: bash
salt-call boto_ec2.delete_volume vol-12345678
R R R R! R� N( R$ t
delete_volumeR& R' R( R) R* R R! (
R� RF R# R� R R R R! R+ R, ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyR& � s !
i c C@ s� d } xy t r� | d } t j | � | j d | g � } t | � d k rQ t S| d } | j d k rn t S| | k r t Sq Wd S( Ni i R u available( R Rw Rx R Rr R R� ( R+ R� R| t intervalRk t volsR ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyR" s
c C@ sf t d | d | d | d | � } y | j | | | � SWn' t j j k
ra } t j | � t SXd S( u
Attach an EBS volume to an EC2 instance.
..
volume_id
(string) – The ID of the EBS volume to be attached.
instance_id
(string) – The ID of the EC2 instance to attach the volume to.
device
(string) – The device on the instance through which the volume is exposed (e.g. /dev/sdh)
returns
(bool) - True on success, False on failure.
CLI Example:
.. code-block:: bash
salt-call boto_ec2.attach_volume vol-12345678 i-87654321 /dev/sdh
R R R R! N( R$ t
attach_volumeR& R' R( R) R* R ( R� RF R# R R R R! R+ R* ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyR) s !
c C@ s | d k r' | d k r' t d � � n i } t d | d | d |
d | � }
y� |
j d | d | d | d | d
| d | d | � } | r� t |
| j � r� d
} t j | � | | d <n
| j | d <Wn- t j j
k
r� } t d | � | d <n X| S( u�
Create an EBS volume to an availability zone.
..
zone_name
(string) – The Availability zone name of the EBS volume to be created.
size
(int) – The size of the new volume, in GiB. If you're creating the
volume from a snapshot and don't specify a volume size, the
default is the snapshot size.
snapshot_id
(string) – The snapshot ID from which the new volume will be created.
volume_type
(string) - The type of the volume. Valid volume types for AWS can be found here:
http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html
iops
(int) - The provisioned IOPS you want to associate with this volume.
encrypted
(bool) - Specifies whether the volume should be encrypted.
kms_key_id
(string) - If encrypted is True, this KMS Key ID may be specified to
encrypt volume with this key
e.g.: arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef
wait_for_creation
(bool) - Whether or not to wait for volume creation to complete.
returns
(string) - created volume id on success, error message on failure.
CLI Example:
.. code-block:: bash
salt-call boto_ec2.create_volume us-east-1a size=10
salt-call boto_ec2.create_volume us-east-1a snapshot_id=snap-0123abcd
u3 Size must be provided if not created from snapshot.R R R R! R� t zonet snapshotR� R� R� t
kms_key_idu4 Timed out waiting for the volume status "available".u erroru resultu boto.get_errorN( R1 R R$ t
create_volumeR" Ra R) R* R& R' R( R ( t zone_nameR� R� R� R� R� R, t wait_for_creationR R R R! R< R+ R R% R* ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyR- > s" ) !
(S t __doc__t
__future__R R R t loggingRw t salt.utils.compatR t salt.utils.datat salt.utils.jsont salt.utils.versionst salt.extR t salt.ext.six.movesR t salt.exceptionsR R R& t boto.ec2t boto.ec2.blockdevicemappingR R t boto.ec2.networkinterfaceR R
R R t ImportErrorR t getLoggerR R) R R R1 R- R0 R8 R2 R? RD RO RR RV RW RZ Rn Rs R R� RJ R� R� R� R� R� R� R� R� R� R� R� RK R� R� R� R� R� R� R� R� R R R� R R
R! R& R" R) R- ( ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/boto_ec2.pyt <module>* s�
. %( " R 92 7 !0 5 � 95 < #7 & E 6~!!% , $
Mini Shell