Add support for CDK Custom Resources #190
Merged
Conversation
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
flostadler
force-pushed
the
flostadler/cdk-custom-resources
branch
from
8768959 to
3b3a40a
Compare
flostadler
force-pushed
the
flostadler/cdk-custom-resources
branch
from
3b3a40a to
e6b7f14
Compare
flostadler
commented
Nov 15, 2024
| @@ -203,13 +211,33 @@ export class GraphBuilder { | |||
| if (resource.Type === 'AWS::EC2::VPC') { | |||
| this.vpcNodes[node.logicalId] = { vpcNode: node, vpcCidrBlockNode: undefined }; | |||
| } | |||
| } else if (node.construct.constructInfo?.fqn === 'aws-cdk-lib.CfnResource') { | |||
There was a problem hiding this comment.
Previously we were missing resources that were not in the tree.
I noticed this because CDK CustomResources label the CfnCustomResource with the id Default. This is a special ID that causes those resources to be ignored in the tree.
We need #186 to validate all resources of the template get mapped.
flostadler
commented
Nov 15, 2024
| @@ -116,7 +116,19 @@ export function mapToCfnResource( | |||
| const mName = moduleName(typeName).toLowerCase(); | |||
| const pType = pulumiTypeName(typeName); | |||
| const awsModule = aws as any; | |||
| return new awsModule[mName][pType](logicalId, props, options); | |||
|
|
|||
| // Workaround until TODO[pulumi/pulumi-aws-native#1816] is resolved. | |||
There was a problem hiding this comment.
Without this none of the CDK CustomResources I tried deploy successfully. They are all nested too deep for the 64 char limits of Lambda Functions and IAM roles
t0yv0
reviewed
Nov 15, 2024
| assert.NotEmpty(t, url) | ||
|
|
||
| // Validate that the index.html file is deployed | ||
| integration.AssertHTTPResultWithRetry(t, url, nil, 60*time.Second, func(body string) bool { |
t0yv0
reviewed
Nov 15, 2024
| stackId: stack.node.id, | ||
| bucketName: stagingBucket, | ||
| bucketKeyPrefix: `${synth.getDeployTimePrefix()}pulumi/custom-resources/${stackId}/${logicalId}`, | ||
| serviceToken: rawProps.ServiceToken, |
There was a problem hiding this comment.
Do we need to check that ServiceToken is not undefined?
t0yv0
reviewed
Nov 15, 2024
| // WHEN | ||
| mapToCustomResource(logicalId, cfnType, cfnProps, {}, stack); | ||
| // THEN | ||
| expect(aws.cloudformation.CustomResourceEmulator).toHaveBeenCalledWith(logicalId, { |
|
This PR has been shipped in release v1.0.0. |
This was referenced Nov 27, 2024
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds support for CloudFormation Custom Resource to pulumi-cdk. It implements does so by using the
CustomResourceEmulatorresource from aws-native.For the first implementation we decided to limit the scope to Lambda backed Custom Resources, because the SNS variants are not widely used.
I'd recommend reviewing in this order:
src/graph.tsandsrc/converters/app-converter.ts. The changes in these files ensure that Custom Resources get correctly parsed and other resources can reference their attributes with theGetAttintrinsicsrc/cfn-resource-mappings.ts: This constructs theCustomResourceEmulatorbased on the CDK inputs while re-using the staging bucket to store the CustomResource responses.Noteworthy:
I added a temporary workaround for shortening the resource names until pulumi/pulumi-aws-native#1816 is resolved. It can be toggled on by setting the
PULUMI_CDK_EXPERIMENTAL_MAX_NAME_LENGTHenv variable. Without this none of the CustomResources worked because they have deeply nested Lambdas and IAM roles. Those resources have a max name limit of 64.Closes #109
Closes #60