Nabbing Pleasant Monads

    @aws-solutions-konstruk/core
    TypeScript icon, indicating that this package has built-in type declarations

    0.8.1 • Public • Published

    core module


    Stability: Experimental

    This is a developer preview (public beta) module.

    All classes are under active development and subject to non-backward compatible changes or removal in any future version. These are not subject to the Semantic Versioning model. This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.


    API Reference: http://docs.awssolutionsbuilder.com/aws-solutions-konstruk/latest/api/core/

    The core library includes the basic building blocks of the AWS Solutions Konstruk Library. It defines the core classes that are used in the rest of the AWS Solutions Konstruk Library.

    Default Properties for AWS CDK Constructs

    Core library sets the default properties for the AWS CDK Constructs used by the AWS Solutions Konstruk Library constructs.

    For example, the following is the snippet of default properties for S3 Bucket construct created by AWS Solutions Konstruk construct. By default, it will turn on the server-side encryption, bucket versioning, block all public access and setup the S3 access logging.

    {
      encryption: s3.BucketEncryption.S3_MANAGED,
      versioned: true,
      blockPublicAccess: s3.BlockPublicAccess.BLOCK_ALL,
      removalPolicy: RemovalPolicy.RETAIN,
      serverAccessLogsBucket: loggingBucket
    }
    

    Override the default properties

    The default properties set by the Core library can be overriden by user provided properties. For example, the user can override the Amazon S3 Block Public Access property to meet specific requirements.

      const stack = new cdk.Stack();
    
      const props: CloudFrontToS3Props = {
        deployBucket: true,
        bucketProps: {
          blockPublicAccess: {
            blockPublicAcls: false,
            blockPublicPolicy: true,
            ignorePublicAcls: false,
            restrictPublicBuckets: true
          }
        }
      };
    
      new CloudFrontToS3(stack, 'test-cloudfront-s3', props);
    
      expect(stack).toHaveResource("AWS::S3::Bucket", {
        PublicAccessBlockConfiguration: {
          BlockPublicAcls: false,
          BlockPublicPolicy: true,
          IgnorePublicAcls: false,
          RestrictPublicBuckets: true
        },
      });
    

    Keywords

    none

    Install

    npm i @aws-solutions-konstruk/core

    DownloadsWeekly Downloads

    557

    Version

    0.8.1

    License

    Apache-2.0

    Unpacked Size

    1.75 MB

    Total Files

    365

    Last publish

    Collaborators

    • aws-solutions-konstruk-support