@aws-cdk/aws-sam

AWS Serverless Application Model Construct Library

---

This is a developer preview (public beta) module.

All classes with the Cfn prefix in this module (CFN Resources) are auto-generated from CloudFormation. They are stable and safe to use.

However, all other classes, i.e., higher level constructs, 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.

---

This module includes low-level constructs that synthesize into AWS::Serverless resources.

const sam = require('@aws-cdk/aws-sam');

Related

The following AWS CDK modules include constructs that can be used to work with Amazon API Gateway and AWS Lambda:

• aws-lambda: define AWS Lambda functions
• aws-lambda-event-sources: classes that allow using various AWS services as event sources for AWS Lambda functions
• aws-apigateway: define APIs through Amazon API Gateway
• aws-codedeploy: define AWS Lambda deployment with traffic shifting support

Changelog

1.32.0 (2020-04-07)

⚠ BREAKING CHANGES TO EXPERIMENTAL FEATURES

• cognito: UserPoolClient construct no longer has the property userPoolClientClientSecret. The functionality to retrieve the client secret never existed in CloudFormation, so this property was not working in the first place.
• cognito: The userPoolClientName property on the UserPoolClient construct will throw an error if client name was not configured on the UserPoolClient during initialization. This property was previously incorrectly configured and was returning a not-implemented message from CloudFormation every time.
• amplify: use the sourceCodeProvider prop to connect your app to a source code provider. The props repository, accessToken and oauthToken do not exist anymore in AppProps.
• kinesis: retentionPeriodHours is now retentionPeriod and of type Duration
• eks: Cluster now creates a default managed nodegroup as its default capacity. Set the new cluster property defaultCapacityType to DefaultCapacityType.EC2 to preserve EC2 as its default capacity.
• cognito: add*Trigger() methods to configure lambda triggers has now been replaced by a single addTrigger() method.
• cognito: addTrigger() method will fail if a trigger was already configured for that user pool operation.
• iam: methods accepting iam conditions now requires passing {[key: string]: any} instead of plain any. You were always supposed to pass a map/dictionary in these locations, but the type system didn't enforce it. It now does.

Features

• amplify: source code providers (#6921) (3dc3d75), closes #6818
• apigateway: access logging (#6559) (7484935), closes #6501
• apigateway: auto-create RequestValidator from options to addMethod() (#6780) (573464d), closes #6193
• applicationautoscaling: add PredefinedMetric for Lambda provisioned concurrency autoscaling (#6394) (45b68d5), closes #6369
• aws-codebuild: add from codebuild image option (#7117) (de8e670), closes #2606
• aws-codebuild: add ProjectFileSystemLocation property to codebuild (#6539) (2195cc2), closes #6533
• bootstrap: require aws:SecureTransport for staging bucket (#7192) (ed106ea)
• cfnspec: cloudformation spec v11.6.0 (#6995) (9a552c2)
• cli: write stack outputs to a file (#7020) (75d5ee9), closes #1773
• codebuild: expose aws/windows/base:2.0 image (#7004) (9374642)
• codebuild: support AL2 3.0 & Standard 4.0 (#6968) (3254c5d)
• cognito: import an existing user pool client (#7091) (abc2144)
• cognito: user pool - OAuth2.0 authentication (#7141) (09852d0)
• core: Size unit representing digital information quantity (#6940) (22a560d)
• ec2: EFS interface VPC endpoint (#6961) (6e61889), closes #6960
• ecs: secret JSON key for environment variables (#6435) (97959f6), closes #5665
• eks: managed nodegroup support (#6759) (74169bf), closes #5086
• elbv2: health checks for Lambda targets (#7023) (cf8c831)
• iam: add arbitrary conditions to existing principals (#7015) (64bad91), closes #5855
• kinesis: stream encryption with the Kinesis master key (#7057) (bded683), closes #751
• kinesis: streams are encrypted by default (#7102) (d6ecf44)
• lambda: .net core 3.1 runtime (#7105) (ca2585c)
• lambda: currentVersion, version.addAlias() (#6771) (c94ce62), closes #6750 #5334
• lambda: ruby 2.7 runtime (#7024) (4994e0d), closes #6979
• cloudformation spec v12.0.0 (#7113) (1956ded)
• Support passing AssetOptions (#7099) (3925d9a)
• rds: aurora - iam role to import and export data from s3 (#6611) (aa60f89), closes #6610
• rds: database instance - auto scale allocated storage (#6788) (22ffae3), closes #6666
• stepfunctions: execution history logging options (#6933) (adb6954), closes #5754
• stepfunctions-tasks: dynamodb tasks (#6654) (435b66f), closes #6468

Bug Fixes

• acm-certificatemanager: DnsValidatedCertificateHandler support for SubjectAlternativeNames (#7050) (a711c01), closes #4659

• aws-ecs-patterns: revert commit f31f4e1 (#6987) (0af2d2e)

• aws-kinesis: test assume order between stacks (#7065) (17aab37)

• cli: can't use credential providers for stacks with assets (#7022) (afd7045), closes #7005

• cloudtrail: include s3KeyPrefix in bucket policy resource (#7053) (b49881f), closes #6741

• cognito: user pool - passwordPolicy.minLength is not optional in all cases (#6971) (49cdd8f)

• dynamodb: cannot use attribute as key in a GSI, non-key in another (#7075) (a6bd34f), closes #4398

• ecs: default Service throws in a VPC without private subnets (#7188) (0ef6a95), closes #7062

• events: Batch target does not work (#7191) (6f00783), closes #7137

• kinesis: retention period does not use Duration type (#7037) (1186227), closes #7036

• rewrite-imports: incorrect main in package.json (#7021) (2bf85b3)

• stepfunctions-tasks: batch job - can not use task input as array size (#7008) (923d2a1), closes #6922

• stepfunctions-tasks: confusion between multiple ways to run a Lambda (#6796) (7485448), closes #4801

• cognito: clean up and document triggers (#6816) (32834cb)