Metadata-Version: 2.1
Name: aws-solutions-konstruk.core
Version: 0.8.0
Summary: Core CDK Construct for patterns library
Home-page: https://github.com/awslabs/aws-solutions-konstruk.git
Author: Amazon Web Services
License: Apache-2.0
Project-URL: Source, https://github.com/awslabs/aws-solutions-konstruk.git
Description: # core module
        
        <!--BEGIN STABILITY BANNER-->---
        
        
        ![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge)
        
        > **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](https://semver.org/) 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.
        
        ---
        <!--END STABILITY BANNER-->
        
        | **API Reference**:| <span style="font-weight: normal">http://docs.awssolutionsbuilder.com/aws-solutions-konstruk/latest/api/core/</span>|
        |:-------------|:-------------|
        
        <div style="height:8px"></div>
        
        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
            },
          });
        ```
        
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: JavaScript
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Typing :: Typed
Classifier: License :: OSI Approved
Requires-Python: >=3.6
Description-Content-Type: text/markdown
