BucketDeploymentProps

class aws_cdk.aws_s3_deployment.BucketDeploymentProps(*, destination_bucket, sources, access_control=None, cache_control=None, content_disposition=None, content_encoding=None, content_language=None, content_type=None, destination_key_prefix=None, distribution=None, distribution_paths=None, exclude=None, expires=None, include=None, memory_limit=None, metadata=None, prune=None, retain_on_delete=None, role=None, server_side_encryption=None, server_side_encryption_aws_kms_key_id=None, server_side_encryption_customer_algorithm=None, storage_class=None, vpc=None, vpc_subnets=None, website_redirect_location=None)

Bases: object

Properties for BucketDeployment.

Parameters
  • destination_bucket (IBucket) – The S3 bucket to sync the contents of the zip file to.

  • sources (Sequence[ISource]) – The sources from which to deploy the contents of this bucket.

  • access_control (Optional[BucketAccessControl]) – System-defined x-amz-acl metadata to be set on all objects in the deployment. Default: - Not set.

  • cache_control (Optional[Sequence[CacheControl]]) – System-defined cache-control metadata to be set on all objects in the deployment. Default: - Not set.

  • content_disposition (Optional[str]) – System-defined cache-disposition metadata to be set on all objects in the deployment. Default: - Not set.

  • content_encoding (Optional[str]) – System-defined content-encoding metadata to be set on all objects in the deployment. Default: - Not set.

  • content_language (Optional[str]) – System-defined content-language metadata to be set on all objects in the deployment. Default: - Not set.

  • content_type (Optional[str]) – System-defined content-type metadata to be set on all objects in the deployment. Default: - Not set.

  • destination_key_prefix (Optional[str]) – Key prefix in the destination bucket. Default: “/” (unzip to root of the destination bucket)

  • distribution (Optional[IDistribution]) – 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. Default: - No invalidation occurs

  • distribution_paths (Optional[Sequence[str]]) – The file paths to invalidate in the CloudFront distribution. Default: - All files under the destination bucket key prefix will be invalidated.

  • exclude (Optional[Sequence[str]]) – 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. Default: - No exclude filters are used

  • expires (Optional[Expiration]) – System-defined expires metadata to be set on all objects in the deployment. Default: - The objects in the distribution will not expire.

  • include (Optional[Sequence[str]]) – 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. Default: - No include filters are used and all files are included with the sync command

  • memory_limit (Union[int, float, None]) – 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. Default: 128

  • metadata (Optional[UserDefinedObjectMetadata]) – User-defined object metadata to be set on all objects in the deployment. Default: - No user metadata is set

  • prune (Optional[bool]) – 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). Default: true

  • retain_on_delete (Optional[bool]) – 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. Default: true - when resource is deleted/updated, files are retained

  • role (Optional[IRole]) – Execution role associated with this function. Default: - A role is automatically created

  • server_side_encryption (Optional[ServerSideEncryption]) – System-defined x-amz-server-side-encryption metadata to be set on all objects in the deployment. Default: - Server side encryption is not used.

  • server_side_encryption_aws_kms_key_id (Optional[str]) – System-defined x-amz-server-side-encryption-aws-kms-key-id metadata to be set on all objects in the deployment. Default: - Not set.

  • server_side_encryption_customer_algorithm (Optional[str]) – 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 Default: - Not set.

  • storage_class (Optional[StorageClass]) – System-defined x-amz-storage-class metadata to be set on all objects in the deployment. Default: - Default storage-class for the bucket is used.

  • vpc (Optional[IVpc]) – The VPC network to place the deployment lambda handler in. Default: None

  • vpc_subnets (Optional[SubnetSelection]) – Where in the VPC to place the deployment lambda handler. Only used if ‘vpc’ is supplied. Default: - the Vpc default strategy if not specified

  • website_redirect_location (Optional[str]) – System-defined x-amz-website-redirect-location metadata to be set on all objects in the deployment. Default: - No website redirection.

Attributes

access_control

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

Default
  • Not set.

See

https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl

Return type

Optional[BucketAccessControl]

cache_control

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

Default
  • Not set.

See

https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#SysMetadata

Return type

Optional[List[CacheControl]]

content_disposition

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

Default
  • Not set.

See

https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#SysMetadata

Return type

Optional[str]

content_encoding

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

Default
  • Not set.

See

https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#SysMetadata

Return type

Optional[str]

content_language

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

Default
  • Not set.

See

https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#SysMetadata

Return type

Optional[str]

content_type

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

Default
  • Not set.

See

https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#SysMetadata

Return type

Optional[str]

destination_bucket

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

Return type

IBucket

destination_key_prefix

Key prefix in the destination bucket.

Default

“/” (unzip to root of the destination bucket)

Return type

Optional[str]

distribution

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.

Default
  • No invalidation occurs

Return type

Optional[IDistribution]

distribution_paths

The file paths to invalidate in the CloudFront distribution.

Default
  • All files under the destination bucket key prefix will be invalidated.

Return type

Optional[List[str]]

exclude

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.

Default
  • No exclude filters are used

See

https://docs.aws.amazon.com/cli/latest/reference/s3/index.html#use-of-exclude-and-include-filters

Return type

Optional[List[str]]

expires

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

Default
  • The objects in the distribution will not expire.

See

https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#SysMetadata

Return type

Optional[Expiration]

include

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.

Default
  • No include filters are used and all files are included with the sync command

See

https://docs.aws.amazon.com/cli/latest/reference/s3/index.html#use-of-exclude-and-include-filters

Return type

Optional[List[str]]

memory_limit

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.

Default

128

Return type

Union[int, float, None]

metadata

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

Default
  • No user metadata is set

See

https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#UserMetadata

Return type

Optional[UserDefinedObjectMetadata]

prune

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

Default

true

See

https://docs.aws.amazon.com/cli/latest/reference/s3/sync.html

Return type

Optional[bool]

retain_on_delete

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.

Default

true - when resource is deleted/updated, files are retained

See

https://github.com/aws/aws-cdk/tree/master/packages/%40aws-cdk/aws-s3-deployment#retain-on-delete

Return type

Optional[bool]

role

Execution role associated with this function.

Default
  • A role is automatically created

Return type

Optional[IRole]

server_side_encryption

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

Default
  • Server side encryption is not used.

See

https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#SysMetadata

Return type

Optional[ServerSideEncryption]

server_side_encryption_aws_kms_key_id

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

Default
  • Not set.

See

https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#SysMetadata

Return type

Optional[str]

server_side_encryption_customer_algorithm

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

Default
  • Not set.

See

https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html#sse-c-how-to-programmatically-intro

Return type

Optional[str]

sources

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

Return type

List[ISource]

storage_class

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

Default
  • Default storage-class for the bucket is used.

See

https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#SysMetadata

Return type

Optional[StorageClass]

vpc

The VPC network to place the deployment lambda handler in.

Default

None

Return type

Optional[IVpc]

vpc_subnets

Where in the VPC to place the deployment lambda handler.

Only used if ‘vpc’ is supplied.

Default
  • the Vpc default strategy if not specified

Return type

Optional[SubnetSelection]

website_redirect_location

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

Default
  • No website redirection.

See

https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#SysMetadata

Return type

Optional[str]