Pulumi AWS Infrastructure Components
Pulumi's framework for Amazon Web Services (AWS) infrastructure.
To use this package, install the Pulumi CLI. For a streamlined Pulumi walkthrough, including language runtime installation and AWS configuration, see the AWS Guides.
The AWS Infrastructure package is intended to provide component wrappers around many core AWS 'raw' resources to make them easier and more convenient to use. In general, the @pulumi/awsx package mirrors the module structure of @pulumi/aws (i.e. @pulumi/awsx/ecs or @pulumi/awsx/ec2). These components are designed to take care of much of the redundancy and boilerplate necessary when using the raw AWS resources, while still striving to expose all underlying functionality if needed.
The AWS Infrastructure package undergoes constant improvements and additions. While we will strive to maintain backward compatibility here, we will occasionally make breaks here as appropriate if it helps improve the overall quality of this package.
The AWS Infrastructure package exposes many high level abstractions. Including:
-
ec2. A module that makes it easier to work with your AWS network, subnets, and security groups. By default, the resources in the package follow the AWS Best Practices, but can be configured as desired in whatever ways you want. Most commonly, this package is used to acquire the default Vpc for a region (usingawsx.ec2.DefaultNetwork). However, it can also be used to easily create or augment an existing Vpc. -
ecs. A module that makes it easy to create and configure clusters, tasks and services for running containers. Convenience resources are created to make the common tasks of creating EC2 or Fargate services and tasks much simpler. -
lb. A module for simply setting up Elastic Load Balancing. This module provides convenient ways to set up eitherNetworkorApplicationload balancers, along with the appropriate ELB Target Groups and Listeners in order to have a high availability, automatically-scaled service. These ELB components also work well with the other awsx components. For example, anlb.defaultTargetcan be passed in directly as theportMappingtarget of anecs.FargateService.
Installing
This package is available in many languages in the standard packaging formats.
Node.js (Java/TypeScript)
To use from JavaScript or TypeScript in Node.js, install using either npm:
npm install @pulumi/awsx
or yarn:
yarn add @pulumi/awsx
Python
To use from Python, install using pip:
pip install pulumi-awsx
Go
To use from Go, use go get to grab the latest version of the library
go get github.com/pulumi/pulumi-awsx/sdk/v3
.NET
To use from .NET, install using dotnet add package:
dotnet add package Pulumi.Awsx
Configuration
The configuration options available for this provider mirror those of the Pulumi AWS Classic Provider
Node.js compatibility warnings
AWSX includes its own Node.js runtime. AWSX warns when the provider host might not support the runtime planned for a future major version.
To suppress this warning for a stack:
pulumi config set awsx:suppressNodeCompatibilityWarning true
The setting applies to all SDK languages. Remove it or set it to false to restore warnings.
Custom AWS Provider Versions
Pulumi dependency resolution may result in awsx.* resources using a different version of the AWS Classic Provider than
the rest of the program. The version used by default is fixed for each @pulumi/awsx release and can be found in
package.json. When this becomes problematic,
for example a newer version of AWS Classic Provider is desired, it can be specified explicitly. For example, in Python:
import pulumi
import pulumi_aws as aws
import pulumi_awsx as awsx
awsp = aws.Provider("awsp", opts=pulumi.ResourceOptions(version="6.36.0"))
lb = awsx.lb.ApplicationLoadBalancer("lb", opts=pulumi.ResourceOptions(providers={"aws": awsp}))
Migration from 0.x to 1.0
Before version 1, this package only supported components in TypeScript. All the existing components from the 0.x releases are now available in the classic namespace. The classic namespace will remain until the next major version release but will only receive updates for critical security fixes.
- Change references from
@pulumi/awsxto@pulumi/awsx/classicto maintain existing behaviour. - Refactor to replace the classic components with the new top-level components.
Note: The new top-level components (outside the classic namespace) may require additional code changes and resource re-creation.
Notable changes
- Removed ECS Cluster as this did not add any functionality over the AWS Classic ECS Cluster resource.
- Removed
Vpc.fromExistingIds()as this was originally added because other components depended on the concrete VPC component class. The new components in v1 no longer have hard dependencies on other resources, so instead the subnets from the existing VPC can be passed into other components directly.
References
1 maintainer
Release files for pulumi-awsx 3.10.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pulumi_awsx-3.10.0.tar.gz | 103.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pulumi_awsx-3.10.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 223.6 kB
Release files / pulumi_awsx-3.10.0.tar.gz
| Download URL | pulumi_awsx-3.10.0.tar.gz |
|---|---|
| Size | 103.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6b13801284c6835642d196ca2d2835d9674c08c1259467ba2a18a83ffaf330f6
|
|
BLAKE2b-256 checksum How to use checksums |
c303afa849eb8fc288325000e55f3632a5e1e51844adaa21e40e4957e5301ed4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.11.15
|
Release files / pulumi_awsx-3.10.0-py3-none-any.whl
| Download URL | pulumi_awsx-3.10.0-py3-none-any.whl |
|---|---|
| Size | 120.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
fbba5c73d82fc156c80c6815766fdb2918ab226c42cf49451ffdec31b97c337e
|
|
BLAKE2b-256 checksum How to use checksums |
843675ffb110ea567cfec8cedb57be1c4b7b2050683a2044d603542f01375c04
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.11.15
|
