@scloud/cdk-patterns/dist/PrivateBucket.d.ts

Serverless CDK patterns for common infrastructure needs

import { Bucket, BucketProps } from 'aws-cdk-lib/aws-s3';
import { Construct } from 'constructs';
/**
 * A private bucket.
 *
 * This bucket will not beaccessible from the internet.
 *
 * NB removalPolicy is set to DESTROY by default, but autoDeleteObjects is set to false.
 * This means that, only if the bucket is empty, it'll be destroyed when removed from the stack.
 * The rationale is that content you don't want to lose will block bucket deletion and, if
 * content is expendable, you can set autoDeleteObjects to true.
 *
 * @param construct The parent CDK construct.
 * @param name The bucket name - used as the ID for CDK.
 * The actual bucket name will be randomised by default.
 * @param props Any additional properties for the bucket.
 * These can override the defaults provided by this function.
 */
export declare class PrivateBucket extends Bucket {
    constructor(scope: Construct, id: string, props?: Partial<BucketProps>);
    /**
     * Creates a private bucket that will be destroyed, along with all content, when removed from the stack.
     *
     * This is useful for content that can be regenerated from source code, e.g. static website files.
     */
    static expendable(scope: Construct, id: string, props?: Partial<BucketProps>): PrivateBucket;
    /**
     * Creates a private bucket that will be retained, along with all content, when removed from the stack.
     *
     * This is useful for content that cannot be regenerated, e.g. user data.
     */
    static retained(scope: Construct, id: string, props?: Partial<BucketProps>): PrivateBucket;
}