GradientEdge CDK Utils
    Preparing search index...

    Interface BucketDeploymentProps

    interface BucketDeploymentProps {
        accessControl?: BucketAccessControl;
        cacheControl?: CacheControl[];
        contentDisposition?: string;
        contentEncoding?: string;
        contentLanguage?: string;
        contentType?: string;
        destinationBucket: IBucket;
        destinationKeyPrefix?: string;
        distribution?: IDistributionRef;
        distributionPaths?: string[];
        ephemeralStorageSize?: Size;
        exclude?: string[];
        expirationInDays?: number;
        expires?: Expiration;
        extract?: boolean;
        include?: string[];
        logGroup?: ILogGroupRef;
        logRetention?: RetentionDays;
        memoryLimit?: number;
        metadata?: { [key: string]: string };
        noncurrentVersionExpirationInDays?: number;
        outputObjectKeys?: boolean;
        prune?: boolean;
        retainOnDelete?: boolean;
        role?: IRole;
        securityGroups?: ISecurityGroup[];
        serverSideEncryption?: ServerSideEncryption;
        serverSideEncryptionAwsKmsKeyId?: string;
        serverSideEncryptionCustomerAlgorithm?: string;
        signContent?: boolean;
        sources: ISource[];
        storageClass?: StorageClass;
        useEfs?: boolean;
        vpc?: IVpc;
        vpcSubnets?: SubnetSelection;
        waitForDistributionInvalidation?: boolean;
        websiteRedirectLocation?: string;
    }

    Hierarchy

    • BucketDeploymentProps
      • BucketDeploymentProps
    Index

    Properties

    accessControl? cacheControl? contentDisposition? contentEncoding? contentLanguage? contentType? destinationBucket destinationKeyPrefix? distribution? distributionPaths? ephemeralStorageSize? exclude? expirationInDays? expires? extract? include? logGroup? logRetention? memoryLimit? metadata? noncurrentVersionExpirationInDays? outputObjectKeys? prune? retainOnDelete? role? securityGroups? serverSideEncryption? serverSideEncryptionAwsKmsKeyId? serverSideEncryptionCustomerAlgorithm? signContent? sources storageClass? useEfs? vpc? vpcSubnets? waitForDistributionInvalidation? websiteRedirectLocation?

    Properties

    accessControl?: BucketAccessControl

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

    - Not set.

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

    cacheControl?: CacheControl[]

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

    - Not set.

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

    contentDisposition?: string

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

    - Not set.

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

    contentEncoding?: string

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

    - Not set.

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

    contentLanguage?: string

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

    - Not set.

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

    contentType?: string

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

    - Not set.

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

    destinationBucket: IBucket

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

    destinationKeyPrefix?: string

    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.

    "/" (unzip to root of the destination bucket)
    distribution?: IDistributionRef

    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.

    - No invalidation occurs
    distributionPaths?: string[]

    The file paths to invalidate in the CloudFront distribution.

    - All files under the destination bucket key prefix will be invalidated.
    ephemeralStorageSize?: Size

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

    512 MiB
    exclude?: string[]

    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.

    - No exclude filters are used

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

    expirationInDays?: number
    expires?: Expiration

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

    - The objects in the distribution will not expire.

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

    extract?: boolean

    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.

    true
    include?: string[]

    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.

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

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

    logGroup?: ILogGroupRef

    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.

    - a default log group created by AWS Lambda
    logRetention?: RetentionDays

    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.

    logs.RetentionDays.INFINITE
    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.

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

    128
    metadata?: { [key: string]: string }

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

    - No user metadata is set

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

    noncurrentVersionExpirationInDays?: number
    outputObjectKeys?: boolean

    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

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

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

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

    true
    retainOnDelete?: boolean

    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.

    https://github.com/aws/aws-cdk/tree/main/packages/aws-cdk-lib/aws-s3-deployment#retain-on-delete

    true - when resource is deleted/updated, files are retained
    role?: IRole

    Execution role associated with this function

    - A role is automatically created
    securityGroups?: ISecurityGroup[]

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

    Only used if 'vpc' is supplied.

    undefined - If the function is placed within a VPC and a security group is
    not specified a dedicated security group will be created for this function.
    serverSideEncryption?: ServerSideEncryption

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

    - Server side encryption is not used.

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

    serverSideEncryptionAwsKmsKeyId?: string

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

    - Not set.

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

    serverSideEncryptionCustomerAlgorithm?: string

    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

    - Not set.

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

    signContent?: boolean

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

    • x-amz-content-sha256 will not be computed
    sources: ISource[]

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

    storageClass?: StorageClass

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

    - Default storage-class for the bucket is used.

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

    useEfs?: boolean

    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.

    - No EFS. Lambda has access only to 512MB of disk space.
    vpc?: IVpc

    The VPC network to place the deployment lambda handler in. This is required if useEfs is set.

    None
    vpcSubnets?: SubnetSelection

    Where in the VPC to place the deployment lambda handler. Only used if 'vpc' is supplied.

    - the Vpc default strategy if not specified
    waitForDistributionInvalidation?: boolean

    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.

    https://github.com/aws/aws-cdk/issues/15891

    true
    websiteRedirectLocation?: string

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

    - No website redirection.

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

    Settings

    Member Visibility

    On This Page

    Properties