-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Expose CloudFormation Custom Resource Emulator Resource (#1807)
This change exposes the new CloudFormation Custom Resource Emulator resource. Additionally, it adds an integration test for it and makes `Check` correctly handle unknowns. One follow up item is to translate the code example to other languages.
- Loading branch information
1 parent
14a21ae
commit 7968d1b
Showing
23 changed files
with
1,298 additions
and
158 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| name: cfn-custom-resource | ||
| runtime: nodejs | ||
| description: A TypeScript Pulumi program with AWS Cloud Control provider |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| /** | ||
| * A sample Lambda function that looks up the latest AMI ID for a given region and architecture. | ||
| **/ | ||
|
|
||
| // Map instance architectures to an AMI name pattern | ||
| var archToAMINamePattern = { | ||
| "PV64": "amzn-ami-pv*x86_64-ebs", | ||
| "HVM64": "al2023-ami-2023.*-kernel-*-x86_64", | ||
| "HVMG2": "amzn-ami-graphics-hvm*x86_64-ebs*" | ||
| }; | ||
| const { EC2Client, DescribeImagesCommand } = require("@aws-sdk/client-ec2"); | ||
|
|
||
| exports.handler = async function(event, context) { | ||
| const redactedEvent = { ...event, ResponseURL: "REDACTED" }; | ||
| console.log("REQUEST RECEIVED:\n" + JSON.stringify(redactedEvent)); | ||
|
|
||
| // For Delete requests, immediately send a SUCCESS response. | ||
| if (event.RequestType == "Delete") { | ||
| await sendResponse(event, context, "SUCCESS"); | ||
| return; | ||
| } | ||
|
|
||
| var responseStatus = "FAILED"; | ||
| var responseData = {}; | ||
|
|
||
| const ec2Client = new EC2Client({ region: event.ResourceProperties.Region }); | ||
| const describeImagesParams = { | ||
| Filters: [{ Name: "name", Values: [archToAMINamePattern[event.ResourceProperties.Architecture]]}], | ||
| Owners: [event.ResourceProperties.Architecture == "HVMG2" ? "679593333241" : "amazon"] | ||
| }; | ||
|
|
||
| try { | ||
| const describeImagesResult = await ec2Client.send(new DescribeImagesCommand(describeImagesParams)); | ||
| var images = describeImagesResult.Images; | ||
| // Sort images by name in descending order. The names contain the AMI version, formatted as YYYY.MM.Ver. | ||
| images.sort((x, y) => y.Name.localeCompare(x.Name)); | ||
| for (var j = 0; j < images.length; j++) { | ||
| if (isBeta(images[j].Name)) continue; | ||
| responseStatus = "SUCCESS"; | ||
| responseData["Id"] = images[j].ImageId; | ||
| break; | ||
| } | ||
| } catch (err) { | ||
| responseData = { Error: "DescribeImages call failed" }; | ||
| console.log(responseData.Error + ":\n", err); | ||
| } | ||
|
|
||
| await sendResponse(event, context, responseStatus, responseData); | ||
| }; | ||
|
|
||
| // Check if the image is a beta or rc image. The Lambda function won't return any of those images. | ||
| function isBeta(imageName) { | ||
| return imageName.toLowerCase().indexOf("beta") > -1 || imageName.toLowerCase().indexOf(".rc") > -1; | ||
| } | ||
|
|
||
| // Send response to the pre-signed S3 URL | ||
| async function sendResponse(event, context, responseStatus, responseData) { | ||
| var responseBody = JSON.stringify({ | ||
| Status: responseStatus, | ||
| Reason: "See the details in CloudWatch Log Stream: " + context.logStreamName, | ||
| PhysicalResourceId: context.logStreamName, | ||
| StackId: event.StackId, | ||
| RequestId: event.RequestId, | ||
| LogicalResourceId: event.LogicalResourceId, | ||
| Data: responseData | ||
| }); | ||
|
|
||
| console.log("RESPONSE BODY:\n", responseBody); | ||
|
|
||
| var https = require("https"); | ||
| var url = require("url"); | ||
|
|
||
| var parsedUrl = url.parse(event.ResponseURL); | ||
| var options = { | ||
| hostname: parsedUrl.hostname, | ||
| port: 443, | ||
| path: parsedUrl.path, | ||
| method: "PUT", | ||
| headers: { | ||
| "content-type": "", | ||
| "content-length": responseBody.length | ||
| } | ||
| }; | ||
|
|
||
| console.log("SENDING RESPONSE...\n"); | ||
|
|
||
| await new Promise((resolve, reject) => { | ||
| var request = https.request(options, function(response) { | ||
| console.log("STATUS: " + response.statusCode); | ||
| console.log("HEADERS: " + JSON.stringify(response.headers)); | ||
| resolve(); | ||
| }); | ||
|
|
||
| request.on("error", function(error) { | ||
| console.log("sendResponse Error:" + error); | ||
| reject(error); | ||
| }); | ||
|
|
||
| // write data to request body | ||
| request.write(responseBody); | ||
| request.end(); | ||
| }); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| // Copyright 2016-2024, Pulumi Corporation. | ||
|
|
||
| import * as pulumi from '@pulumi/pulumi'; | ||
| import * as aws from "@pulumi/aws-native"; | ||
| import * as awsClassic from "@pulumi/aws"; | ||
|
|
||
| const amiRegion = new pulumi.Config().require("amiRegion"); | ||
|
|
||
| // Create an IAM role for the Lambda function | ||
| const lambdaRole = new awsClassic.iam.Role("lambdaRole", { | ||
| assumeRolePolicy: awsClassic.iam.assumeRolePolicyForPrincipal({ Service: "lambda.amazonaws.com" }), | ||
| }); | ||
|
|
||
| const policy = new awsClassic.iam.Policy("lambdaPolicy", { | ||
| policy: { | ||
| Version: "2012-10-17", | ||
| Statement: [{ | ||
| Action: "ec2:DescribeImages", | ||
| Effect: "Allow", | ||
| Resource: "*", | ||
| }], | ||
| }, | ||
| }); | ||
|
|
||
| const rpa1 = new awsClassic.iam.RolePolicyAttachment("lambdaRolePolicyAttachment1", { | ||
| role: lambdaRole.name, | ||
| policyArn: policy.arn, | ||
| }); | ||
|
|
||
| const rpa2 = new awsClassic.iam.RolePolicyAttachment("lambdaRolePolicyAttachment2", { | ||
| role: lambdaRole.name, | ||
| policyArn: awsClassic.iam.ManagedPolicies.AWSLambdaBasicExecutionRole, | ||
| }); | ||
|
|
||
| const bucket = new awsClassic.s3.BucketV2('custom-resource-emulator', { | ||
| forceDestroy: true, | ||
| }); | ||
|
|
||
| const handlerCode = new awsClassic.s3.BucketObjectv2("handler-code", { | ||
| bucket: bucket.bucket, | ||
| key: "handlerCode", | ||
| source: new pulumi.asset.AssetArchive({ | ||
| "index.js": new pulumi.asset.FileAsset("ami-lookup.js"), | ||
| }) | ||
| }) | ||
|
|
||
| // Create the Lambda function for the custom resource | ||
| const lambdaFunction = new awsClassic.lambda.Function("ami-lookup-custom-resource", { | ||
| runtime: awsClassic.types.enums.lambda.Runtime.NodeJS20dX, | ||
| s3Bucket: bucket.bucket, | ||
| s3Key: handlerCode.key, | ||
| handler: "index.handler", | ||
| role: lambdaRole.arn, | ||
| memorySize: 128, | ||
| timeout: 30, | ||
| }, { dependsOn: [rpa1, rpa2] }); | ||
|
|
||
| const cfnCustomResource = new aws.cloudformation.CustomResourceEmulator('emulator', { | ||
| bucketName: bucket.id, | ||
| bucketKeyPrefix: 'custom-resource-emulator', | ||
| customResourceProperties: { | ||
| Region: amiRegion, | ||
| Architecture: 'HVM64', | ||
| }, | ||
| serviceToken: lambdaFunction.arn, | ||
| resourceType: 'Custom::MyResource', | ||
| }, { customTimeouts: { create: '5m', update: '5m', delete: '5m' } }); | ||
|
|
||
| const cloudformationStack = new awsClassic.cloudformation.Stack('stack', { | ||
| templateBody: pulumi.interpolate`{ | ||
| "AWSTemplateFormatVersion" : "2010-09-09", | ||
| "Description" : "AWS CloudFormation AMI Look Up Sample Template: Demonstrates how to dynamically specify an AMI ID. This template provisions an EC2 instance with an AMI ID that is based on the instance's type and region. **WARNING** This template creates an Amazon EC2 instance. You will be billed for the AWS resources used if you create a stack from this template.", | ||
| "Resources" : { | ||
| "AMIInfo": { | ||
| "Type": "Custom::AMIInfo", | ||
| "Properties": { | ||
| "ServiceToken": "${lambdaFunction.arn}", | ||
| "ServiceTimeout": 300, | ||
| "Region": "${amiRegion}", | ||
| "Architecture": "HVM64" | ||
| } | ||
| } | ||
| }, | ||
| "Outputs" : { | ||
| "AMIID" : { | ||
| "Description": "The Amazon EC2 instance AMI ID.", | ||
| "Value" : { "Fn::GetAtt": [ "AMIInfo", "Id" ] } | ||
| } | ||
| } | ||
| } | ||
| ` | ||
| }); | ||
|
|
||
| export const cloudformationAmiId = cloudformationStack.outputs['AMIID']; | ||
| export const emulatorAmiId = cfnCustomResource.data['Id']; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| { | ||
| "name": "cfn-custom-resource", | ||
| "devDependencies": { | ||
| "@types/node": "^8.0.0" | ||
| }, | ||
| "dependencies": { | ||
| "@pulumi/pulumi": "^3.136.0", | ||
| "@pulumi/aws": "^6.57.0" | ||
| }, | ||
| "peerDependencies": { | ||
| "@pulumi/aws-native": "dev" | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| { | ||
| "compilerOptions": { | ||
| "strict": true, | ||
| "outDir": "bin", | ||
| "target": "es2016", | ||
| "module": "commonjs", | ||
| "moduleResolution": "node", | ||
| "sourceMap": true, | ||
| "experimentalDecorators": true, | ||
| "pretty": true, | ||
| "noFallthroughCasesInSwitch": true, | ||
| "noImplicitReturns": true, | ||
| "forceConsistentCasingInFileNames": true | ||
| }, | ||
| "files": [ | ||
| "index.ts" | ||
| ] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.