Skip to content

mtslzr/boto3auth

develop
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 

boto3auth

CircleCI PyPI version

boto3auth is a simple (Python 3) wrapper for starting clients/resources with Boto3.

Installation

Requires boto3.

pip install boto3auth

Usage

import boto3auth

b3a = boto3auth.Boto3Auth(region, account_id, role, sts)

Properties:

  • region: AWS region (e.g. us-east-1, ca-central-1, etc.)
    • Defaults to us-east-1, if not set.
  • account_id: AWS account number (if assuming role)
  • role: AWS IAM role (if assuming role)
  • sts: Boto3 STS credentials (if assuming a secondary role)

Auth

b3a.auth(resource, type)

Arguments:

  • resource: AWS resource (e.g. ec2, dynamodb, sqs, etc.)
  • type: Boto3 Session type (resource or client)

boto3auth will use local AWS credentials (works well with aws-vault).

import boto3auth

# EC2 resource in us-east-1, with local credentials.
b3a = boto3auth.Boto3Auth()
resource = b3a.auth('ec2')

# DynamoDB resource in us-west-2, with assumed role.
b3a = boto3auth.Boto3Auth('us-west-2', '123412341234', 'my-cool-role')
resource = b3a.auth('dynamodb', 'resource')

# EC2 client in ca-central-1 that requires two assumed roles.
# e.g. Local -> Account #1 -> Account #2
first = boto3auth.Boto3Auth('ca-central-1', '123412341234', 'first-role')
first.creds() # creds() runs sts.AssumeRole and sets result to self.sts.

second = boto3auth.Boto3Auth('ca-central-1', '456745674567', 'second-role', first.sts)
client = second.auth('ec2', 'client')

About

Simple (Python 3) wrapper for starting clients/services with Boto3

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages