pat-rapidai / pulumi-awsx Goto Github PK

Pulumi's framework for Amazon Web Services (AWS) infrastructure.

This package is meant for use with the Pulumi CLI. Please visit pulumi.io for installation instructions.

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, but not limited to:

• apigateway. A module that makes creating API Gateway RestApis easily. It includes native support to easily route incoming requests to AWS Lambdas, S3 buckets, or proxying requests to internal Load Balancer endpoints.

• autoscaling. A module that makes creating auto-scaling launch configurations and launch groups easier. Note: given an awsx ecs.Cluster, the easiest way to create an auto-scaling group is to just call createAutoScalingGroup on it. This will produce an auto-scaling group already property configured for that cluster.

• 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 (using Vpc.getDefault). 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 either Network or Application load 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, an lb.TargetGroup can be passed in directly as the portMapping target of an ecs.Container.

• Network. Deprecated. Use ec2.VPC instead.

• Cluster. Deprecated. Use ecs.Cluster instead.

This package is available in JavaScript/TypeScript for use with Node.js. Install it using either npm:

$ npm install @pulumi/awsx

or yarn:

$ yarn add @pulumi/awsx

For detailed reference documentation, please visit the API docs.