Current File : //lib/python2.7/site-packages/salt/states/boto_s3_bucket.pyc
�
���^c @@ s 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 m
Z
e j e � Z
d � Z d � Z d � Z d � Z d � Z e e e e d
� Z d � Z d � Z d
� Z d � Z e e e e e e e e e e e e e e e e d � Z e e e e e d � Z d S( uL
Manage S3 Buckets
=================
.. versionadded:: 2016.3.0
Create and destroy S3 buckets. Be aware that this interacts with Amazon's services,
and so may incur charges.
:depends:
- boto
- boto3
The dependencies listed above can be installed via package or pip.
This module accepts explicit vpc 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 file or
in the minion's config file:
.. code-block:: yaml
vpc.keyid: GKTADJGHEIQSXMKKRBJ08H
vpc.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
It's also possible to specify ``key``, ``keyid`` and ``region`` via a profile,
either passed in as a dict, or as a string to pull from pillars or minion
config:
.. code-block:: yaml
myprofile:
keyid: GKTADJGHEIQSXMKKRBJ08H
key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
region: us-east-1
.. code-block:: text
Ensure bucket exists:
boto_s3_bucket.present:
- Bucket: mybucket
- LocationConstraint: EU
- ACL:
- GrantRead: "uri=http://acs.amazonaws.com/groups/global/AllUsers"
- CORSRules:
- AllowedHeaders: []
AllowedMethods: ["GET"]
AllowedOrigins: ["*"]
ExposeHeaders: []
MaxAgeSeconds: 123
- LifecycleConfiguration:
- Expiration:
Days: 123
ID: "idstring"
Prefix: "prefixstring"
Status: "enabled",
ID: "lc1"
Transitions:
- Days: 123
StorageClass: "GLACIER"
NoncurrentVersionTransitions:
- NoncurrentDays: 123
StorageClass: "GLACIER"
NoncurrentVersionExpiration:
NoncurrentDays: 123
- Logging:
TargetBucket: log_bucket
TargetPrefix: prefix
TargetGrants:
- Grantee:
DisplayName: "string"
EmailAddress: "string"
ID: "string"
Type: "AmazonCustomerByEmail"
URI: "string"
Permission: "READ"
- NotificationConfiguration:
LambdaFunctionConfiguration:
- Id: "string"
LambdaFunctionArn: "string"
Events:
- "s3:ObjectCreated:*"
Filter:
Key:
FilterRules:
- Name: "prefix"
Value: "string"
- Policy:
Version: "2012-10-17"
Statement:
- Sid: "String"
Effect: "Allow"
Principal:
AWS: "arn:aws:iam::133434421342:root"
Action: "s3:PutObject"
Resource: "arn:aws:s3:::my-bucket/*"
- Replication:
Role: myrole
Rules:
- ID: "string"
Prefix: "string"
Status: "Enabled"
Destination:
Bucket: "arn:aws:s3:::my-bucket"
- RequestPayment:
Payer: Requester
- Tagging:
tag_name: tag_value
tag_name_2: tag_value
- Versioning:
Status: "Enabled"
- Website:
ErrorDocument:
Key: "error.html"
IndexDocument:
Suffix: "index.html"
RedirectAllRequestsTo:
Hostname: "string"
Protocol: "http"
RoutingRules:
- Condition:
HttpErrorCodeReturnedEquals: "string"
KeyPrefixEquals: "string"
Redirect:
HostName: "string"
HttpRedirectCode: "string"
Protocol: "http"
ReplaceKeyPrefixWith: "string"
ReplaceKeyWith: "string"
- region: us-east-1
- keyid: GKTADJGHEIQSXMKKRBJ08H
- key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
i ( t absolute_importt print_functiont unicode_literalsN( t sixc C@ s d t k r d St S( u)
Only load if boto is available.
u boto_s3_bucket.existsu boto_s3_bucket( t __salt__t False( ( ( s> /usr/lib/python2.7/site-packages/salt/states/boto_s3_bucket.pyt __virtual__� s c C@ s) t j | � } d | k r% | d =n | S( Nu Type( t copyt deepcopy( t user_dictt ret( ( s> /usr/lib/python2.7/site-packages/salt/states/boto_s3_bucket.pyt _normalize_user� s
c C@ s8 t d d | d | d | d | � j d � } t | � S( Nu boto_s3_bucket.listt regiont keyt keyidt profileu Owner( R t getR ( R R
R R R
( ( s> /usr/lib/python2.7/site-packages/salt/states/boto_s3_bucket.pyt _get_canonical_id� s
c C@ s] t j | � } t | d � | d <x3 | j d d � D] } t | j d � � | d <q6 W| S( uU
Prepares the ACL returned from the AWS API for comparison with a given one.
u Owneru Grantsu Grantee( ( R R R R ( t ACLR
t item( ( s> /usr/lib/python2.7/site-packages/salt/states/boto_s3_bucket.pyt _prep_acl_for_compare� s
c C@ s d | k rm t j | d � } t | d � | d <x3 | j d d% � D] } t | j d � � | d <qF W| St j | � } | j i d d 6� i g d 6| d 6} d | k r| d } | d& k r� | d j i i d
d 6d d 6d 6d
d 6� n | d k r2| d j i i d
d 6d d 6d 6d d 6� n | d k ru| d j i i d d 6d d 6d d 6d 6d
d 6� n | d k r�| d j i i d
d 6d d 6d 6d
d 6� n | d k rx> d' D]3 } | d j i i d
d 6d d 6d 6| d 6� q�Wqn x� d( d) d* d+ d, f D]� \ } } | | k rx� | | j d! � D]� } | j d" � \ } } | d# k r�i d
d 6| d 6}
n) | d$ k r�i d d 6| d 6}
n i }
| d j i |
d 6| d 6� qCWqqW| d s�i | d 6d d 6g | d <n | S(- Nu AccessControlPolicyu Owneru Grantsu Granteeu
CanonicalUseru Typeu ACLu public-readu public-read-writeu Groupu/ http://acs.amazonaws.com/groups/global/AllUsersu URIu READu
Permissionu WRITEu
aws-exec-readu za-teamu DisplayNameu@ 6aa5a366c34c1cbe25dc49211496e913e0351eb0e8c37aa3477e40942ec6b97cu IDu authenticated-readu9 http://acs.amazonaws.com/groups/global/AuthenticatedUsersu log-delivery-writeu READ_ACPu. http://acs.amazonaws.com/groups/s3/LogDeliveryu GrantFullControlu FULL_CONTROLu GrantReadu GrantReadACPu
GrantWriteu
GrantWriteACPu WRITE_ACPu ,u =u uriu id( ( u public-readu public-read-write( u WRITEu READ_ACP( u GrantFullControlu FULL_CONTROL( u GrantReadu READ( u GrantReadACPu READ_ACP( u
GrantWriteu WRITE( u
GrantWriteACPu WRITE_ACP( R R R R t updatet appendt split( R t owner_canonical_idR
R t owner_canonical_grantt aclt
permissionR
t kindt valt grantee( ( s> /usr/lib/python2.7/site-packages/salt/states/boto_s3_bucket.pyt
_acl_to_grant� s�
c C@ s| | j d � r | St d d | d | d | d | � } | rW d | k rW | d } n | d k rl d } n d j | | � S(
Nu arn:aws:iam:u boto_iam.get_account_idR R
R R u regionu us-east-1u arn:aws:iam::{0}:role/{1}( t
startswithR t Nonet format( t nameR R
R R t
account_id( ( s> /usr/lib/python2.7/site-packages/salt/states/boto_s3_bucket.pyt
_get_role_arn% s
c C@ s t d | | � S( Nu boto3.json_objs_equal( t __utils__( t currentt desiredR R
R R ( ( s> /usr/lib/python2.7/site-packages/salt/states/boto_s3_bucket.pyt
_compare_json3 s c C@ s/ t | | | | � } t d | t | | � � S( u�
ACLs can be specified using macro-style names that get expanded to
something more complex. There's no predictable way to reverse it.
So expand all syntactic sugar in our input, and compare against that
rather than the input itself.
u boto3.json_objs_equal( R R& R ( R' R( R R
R R t ocid( ( s> /usr/lib/python2.7/site-packages/salt/states/boto_s3_bucket.pyt _compare_acl7 s c C@ s
| | k S( N( ( R' R( R R
R R ( ( s> /usr/lib/python2.7/site-packages/salt/states/boto_s3_bucket.pyt _compare_policyB s c C@ sj | d k rY | j d � rY t j | � } t | d d | d | d | d | �| d <n t d | | � S( uL
Replication accepts a non-ARN role name, but always returns an ARN
u RoleR R
R R u boto3.json_objs_equalN( R! R R R R% R& ( R' R( R R
R R ( ( s> /usr/lib/python2.7/site-packages/salt/states/boto_s3_bucket.pyt _compare_replicationF s
"c # C@ s� i | d 6t d 6d d 6i d 6} | dJ k r> i d d 6} n | dJ k rS i } n |
dJ k ro i d d 6}
n | r� t | t j � r� t j j j | � } n t d
| � } n t
d d | d
| d | d | d | � } d | k rt | d <d j | d d � | d <| S| j
d � sHt d rLd j | � | d <dJ | d <| St
d d | d | d
| d | d | d | � } | j
d � s�t | d <d j | d d � | d <| Sx.d | | f d | i | d 6f d | i | d 6f d | | f d | | f d! | i | d" 6f d# | | f d$ | | f d% |
|
f d& | | f d' |
|
f f D]� \ } } } | dJ k rUt
d( j | � d | d
| d | d | d | | � } | j
d) � s�t | d <d j | d d � | d <| SqUqUWt
d* | d
| d | d | d | �} i dJ d+ 6| d d, <| | d d- <d. j | � | d <| Sd/ j | d d0 j | � g � | d <i | d <t
d* d | d
| d | d | d | � } d | k r�t | d <d1 j | d d � | d <i | d <| S| d+ } t | � r t | j
d2 � � r i d3 d4 6} n d d | j
d � t | dJ f d5 d | j
d5 � t | rdi | d 6n dJ d6 f d7 d | j
d7 � t | r�i | d 6n dJ d8 f d9 d | j
d9 i � j
d: � t | dJ f d; d | j
d; � t | dJ f d" d! | j
d" � t | ri | d" 6n dJ d< f d= d% | j
d= � t |
dJ f d> d& | j
d> � t | d? f d@ d' | j
d@ � t |
dA f g } d2 d# | j
d2 � t | p�i dJ f } dB d$ | j
dB i � j
dC � t | dD f } | dJ k r�| j | � | j | � n | j | � | j | � t } x8| D]0\ } } } } } } | d" k r�| dJ k r�| j
d" � }! t |! t j � r�t d
i t j j j |! � d" 6� } q�q�n | | | | | | | � st } | d k r�t | t | | | | � � | d j d- i � | <n | | d j d- i � | <| | d j d, i � | <t d sK| r�| dJ k r�t
d( j | � d | d
| d | d | d | � } | j
dE � sEt | d <d1 j | d d � | d <i | d <| SqHt
d( j | � d | d
| d | d | d | | p�i � } | j
d) � sHt | d <d1 j | d d � | d <i | d <| SqKqqW| r�t d r�dF j | � }" |" | d <dJ | d <| S| j
dG i � j
dH � | k r�dI j | � }" t j |" � t | d <d1 j |" � | d <| S| S(K u�
Ensure bucket exists.
name
The name of the state definition
Bucket
Name of the bucket.
LocationConstraint
'EU'|'eu-west-1'|'us-west-1'|'us-west-2'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'sa-east-1'|'cn-north-1'|'eu-central-1'
ACL
The permissions on a bucket using access control lists (ACL).
CORSRules
The cors configuration for a bucket.
LifecycleConfiguration
Lifecycle configuration for your bucket
Logging
The logging parameters for a bucket and to specify permissions for who
can view and modify the logging parameters.
NotificationConfiguration
notifications of specified events for a bucket
Policy
Policy on the bucket
Replication
Replication rules. You can add as many as 1,000 rules.
Total replication configuration size can be up to 2 MB
RequestPayment
The request payment configuration for a bucket. By default, the bucket
owner pays for downloads from the bucket. This configuration parameter
enables the bucket owner (only) to specify that the person requesting
the download will be charged for the download
Tagging
A dictionary of tags that should be set on the bucket
Versioning
The versioning state of the bucket
Website
The website configuration of the bucket
region
Region to connect to.
key
Secret key to be used.
keyid
Access key to be used.
profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
u nameu resultu u commentu changesu privateu ACLu BucketOwneru Payeru
boto3.orderedu boto_s3_bucket.existst BucketR R
R R u erroru Failed to create bucket: {0}.u messageu existsu testu# S3 bucket {0} is set to be created.u boto_s3_bucket.createt LocationConstraintu createdu put_aclu put_corsu CORSRulesu put_lifecycle_configurationu Rulesu put_loggingu put_notification_configurationu
put_policyu Policyu put_versioningu put_replicationu put_request_paymentu put_taggingu put_websiteu boto_s3_bucket.{0}u updatedu boto_s3_bucket.describeu bucketu oldu newu S3 bucket {0} created.u u S3 bucket {0} is present.u Failed to update bucket: {0}.u
Versioningu Suspendedu Statusu CORSu delete_corsu LifecycleConfigurationu delete_lifecycle_configurationu Loggingu LoggingEnabledu NotificationConfigurationu
delete_policyu RequestPaymentu Taggingu delete_taggingu Websiteu delete_websiteu Replicationu ReplicationConfigurationu delete_replicationu deletedu! S3 bucket {0} set to be modified.u Locationu LocationConstraintuO Bucket {0} location does not match desired configuration, but cannot be changedN( t TrueR! t
isinstanceR t string_typest saltt utilst jsont loadsR& R R R" R t __opts__t joint boolR+ R) R, R- R R R t
setdefaultt logt warning(# R# R. R/ R t CORSRulest LifecycleConfigurationt Loggingt NotificationConfigurationt Policyt Replicationt RequestPaymentt Taggingt
Versioningt WebsiteR R
R R R
t rt settert testvalt funcargst _describet config_itemst versioning_itemt replication_itemR t varnameR' t
comparatorR( t deletert tempt msg( ( s> /usr/lib/python2.7/site-packages/salt/states/boto_s3_bucket.pyt presentQ s0 M
&
"%% %
( 2
!
c
C@ st i | d 6t d 6d d 6i d 6} t d | d | d | d | d
| �} d | k r t | d <d j | d d
� | d <| S| r� | d r� d j | � | d <| St d r� d j | � | d <d | d <| St d | d | d | d | d | d
| �} | d s3t | d <d j | d d
� | d <| Si | d 6| d d <i d d 6| d d <d j | � | d <| S( u�
Ensure bucket with passed properties is absent.
name
The name of the state definition.
Bucket
Name of the bucket.
Force
Empty the bucket first if necessary - Boolean.
region
Region to connect to.
key
Secret key to be used.
keyid
Access key to be used.
profile
A dict with region, key and keyid, or a pillar key (string) that
contains a dict with region, key and keyid.
u nameu resultu u commentu changesu boto_s3_bucket.existsR R
R R u erroru Failed to delete bucket: {0}.u messageu existsu S3 bucket {0} does not exist.u testu# S3 bucket {0} is set to be removed.u boto_s3_bucket.deletet Forceu deletedu bucketu oldu newu S3 bucket {0} deleted.N( R0 R R R" R7 R! ( R# R. RU R R
R R R
RG ( ( s> /usr/lib/python2.7/site-packages/salt/states/boto_s3_bucket.pyt absent^ s6
( t __doc__t
__future__R R R R t loggingt salt.utils.jsonR3 t salt.extR t getLoggert __name__R; R R R R R R! R% R) R+ R, R- RT R RV ( ( ( s> /usr/lib/python2.7/site-packages/salt/states/boto_s3_bucket.pyt <module>� s@ h �
Mini Shell