Skip to content

Latest commit

 

History

History
62 lines (44 loc) · 4.59 KB

sam-cli-command-reference-sam-build.md

File metadata and controls

62 lines (44 loc) · 4.59 KB

sam build

Builds a serverless application, and prepares it for subsequent steps in your workflow, like locally testing the application, or deploying it to the AWS Cloud.

The sam build command processes your AWS SAM template file, application code, and any applicable language-specific files and dependencies, and copies build artifacts in the format and location expected by subsequent steps in your workflow. You specify dependencies in a manifest file that you include in your application, such as requirements.txt for Python functions, or package.json for Node.js functions.

If a resource includes a Metadata resource attribute with a BuildMethod entry, sam build builds that resource according to the value of the BuildMethod entry. Valid values for BuildMethod are identifiers for an AWS Lambda runtime, or makefile:

  • AWS Lambda runtime identifier. Build the resource against a Lambda runtime. For the list of supported runtime identifiers, see AWS Lambda runtimes.
  • **makefile. **You must have a makefile that includes a build target named build-resource-logical-id. In this case, sam build executes the commands of the build target.

You can use the Metadata resource attribute with a BuildMethod entry to build layers and custom runtimes. For information about building layers, see Building Layers. For information about building custom runtimes, see Building Custom Runtimes.

To see an end-to-end example that uses this command, including locally testing and deploying to the AWS Cloud, see Tutorial: Deploying a Hello World Application. The sam build command is part of Step 2: Build Your Application.

Usage:

sam build [OPTIONS] [RESOURCE_LOGICAL_ID]

Examples:

To use this command, update your SAM template to specify the path
to your function's source code in the resource's Code or CodeUri property.

To build on your workstation, run this command in folder containing
SAM template. Built artifacts will be written to .aws-sam/build folder
$ sam build
 
To build inside a AWS Lambda like Docker container
$ sam build --use-container
  
To build & run your functions locally
$ sam build && sam local invoke
  
To build and package for deployment
$ sam build && sam package --s3-bucket <bucketname>

To build the 'MyFunction' resource
$ sam build MyFunction

Options:

Option Description
-b, --build-dir DIRECTORY The path to a folder where the built artifacts are stored. This directory and all of its content is removed with this option.
-s, --base-dir DIRECTORY Resolves relative paths to the function's source code with respect to this folder. Use this option if the AWS SAM template and your source code aren't in the same folder. By default, relative paths are resolved with respect to the template's location.
-u, --use-container If your functions depend on packages that have natively compiled dependencies, use this flag to build your function inside an AWS Lambda-like Docker container.
-m, --manifest PATH The path to a custom dependency manifest file (for example, package.json) to use instead of the default.
-t, --template PATH The AWS SAM template file [default: template.[yaml|yml]].
--parameter-overrides Optional. A string that contains AWS CloudFormation parameter overrides, encoded as key-value pairs. Use the same format as the AWS CLI—for example, 'ParameterKey=KeyPairName, ParameterValue=MyKey ParameterKey=InstanceType, ParameterValue=t1.micro'.
--skip-pull-image Specifies whether the command should skip pulling down the latest Docker image for the Lambda runtime.
--docker-network TEXT Specifies the name or ID of an existing Docker network that Lambda Docker containers should connect to, along with the default bridge network. If not specified, the Lambda containers connect only to the default bridge Docker network.
--profile TEXT Selects a specific profile from your credential file to get AWS credentials.
--region TEXT Sets the AWS Region of the service (for example, us-east-1).
--debug Turns on debug logging to print debug message generated by the AWS SAM CLI.
--help Shows this message and exits.