Pulumi Amazon Web Services (AWS) Infrastructure Components

Use a Raw Data Route when you need direct control over the Swagger/OpenAPI specification. The data field accepts an object that is merged into the final Swagger spec. This is useful for configuring advanced x-amazon-apigateway-integration settings.

import * as awsx from "@pulumi/awsx";

let endpoint = new awsx.apigateway.API("example", {
    routes: [{
        path: "/rawdata",
        method: "GET",
        data: {
            "x-amazon-apigateway-integration": {
                "uri": "https://www.google.com/",
                "responses": {
                    "default": {
                        "statusCode": "200",
                    },
                },
                "passthroughBehavior": "when_no_match",
                "httpMethod": "GET",
                "type": "http_proxy",
            },
        },
    }],
});

API Gateway can validate request parameters or the request body. If validation fails, a 400 error is returned.

Validators can be set at the API level or the method level (method level overrides API level). Valid values are:

• ALL: Validates both body and parameters.
• BODY_ONLY: Validates only the request body.
• PARAMS_ONLY: Validates only the request parameters.

Required Parameters must specify a name and the location (in): path, query, or header.

Note: Request body validation is currently not supported.

import * as awsx from "@pulumi/awsx";

let endpoint = new awsx.apigateway.API("example", {
    routes: [{
        path: "/www",
        localPath: "www",
        index: false,
        requestValidator: "PARAMS_ONLY",
        requiredParams: [{
            name: "key",
            in: "query",
        }]
    }],
    requestValidator: "ALL",
});

When vpcEndpointStrategy is set to "Auto" and a spec has vpcEndpointType: "Gateway" (or the type is omitted, as Gateway is the provider default), AWSX manages the route tables:

• Route Tables: If routeTableIds is omitted, AWSX automatically selects all generated VPC route tables. This includes generated Private, Isolated, and Public route tables.
• Preservation: If you provide explicit routeTableIds, AWSX will preserve those values and not perform automatic selection.

Caution: AWSX does not deduplicate routes against endpoints managed outside of the awsx.ec2.Vpc component. Ensure you do not have overlapping Gateway endpoint routes if mixing AWSX-managed and manually managed endpoints.

Metrics are the fundamental building blocks in CloudWatch, representing time-ordered data points for a specific variable (e.g., CPU usage).

In awsx, metrics are often provided as predefined submodules tied to specific AWS resources. For example, awsx.lambda.metrics provides metrics specifically for Lambda functions.

When working with metrics, you can typically specify:

1. period: The time period over which data is collected.
2. statistic: The type of statistic to collect (e.g., Average, Maximum).
3. unit: The unit of measure (e.g., Seconds, Megabytes/Second).

Note: Not all metrics support all statistics or units; check the specific metric documentation for supported values.

const func = new aws.lambda.CallbackFunction(...);
const funcMetric = awsx.lambda.metrics.duration({ function: func, unit: "Seconds" });

The @pulumi/awsx package provides high-level component wrappers around core AWS 'raw' resources from @pulumi/aws. These components reduce boilerplate and follow AWS best practices by default while still exposing underlying functionality.

Key modules include:

• ec2: Simplifies working with networks, subnets, and security groups. A common pattern is using awsx.ec2.DefaultNetwork to acquire a default VPC for a region.
• ecs: Simplifies creating and configuring clusters, tasks, and services for containerized workloads (EC2 or Fargate).
• lb: Simplifies setting up Elastic Load Balancing (Network or Application load balancers) with associated Target Groups and Listeners. Components like lb.defaultTarget can be passed directly into other awsx components (e.g., as a portMapping target for ecs.FargateService).

The awsx.ecr.RegistryImage resource manages the lifecycle of a Docker image in a registry by performing a docker push operation. Unlike awsx.ecr.Image, which builds an image from source, RegistryImage is used to push an existing image (identified by a source tag) to an ECR repository. The image is pushed whenever the sourceImage property changes or is updated.

To use this, you must provide the repositoryUrl of the target ECR repository and the sourceImage string (e.g., name:tag).

import * as pulumi from "@pulumi/pulumi";
import * as awsx from "@pulumi/awsx";

const repository = new awsx.ecr.Repository("repository", { forceDelete: true });

const preTaggedImage = new awsx.ecr.RegistryImage("registry-image", {
  repositoryUrl: repository.url,
  sourceImage: "my-awesome-image:v1.0.0",
});