Skip to main content

Add your description here

Project description

Pulumi Easy

A streamlined Python library for AWS infrastructure provisioning using Pulumi.

Overview

pulumi-easy is a Python package that simplifies AWS infrastructure-as-code using Pulumi. It provides higher-level abstractions that make it easier to create common AWS resources without having to write boilerplate code.

Installation

# Using pip
pip install pulumi-easy

# Using poetry
poetry add pulumi-easy

# Using uv
uv add pulumi-easy

Requirements

  • Python 3.12+
  • Pulumi CLI
  • AWS credentials configured

Getting Started

  1. Install Pulumi CLI by following the official guide
# MacOS
brew install pulumi/tap/pulumi

# Linux
curl -fsSL https://get.pulumi.com | sh

# Windows
# Please refer to the official guide
  1. Configure AWS credentials using the aws configure command
aws configure
  1. Initialize a new Pulumi project
pulumi new aws-python
  1. Install the pulumi-easy package
pip install pulumi-easy
  1. Start using the library in your Pulumi program
from pulumi_easy.aws.iam.s3 import IamRoleS3Manager

# Initialize the manager
iam_manager = IamRoleS3Manager()

# Create an IAM role for EC2 to access specific S3 buckets
role = iam_manager.create_iam_ec2_s3(
    name="my-ec2-s3-role",
    bucket_resources=[
        "arn:aws:s3:::my-bucket/*",
        "arn:aws:s3:::my-bucket"
    ]
)

Optional Dependencies

By default, the library does not include any dependencies. However, you can install additional packages to enable more features:

Package Description
requests Required for get_my_ip() function in pulumi_easy.utils.ip

Benefits

  • Simplified Syntax: Create AWS resources with less code and cleaner APIs
  • Best Practices Built-in: IAM policies, security groups, and other resources follow AWS best practices
  • Type Safety: Python type hints for better IDE integration and error detection
  • Modular Design: Use only what you need from the library
  • Production-Ready: Designed to be used in real-world projects

Features

The library currently supports the following AWS components:

IAM Management

IamManager Class

Method Description
get_assume_role_policy(service_identifiers) Creates an assume role policy document for specified AWS services
create_iam_role_with_policy(name, assume_role_services, policy_document, description) Creates an IAM role with the specified policy and assume role configuration

IamRoleS3Manager Class

Method Description
create_iam_ec2_s3(name, bucket_resources, bucket_permissions, description, services) Creates an IAM role and policy for EC2 instances to access S3 buckets

EC2 Management

EC2Manager Class

Method Description
get_ubuntu_ami(version, arch) Gets the latest Ubuntu AMI ID for a specified version and architecture
create_key_pair(name, public_key) Creates an EC2 key pair using a provided public key
create_security_group(name, description) Creates a security group with SSH access
create_ubuntu_instance(name, storage, version, arch, instance_type, ssh_key_name) Creates an Ubuntu EC2 instance with specified parameters

Usage Examples

Create an IAM Role for EC2 to Access S3

from pulumi_easy.aws.iam.s3 import IamRoleS3Manager

# Initialize the manager
iam_manager = IamRoleS3Manager()

# Create an IAM role for EC2 to access specific S3 buckets
role = iam_manager.create_iam_ec2_s3(
    name="my-ec2-s3-role",
    bucket_resources=[
        "arn:aws:s3:::my-bucket/*",
        "arn:aws:s3:::my-bucket"
    ]
)

Create an Ubuntu EC2 Instance

from pulumi_easy.aws.ec2.ec2 import EC2Manager

# Initialize the manager
ec2_manager = EC2Manager()

# Create a key pair
key_pair = ec2_manager.create_key_pair(
    name="my-key",
    public_key="ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAI... user@hostname"
)

# Create an Ubuntu instance
instance = ec2_manager.create_ubuntu_instance(
    name="web-server",
    storage=20,                  # 20 GB root volume
    version="22.04",             # Ubuntu version
    arch="arm64",                # Architecture
    instance_type="t4g.nano",    # Instance type
    ssh_key_name=key_pair.key_name
)

See more examples in the documentation.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pulumi_easy-0.6.0.tar.gz (12.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pulumi_easy-0.6.0-py3-none-any.whl (15.2 kB view details)

Uploaded Python 3

File details

Details for the file pulumi_easy-0.6.0.tar.gz.

File metadata

  • Download URL: pulumi_easy-0.6.0.tar.gz
  • Upload date:
  • Size: 12.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for pulumi_easy-0.6.0.tar.gz
Algorithm Hash digest
SHA256 208540fc60b354bb73abfd159650d3a8c85634a962abfa904ea34e2506f865e2
MD5 34e5e4de567497299ea42e969ae09c0b
BLAKE2b-256 da500c95e213688aaff9038e97dd980c06adbd3c5365f22cb5a23e1e3f3b43c5

See more details on using hashes here.

Provenance

The following attestation bundles were made for pulumi_easy-0.6.0.tar.gz:

Publisher: release.yml on JuniYadi/python-pulumi

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pulumi_easy-0.6.0-py3-none-any.whl.

File metadata

  • Download URL: pulumi_easy-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 15.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for pulumi_easy-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 51e469d6fe63dd351752145c8e0ddbb5b5b6b6bdc02737afe15c7b434ea15e5c
MD5 24bbd27ac3f8bf0b8ec5a2e78e7c7690
BLAKE2b-256 5e8e7ab90ae6a77c5901ef419d9add4d84a1c5d81e39c3e550bc3446d7601aa8

See more details on using hashes here.

Provenance

The following attestation bundles were made for pulumi_easy-0.6.0-py3-none-any.whl:

Publisher: release.yml on JuniYadi/python-pulumi

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page