Metadata-Version: 1.1
Name: iam-starter
Version: 0.1.1
Summary: A CLI which starts your program in the context of an assumed AWS IAM Role
Home-page: https://github.com/billtrust/iam-starter
Author: Doug Kerwin
Author-email: dwkerwin@gmail.com
License: MIT
Description: IAM-Starter
        ===========
        
        A CLI which starts your program in the context of an assumed AWS IAM
        Role
        
        Installation
        ------------
        
        .. code:: shell
        
            $ pip install iam-starter
        
        Usage
        -----
        
        .. code:: shell
        
            # start a program given an IAM Role (assumes default creds can assume role)
            $ iam-starter --role myrole --start ./my-program.sh
        
            # start a program given an IAM Role and AWS Profile with access to assume that role
            $ iam-starter --role myrole --profile dev --start ./my-program.sh
        
            # get export commands to paste into shell to assume the role manually
            $ iam-starter --role myrole --profile dev
            export AWS_ACCESS_KEY_ID="ASIAI....UOCA"
            export AWS_SECRET_ACCESS_KEY="DWYnQ....h93k"
            export AWS_SESSION_TOKEN="KMWSz...8wX=="
            # Run this to configure your shell:
            # eval $(iam-starter --role myrole --profile dev)
        
        Motivation
        ----------
        
        To be able to use AWS IAM Roles wherever possible, and to avoid having
        to specify profile names in code, or necessitate any other code changes
        to support different methods of gaining AWS credentials inside or
        outside of EC2 / ECS.
        
        The desire was to accomplish this without having to configure a profile
        in your ``~/.aws/config`` for each role as that may be cumbersome for a
        large number of different roles, or inconvenient when executing in
        environments such as CI servers where you may or may not have access to
        setup AWS profiles in that environment.
        
        Use with Docker
        ---------------
        
        This is primarily intended to be used outside Docker. To run a Docker
        container with an assumed IAM Role, you are probably better off using
        `IAM-Docker-Run <https://github.com/billtrust/iam-docker-run>`__.
        
        Limitations
        -----------
        
        **This is a development workflow tool, not designed to run production
        applications.**
        
        Temporary credentials expire within 1 hour and do not auto renew. This
        tool was designed to be used with development, adhoc, or witih build/CI
        environments where execution time is short.
        
        Publishing Updates to PyPi
        --------------------------
        
        For the maintainer - to publish an updated version of ssm-search,
        increment the version number in version.py and run the following:
        
        .. code:: shell
        
            docker build -f ./Dockerfile.buildenv -t iam-starter:build .
            docker run --rm -it --entrypoint make iam-starter:build publish
        
        At the prompts, enter the username and password to the pypi.org repo.
        
Keywords: aws-iam,aws-iam-role
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
