Skip to main content

core module

---

Stability: Experimental

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.


Reference Documentation: https://docs.aws.amazon.com/solutions/latest/constructs/

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

NOTE: Functions in the core library are not part of the published interface for Solutions Constructs. While they are not hidden, using them directly can result in breaking changes outside the scope of a Major release. As many users have expressed an interest in accessing this functionality, we are in the process of exposing this functionality through factories that will produce individual well architected resources. Find the current state of this effort under aws-constructs-factories.

Default Properties for AWS CDK Constructs

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

For example, the following is the snippet of default properties for S3 Bucket construct created by AWS Solutions Constructs. 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 overridden 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 = {
    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
    },
  });

Property override warnings

When a default property from the Core library is overridden by a user-provided property, Constructs will emit one or more warning messages to the console highlighting the change(s). These messages are intended to provide situational awareness to the user and prevent unintentional overrides that could create security risks. These messages will appear whenever deployment/build-related commands are executed, including cdk deploy, cdk synth, npm test, etc.

Example message: AWS_CONSTRUCTS_WARNING: An override has been provided for the property: BillingMode. Default value: 'PAY_PER_REQUEST'. You provided: 'PROVISIONED'.

Toggling override warnings

Override warning messages are enabled by default, but can be explicitly turned on/off using the overrideWarningsEnabled shell variable.

  • To explicitly turn off override warnings, run export overrideWarningsEnabled=false.
  • To explicitly turn on override warnings, run export overrideWarningsEnabled=true.
  • To revert to the default, run unset overrideWarningsEnabled.

Metadata

Release files for aws-solutions-constructs.core 2.106.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for aws-solutions-constructs.core 2.106.0
File Size Uploaded Provenance Actions
aws_solutions_constructs_core-2.106.0.tar.gz 970.2 kB Without provenance Details for aws_solutions_constructs_core-2.106.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for aws-solutions-constructs.core 2.106.0
File Interpreter ABI Platform Actions
aws_solutions_constructs_core-2.106.0-py3-none-any.whl Python 3 none any Details for aws_solutions_constructs_core-2.106.0-py3-none-any.whl

Total release size: 1.9 MB

Release files / aws_solutions_constructs_core-2.106.0.tar.gz

Download URL aws_solutions_constructs_core-2.106.0.tar.gz
Size 970.2 kB
Tags Source
SHA-256 checksum
How to use checksums
61568865a36237e25a40edb0f915131221203776cea7486e03602f910ad2d513
BLAKE2b-256 checksum
How to use checksums
c10e7f4824d797c339829eb6c3842af77e87d1b4745847b396880607d17221f8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.18

Release files / aws_solutions_constructs_core-2.106.0-py3-none-any.whl

Download URL aws_solutions_constructs_core-2.106.0-py3-none-any.whl
Size 968.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
97b17c9c1392f5b251c5241e343d2b320d9b70688e9905e85b9e1bbae0fa6a9d
BLAKE2b-256 checksum
How to use checksums
86978731a9894f1c3dbccbe97918684cc6a72a74730a5a5687273daaf8f5b3ce
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.18

Security for aws-solutions-constructs.core 2.106.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

2.106.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page