BucketDeployment

class aws_cdk.aws_s3_deployment.BucketDeployment(scope, id, *, destination_bucket, sources, cache_control=None, content_disposition=None, content_encoding=None, content_language=None, content_type=None, destination_key_prefix=None, distribution=None, distribution_paths=None, expires=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, website_redirect_location=None)

Bases: aws_cdk.core.Construct

Stability

experimental

Parameters
  • scope (Construct) –

  • id (str) –

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

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

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

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

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

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

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

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

  • distribution (Optional[IDistribution]) – (experimental) 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[List[str]]) – (experimental) The file paths to invalidate in the CloudFront distribution. Default: - All files under the destination bucket key prefix will be invalidated.

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

  • memory_limit (Union[int, float, None]) – (experimental) 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]) – (experimental) User-defined object metadata to be set on all objects in the deployment. Default: - No user metadata is set

  • prune (Optional[bool]) – (experimental) 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]) – (experimental) If this is set to “false”, the destination files will be deleted when the resource is deleted or the destination is updated. NOTICE: if this is set to “false” and destination bucket/prefix is updated, all files in the previous destination will first be deleted and then uploaded to the new destination location. This could have availablity implications on your users. Default: true - when resource is deleted/updated, files are retained

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

  • server_side_encryption (Optional[ServerSideEncryption]) – (experimental) 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]) – (experimental) 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]) – (experimental) 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]) – (experimental) 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.

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

Stability

experimental

Methods

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

node

The construct tree node associated with this construct.

Return type

ConstructNode

Static Methods

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool