interface BucketDeploymentProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.S3.Deployment.BucketDeploymentProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awss3deployment#BucketDeploymentProps |
![]() | software.amazon.awscdk.services.s3.deployment.BucketDeploymentProps |
![]() | aws_cdk.aws_s3_deployment.BucketDeploymentProps |
![]() | aws-cdk-lib » aws_s3_deployment » BucketDeploymentProps |
Properties for BucketDeployment
.
Example
declare const destinationBucket: s3.Bucket;
const deployment = new s3deploy.BucketDeployment(this, 'DeployFiles', {
sources: [s3deploy.Source.asset(path.join(__dirname, 'source-files'))],
destinationBucket,
});
deployment.handlerRole.addToPolicy(
new iam.PolicyStatement({
actions: ['kms:Decrypt', 'kms:DescribeKey'],
effect: iam.Effect.ALLOW,
resources: ['<encryption key ARN>'],
}),
);
Properties
Name | Type | Description |
---|---|---|
destination | 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. |
access | Bucket | System-defined x-amz-acl metadata to be set on all objects in the deployment. |
cache | Cache [] | System-defined cache-control metadata to be set on all objects in the deployment. |
content | string | System-defined cache-disposition metadata to be set on all objects in the deployment. |
content | string | System-defined content-encoding metadata to be set on all objects in the deployment. |
content | string | System-defined content-language metadata to be set on all objects in the deployment. |
content | string | System-defined content-type metadata to be set on all objects in the deployment. |
destination | string | Key prefix in the destination bucket. Must be <=104 characters. |
distribution? | IDistribution | The CloudFront distribution using the destination bucket as an origin. |
distribution | string[] | The file paths to invalidate in the CloudFront distribution. |
ephemeral | 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. |
extract? | boolean | If this is set, the zip file will be synced to the destination S3 bucket and extracted. |
include? | string[] | If this is set, matching files or objects will be included with the deployment's sync command. |
log | ILog | The Log Group used for logging of events emitted by the custom resource's lambda function. |
log | Retention | The number of days that the lambda function's log events are kept in CloudWatch Logs. |
memory | 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? | { [string]: string } | User-defined object metadata to be set on all objects in the deployment. |
output | boolean | If set to false, the custom resource will not send back the SourceObjectKeys. |
prune? | boolean | 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. |
retain | 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. |
server | Server | System-defined x-amz-server-side-encryption metadata to be set on all objects in the deployment. |
server | string | System-defined x-amz-server-side-encryption-aws-kms-key-id metadata to be set on all objects in the deployment. |
server | string | System-defined x-amz-server-side-encryption-customer-algorithm metadata to be set on all objects in the deployment. |
sign | boolean | If set to true, uploads will precompute the value of x-amz-content-sha256 and include it in the signed S3 request headers. |
storage | Storage | System-defined x-amz-storage-class metadata to be set on all objects in the deployment. |
use | boolean | Mount an EFS file system. |
vpc? | IVpc | The VPC network to place the deployment lambda handler in. |
vpc | Subnet | Where in the VPC to place the deployment lambda handler. |
website | 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:
Bucket
(optional, default: Not set.)
System-defined x-amz-acl metadata to be set on all objects in the deployment.
cacheControl?
Type:
Cache
[]
(optional, default: Not set.)
System-defined cache-control metadata to be set on all objects in the deployment.
See also: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#SysMetadata
contentDisposition?
Type:
string
(optional, default: Not set.)
System-defined cache-disposition metadata to be set on all objects in the deployment.
See also: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#SysMetadata
contentEncoding?
Type:
string
(optional, default: Not set.)
System-defined content-encoding metadata to be set on all objects in the deployment.
See also: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#SysMetadata
contentLanguage?
Type:
string
(optional, default: Not set.)
System-defined content-language metadata to be set on all objects in the deployment.
See also: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#SysMetadata
contentType?
Type:
string
(optional, default: Not set.)
System-defined content-type metadata to be set on all objects in the deployment.
See also: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#SysMetadata
destinationKeyPrefix?
Type:
string
(optional, default: "/" (unzip to root of the destination bucket))
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.
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.
See also: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#SysMetadata
extract?
Type:
boolean
(optional, default: true)
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.
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.
logGroup?
Type:
ILog
(optional, default: a default log group created by AWS Lambda)
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.
logRetention?
Type:
Retention
(optional, default: logs.RetentionDays.INFINITE)
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.
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:
{ [string]: string }
(optional, default: No user metadata is set)
User-defined object metadata to be set on all objects in the deployment.
See also: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#UserMetadata
outputObjectKeys?
Type:
boolean
(optional, default: true)
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
prune?
Type:
boolean
(optional, default: true)
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).
See also: https://docs.aws.amazon.com/cli/latest/reference/s3/sync.html
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.
See also: https://github.com/aws/aws-cdk/tree/main/packages/aws-cdk-lib/aws-s3-deployment#retain-on-delete
role?
Type:
IRole
(optional, default: A role is automatically created)
Execution role associated with this function.
serverSideEncryption?
Type:
Server
(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.
See also: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#SysMetadata
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.
See also: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#SysMetadata
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
signContent?
Type:
boolean
(optional, default: x-amz-content-sha256
will not be computed)
If set to true, uploads will precompute the value of x-amz-content-sha256
and include it in the signed S3 request headers.
storageClass?
Type:
Storage
(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.
See also: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#SysMetadata
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:
Subnet
(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.
See also: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#SysMetadata