`BucketDeployment` populates an S3 bucket with the contents of .zip files from other S3 buckets or from local disk.

Add an additional source to the bucket deployment.

addSource

BucketDeployment

The S3 bucket to sync the contents of the zip file to.

destinationBucket

The sources from which to deploy the contents of this bucket.

sources

System-defined x-amz-acl metadata to be set on all objects in the deployment.

accessControl

System-defined cache-control metadata to be set on all objects in the deployment.

cacheControl

System-defined cache-disposition metadata to be set on all objects in the deployment.

contentDisposition

System-defined content-encoding metadata to be set on all objects in the deployment.

contentEncoding

System-defined content-language metadata to be set on all objects in the deployment.

contentLanguage

System-defined content-type metadata to be set on all objects in the deployment.

contentType

Key prefix in the destination bucket. Must be <=104 characters.

If it's set with prune: true, it will only prune files with the prefix.

We recommend to always configure the `destinationKeyPrefix` property. This will prevent the deployment
from accidentally deleting data that wasn't uploaded by it.

destinationKeyPrefix

The CloudFront distribution using the destination bucket as an origin.

Files in the distribution's edge caches will be invalidated after
files are uploaded to the destination bucket.

distribution

The file paths to invalidate in the CloudFront distribution.

distributionPaths

The size of the AWS Lambda function’s /tmp directory in MiB.

ephemeralStorageSize

If this is set, matching files or objects will be excluded from the deployment's sync command.

This can be used to exclude a file from being pruned in the destination bucket.

If you want to just exclude files from the deployment package (which excludes these files
evaluated when invalidating the asset), you should leverage the `exclude` property of
`AssetOptions` when defining your source.

exclude

System-defined expires metadata to be set on all objects in the deployment.

expires

If this is set, the zip file will be synced to the destination S3 bucket and extracted.

If false, the file will remain zipped in the destination bucket.

extract

If this is set, matching files or objects will be included with the deployment's sync command.

Since all files from the deployment package are included by default, this property
is usually leveraged alongside an `exclude` filter.

include

The Log Group used for logging of events emitted by the custom resource's lambda function.

Providing a user-controlled log group was rolled out to commercial regions on 2023-11-16.
If you are deploying to another type of region, please check regional availability first.

logGroup

The number of days that the lambda function's log events are kept in CloudWatch Logs.

This is a legacy API and we strongly recommend you migrate to `logGroup` if you can.
`logGroup` allows you to create a fully customizable log group and instruct the Lambda function to send logs to it.

logRetention

The amount of memory (in MiB) to allocate to the AWS Lambda function which replicates the files from the CDK bucket to the destination bucket.

If you are deploying large files, you will need to increase this number
accordingly.

memoryLimit

User-defined object metadata to be set on all objects in the deployment.

metadata

If set to false, the custom resource will not send back the SourceObjectKeys.

This is useful when you are facing the error `Response object is too long`

See https://github.com/aws/aws-cdk/issues/28579

outputObjectKeys

By default, files in the destination bucket that don't exist in the source will be deleted when the BucketDeployment resource is created or updated.

If this is set to false, files in the destination bucket that
do not exist in the asset, will NOT be deleted during deployment (create/update).

prune

If this is set to "false", the destination files will be deleted when the resource is deleted or the destination is updated.

NOTICE: Configuring this to "false" might have operational implications. Please
visit to the package documentation referred below to make sure you fully understand those implications.

retainOnDelete

Execution role associated with this function.

role

The list of security groups to associate with the lambda handlers network interfaces.

Only used if 'vpc' is supplied.

securityGroups

System-defined x-amz-server-side-encryption metadata to be set on all objects in the deployment.

serverSideEncryption

System-defined x-amz-server-side-encryption-aws-kms-key-id metadata to be set on all objects in the deployment.

serverSideEncryptionAwsKmsKeyId

System-defined x-amz-server-side-encryption-customer-algorithm metadata to be set on all objects in the deployment.

Warning: This is not a useful parameter until this bug is fixed: https://github.com/aws/aws-cdk/issues/6080

serverSideEncryptionCustomerAlgorithm

If set to true, uploads will precompute the value of `x-amz-content-sha256` and include it in the signed S3 request headers.

signContent

System-defined x-amz-storage-class metadata to be set on all objects in the deployment.

storageClass

Mount an EFS file system.

Enable this if your assets are large and you encounter disk space errors.
Enabling this option will require a VPC to be specified.

useEfs

The VPC network to place the deployment lambda handler in.

This is required if `useEfs` is set.

Where in the VPC to place the deployment lambda handler.

Only used if 'vpc' is supplied.

vpcSubnets

In case of using a cloudfront distribution, if this property is set to false then the custom resource will not wait and verify for Cloudfront invalidation to complete.

This may speed up deployment and avoid
intermittent Cloudfront issues. However, this is risky and not recommended as cache invalidation
can silently fail.

waitForDistributionInvalidation

System-defined x-amz-website-redirect-location metadata to be set on all objects in the deployment.

websiteRedirectLocation

`DeployTimeSubstitutedFile` is an extension of `BucketDeployment` that allows users to upload individual files and specify to make substitutions in the file.

DeployTimeSubstitutedFile

source

User-defined substitutions to make in the file.

Placeholders in the user's local file must be specified with double curly
brackets and spaces. For example, if you use the key 'xxxx' in the file,
it must be written as: {{ xxxx }} to be recognized by the construct as a
substitution.

substitutions

The object key in the destination bucket where the processed file would be written to.

AWS s3 Deployment

L2 Constructs2

BucketDeployment

DeployTimeSubstitutedFile

Learn AWS the Practical Way

Quick Facts

Related Links