Manage S3 Buckets

Create and destroy S3 buckets. Be aware that this interacts with Amazon's services, and so may incur charges.

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.

If IAM roles are not used you need to specify them either in a pillar file or in the minion's config file:

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:

myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    region: us-east-1

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

salt.states.boto_s3_bucket.absent(name, Bucket, Force=False, region=None, key=None, keyid=None, profile=None)

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.

salt.states.boto_s3_bucket.present(name, Bucket, LocationConstraint=None, ACL=None, CORSRules=None, LifecycleConfiguration=None, Logging=None, NotificationConfiguration=None, Policy=None, Replication=None, RequestPayment=None, Tagging=None, Versioning=None, Website=None, region=None, key=None, keyid=None, profile=None)

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.