@scloud/cdk-patterns/dist/deprecated/bucket.d.ts

Serverless CDK patterns for common infrastructure needs

import { Stack } from 'aws-cdk-lib';
import { Key } from 'aws-cdk-lib/aws-kms';
import { Bucket, BucketProps } from 'aws-cdk-lib/aws-s3';
import { Construct } from 'constructs';
/**
 * @deprecated Use PrivateBucket instead
 *
 * A private bucket bucket.
 * @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.
 * @returns A new Bucket
 */
export declare function privateBucket(construct: Construct, name: string, props?: BucketProps): Bucket;
/**
 * @deprecated Use KmsBucket instead
 *
 * A bucket with a KMS key.
 * @param stack The parent CDK stack.
 * @param name The bucket name - used as the bucket and key IDs 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.
 * @returns An s3.Bucket
 */
export declare function kmsBucket(stack: Stack, name: string, props?: BucketProps): {
    bucket: Bucket;
    key?: Key;
};