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 Crosswalk for AWS documentation.
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 compatability 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/awsxor yarn:
yarn add @pulumi/awsxPython
To use from Python, install using pip:
pip install pulumi-awsxGo
To use from Go, use go get to grab the latest version of the library
go get github.com/pulumi/pulumi-awsx/sdk.NET
To use from .NET, install using dotnet add package:
dotnet add package Pulumi.AwsxConfiguration
The configuration options available for this provider mirror those of the Pulumi AWS Classic Provider
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 functionaly 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.