feat: no more generated attribute types in CFN layer (L1) (#1489)

Now that we can represent attributes as native strings and string lists, this covers the majority of resource attributes in CloudFormation. This change: * String attributes are represented as `string` (like before). * String list attribute are now represented as `string[]`. * Any other attribute types are represented as `cdk.Token`. Attributes that are represented as Tokens as of this change: * amazonmq has a bunch of `Integer` attributes (will be solved by #1455) * iot1click has a bunch of `Boolean` attributes * cloudformation has a JSON attribute * That's all. A few improvements to cfn2ts: * Auto-detect cfn2ts scope from package.json so it is more self-contained and doesn't rely on cdk-build-tools to run. * Added a "cfn2ts" npm script to all modules so it is now possible to regenerate all L1 via "lerna run cfn2ts". * Removed the premature optimization for avoiding code regeneration (it saved about 0.5ms). Fixes #1406 BREAKING CHANGE: any `CfnXxx` resource attributes that represented a list of strings are now typed as `string[]`s (via #1144). Attributes that represent strings, are still typed as `string` (#712) and all other attribute types are represented as `cdk.Token`.
aws · Jan 8, 2019 · 4d6d5ca · 4d6d5ca
1 parent 17eddd1
commit 4d6d5ca
Show file tree

Hide file tree

Showing 94 changed files with 297 additions and 184 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -156,6 +156,22 @@ Here are a few useful commands:
  evaluate only the rule specified [awslint README](./tools/awslint/README.md)
  for details on include/exclude rule patterns.
 
+### cfn2ts
+
+This tool is used to generate our low-level CloudFormation resources
+(L1/`CfnFoo`). It is executed as part of the build step of all modules in the
+AWS Construct Library.
+
+The tool consults the `cdk-build.cloudformation` key in `package.json` to
+determine which CloudFormation namespace this library represents (e.g.
+`AWS::EC2` is the namespace for `aws-ec2`). We maintain strict 1:1 relationship
+between those.
+
+Each module also has an npm script called `cfn2ts`:
+
+* `npm run cfn2ts`: generates L1 for a specific module
+* `lerna run cfn2ts`: generates L1 for the entire repo
+
 ## Development Workflows
 
 ### Full clean build

diff --git a/packages/@aws-cdk/alexa-ask/package.json b/packages/@aws-cdk/alexa-ask/package.json
@@ -36,7 +36,8 @@
  "pkglint": "pkglint -f",
  "test": "cdk-test",
  "watch": "cdk-watch",
- "awslint": "cdk-awslint"
+ "awslint": "cdk-awslint",
+ "cfn2ts": "cfn2ts"
  },
  "cdk-build": {
  "cloudformation": "Alexa::ASK"

diff --git a/packages/@aws-cdk/aws-amazonmq/package.json b/packages/@aws-cdk/aws-amazonmq/package.json
@@ -36,7 +36,8 @@
  "pkglint": "pkglint -f",
  "test": "cdk-test",
  "watch": "cdk-watch",
- "awslint": "cdk-awslint"
+ "awslint": "cdk-awslint",
+ "cfn2ts": "cfn2ts"
  },
  "cdk-build": {
  "cloudformation": "AWS::AmazonMQ"

diff --git a/packages/@aws-cdk/aws-apigateway/package.json b/packages/@aws-cdk/aws-apigateway/package.json
@@ -35,7 +35,8 @@
  "integ": "cdk-integ",
  "pkglint": "pkglint -f",
  "package": "cdk-package",
- "awslint": "cdk-awslint"
+ "awslint": "cdk-awslint",
+ "cfn2ts": "cfn2ts"
  },
  "cdk-build": {
  "cloudformation": "AWS::ApiGateway"

diff --git a/packages/@aws-cdk/aws-applicationautoscaling/package.json b/packages/@aws-cdk/aws-applicationautoscaling/package.json
@@ -35,7 +35,8 @@
  "integ": "cdk-integ",
  "pkglint": "pkglint -f",
  "package": "cdk-package",
- "awslint": "cdk-awslint"
+ "awslint": "cdk-awslint",
+ "cfn2ts": "cfn2ts"
  },
  "cdk-build": {
  "cloudformation": "AWS::ApplicationAutoScaling"

diff --git a/packages/@aws-cdk/aws-appstream/package.json b/packages/@aws-cdk/aws-appstream/package.json
@@ -36,7 +36,8 @@
  "pkglint": "pkglint -f",
  "test": "cdk-test",
  "watch": "cdk-watch",
- "awslint": "cdk-awslint"
+ "awslint": "cdk-awslint",
+ "cfn2ts": "cfn2ts"
  },
  "cdk-build": {
  "cloudformation": "AWS::AppStream"

diff --git a/packages/@aws-cdk/aws-appsync/package.json b/packages/@aws-cdk/aws-appsync/package.json
@@ -35,7 +35,8 @@
  "integ": "cdk-integ",
  "pkglint": "pkglint -f",
  "package": "cdk-package",
- "awslint": "cdk-awslint"
+ "awslint": "cdk-awslint",
+ "cfn2ts": "cfn2ts"
  },
  "cdk-build": {
  "cloudformation": "AWS::AppSync"

diff --git a/packages/@aws-cdk/aws-athena/package.json b/packages/@aws-cdk/aws-athena/package.json
@@ -38,7 +38,8 @@
  "integ": "cdk-integ",
  "pkglint": "pkglint -f",
  "package": "cdk-package",
- "awslint": "cdk-awslint"
+ "awslint": "cdk-awslint",
+ "cfn2ts": "cfn2ts"
  },
  "keywords": [
  "aws",

diff --git a/packages/@aws-cdk/aws-autoscaling/lib/auto-scaling-group.ts b/packages/@aws-cdk/aws-autoscaling/lib/auto-scaling-group.ts
@@ -222,7 +222,7 @@ export class AutoScalingGroup extends cdk.Construct implements IAutoScalingGroup
 
  // use delayed evaluation
  const machineImage = props.machineImage.getImage(this);
- const userDataToken = new cdk.Token(() => cdk.Fn.base64((machineImage.os.createUserData(this.userDataLines))));
+ const userDataToken = new cdk.Token(() => cdk.Fn.base64((machineImage.os.createUserData(this.userDataLines)))).toString();
  const securityGroupsToken = new cdk.Token(() => this.securityGroups.map(sg => sg.securityGroupId));
 
  const launchConfig = new CfnLaunchConfiguration(this, 'LaunchConfig', {

diff --git a/packages/@aws-cdk/aws-autoscaling/package.json b/packages/@aws-cdk/aws-autoscaling/package.json
@@ -35,7 +35,8 @@
  "integ": "cdk-integ",
  "pkglint": "pkglint -f",
  "package": "cdk-package",
- "awslint": "cdk-awslint"
+ "awslint": "cdk-awslint",
+ "cfn2ts": "cfn2ts"
  },
  "cdk-build": {
  "cloudformation": "AWS::AutoScaling"

diff --git a/packages/@aws-cdk/aws-autoscalingplans/package.json b/packages/@aws-cdk/aws-autoscalingplans/package.json
@@ -35,7 +35,8 @@
  "integ": "cdk-integ",
  "pkglint": "pkglint -f",
  "package": "cdk-package",
- "awslint": "cdk-awslint"
+ "awslint": "cdk-awslint",
+ "cfn2ts": "cfn2ts"
  },
  "cdk-build": {
  "cloudformation": "AWS::AutoScalingPlans"

diff --git a/packages/@aws-cdk/aws-batch/package.json b/packages/@aws-cdk/aws-batch/package.json
@@ -35,7 +35,8 @@
  "integ": "cdk-integ",
  "pkglint": "pkglint -f",
  "package": "cdk-package",
- "awslint": "cdk-awslint"
+ "awslint": "cdk-awslint",
+ "cfn2ts": "cfn2ts"
  },
  "cdk-build": {
  "cloudformation": "AWS::Batch"

diff --git a/packages/@aws-cdk/aws-budgets/package.json b/packages/@aws-cdk/aws-budgets/package.json
@@ -35,7 +35,8 @@
  "integ": "cdk-integ",
  "pkglint": "pkglint -f",
  "package": "cdk-package",
- "awslint": "cdk-awslint"
+ "awslint": "cdk-awslint",
+ "cfn2ts": "cfn2ts"
  },
  "cdk-build": {
  "cloudformation": "AWS::Budgets"

diff --git a/packages/@aws-cdk/aws-certificatemanager/package.json b/packages/@aws-cdk/aws-certificatemanager/package.json
@@ -35,7 +35,8 @@
  "integ": "cdk-integ",
  "pkglint": "pkglint -f",
  "package": "cdk-package",
- "awslint": "cdk-awslint"
+ "awslint": "cdk-awslint",
+ "cfn2ts": "cfn2ts"
  },
  "cdk-build": {
  "cloudformation": "AWS::CertificateManager"

diff --git a/packages/@aws-cdk/aws-cloud9/package.json b/packages/@aws-cdk/aws-cloud9/package.json
@@ -35,7 +35,8 @@
  "integ": "cdk-integ",
  "pkglint": "pkglint -f",
  "package": "cdk-package",
- "awslint": "cdk-awslint"
+ "awslint": "cdk-awslint",
+ "cfn2ts": "cfn2ts"
  },
  "cdk-build": {
  "cloudformation": "AWS::Cloud9"

diff --git a/packages/@aws-cdk/aws-cloudformation/package.json b/packages/@aws-cdk/aws-cloudformation/package.json
@@ -35,7 +35,8 @@
  "integ": "cdk-integ",
  "pkglint": "pkglint -f",
  "package": "cdk-package",
- "awslint": "cdk-awslint"
+ "awslint": "cdk-awslint",
+ "cfn2ts": "cfn2ts"
  },
  "cdk-build": {
  "cloudformation": "AWS::CloudFormation"

diff --git a/packages/@aws-cdk/aws-cloudfront/package.json b/packages/@aws-cdk/aws-cloudfront/package.json
@@ -35,7 +35,8 @@
  "integ": "cdk-integ",
  "pkglint": "pkglint -f",
  "package": "cdk-package",
- "awslint": "cdk-awslint"
+ "awslint": "cdk-awslint",
+ "cfn2ts": "cfn2ts"
  },
  "cdk-build": {
  "cloudformation": "AWS::CloudFront"

diff --git a/packages/@aws-cdk/aws-cloudtrail/package.json b/packages/@aws-cdk/aws-cloudtrail/package.json
@@ -34,7 +34,8 @@
  "test": "cdk-test",
  "pkglint": "pkglint -f",
  "package": "cdk-package",
- "awslint": "cdk-awslint"
+ "awslint": "cdk-awslint",
+ "cfn2ts": "cfn2ts"
  },
  "cdk-build": {
  "cloudformation": "AWS::CloudTrail"

diff --git a/packages/@aws-cdk/aws-cloudwatch/lib/dashboard.ts b/packages/@aws-cdk/aws-cloudwatch/lib/dashboard.ts
@@ -26,15 +26,15 @@ export class Dashboard extends Construct {
  // This is a bug in CloudFormation, but we don't want CDK users to have a bad
  // experience. We'll generate a name here if you did not supply one.
  // See: https://github.com/awslabs/aws-cdk/issues/213
- const dashboardName = (props && props.dashboardName) || new Token(() => this.generateDashboardName());
+ const dashboardName = (props && props.dashboardName) || new Token(() => this.generateDashboardName()).toString();
 
  this.dashboard = new CfnDashboard(this, 'Resource', {
  dashboardName,
  dashboardBody: new Token(() => {
  const column = new Column(...this.rows);
  column.position(0, 0);
  return CloudFormationJSON.stringify({ widgets: column.toJson() });
- })
+ }).toString()
  });
  }
 

diff --git a/packages/@aws-cdk/aws-cloudwatch/package.json b/packages/@aws-cdk/aws-cloudwatch/package.json
@@ -35,7 +35,8 @@
  "integ": "cdk-integ",
  "pkglint": "pkglint -f",
  "package": "cdk-package",
- "awslint": "cdk-awslint"
+ "awslint": "cdk-awslint",
+ "cfn2ts": "cfn2ts"
  },
  "cdk-build": {
  "cloudformation": "AWS::CloudWatch"

diff --git a/packages/@aws-cdk/aws-codebuild/package.json b/packages/@aws-cdk/aws-codebuild/package.json
@@ -35,7 +35,8 @@
  "integ": "cdk-integ",
  "pkglint": "pkglint -f",
  "package": "cdk-package",
- "awslint": "cdk-awslint"
+ "awslint": "cdk-awslint",
+ "cfn2ts": "cfn2ts"
  },
  "cdk-build": {
  "cloudformation": "AWS::CodeBuild"

diff --git a/packages/@aws-cdk/aws-codecommit/package.json b/packages/@aws-cdk/aws-codecommit/package.json
@@ -35,7 +35,8 @@
  "integ": "cdk-integ",
  "pkglint": "pkglint -f",
  "package": "cdk-package",
- "awslint": "cdk-awslint"
+ "awslint": "cdk-awslint",
+ "cfn2ts": "cfn2ts"
  },
  "cdk-build": {
  "cloudformation": "AWS::CodeCommit"

diff --git a/packages/@aws-cdk/aws-codedeploy/package.json b/packages/@aws-cdk/aws-codedeploy/package.json
@@ -35,7 +35,8 @@
  "integ": "cdk-integ",
  "pkglint": "pkglint -f",
  "package": "cdk-package",
- "awslint": "cdk-awslint"
+ "awslint": "cdk-awslint",
+ "cfn2ts": "cfn2ts"
  },
  "cdk-build": {
  "cloudformation": "AWS::CodeDeploy"

diff --git a/packages/@aws-cdk/aws-codepipeline/lib/github-source-action.ts b/packages/@aws-cdk/aws-codepipeline/lib/github-source-action.ts
@@ -76,7 +76,7 @@ export class GitHubSourceAction extends actions.SourceAction {
  new CfnWebhook(this, 'WebhookResource', {
  authentication: 'GITHUB_HMAC',
  authenticationConfiguration: {
- secretToken: props.oauthToken,
+ secretToken: props.oauthToken.toString(),
  },
  filters: [
  {

diff --git a/packages/@aws-cdk/aws-codepipeline/package.json b/packages/@aws-cdk/aws-codepipeline/package.json
@@ -35,7 +35,8 @@
  "integ": "cdk-integ",
  "pkglint": "pkglint -f",
  "package": "cdk-package",
- "awslint": "cdk-awslint"
+ "awslint": "cdk-awslint",
+ "cfn2ts": "cfn2ts"
  },
  "cdk-build": {
  "cloudformation": "AWS::CodePipeline"

diff --git a/packages/@aws-cdk/aws-cognito/package.json b/packages/@aws-cdk/aws-cognito/package.json
@@ -35,7 +35,8 @@
  "integ": "cdk-integ",
  "pkglint": "pkglint -f",
  "package": "cdk-package",
- "awslint": "cdk-awslint"
+ "awslint": "cdk-awslint",
+ "cfn2ts": "cfn2ts"
  },
  "cdk-build": {
  "cloudformation": "AWS::Cognito"

diff --git a/packages/@aws-cdk/aws-config/package.json b/packages/@aws-cdk/aws-config/package.json
@@ -35,7 +35,8 @@
  "integ": "cdk-integ",
  "pkglint": "pkglint -f",
  "package": "cdk-package",
- "awslint": "cdk-awslint"
+ "awslint": "cdk-awslint",
+ "cfn2ts": "cfn2ts"
  },
  "cdk-build": {
  "cloudformation": "AWS::Config"

diff --git a/packages/@aws-cdk/aws-datapipeline/package.json b/packages/@aws-cdk/aws-datapipeline/package.json
@@ -35,7 +35,8 @@
  "integ": "cdk-integ",
  "pkglint": "pkglint -f",
  "package": "cdk-package",
- "awslint": "cdk-awslint"
+ "awslint": "cdk-awslint",
+ "cfn2ts": "cfn2ts"
  },
  "cdk-build": {
  "cloudformation": "AWS::DataPipeline"

diff --git a/packages/@aws-cdk/aws-dax/package.json b/packages/@aws-cdk/aws-dax/package.json
@@ -35,7 +35,8 @@
  "integ": "cdk-integ",
  "pkglint": "pkglint -f",
  "package": "cdk-package",
- "awslint": "cdk-awslint"
+ "awslint": "cdk-awslint",
+ "cfn2ts": "cfn2ts"
  },
  "cdk-build": {
  "cloudformation": "AWS::DAX"

diff --git a/packages/@aws-cdk/aws-directoryservice/package.json b/packages/@aws-cdk/aws-directoryservice/package.json
@@ -35,7 +35,8 @@
  "integ": "cdk-integ",
  "pkglint": "pkglint -f",
  "package": "cdk-package",
- "awslint": "cdk-awslint"
+ "awslint": "cdk-awslint",
+ "cfn2ts": "cfn2ts"
  },
  "cdk-build": {
  "cloudformation": "AWS::DirectoryService"

diff --git a/packages/@aws-cdk/aws-dlm/package.json b/packages/@aws-cdk/aws-dlm/package.json
@@ -36,7 +36,8 @@
  "pkglint": "pkglint -f",
  "test": "cdk-test",
  "watch": "cdk-watch",
- "awslint": "cdk-awslint"
+ "awslint": "cdk-awslint",
+ "cfn2ts": "cfn2ts"
  },
  "cdk-build": {
  "cloudformation": "AWS::DLM"

diff --git a/packages/@aws-cdk/aws-dms/package.json b/packages/@aws-cdk/aws-dms/package.json
@@ -35,7 +35,8 @@
  "integ": "cdk-integ",
  "pkglint": "pkglint -f",
  "package": "cdk-package",
- "awslint": "cdk-awslint"
+ "awslint": "cdk-awslint",
+ "cfn2ts": "cfn2ts"
  },
  "cdk-build": {
  "cloudformation": "AWS::DMS"

diff --git a/packages/@aws-cdk/aws-dynamodb/package.json b/packages/@aws-cdk/aws-dynamodb/package.json
@@ -35,7 +35,8 @@
  "integ": "cdk-integ",
  "pkglint": "pkglint -f",
  "package": "cdk-package",
- "awslint": "cdk-awslint"
+ "awslint": "cdk-awslint",
+ "cfn2ts": "cfn2ts"
  },
  "cdk-build": {
  "cloudformation": "AWS::DynamoDB"

diff --git a/packages/@aws-cdk/aws-ec2/package.json b/packages/@aws-cdk/aws-ec2/package.json
@@ -35,7 +35,8 @@
  "integ": "cdk-integ",
  "pkglint": "pkglint -f",
  "package": "cdk-package",
- "awslint": "cdk-awslint"
+ "awslint": "cdk-awslint",
+ "cfn2ts": "cfn2ts"
  },
  "cdk-build": {
  "cloudformation": "AWS::EC2"

diff --git a/packages/@aws-cdk/aws-ecr/package.json b/packages/@aws-cdk/aws-ecr/package.json
@@ -35,7 +35,8 @@
  "integ": "cdk-integ",
  "pkglint": "pkglint -f",
  "package": "cdk-package",
- "awslint": "cdk-awslint"
+ "awslint": "cdk-awslint",
+ "cfn2ts": "cfn2ts"
  },
  "cdk-build": {
  "cloudformation": "AWS::ECR"

diff --git a/packages/@aws-cdk/aws-ecs/lib/base/task-definition.ts b/packages/@aws-cdk/aws-ecs/lib/base/task-definition.ts
@@ -188,7 +188,7 @@ export class TaskDefinition extends cdk.Construct {
  const taskDef = new CfnTaskDefinition(this, 'Resource', {
  containerDefinitions: new cdk.Token(() => this.containers.map(x => x.renderContainerDefinition())),
  volumes: new cdk.Token(() => this.volumes),
- executionRoleArn: new cdk.Token(() => this.executionRole && this.executionRole.roleArn),
+ executionRoleArn: new cdk.Token(() => this.executionRole && this.executionRole.roleArn).toString(),
  family: this.family,
  taskRoleArn: this.taskRole.roleArn,
  requiresCompatibilities: [

diff --git a/packages/@aws-cdk/aws-ecs/package.json b/packages/@aws-cdk/aws-ecs/package.json
@@ -35,7 +35,8 @@
  "integ": "cdk-integ",
  "pkglint": "pkglint -f",
  "package": "cdk-package",
- "awslint": "cdk-awslint"
+ "awslint": "cdk-awslint",
+ "cfn2ts": "cfn2ts"
  },
  "cdk-build": {
  "cloudformation": "AWS::ECS"

diff --git a/packages/@aws-cdk/aws-efs/package.json b/packages/@aws-cdk/aws-efs/package.json
@@ -35,7 +35,8 @@
  "integ": "cdk-integ",
  "pkglint": "pkglint -f",
  "package": "cdk-package",
- "awslint": "cdk-awslint"
+ "awslint": "cdk-awslint",
+ "cfn2ts": "cfn2ts"
  },
  "cdk-build": {
  "cloudformation": "AWS::EFS"