class BucketDeployment (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.S3.Deployment.BucketDeployment`
Java	`software.amazon.awscdk.services.s3.deployment.BucketDeployment`
Python	`aws_cdk.aws_s3_deployment.BucketDeployment`
TypeScript (source)	`@aws-cdk/aws-s3-deployment` » `BucketDeployment`

Implements IConstruct, IConstruct, IDependable

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

Example

declare const websiteBucket: s3.Bucket;

const deployment = new s3deploy.BucketDeployment(this, 'DeployWebsite', {
  sources: [s3deploy.Source.asset(path.join(__dirname, 'my-website'))],
  destinationBucket: websiteBucket,
});

new ConstructThatReadsFromTheBucket(this, 'Consumer', {
  // Use 'deployment.deployedBucket' instead of 'websiteBucket' here
  bucket: deployment.deployedBucket,
});

Initializer

new BucketDeployment(scope: Construct, id: string, props: BucketDeploymentProps)

Parameters

scope Construct
id string
props BucketDeploymentProps

Construct Props

Name	Type	Description
destinationBucket	`IBucket`	The S3 bucket to sync the contents of the zip file to.
sources	`ISource[]`	The sources from which to deploy the contents of this bucket.
accessControl?	`BucketAccessControl`	System-defined x-amz-acl metadata to be set on all objects in the deployment.
cacheControl?	`CacheControl[]`	System-defined cache-control metadata to be set on all objects in the deployment.
contentDisposition?	`string`	System-defined cache-disposition metadata to be set on all objects in the deployment.
contentEncoding?	`string`	System-defined content-encoding metadata to be set on all objects in the deployment.
contentLanguage?	`string`	System-defined content-language metadata to be set on all objects in the deployment.
contentType?	`string`	System-defined content-type metadata to be set on all objects in the deployment.
destinationKeyPrefix?	`string`	Key prefix in the destination bucket.
distribution?	`IDistribution`	The CloudFront distribution using the destination bucket as an origin.
distributionPaths?	`string[]`	The file paths to invalidate in the CloudFront distribution.
ephemeralStorageSize?	`Size`	The size of the AWS Lambda function’s /tmp directory in MiB.
exclude?	`string[]`	If this is set, matching files or objects will be excluded from the deployment's sync command.
expires?	`Expiration`	System-defined expires metadata to be set on all objects in the deployment.
include?	`string[]`	If this is set, matching files or objects will be included with the deployment's sync command.
logRetention?	`RetentionDays`	The number of days that the lambda function's log events are kept in CloudWatch Logs.
memoryLimit?	`number`	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.
metadata?	`UserDefinedObjectMetadata`	User-defined object metadata to be set on all objects in the deployment.
prune?	`boolean`	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).
retainOnDelete?	`boolean`	If this is set to "false", the destination files will be deleted when the resource is deleted or the destination is updated.
role?	`IRole`	Execution role associated with this function.
serverSideEncryption?	`ServerSideEncryption`	System-defined x-amz-server-side-encryption metadata to be set on all objects in the deployment.
serverSideEncryptionAwsKmsKeyId?	`string`	System-defined x-amz-server-side-encryption-aws-kms-key-id metadata to be set on all objects in the deployment.
serverSideEncryptionCustomerAlgorithm?	`string`	System-defined x-amz-server-side-encryption-customer-algorithm metadata to be set on all objects in the deployment.
storageClass?	`StorageClass`	System-defined x-amz-storage-class metadata to be set on all objects in the deployment.
useEfs?	`boolean`	Mount an EFS file system.
vpc?	`IVpc`	The VPC network to place the deployment lambda handler in.
vpcSubnets?	`SubnetSelection`	Where in the VPC to place the deployment lambda handler.
websiteRedirectLocation?	`string`	System-defined x-amz-website-redirect-location metadata to be set on all objects in the deployment.

destinationBucket

Type: IBucket

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

sources

Type: ISource[]

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

accessControl?

Type: BucketAccessControl (optional, default: Not set.)

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

cacheControl?

Type: CacheControl[] (optional, default: Not set.)

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

contentDisposition?

Type: string (optional, default: Not set.)

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

contentEncoding?

Type: string (optional, default: Not set.)

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

contentLanguage?

Type: string (optional, default: Not set.)

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

contentType?

Type: string (optional, default: Not set.)

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

destinationKeyPrefix?

Type: string (optional, default: "/" (unzip to root of the destination bucket))

Key prefix in the destination bucket.

Must be <=104 characters

distribution?

Type: IDistribution (optional, default: No invalidation occurs)

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.

distributionPaths?

Type: string[] (optional, default: All files under the destination bucket key prefix will be invalidated.)

The file paths to invalidate in the CloudFront distribution.

ephemeralStorageSize?

Type: Size (optional, default: 512 MiB)

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

exclude?

Type: string[] (optional, default: No exclude filters are used)

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.

expires?

Type: Expiration (optional, default: The objects in the distribution will not expire.)

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

include?

Type: string[] (optional, default: No include filters are used and all files are included with the sync command)

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.

logRetention?

Type: RetentionDays (optional, default: logs.RetentionDays.INFINITE)

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

memoryLimit?

Type: number (optional, default: 128)

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.

metadata?

Type: UserDefinedObjectMetadata (optional, default: No user metadata is set)

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

prune?

Type: boolean (optional, default: true)

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).

retainOnDelete?

Type: boolean (optional, default: true - when resource is deleted/updated, files are retained)

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.

role?

Type: IRole (optional, default: A role is automatically created)

Execution role associated with this function.

serverSideEncryption?

Type: ServerSideEncryption (optional, default: Server side encryption is not used.)

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

serverSideEncryptionAwsKmsKeyId?

Type: string (optional, default: Not set.)

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

serverSideEncryptionCustomerAlgorithm?

Type: string (optional, default: Not set.)

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

storageClass?

Type: StorageClass (optional, default: Default storage-class for the bucket is used.)

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

useEfs?

Type: boolean (optional, default: No EFS. Lambda has access only to 512MB of disk space.)

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.

vpc?

Type: IVpc (optional, default: None)

The VPC network to place the deployment lambda handler in.

This is required if useEfs is set.

vpcSubnets?

Type: SubnetSelection (optional, default: the Vpc default strategy if not specified)

Where in the VPC to place the deployment lambda handler.

Only used if 'vpc' is supplied.

websiteRedirectLocation?

Type: string (optional, default: No website redirection.)

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

Properties

Name	Type	Description
deployedBucket	`IBucket`	The bucket after the deployment.
node	`ConstructNode`	The construct tree node associated with this construct.

deployedBucket

Type: IBucket

The bucket after the deployment.

If you want to reference the destination bucket in another construct and make sure the bucket deployment has happened before the next operation is started, pass the other construct a reference to deployment.deployedBucket.

Doing this replaces calling otherResource.node.addDependency(deployment).

node

Type: ConstructNode

The construct tree node associated with this construct.

Methods

Name	Description
toString()	Returns a string representation of this construct.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.