@gammarers/aws-secure-bucket
Version:
This is a Simple S3 Secure Bucket.
67 lines (66 loc) • 3.04 kB
TypeScript
import * as s3 from 'aws-cdk-lib/aws-s3';
import { Construct } from 'constructs';
/**
* @TODO: Not yet supported
* https://github.com/aws/jsii/issues/4468
* type omitKeys = 'publicReadAccess|enforceSSL|blockPublicAccess';
* export interface CodePipelineStateChangeDetectionEventRuleProps extends Omit<s3.BucketProps, 'publicReadAccess'> {}
*/
export declare enum SecureBucketType {
/**
* @deprecated This property is deprecated. Use the bucketType property instead.
*/
SINGLE_PIPELINE_ARTIFACT = "single-pipeline-artifact",
/**
* If you are setting a custom Qualifier and using it as the artifact bucket for the CDK pipeline, is it selected as the single region deployment pipeline artifact bucket.
*/
SINGLE_REGION_DEPLOYMENT_PIPELINE_ARTIFACT_BUCKET = "single-region-deployment-pipeline-artifact-bucket",
/**
* @deprecated This property is deprecated. Use the bucketType property instead.
*/
MULTI_PIPELINE_ARTIFACT = "multi-pipeline-artifact",
/**
* If you are setting a custom Qualifier and using it as the artifact bucket for the CDK pipeline, is it selected as the multi region deployment pipeline artifact bucket.
*/
MULTI_REGION_DEPLOYMENT_PIPELINE_ARTIFACT_BUCKET = "multi-region-deployment-pipeline-artifact-bucket",
/**
* If you are using it as the CloudFront origin bucket, is it selected as the cloudfront origin bucket.
* @deprecated This property is deprecated. Use the bucketType property instead.
*/
CLOUD_FRONT_ORIGIN = "cloudfront-origin",
/**
* If you are using it as the CloudFront origin bucket, is it selected as the cloudfront origin bucket.
*/
CLOUD_FRONT_ORIGIN_BUCKET = "cloudfront-origin-bucket",
/**
* If you are not setting a custom Qualifier and using it as the default bucket, is it selected as the default bucket.
* @deprecated This property is deprecated. Use the bucketType property instead.
*/
DEFAULT = "default",
/**
* If you are not setting a custom Qualifier and using it as the default bucket, is it selected as the default bucket.
*/
DEFAULT_BUCKET = "default-bucket"
}
export interface SecureBucketProps extends s3.BucketProps {
/**
* If you are setting a custom Qualifier and using it as the artifact bucket for the CDK pipeline, set it to true.
* @deprecated This property is deprecated. Use the bucketType property instead.
* @default false
*/
readonly isPipelineArtifactBucket?: boolean;
/**
* If your are using it as the CloudFront origin bucket, set it to true.
* @deprecated This property is deprecated. Use the bucketType property instead.
* @default false
*/
readonly isCloudFrontOriginBucket?: boolean;
/**
* The type of the bucket.
* @default SecureBucketType.DEFAULT
*/
readonly bucketType?: SecureBucketType;
}
export declare class SecureBucket extends s3.Bucket {
constructor(scope: Construct, id: string, props?: SecureBucketProps);
}