Skip to content

Latest commit

 

History

History
74 lines (68 loc) · 5.12 KB

update.md

File metadata and controls

74 lines (68 loc) · 5.12 KB
Raw

update

Deploy a new version of the Lambda function using project files, update any associated web APIs

Usage

claudia update {OPTIONS}

Options

  • --version: (optional) A version alias to automatically assign to the new deployment

    • For example: development

  • --source: (optional) Directory with project files

    • Defaults to: current directory

  • --config: (optional) Config file containing the resource names

    • Defaults to: claudia.json

  • --timeout: (optional) The function execution time, in seconds, at which AWS Lambda should terminate the function

  • --runtime: (optional) Node.js runtime to use. For supported values, see http://docs.aws.amazon.com/lambda/latest/dg/API_CreateFunction.html

  • --memory: (optional) The amount of memory, in MB, your Lambda function is given. The value must be a multiple of 64 MB.

  • --arch: (optional) Specifies the desired architecture, either x86_64 or arm64. If this option is not provided, the architecture will not be modfied.

    • Introduced in version: 5.13.2

  • --no-optional-dependencies: (optional) Do not upload optional dependencies to Lambda.

  • --use-local-dependencies: (optional) Do not install dependencies, use local node_modules directory instead

  • --npm-options: (optional) Any additional options to pass on to NPM when installing packages. Check https://docs.npmjs.com/cli/install for more information

    • For example: --ignore-scripts
    • Introduced in version: 5.0.0

  • --cache-api-config: (optional) Name of the stage variable for storing the current API configuration signature. If set, it will also be used to check if the previously deployed configuration can be re-used and speed up deployment

    • For example: claudiaConfigCache

  • --post-package-script: (optional) the name of a NPM script to execute custom processing after claudia finished packaging your files. Note that development dependencies are not available at this point, but you can use npm uninstall to remove utility tools as part of this step.

    • For example: customNpmScript
    • Introduced in version: 5.0.0

  • --keep: (optional) keep the produced package archive on disk for troubleshooting purposes. If not set, the temporary files will be removed after the Lambda function is successfully created

  • --use-s3-bucket: (optional) The name of a S3 bucket that Claudia will use to upload the function code before installing in Lambda. You can use this to upload large functions over slower connections more reliably, and to leave a binary artifact after uploads for auditing purposes. If not set, the archive will be uploaded directly to Lambda.

    • For example: claudia-uploads

  • --s3-key: (optional) The key to which the function code will be uploaded in the s3 bucket referenced in --use-s3-bucket

    • For example: path/to/file.zip

  • --s3-sse: (optional) The type of Server Side Encryption applied to the S3 bucket referenced in --use-s3-bucket

    • For example: AES256

  • --update-env: (optional) comma-separated list of VAR=VALUE environment variables to set, merging with old variables

    • For example: S3BUCKET=testbucket,SNSQUEUE=testqueue

  • --set-env: (optional) comma-separated list of VAR=VALUE environment variables to set. replaces the whole set, removing old variables.

    • For example: S3BUCKET=testbucket,SNSQUEUE=testqueue

  • --update-env-from-json: (optional) file path to a JSON file containing environment variables to set, merging with old variables

    • For example: production-env.json

  • --set-env-from-json: (optional) file path to a JSON file containing environment variables to set. replaces the whole set, removing old variables.

    • For example: production-env.json

  • --env-kms-key-arn: (optional) KMS Key ARN to encrypt/decrypt environment variables

  • --layers: (optional) A comma-delimited list of Lambda layers to attach to this function. Setting this during an update replaces all previous layers.

    • For example: arn:aws:lambda:us-east-1:12345678:layer:ffmpeg:4

  • --add-layers: (optional) A comma-delimited list of additional Lambda layers to attach to this function. Setting this during an update leaves old layers in place, and just adds new layers.

    • For example: arn:aws:lambda:us-east-1:12345678:layer:ffmpeg:4

  • --remove-layers: (optional) A comma-delimited list of Lambda layers to remove from this function. It will not remove any layers apart from the ones specified in the argument.

    • For example: arn:aws:lambda:us-east-1:12345678:layer:ffmpeg:4

  • --dlq-sns: (optional) Dead letter queue SNS topic name or ARN

    • For example: arn:aws:sns:us-east-1:123456789012:my_corporate_topic

  • --skip-iam: (optional) Do not try to modify the IAM role for Lambda

    • For example: true

  • --aws-delay: (optional) number of milliseconds betweeen retrying AWS operations if they fail

    • For example: 3000
    • Defaults to: 5000

  • --aws-retries: (optional) number of times to retry AWS operations if they fail

    • For example: 15
    • Defaults to: 15