feat(s3-deployment): allow ability to specify versionId for S3 bucket source #32484

nritholtz · 2024-12-11T17:53:14Z

Issue # (if applicable)

Reason for this change

Allow user to specify optional versionId of the zipped file for the s3 bucket source type.

Description of changes

Added optional versionId to S3 Bucket source properties and new BucketSourceOptions interface.
Changed the underlying CLI commands to use s3api get-object instead of aws cp to allow support of specifying versionId when supplied.

Description of how you validated changes

Added and updated appropriate unit/integration tests. Also needed to update solutionStackName: '64bit Amazon Linux 2023 v6.2.2 running Node.js 20', since no longer available.

Checklist

My code adheres to the CONTRIBUTING GUIDE and DESIGN GUIDELINES

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

…cket source

aws-cdk-automation

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

aws-cdk-automation · 2024-12-12T19:40:10Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
Commit ID: 4c0e0fb
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

aws-cdk-automation · 2025-02-02T00:12:57Z

This PR has been in the MERGE CONFLICTS state for 3 weeks, and looks abandoned. To keep this PR from being closed, please continue work on it. If not, it will automatically be closed in a week.

lpizzinidev

Sorry for the super-late review. Left comments for some minor adjustments👍

lpizzinidev · 2025-02-03T14:28:36Z

packages/aws-cdk-lib/aws-s3-deployment/lib/source.ts

@@ -96,15 +113,19 @@ export class Source {
   * @param bucket The S3 Bucket
   * @param zipObjectKey The S3 object key of the zip file with contents
   */
-  public static bucket(bucket: s3.IBucket, zipObjectKey: string): ISource {
+  public static bucket(bucket: s3.IBucket, zipObjectKey: string, options?: BucketSourceOptions): ISource {


Can you please update the documentation above and the related @example and @param?

lpizzinidev · 2025-02-03T14:40:33Z

packages/aws-cdk-lib/aws-s3-deployment/lib/bucket-deployment.ts

+        SourceVersionIds: cdk.Lazy.uncachedAny({
+          produce: () => {
+            const versionIds = this.sources.map(source => source.versionId ?? '');
+            // in the case where no version IDs supplied, then omit the property
+            return versionIds.some(versionId => versionId.length > 0) ? versionIds : [];
+          },
+        }, { omitEmptyArray: true } ),


Suggested change

SourceVersionIds: cdk.Lazy.uncachedAny({

produce: () => {

const versionIds = this.sources.map(source => source.versionId ?? '');

// in the case where no version IDs supplied, then omit the property

return versionIds.some(versionId => versionId.length > 0) ? versionIds : [];

},

}, { omitEmptyArray: true } ),

SourceVersionIds: cdk.Lazy.uncachedList({

produce: () => {

const versionIds = this.sources.map(source => source.versionId ?? '');

// in the case where no version IDs are supplied, then omit the property

return versionIds.some(versionId => versionId.length > 0) ? versionIds : [];

},

}, { omitEmpty: true } ),

Nit, uncachedList seems more appropriate.

lpizzinidev · 2025-02-03T14:41:30Z

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

+
+const myBucketDeployment = new s3deploy.BucketDeployment(this, 'DeployMeWithVersioningSupport', {
+  sources: [s3deploy.Source.bucket(sourceBucket, 'object-key', {
+    versionId: '3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo',


Suggested change

versionId: '3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo',

versionId: 'version-id',

Let's use a placeholder value.

lpizzinidev · 2025-02-03T15:12:06Z

...s/@aws-cdk/custom-resource-handlers/lib/aws-s3-deployment/bucket-deployment-handler/index.py

+        s3_source_zips = [
+            {
+                "BucketName": bucket,
+                "ObjectKey": object_key,
+                "VersionID": source_version_ids[i] if i < len(source_version_ids) else ""
+            }
+            for i, (bucket, object_key) in enumerate(zip(source_bucket_names, source_object_keys))
+        ]


Suggested change

s3_source_zips = [

{

"BucketName": bucket,

"ObjectKey": object_key,

"VersionID": source_version_ids[i] if i < len(source_version_ids) else ""

}

for i, (bucket, object_key) in enumerate(zip(source_bucket_names, source_object_keys))

]

if not source_version_ids:

source_version_ids = [""] * len(source_bucket_names)

s3_source_zips = zip(source_bucket_names, source_object_keys, source_version_ids)

...

for i in range(len(s3_source_zips)):

s3_source_bucket, s3_source_key, s3_source_version_id = s3_source_zips[i]

Bit cleaner.

aws-cdk-automation · 2025-02-10T00:12:12Z

This PR has been deemed to be abandoned, and will be automatically closed. Please create a new PR for these changes if you think this decision has been made in error.

github-actions · 2025-02-10T00:12:25Z

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.

aaythapa · 2025-02-19T00:50:52Z

Hi @nritholtz thank you for opening this PR! Sorry about the late response. Looks like it got close because it was deemed that it was abandoned because there was some merge conflicts. Not that if the BUILD is failing or if there are merge conflicts then the PR won't show up on our board to review. I've re-opened the PR and if you're still working on it and can fix the conflicts then we'd be happy to take a look after. Thanks again for your contribution.

feat(aws-s3-deployment): allow ability to specify versionId for S3 bu…

72523fe

…cket source

github-actions bot added effort/small feature-request p2 labels Dec 11, 2024

aws-cdk-automation requested a review from a team December 11, 2024 17:53

github-actions bot added the beginning-contributor label Dec 11, 2024

aws-cdk-automation previously requested changes Dec 11, 2024

View reviewed changes

nritholtz changed the title ~~feat(aws-s3-deployment): allow ability to specify versionId for S3 bucket source~~ feat(s3-deployment): allow ability to specify versionId for S3 bucket source Dec 11, 2024

nritholtz added 2 commits December 11, 2024 23:16

updates - still needs integration tests to refresh

b523065

reran snapshots

7e93569

nritholtz marked this pull request as ready for review December 12, 2024 02:28

aws-cdk-automation added the pr-linter/exemption-requested label Dec 12, 2024

nritholtz marked this pull request as draft December 12, 2024 16:21

rerun snapshots

1905ed8

aws-cdk-automation removed the pr-linter/exemption-requested label Dec 12, 2024

fix README

4c0e0fb

nritholtz marked this pull request as ready for review December 12, 2024 19:40

aws-cdk-automation added the pr/needs-community-review label Dec 12, 2024

khushail mentioned this pull request Dec 16, 2024

(aws-s3-deployment): Allow ability to specify versionId for S3 bucket source #32462

Open

2 tasks

github-actions bot mentioned this pull request Jan 1, 2025

Monthly PR metrics report #32703

Closed

lpizzinidev suggested changes Feb 3, 2025

View reviewed changes

aws-cdk-automation added the closed-for-staleness label Feb 10, 2025

aws-cdk-automation closed this Feb 10, 2025

github-actions bot locked as resolved and limited conversation to collaborators Feb 10, 2025

aws-cdk-automation removed the pr/needs-community-review label Feb 10, 2025

aaythapa reopened this Feb 19, 2025

aaythapa added the pr-linter/do-not-close label Feb 19, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(s3-deployment): allow ability to specify versionId for S3 bucket source #32484

feat(s3-deployment): allow ability to specify versionId for S3 bucket source #32484

nritholtz commented Dec 11, 2024 •

edited

Loading

aws-cdk-automation left a comment

aws-cdk-automation commented Dec 12, 2024

aws-cdk-automation commented Feb 2, 2025

lpizzinidev left a comment

lpizzinidev Feb 3, 2025

lpizzinidev Feb 3, 2025

lpizzinidev Feb 3, 2025

lpizzinidev Feb 3, 2025

aws-cdk-automation commented Feb 10, 2025

github-actions bot commented Feb 10, 2025

aaythapa commented Feb 19, 2025

	versionId: '3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo',
	versionId: 'version-id',

feat(s3-deployment): allow ability to specify versionId for S3 bucket source #32484

Are you sure you want to change the base?

feat(s3-deployment): allow ability to specify versionId for S3 bucket source #32484

Conversation

nritholtz commented Dec 11, 2024 • edited Loading

Issue # (if applicable)

Reason for this change

Description of changes

Description of how you validated changes

Checklist

aws-cdk-automation left a comment

Choose a reason for hiding this comment

aws-cdk-automation commented Dec 12, 2024

AWS CodeBuild CI Report

aws-cdk-automation commented Feb 2, 2025

lpizzinidev left a comment

Choose a reason for hiding this comment

lpizzinidev Feb 3, 2025

Choose a reason for hiding this comment

lpizzinidev Feb 3, 2025

Choose a reason for hiding this comment

lpizzinidev Feb 3, 2025

Choose a reason for hiding this comment

lpizzinidev Feb 3, 2025

Choose a reason for hiding this comment

aws-cdk-automation commented Feb 10, 2025

github-actions bot commented Feb 10, 2025

aaythapa commented Feb 19, 2025

nritholtz commented Dec 11, 2024 •

edited

Loading