Serverless Framework Deprecations

How to disable specific deprecation logs

To disable specific deprecations set SLS_DEPRECATION_DISABLE environment variable. Setting SLS_DEPRECATION_DISABLE=* will disable all deprecations. If you want to disable specific deprecations set SLS_DEPRECATION_DISABLE=CODE1,CODE2. Alternatively, you can also use disabledDeprecations in your serverless.yml in the following manner:

service: myService
disabledDeprecations:
  - CODE_1 # To disable specific deprecation with code "CODE_1"
  - '*' # To disable all deprecation messages

Notifications mode

By default deprecations are logged, after command finalizes with a warning summary (warn:summary mode)

Alternatively deprecation warnings can be displayed as they're discovered, on the go, that can be turned on with warn mode (this mode is automatically pursued on in case we fallback to locally installed Serverless Framework installation)

If there's an intention to work with deprecation free service, reporting mode can be switched to error, so approached deprecation is reported with a thrown error.

Mode can be set via environment variable: SLS_DEPRECATION_NOTIFICATION_MODE=error or via top level service configuration setting:

deprecationNotificationMode: error

Note:

  • In service configuration setting is ineffective for deprecations reported before service configuration is read.
  • SLS_DEPRECATION_DISABLE env var and disabledDeprecations configuration setting remain respected, and no errors will be thrown for mentioned deprecation coodes.

 

CLI -v alias for --verbose option

Deprecation code: CLI_VERBOSE_OPTION_ALIAS

Starting with v3.0.0, -v will no longer be supported as alias for --verbose option. Please use --verbose flag instead.

 

Default identitySource for http.authorizer

Deprecation code: AWS_API_GATEWAY_DEFAULT_IDENTITY_SOURCE

Starting with v3.0.0, functions[].events[].http.authorizer.identitySource will no longer be set to "method.request.header.Authorization" by default for authorizers of "request" type with caching disabled ("resultTtlInSeconds" set to "0"). If you want to keep this setting, please set it explicitly in your configuration. If you do not want this to be set, please set it explicitly to "null".

 

Disable default Output Export names

Deprecation code: DISABLE_DEFAULT_OUTPUT_EXPORT_NAMES

Starting with v3.0.0, it will not be possible to disable default export names for outputs. To hide this deprecation message and ensure seamless upgrade, please remove this flag.

 

CLI --function/-f option for deploy command

Deprecation code: CLI_DEPLOY_FUNCTION_OPTION'

Starting with v3.0.0, --function or -f option for deploy command will be removed. In order to deploy a single function, please use deploy function command instead.

 

Change of default runtime to nodejs14.x

Deprecation code: CHANGE_OF_DEFAULT_RUNTIME_TO_NODEJS14X

Starting with v3.0.0, the default runtime will change from nodejs12.x to nodejs14.x. In order to hide the deprecation message and ensure seamless upgrade, please set the runtime explicitly.

 

AWS API Gateway non-applicable settings configured

Deprecation code: AWS_API_GATEWAY_NON_APPLICABLE_SETTINGS

When external API Gateway resource is used and imported via provider.apiGateway.restApiId setting, both provider.logs.restApi and provider.tracing.apiGateway will be ignored. These settings are applicable only if API Gateway resource is provisioned by Serverless Framework.

 

CLI Options extensions, type requirement

Deprecation code: CLI_OPTIONS_SCHEMA'

Internal handling of CLI arguments was improved with type awareness for options. Now each option definition is expected have type defined in its settings.

Possible values are string, boolean and multiple. Check Defining options documentation for more info.

If you rely on a plugin which does not set types (yet) please report the issue at its issue tracker.

Starting with v3.0.0 any option extensions which does not have type defined will be communicated with a thrown error

 

New way to define packaging patterns

Deprecation code: NEW_PACKAGE_PATTERNS

Support for package.include and package.exclude will be removed with v3.0.0. Instead please use package.patterns with which both include and exclude (prefixed with !) rules can be configured.

Check Packaging Patterns documentation for more info.

 

Handling of unrecognized CLI options

Deprecation code: UNSUPPORTED_CLI_OPTIONS

Framework was upgraded with extensive CLI options validation and that required dropping support for free form CLI options (keeping that in will make not possible to reliably detect accidental typos in option names).

For free form process configuration options it is advised to rely on environment variables instead, as e.g.:

provider:
  stackName: ${env:STACK_NAME, 'T001'}
STACK_NAME=test sls deploy

Note that setup of environment variables is way more convenient since we've added support for .env files.

Starting with v3.0.0, Serverless will report unrecognized options with a thrown error.

 

CLI command options should follow command

Deprecation code: CLI_OPTIONS_BEFORE_COMMAND

Starting with v3.0.0, Serverless will not support putting options before command, e.g. sls -v deploy will no longer be recognized as deploy command.

Ensure to always format CLI command as sls [command..] [options...]

 

configValidationMode: error will be new default

Deprecation code: CONFIG_VALIDATION_MODE_DEFAULT

Starting with v3.0.0, Serverless will throw on configuration errors by default. This is changing from the previous default, configValidationMode: warn

Learn more about configuration validation here: http://slss.io/configuration-validation

 

AWS API Gateway schemas

Deprecation code: AWS_API_GATEWAY_SCHEMAS

Starting with v3.0.0, http.request.schema property will be replaced by http.request.schemas. In addition to supporting functionalities such as model name definition and reuse of existing schemas, http.request.schemas also supports the same notation as http.request.schema, so you can safely migrate your existing configuration to the new property. For more details about the new configuration, please refer to the API Gateway Event

 

AWS EventBridge lambda event triggers

Deprecation code: AWS_EVENT_BRIDGE_CUSTOM_RESOURCE

Starting with v3.0.0 AWS EventBridge lambda event triggers and all associated EventBridge resources will be deployed using native CloudFormation resources instead of a custom resource that used a lambda to deploy them via the AWS SDK/API.

Adapt to this behavior now by setting provider.eventBridge.useCloudFormation: true.

 

New variables resolver

Deprecation code: NEW_VARIABLES_RESOLVER

Framework was updated with a new implementation of variables resolver.

It supports very same variable syntax, and is being updated with support for same resolution sources. Still as it has improved internal resolution rules (which leave no room for ambiguity) in some edge cases it may report errors on which old parser passed by.

It's recommended to expose all errors that eventually new resolver may report (those will be an unconditional errors in v3). You can turn that behavior on by adding variablesResolutionMode: 20210326 to service configuration

 

Http Api provider tags

Deprecation code: AWS_HTTP_API_USE_PROVIDER_TAGS

Starting with v3.0.0, provider.tags will be applied to Http Api Gateway by default Set provider.httpApi.useProviderTags to true to adapt to the new behavior now.

 

Serverless constructor config.commands and config.options requirement

Deprecation code: MISSING_COMMANDS_OR_OPTIONS_AT_CONSTRUCTION

Note: Applies only to eventual programmatic usage of the Framework

Serverless constructor was refactored to depend on CLI commands and arguments, to be resolved externally and passed to its constructor with config.commands and config.options. Starting from v3.0.0 CLI arguments will not be resolved internally.

 

Serverless constructor service configuration dependency

Deprecation code: MISSING_SERVICE_CONFIGURATION

Note: Applies only to eventual programmatic usage of the Framework

Serverless constructor was refactored to depend on service configuration being resolved externally and passed to its constructor with following options:

  • configuration - Service configuration (JSON serializable plain object)
  • serviceDir - Directory in which service is placed (All path references in service configuration will be resolved against this path)
  • configurationFilename - Name of configuration file (e.g. serverless.yml).

Starting from v3.0.0 configuration data will not be resolved internally, and if Serverless is invoked in service context, all three options will have to be provided

 

Service configurations should not be nested in service sub directories

Deprecation code: NESTED_CUSTOM_CONFIGURATION_PATH

Note: Applies only to eventual programmatic usage of the Framework

Service configuration in all cases should be put at root folder of a service. All paths in this configuration are resolved against service directory, and it's also the case if configuration is nested in sub directory.

To avoid confusing behavior starting with v3.0.0 Framework will no longer permit to rely on configurations placed in sub directories

 

Serverless constructor service configuration dependency

Deprecation code: MISSING_SERVICE_CONFIGURATION_PATH

Note: Applies only to eventual programmatic usage of the Framework

Serverless constructor was refactored to depend on service configuration being resolved externally and passed to its constructor with following options:

  • configuration - Service configuration (JSON serializable plain object)
  • serviceDir - Directory in which service is placed (All path references in service configuration will be resolved against this path)
  • configurationFilename - Name of configuration file (e.g. serverless.yml).

Starting from v3.0.0 configuration data will not be resolved internally, and if Serverless is invoked in service context, all three options will have to be provided

 

Erroring on unresolved variable references

Deprecation code: VARIABLES_ERROR_ON_UNRESOLVED

Note: Starting with v3.0.0, Serverless Framework will switch exclusively to a new variables resolver. If you see this deprecation please upgrade to latest v2 release of Serverless Framework, as that will provide a more accurate insight on planned changes.

In context of v2 you may adapt old variables resolver so errors on unresolved variables are thrown by adding unresolvedVariablesNotificationMode: error to service configuration.

 

Grouping IAM settings under provider.iam

Deprecation code: PROVIDER_IAM_SETTINGS

Note: Originally support for old IAM settings was scheduled to be dropped with new major release. It's no longer the case. If you see this deprecation notice please upgrade to latest version of Serverless Framework

All IAM-related settings of provider including iamRoleStatements, iamManagedPolicies, role and cfnRole are also now supported at iam property. Refer to the IAM Guide.

  • provider.role -> provider.iam.role
  • provider.rolePermissionsBoundary -> provider.iam.role.permissionsBoundary
  • provider.iamRoleStatements -> provider.iam.role.statements
  • provider.iamManagedPolicies -> provider.iam.role.managedPolicies
  • provider.cfnRole -> provider.iam.deploymentRole

In addition iam.role.permissionBoundary can also be set at iam.role.permissionsBoundary (which matches CloudFormation property name).

 

API Gateway specific configuration

Deprecation code: AWS_API_GATEWAY_SPECIFIC_KEYS

Please use provider.apiGateway.apiKeys instead of provider.apiKeys. Please use provider.apiGateway.resourcePolicy instead of provider.resourcePolicy. Please use provider.apiGateway.usagePlan instead of provider.usagePlan.

Starting with v3.0.0, API Gateway-specific configuration keys apiKeys, resourcePolicy and usagePlan will be relocated from provider to provider.apiGateway.

 

Parameterized org, app, service, stage, and region usage

Org, app, service, stage, and region are required to resolve variables when logged in, variable resolution will not function without plaintext value. You may override values in serverless.yml for stage and region with command line arguments --stage and --region. The rest must be plain text.

 

Default provider.lambdaHashingVersion

Deprecation code: LAMBDA_HASHING_VERSION_V2

Resolution of lambda version hashes was improved with better (fixed deterministism issues) algorithm, which will be used starting with v3.0.0

You can adapt your services to use it now, by setting provider.lambdaHashingVersion to 20201221.

Notice: If you apply this on already deployed service without any changes to lambda code, you might encounter an error similar to the one below:

  Serverless Error ---------------------------------------

  An error occurred: FooLambdaVersion3IV5NZ3sE5T2UFimCOai2Tc6eCaW7yIYOP786U0Oc - A version for this Lambda function exists ( 11 ). Modify the function to create a new version..

It is an expected behavior. AWS complains here that received a different hash for very same lambda configuration. To workaround that, you need to modify your function(s) code and try to redeploy it again. One common approach is to modify an utility function that is used by all/most of your Lambda functions.

 

Automatic loading environment variables from .env and .env.{stage} files

Deprecation code: LOAD_VARIABLES_FROM_ENV_FILES

Starting with v3.0.0, environment variables will be automatically loaded from .env and .env.{stage} files if they're present. In addition, .env files will be excluded from package in order to avoid uploading sensitive data as a part of the package by mistake.

Adapt to this behavior now by adding useDotenv: true to service configuration.

Note that env vars are handled differently than with serverless-dotenv-plugin, check documentation for more info.

 

service property object notation

Deprecation code: SERVICE_OBJECT_NOTATION

Starting with v3.0.0, object notation for service property will no longer be recognized. Set service property directly with service name.

 

cloudFront event behavior.ForwardedValues property

Deprecation code: CLOUDFRONT_CACHE_BEHAVIOR_FORWARDED_VALUES_AND_TTL

Cloudfront cache behavior ForwardedValues, MinTTL, MaxTTL and DefaultTTL fields are deprecated. We recommend that you use a cache policy instead of this field. Please follow cache policy documentation for implementation details.

 

API Gateway naming will be changed to ${service}-${stage}

Deprecation code: AWS_API_GATEWAY_NAME_STARTING_WITH_SERVICE

Note: This deprecation notice has been removed and the behavior won't be enforced with next major. Below you can find original description of the deprecation. You can still continue using shouldStartNameWithService property to adapt to the new convention of API Gateway name.

Starting with v3.0.0, API Gateway naming will be changed from ${stage}-${service} to ${service}-${stage}.

Adapt to this convention now by setting provider.apiGateway.shouldStartNameWithService to true.

Eventually if you have a strong reason to stick to current convention, you may ensure it's kept after upgrading by setting: provider.apiName: ${sls:stage}

 

Support for alexaSkill event without appId is to be removed

Deprecation code: ALEXA_SKILL_EVENT_WITHOUT_APP_ID

Starting with v3.0.0, support for alexaSkill event without appId provided will be removed.

 

awsKmsKeyArn references

Deprecation code: AWS_KMS_KEY_ARN

Please use provider.kmsKeyArn and functions[].kmsKeyArn. service.awsKmsKeyArn and functions[].awsKmsKeyArn will be removed with v3.0.0

 

Defining extensions to nonexistent resources in resources.extensions

Deprecation code: RESOURCES_EXTENSIONS_REFERENCE_TO_NONEXISTENT_RESOURCE

Starting with v3.0.0, extensions to nonexistent resources in resources.extensions will throw an error instead of passing silently.

 

Support for enableLocalInstallationFallback setting is to be removed

Deprecation code: DISABLE_LOCAL_INSTALLATION_FALLBACK_SETTING

Starting with v3.0.0, framework will unconditionally run service local installation of serverless if it's found.

 

Fallback to a service local serverless installation

Deprecation code: LOCAL_INSTALLATION_FALLBACK

Starting with v2.0.0, globally installed CLI will by default run (fallback to) service local installation of serverless if it's found.

Adapt to this behavior now by adding enableLocalInstallationFallback: true to service configuration. Alternatively you may opt-out by setting it to false (note that'll be ineffective starting from v3.0.0, where support for this setting will be dropped, and CLI will unconditionally favor locally installed serverless installations when found)

 

AWS HTTP API timeout

Deprecation code: AWS_HTTP_API_TIMEOUT

provider.httpApi.timeout and functions[].events[].httpApi.timeout settings will no longer be recognized with v2.0.0.

Endpoints are configured to automatically follow timeout setting as configured on functions (with extra margin needed to process HTTP request on AWS side)

 

slss alias

Deprecation code: SLSS_CLI_ALIAS

Support for slss command will be removed with v2.0.0. Use sls or serverless instead.

 

AWS Lambda Function Destinations maximumEventAge & maximumRetryAttempts

Deprecation code: AWS_FUNCTION_DESTINATIONS_ASYNC_CONFIG

maximumEventAge and maximumRetryAttempts should be defined directly at function level. Support for those settings on destinations level, will be removed with v2.0.0

 

AWS HTTP API payload format

Deprecation code: AWS_HTTP_API_VERSION

Default HTTP API Payload version will be switched to 2.0 with next major release (For more details see payload format documentation)

Configure httpApi.payload explicitly to ensure seamless migration.

 

Outdated Node.js version

Deprecation code: OUTDATED_NODEJS

Support for Node.js v8 was dropped with v2 release, while support for Node.js v10 will be dropped with v3 release

Ensure to rely on at least Node.js v12 (It's recommended to use LTS version, as listed at https://nodejs.org/en/)

 

AWS ALB allowUnauthenticated

Deprecation code: AWS_ALB_ALLOW_UNAUTHENTICATED

Please use onUnauthenticatedRequest instead. allowUnauthenticated will be removed with v2.0.0

 

bin/serverless

Deprecation code: BIN_SERVERLESS

Please use bin/serverless.js instead. bin/serverless will be removed with v2.0.0

GitHub
Go to Github