feat(s3-deployment): support Fn::Select in renderData()

packages/@aws-cdk-testing/framework-integ/test/aws-s3-deployment/test/integ.bucket-deployment-data.js.snapshot/TestBucketDeploymentContent.template.json

@@ -20,7 +20,7 @@
      "S3Bucket": {
       "Fn::Sub": "cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}"
      },
-     "S3Key": "68b22621fff135f9e3f225bad7ff80fdf2f45c3d9910af601206a0d9b279933a.zip"
+     "S3Key": "e2277687077a2abf9ae1af1cc9565e6715e2ebb62f79ec53aa75a1af9298f642.zip"
     },
     "Description": "/opt/awscli/aws"
    }
@@ -44,6 +44,9 @@
      {
       "Fn::Sub": "cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}"
      },
+     {
+      "Fn::Sub": "cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}"
+     },
      {
       "Fn::Sub": "cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}"
      }
@@ -52,7 +55,8 @@
      "d09271be89b6cb0398f793b40c1531fd9b076aa92ba80b5e436914b1808fe18d.zip",
      "0f14dedeaf4386031c978375cbda0f65d7b52b29452cabb8873eb8f0d0fa936b.zip",
      "27eff729291aea0a2b33592996b9a764c233dc3387bd9cfd58c6f064073f177f.zip",
-     "939a4ab8b51f1a1cccb59d97f04c318ad41c1d404e666c158ca2810894bc5f5f.zip"
+     "939a4ab8b51f1a1cccb59d97f04c318ad41c1d404e666c158ca2810894bc5f5f.zip",
+     "4050143e044258715dc77e0d45e38dfaaba94cba5339fe6f76f1c067fa45020d.zip"
     ],
     "SourceMarkers": [
      {},
@@ -76,6 +80,24 @@
         "WebsiteURL"
        ]
       }
+     },
+     {
+      "<<marker:0xbaba:0>>": {
+       "Fn::Select": [
+        2,
+        {
+         "Fn::Split": [
+          "/",
+          {
+           "Fn::GetAtt": [
+            "Bucket83908E77",
+            "WebsiteURL"
+           ]
+          }
+         ]
+        }
+       ]
+      }
      }
     ],
     "DestinationBucketName": {
@@ -222,12 +244,6 @@
      },
      "S3Key": "9eb41a5505d37607ac419321497a4f8c21cf0ee1f9b4a6b29aa04301aea5c7fd.zip"
     },
-    "Role": {
-     "Fn::GetAtt": [
-      "CustomCDKBucketDeployment8693BB64968944B69AAFB0CC9EB8756CServiceRole89A01265",
-      "Arn"
-     ]
-    },
     "Environment": {
      "Variables": {
       "AWS_CA_BUNDLE": "/etc/pki/ca-trust/extracted/pem/tls-ca-bundle.pem"
@@ -239,6 +255,12 @@
       "Ref": "DeployMeHereAwsCliLayerDDC2FE7D"
      }
     ],
+    "Role": {
+     "Fn::GetAtt": [
+      "CustomCDKBucketDeployment8693BB64968944B69AAFB0CC9EB8756CServiceRole89A01265",
+      "Arn"
+     ]
+    },
     "Runtime": "python3.9",
     "Timeout": 900
    },

packages/@aws-cdk-testing/framework-integ/test/aws-s3-deployment/test/integ.bucket-deployment-data.ts

@@ -11,6 +11,7 @@ const file1 = Source.data('file1.txt', 'boom');
 const file2 = Source.data('path/to/file2.txt', `bam! ${bucket.bucketName}`);
 const file3 = Source.jsonData('my-json/config.json', { website_url: bucket.bucketWebsiteUrl });
 const file4 = Source.yamlData('my-yaml/config.yaml', { website_url: bucket.bucketWebsiteUrl });
+const file5 = Source.jsonData('my-json/config2.json', { bucket_domain_name: bucket.bucketWebsiteDomainName });
 
 const deployment = new BucketDeployment(stack, 'DeployMeHere', {
   destinationBucket: bucket,
@@ -20,6 +21,7 @@ const deployment = new BucketDeployment(stack, 'DeployMeHere', {
 });
 deployment.addSource(file3);
 deployment.addSource(file4);
+deployment.addSource(file5);
 
 new CfnOutput(stack, 'BucketName', { value: bucket.bucketName });
 

packages/aws-cdk-lib/aws-s3-deployment/README.md

@@ -330,19 +330,23 @@ new s3deploy.BucketDeployment(this, 'DeployMeWithEfsStorage', {
 ## Data with deploy-time values
 
 The content passed to `Source.data()`, `Source.jsonData()`, or `Source.yamlData()` can include
-references that will get resolved only during deployment.
+references that will get resolved only during deployment. Only a subset of CloudFormation functions
+are supported however, namely: Ref, Fn::GetAtt, Fn::Join, and Fn::Select (Fn::Split may be nested under Fn::Select).
 
 For example:
 
 ```ts
 import * as sns from 'aws-cdk-lib/aws-sns';
+import * as elbv2 from 'aws-cdk-lib/aws-elasticloadbalancingv2';
 
 declare const destinationBucket: s3.Bucket;
 declare const topic: sns.Topic;
+declare const tg: elbv2.ApplicationTargetGroup;
 
 const appConfig = {
   topic_arn: topic.topicArn,
   base_url: 'https://my-endpoint',
+  lb_name: tg.firstLoadBalancerFullName,
 };
 
 new s3deploy.BucketDeployment(this, 'BucketDeployment', {

packages/aws-cdk-lib/aws-s3-deployment/lib/render-data.ts

@@ -52,16 +52,18 @@ export function renderData(scope: Construct, data: string): Content {
       throw new Error(`Unexpected "Fn::Join" part, expecting string or object but got ${typeof (part)}`);
     }
 
-  } else if (obj.Ref || obj['Fn::GetAtt']) {
+  } else if (obj.Ref || obj['Fn::GetAtt'] || obj['Fn::Select']) {
     addMarker(obj);
   } else {
     throw new Error('Unexpected: Expecting `resolve()` to return "Fn::Join", "Ref" or "Fn::GetAtt"');
   }
 
-  function addMarker(part: Ref | GetAtt) {
+  function addMarker(part: Ref | GetAtt | FnSelect) {
     const keys = Object.keys(part);
-    if (keys.length !== 1 || (keys[0] != 'Ref' && keys[0] != 'Fn::GetAtt')) {
-      throw new Error(`Invalid CloudFormation reference. "Ref" or "Fn::GetAtt". Got ${JSON.stringify(part)}`);
+    const acceptedCfnFns = ['Ref', 'Fn::GetAtt', 'Fn::Select'];
+    if (keys.length !== 1 || !acceptedCfnFns.includes(keys[0])) {
+      const stringifiedAcceptedCfnFns = acceptedCfnFns.map((fn) => `"${fn}"`).join(' or ');
+      throw new Error(`Invalid CloudFormation reference. Key must start with any of ${stringifiedAcceptedCfnFns}. Got ${JSON.stringify(part)}`);
     }
 
     const marker = `<<marker:0xbaba:${markerIndex++}>>`;
@@ -73,6 +75,8 @@ export function renderData(scope: Construct, data: string): Content {
 }
 
 type FnJoin = [string, FnJoinPart[]];
-type FnJoinPart = string | Ref | GetAtt;
+type FnJoinPart = string | Ref | GetAtt | FnSelect;
 type Ref = { Ref: string };
-type GetAtt = { 'Fn::GetAtt': [string, string] };
+type GetAtt = { 'Fn::GetAtt': [string, string] };
+type FnSplit = { 'Fn::Split': [string, string | Ref] };
+type FnSelect = { 'Fn::Select': [number, string[] | FnSplit] };