(aws-s3-deployment): Support include and exclude options for S3 sync

[davidtucker]

The aws-s3-deployment module currently does not support the include and exclude options that are available in the S3 sync command. By adding this, additional use cases can be supported.

Use Case

In my case, I have a single-page web app that uses a config file that is generated by a CloudFormation custom resource. I would like to leverage aws-s3-deployment for the deployment of the web application, but I want to ensure that the config file is not deleted when prune is set to true (although I do want all of the other files to be deleted).

Proposed Solution

By supporting the include and exclude properties for the S3 sync command with the aws-s3-deployment Lambda function, you can support this use case.

• 👋 I may be able to implement this feature request
• ⚠️ This feature might incur a breaking change

---

This is a 🚀 Feature Request

[iliapolo]

I'm not sure I follow. Are you looking for the exclude flag to only be considered on delete?

Can you share a code snippet of how your use-case would be supported?

[github-actions]

This issue has not received a response in a while. If you want to keep this issue open, please leave a comment below and auto-close will be canceled.

[davidtucker]

I'll get a sample up for this early next week.

[davidtucker]

In this case, it is common to generate config from the CDK that needs to be read at runtime by a web application (items that aren't yet known at synth time). With this being the case, I generally (and I have seen others do this as well) generate a file that is read at runtime (for the purposes of this example, I will call this config.js). This leads to the situation where you would want to leverage prune for the webapp, but yet also not remove the configuration file.

This can be accomplished with the AWS CLI by using either the exclude or include options for the s3 sync command. Thus, you could accomplish this with the following commands:

# build webapp
npm run build
# deploy webapp
aws s3 sync . s3://cdk-s3sync-test/
# generate config file (by whatever process)
# upload config file
aws s3 cp config.js s3://cdk-s3sync-test/
# redeploy webapp on change (doesn't delete config.js)
aws s3 sync . s3://cdk-s3sync-test/ --delete --exclude config.js

In terms of the CDK, I would like to see this work in the following manner:

new s3Deploy.BucketDeployment(this, 'WebAppDeploy', {
	// bundling options....
	prune: true,
	exclude: 'config.js'
});

Include could also be used for a similar effect. Since both options are supported in the AWS CLI, these could be added into the current process with minimal rework.

[iliapolo]

@davidtucker Thanks for the explanation, I understand what you mean now.

I am unassigning and marking this issue as p2, which means that we are unable to work on this immediately.

We use +1s to help prioritize our work, and are happy to revaluate this issue based on community feedback. You can reach out to the cdk.dev community on Slack to solicit support for reprioritization.

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.