@aws-cdk/cdk - npm Package Compare versions

Comparing version 0.35.0 to 0.36.0

lib/index.js

 "use strict";
-function __export(m) {
-    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
-}
-Object.defineProperty(exports, "__esModule", { value: true });
-__export(require("./tag-aspect"));
-__export(require("./construct"));
-__export(require("./token"));
-__export(require("./resolvable"));
-__export(require("./lazy"));
-__export(require("./tag-manager"));
-__export(require("./dependency"));
-__export(require("./string-fragments"));
-__export(require("./reference"));
-__export(require("./cfn-condition"));
-__export(require("./fn"));
-__export(require("./include"));
-__export(require("./cfn-mapping"));
-__export(require("./cfn-output"));
-__export(require("./cfn-parameter"));
-__export(require("./pseudo"));
-__export(require("./cfn-resource"));
-__export(require("./resource-policy"));
-__export(require("./cfn-rule"));
-__export(require("./stack"));
-__export(require("./cfn-element"));
-__export(require("./cfn-dynamic-reference"));
-__export(require("./removal-policy"));
-__export(require("./arn"));
-__export(require("./stack-trace"));
-__export(require("./app"));
-__export(require("./context"));
-__export(require("./runtime"));
-__export(require("./secret-value"));
-__export(require("./resource"));
-__export(require("./physical-name"));
-__export(require("./resource-identifiers"));
-// WARNING: Should not be exported, but currently is because of a bug. See the
-// class description for more information.
-__export(require("./private/intrinsic"));
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyJpbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7OztBQUNBLGtDQUE2QjtBQUU3QixpQ0FBNEI7QUFDNUIsNkJBQXdCO0FBQ3hCLGtDQUE2QjtBQUM3Qiw0QkFBdUI7QUFDdkIsbUNBQThCO0FBQzlCLGtDQUE2QjtBQUM3Qix3Q0FBbUM7QUFFbkMsaUNBQTRCO0FBQzVCLHFDQUFnQztBQUNoQywwQkFBcUI7QUFDckIsK0JBQTBCO0FBQzFCLG1DQUE4QjtBQUM5QixrQ0FBNkI7QUFDN0IscUNBQWdDO0FBQ2hDLDhCQUF5QjtBQUN6QixvQ0FBK0I7QUFDL0IsdUNBQWtDO0FBQ2xDLGdDQUEyQjtBQUMzQiw2QkFBd0I7QUFDeEIsbUNBQThCO0FBQzlCLDZDQUF3QztBQUV4QyxzQ0FBaUM7QUFDakMsMkJBQXNCO0FBQ3RCLG1DQUE4QjtBQUU5QiwyQkFBc0I7QUFDdEIsK0JBQTBCO0FBRzFCLCtCQUEwQjtBQUMxQixvQ0FBK0I7QUFFL0IsZ0NBQTJCO0FBQzNCLHFDQUFnQztBQUNoQyw0Q0FBdUM7QUFFdkMsOEVBQThFO0FBQzlFLDBDQUEwQztBQUMxQyx5Q0FBb0MiLCJzb3VyY2VzQ29udGVudCI6WyJleHBvcnQgKiBmcm9tICcuL2FzcGVjdCc7XG5leHBvcnQgKiBmcm9tICcuL3RhZy1hc3BlY3QnO1xuXG5leHBvcnQgKiBmcm9tICcuL2NvbnN0cnVjdCc7XG5leHBvcnQgKiBmcm9tICcuL3Rva2VuJztcbmV4cG9ydCAqIGZyb20gJy4vcmVzb2x2YWJsZSc7XG5leHBvcnQgKiBmcm9tICcuL2xhenknO1xuZXhwb3J0ICogZnJvbSAnLi90YWctbWFuYWdlcic7XG5leHBvcnQgKiBmcm9tICcuL2RlcGVuZGVuY3knO1xuZXhwb3J0ICogZnJvbSAnLi9zdHJpbmctZnJhZ21lbnRzJztcblxuZXhwb3J0ICogZnJvbSAnLi9yZWZlcmVuY2UnO1xuZXhwb3J0ICogZnJvbSAnLi9jZm4tY29uZGl0aW9uJztcbmV4cG9ydCAqIGZyb20gJy4vZm4nO1xuZXhwb3J0ICogZnJvbSAnLi9pbmNsdWRlJztcbmV4cG9ydCAqIGZyb20gJy4vY2ZuLW1hcHBpbmcnO1xuZXhwb3J0ICogZnJvbSAnLi9jZm4tb3V0cHV0JztcbmV4cG9ydCAqIGZyb20gJy4vY2ZuLXBhcmFtZXRlcic7XG5leHBvcnQgKiBmcm9tICcuL3BzZXVkbyc7XG5leHBvcnQgKiBmcm9tICcuL2Nmbi1yZXNvdXJjZSc7XG5leHBvcnQgKiBmcm9tICcuL3Jlc291cmNlLXBvbGljeSc7XG5leHBvcnQgKiBmcm9tICcuL2Nmbi1ydWxlJztcbmV4cG9ydCAqIGZyb20gJy4vc3RhY2snO1xuZXhwb3J0ICogZnJvbSAnLi9jZm4tZWxlbWVudCc7XG5leHBvcnQgKiBmcm9tICcuL2Nmbi1keW5hbWljLXJlZmVyZW5jZSc7XG5leHBvcnQgKiBmcm9tICcuL3RhZyc7XG5leHBvcnQgKiBmcm9tICcuL3JlbW92YWwtcG9saWN5JztcbmV4cG9ydCAqIGZyb20gJy4vYXJuJztcbmV4cG9ydCAqIGZyb20gJy4vc3RhY2stdHJhY2UnO1xuXG5leHBvcnQgKiBmcm9tICcuL2FwcCc7XG5leHBvcnQgKiBmcm9tICcuL2NvbnRleHQnO1xuZXhwb3J0ICogZnJvbSAnLi9lbnZpcm9ubWVudCc7XG5cbmV4cG9ydCAqIGZyb20gJy4vcnVudGltZSc7XG5leHBvcnQgKiBmcm9tICcuL3NlY3JldC12YWx1ZSc7XG5cbmV4cG9ydCAqIGZyb20gJy4vcmVzb3VyY2UnO1xuZXhwb3J0ICogZnJvbSAnLi9waHlzaWNhbC1uYW1lJztcbmV4cG9ydCAqIGZyb20gJy4vcmVzb3VyY2UtaWRlbnRpZmllcnMnO1xuXG4vLyBXQVJOSU5HOiBTaG91bGQgbm90IGJlIGV4cG9ydGVkLCBidXQgY3VycmVudGx5IGlzIGJlY2F1c2Ugb2YgYSBidWcuIFNlZSB0aGVcbi8vIGNsYXNzIGRlc2NyaXB0aW9uIGZvciBtb3JlIGluZm9ybWF0aW9uLlxuZXhwb3J0ICogZnJvbSAnLi9wcml2YXRlL2ludHJpbnNpYyc7XG4iXX0=
+// tslint:disable-next-line:no-console
+console.error('ERROR: this module has been renamed to @aws-cdk/core');
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyJpbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsc0NBQXNDO0FBQ3RDLE9BQU8sQ0FBQyxLQUFLLENBQUMsc0RBQXNELENBQUMsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbIi8vIHRzbGludDpkaXNhYmxlLW5leHQtbGluZTpuby1jb25zb2xlXG5jb25zb2xlLmVycm9yKCdFUlJPUjogdGhpcyBtb2R1bGUgaGFzIGJlZW4gcmVuYW1lZCB0byBAYXdzLWNkay9jb3JlJyk7XG4iXX0=

package.json

 {
   "name": "@aws-cdk/cdk",
-  "version": "0.35.0",
-  "description": "AWS Cloud Development Kit Core Library",
+  "deprecated": "This module has been renamed to @aws-cdk/core",
+  "version": "0.36.0",
+  "description": "Deprecated: this module ha been renamed to @aws-cdk/core",
   "main": "lib/index.js",
@@ -17,8 +18,2 @@ "types": "lib/index.d.ts",
       },
-      "dotnet": {
-        "namespace": "Amazon.CDK",
-        "packageId": "Amazon.CDK",
-        "signAssembly": true,
-        "assemblyOriginatorKeyFile": "../../key.snk"
-      },
       "python": {
@@ -35,14 +30,2 @@ "distName": "aws-cdk.cdk",
   },
-  "awslint": {
-    "exclude": [
-      "construct-ctor:@aws-cdk/cdk.App.<initializer>",
-      "construct-ctor:@aws-cdk/cdk.Root.<initializer>",
-      "construct-ctor:@aws-cdk/cdk.Stack.<initializer>.params*",
-      "props-no-any:@aws-cdk/cdk.CfnOutputProps.value",
-      "props-no-any:@aws-cdk/cdk.CfnParameterProps.default",
-      "props-no-any:@aws-cdk/cdk.CfnResourceProps.properties",
-      "props-no-cfn-types:@aws-cdk/cdk.CfnOutputProps*",
-      "props-no-cfn-types:@aws-cdk/cdk.StringListCfnOutputProps*"
-    ]
-  },
   "scripts": {
@@ -59,7 +42,2 @@ "build": "cdk-build",
   },
-  "nyc": {
-    "statements": 55,
-    "lines": 55,
-    "branches": 35
-  },
   "keywords": [
@@ -78,20 +56,10 @@ "aws",
   "devDependencies": {
-    "@types/lodash": "^4.14.134",
-    "cdk-build-tools": "^0.35.0",
-    "cfn2ts": "^0.35.0",
-    "fast-check": "^1.15.1",
-    "lodash": "^4.17.11",
-    "pkglint": "^0.35.0"
+    "cdk-build-tools": "^0.36.0",
+    "pkglint": "^0.36.0"
   },
-  "dependencies": {
-    "@aws-cdk/cx-api": "^0.35.0"
-  },
   "homepage": "https://github.com/awslabs/aws-cdk",
-  "peerDependencies": {
-    "@aws-cdk/cx-api": "^0.35.0"
-  },
   "engines": {
     "node": ">= 8.10.0"
   },
-  "stability": "experimental"
-}
+  "stability": "deprecated"
+}

README.md

@@ -1,2 +0,3 @@
-## AWS Cloud Development Kit Core Library
+# Renamed to @aws-cdk/core
+
 <!--BEGIN STABILITY BANNER-->
@@ -6,10 +7,5 @@
 
-![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge)
+![Stability: Deprecated](https://img.shields.io/badge/stability-Deprecated-critical.svg?style=for-the-badge)
 
-> **This is a _developer preview_ (public beta) module. Releases might lack important features and might have
-> future breaking changes.**
-> 
-> This API is still under active development and subject to non-backward
-> compatible changes or removal in any future version. Use of the API is not recommended in production
-> environments. Experimental APIs are not subject to the Semantic Versioning model.
+> This API may emit warnings. Backward compatibility is not guaranteed.
 
@@ -19,209 +15,3 @@ ---
 
-This library includes the basic building blocks of
-the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) (AWS CDK).
 
-## Aspects
-
-Aspects are a mechanism to extend the CDK without having to directly impact the
-class hierarchy. We have implemented aspects using the [Visitor
-Pattern](https://en.wikipedia.org/wiki/Visitor_pattern).
-
-An aspect in the CDK is defined by this [interface](lib/aspect.ts)
-
-Aspects can be applied to any construct. During the tree
-"prepare" phase the aspect will visit each construct in the tree once.
-Aspects are invoked in the order they were added to the construct. They
-traverse the construct tree in a breadth first order starting at the `App`
-ending at the leaf nodes (most commonly the CloudFormation Resource). Aspect 
-authors implement the `visit(IConstruct)` function and can inspect the 
-`Construct` for specific characteristics. Such as, is this construct a 
-CloudFormation Resource?
-
-## Tagging
-
-Tags are implemented using aspects.
-
-Tags can be applied to any construct. Tags are inherited, based on the scope. If
-you tag construct A, and A contains construct B, construct B inherits the tag.
-The Tag API supports: 
-
- * `Tag` add (apply) a tag, either to specific resources or all but specific resources
- * `RemoveTag` remove a tag, again either from specific resources or all but specific resources
-
-A simple example, if you create a stack and want anything in the stack to receive a
-tag:
-
-```ts
-import cdk = require('@aws-cdk/cdk');
-
-const app = new cdk.App();
-const theBestStack = new cdk.Stack(app, 'MarketingSystem');
-theBestStack.node.apply(new cdk.Tag('StackType', 'TheBest'));
-
-// any resources added that support tags will get them
-```
-
-> The goal was to enable the ability to define tags in one place and have them 
-> applied consistently for all resources that support tagging. In addition 
-> the developer should not have to know if the resource supports tags. The
-> developer defines the tagging intents for all resources within a path. 
-> If the resources support tags they are added, else no action is taken.
-
-### Tag Example with ECS
-
-We are going to use the [ECS example](https://awslabs.github.io/aws-cdk/ecs_example.html) as starting point.
-
-For the purposes of example, this ECS cluster is for the Marketing Department.
-Marketing has two core groups Business to Business (B2B) and Business to Consumer
-(B2C). However, the Marketing team relies on the Platform team to help build the
-common components across businesses and separates costs to match. The goal here
-is tag the Platform team resources, the Marketing Department and then Marketing
-groups to enable proper cost allocations.
-
-We have modified the example and the code is located:
-examples/cdk-examples-typescript/hello-cdk-ecs-tags
-
-When the example is run the following tags are created:
-
-> We are omitting the default tags for VPC components.
-
-| Construct Path | Tag Key | Tag Value |
-| ----------|:---------|:-----|
-|MarketingSystem/MarketingVpc|CostCenter|Platform|
-|MarketingSystem/MarketingVpc/PublicSubnet1| CostCenter | Platform|
-|MarketingSystem/MarketingVpc/PublicSubnet1/RouteTable| CostCenter | Platform|
-|MarketingSystem/MarketingVpc/PublicSubnet1/NATGateway| CostCenter | Platform|
-|MarketingSystem/MarketingVpc/PublicSubnet2| CostCenter | Platform|
-|MarketingSystem/MarketingVpc/PublicSubnet2/RouteTable| CostCenter | Platform|
-|MarketingSystem/MarketingVpc/PublicSubnet2/NATGateway| CostCenter | Platform|
-|MarketingSystem/MarketingVpc/PublicSubnet3| CostCenter | Platform|
-|MarketingSystem/MarketingVpc/PublicSubnet3/RouteTable| CostCenter | Platform|
-|MarketingSystem/MarketingVpc/PublicSubnet3/NATGateway| CostCenter | Platform|
-|MarketingSystem/MarketingVpc/PrivateSubnet1| CostCenter | Platform|
-|MarketingSystem/MarketingVpc/PrivateSubnet1/RouteTable| CostCenter | Platform|
-|MarketingSystem/MarketingVpc/PrivateSubnet2| CostCenter | Platform|
-|MarketingSystem/MarketingVpc/PrivateSubnet2/RouteTable| CostCenter | Platform|
-|MarketingSystem/MarketingVpc/PrivateSubnet3| CostCenter | Platform|
-|MarketingSystem/MarketingVpc/PrivateSubnet3/RouteTable| CostCenter | Platform|
-|MarketingSystem/MarketingVpc/IGW|CostCenter|Platform|
-|MarketingSystem/B2BService/Service/SecurityGroup/Resource|CostCenter|Marketing|
-|MarketingSystem/B2BService/LB/Resource|CostCenter|Marketing|
-|MarketingSystem/B2BService/LB/SecurityGroup/Resource|CostCenter|Marketing|
-|MarketingSystem/B2BService/LB/PublicListener/ECSGroup/Resource|CostCenter|Marketing|
-|MarketingSystem/B2CService/Service/SecurityGroup/Resource|CostCenter|Marketing|
-|MarketingSystem/B2CService/LB/Resource|CostCenter|Marketing|
-|MarketingSystem/B2CService/LB/SecurityGroup/Resource|CostCenter|Marketing|
-|MarketingSystem/B2CService/LB/PublicListener/ECSGroup/Resource|CostCenter|Marketing|
-
-As you can see many tags are generated with only a few intent based directives. The CDK does default some additional tags for suggested `Name` keys. If you want to remove those tags you can do so by using the `RemoveTag` aspect, see below:
-
-```ts
-// snip //
-const vpc = new ec2.Vpc(marketingStack, 'MarketingVpc', {
-  maxAZs: 3 // Default is all AZs in region
-  });
-// override the VPC tags with Platform
-// this will tag the VPC, Subnets, Route Tables, IGW, and NatGWs
-vpc.node.apply(new cdk.Tag(COST_CENTER_KEY, 'Platform'));
-vpc.node.apply(new cdk.RemoveTag('Name'));
-// snip //
-```
-
-This will remove the name tags from the VPC, subnets, route tables and NAT
-gateways. If you've been following closely, this may lead you to ask how does
-remove work when the tag is actually applied closer to the resource? The Tag API
-has a few features that are covered later to explain how this works.
-
-### API
-
-In order to enable additional controls a Tag can specifically include or
-exclude a CloudFormation Resource Type, propagate tags for an autoscaling group,
-and use priority to override the default precedence. See the `TagProps` 
-interface for more details. 
-
-Tags can be configured by using the properties for the AWS CloudFormation layer
-resources or by using the tag aspects described here. The aspects will always
-take precedence over the AWS CloudFormation layer in the event of a name
-collision. The tags will be merged otherwise. For the aspect based tags, the
-tags applied closest to the resource will take precedence, given an equal
-priority. A higher priority tag will always take precedence over a lower
-priority tag.
-
-#### applyToLaunchedInstances
-
-This property is a boolean that defaults to `true`. When `true` and the aspect
-visits an AutoScalingGroup resource the `PropagateAtLaunch` property is set to
-true. If false the property is set accordingly.
-
-```ts
-// ... snip
-const vpc = new ec2.Vpc(this, 'MyVpc', { ... });
-vpc.node.apply(new cdk.Tag('MyKey', 'MyValue', { applyToLaunchedInstances: false }));
-// ... snip
-```
-
-#### includeResourceTypes
-
-Include is an array property that contains strings of CloudFormation Resource
-Types. As the aspect visits nodes it only takes action if node is one of the
-resource types in the array. By default the array is empty and an empty array is
-interpreted as apply to any resource type.
-
-```ts
-// ... snip
-const vpc = new ec2.Vpc(this, 'MyVpc', { ... });
-vpc.node.apply(new cdk.Tag('MyKey', 'MyValue', { includeResourceTypes: ['AWS::EC2::Subnet']}));
-// ... snip
-```
-
-#### excludeResourceTypes
-
-Exclude is the inverse of include. Exclude is also an array of CloudFormation
-Resource Types. As the aspect visit nodes it will not take action if the node is
-one of the resource types in the array. By default the array is empty and an
-empty array is interpreted to match no resource type. Exclude takes precedence
-over include in the event of a collision.
-
-```ts
-// ... snip
-const vpc = new ec2.Vpc(this, 'MyVpc', { ... });
-vpc.node.apply(new cdk.Tag('MyKey', 'MyValue', { exludeResourceTypes: ['AWS::EC2::Subnet']}));
-// ... snip
-```
-
-#### priority 
-
-Priority is used to control precedence when the default pattern does not work.
-In general users should try to avoid using priority, but in some situations it
-is required. In the example above, this is how `RemoveTag` works. The default
-setting for removing tags uses a higher priority than the standard tag. 
-
-```ts
-// ... snip
-const vpc = new ec2.Vpc(this, 'MyVpc', { ... });
-vpc.node.apply(new cdk.Tag('MyKey', 'MyValue', { priority: 2 }));
-// ... snip
-```
-
-## Secrets
-
-To help avoid accidental storage of secrets as plain text we use the `SecretValue` type to
-represent secrets.
-
-The best practice is to store secrets in AWS Secrets Manager and reference them using `SecretValue.secretsManager`:
-
-```ts
-const secret = SecretValue.secretsManager('secretId', {
-  jsonField: 'password' // optional: key of a JSON field to retrieve (defaults to all content),
-  versionId: 'id'       // optional: id of the version (default AWSCURRENT)
-  versionStage: 'stage' // optional: version stage name (default AWSCURRENT)
-});
-```
-
-Using AWS Secrets Manager is the recommended way to reference secrets in a CDK app.
-However, `SecretValue` supports the following additional options:
-
- * `SecretValue.plainText(secret)`: stores the secret as plain text in your app and the resulting template (not recommended).
- * `SecretValue.ssmSecure(param, version)`: refers to a secret stored as a SecureString in the SSM Parameter Store.
- * `SecretValue.cfnParameter(param)`: refers to a secret passed through a CloudFormation parameter (must have `NoEcho: true`).
- * `SecretValue.cfnDynamicReference(dynref)`: refers to a secret described by a CloudFormation dynamic reference (used by `ssmSecure` and `secretsManager`).
+This module has been renamed to @aws-cdk/core

tsconfig.json

@@ -38,5 +38,2 @@ {
     {
-      "path": "../cx-api"
-    },
-    {
       "path": "../../../tools/cdk-build-tools"
@@ -43,0 +40,0 @@ },

New alerts

Deprecated

Maintenance

The maintainer of the package marked it as deprecated. This could indicate that a single version should not be used, or that the package is no longer maintained and any new vulnerabilities will not be fixed.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 2 instances in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Improved metrics

Dependency count

0

decreased by-100%

Dev dependency count

2

decreased by-66.67%

Number of low supply chain risk alerts

0

decreased by-100%

Worsened metrics

Total package byte prevSize

16324

decreased by-99.15%

Number of package files

8

decreased by-94.94%

Lines of code

48

decreased by-99.67%

Number of medium maintenance alerts

1

increased byInfinity%

Number of lines in readme file

16

decreased by-92.92%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• - Removed@aws-cdk/cx-api@^0.35.0

• - Removed@aws-cdk/cx-api@0.35.0(transitive)