schema stringclasses 471
values | key stringlengths 0 203 | description stringlengths 0 4.37k | object stringlengths 2 322k |
|---|---|---|---|
samcli.json | location | Template location (git, mercurial, http(s), zip, path). | {"type": "string"} |
samcli.json | runtime | Lambda runtime for application.
Runtimes: dotnet6, go1.x, java17, java11, java8.al2, java8, nodejs18.x, nodejs16.x, nodejs14.x, nodejs12.x, provided, provided.al2, python3.9, python3.8, python3.7, python3.11, python3.10, ruby3.2, ruby2.7 | {"type": "string", "enum": ["dotnet6", "go1.x", "java11", "java17", "java8", "java8.al2", "nodejs12.x", "nodejs14.x", "nodejs16.x", "nodejs18.x", "provided", "provided.al2", "python3.10", "python3.11", "python3.7", "python3.8", "python3.9", "ruby2.7", "ruby3.2"]} |
samcli.json | package_type | Lambda deployment package type.
Package Types: Zip, Image | {"type": "string", "enum": ["Image", "Zip"]} |
samcli.json | base_image | Lambda base image for deploying IMAGE based package type.
Base images: amazon/dotnet6-base, amazon/go-provided.al2-base, amazon/go1.x-base, amazon/java11-base, amazon/java17-base, amazon/java8-base, amazon/java8.al2-base, amazon/nodejs12.x-base, amazon/nodejs14.x-base, amazon/nodejs16.x-base, amazon/nodejs18.x-base, amazon/python3.10-base, amazon/python3.11-base, amazon/python3.7-base, amazon/python3.8-base, amazon/python3.9-base, amazon/ruby2.7-base, amazon/ruby3.2-base | {"type": "string", "enum": ["amazon/dotnet6-base", "amazon/go-provided.al2-base", "amazon/go1.x-base", "amazon/java11-base", "amazon/java17-base", "amazon/java8-base", "amazon/java8.al2-base", "amazon/nodejs12.x-base", "amazon/nodejs14.x-base", "amazon/nodejs16.x-base", "amazon/nodejs18.x-base", "amazon/python3.10-base", "amazon/python3.11-base", "amazon/python3.7-base", "amazon/python3.8-base", "amazon/python3.9-base", "amazon/ruby2.7-base", "amazon/ruby3.2-base"]} |
samcli.json | dependency_manager | Dependency manager for Lambda runtime.
Dependency managers: bundler, cli-package, gradle, maven, mod, npm, pip | {"type": "string", "enum": ["bundler", "cli-package", "gradle", "maven", "mod", "npm", "pip"]} |
samcli.json | output_dir | Directory to initialize AWS SAM application. | {"type": "string", "default": "."} |
samcli.json | name | Name of AWS SAM Application. | {"type": "string"} |
samcli.json | app_template | Identifier of the managed application template to be used. Alternatively, run '$sam init' without options for an interactive workflow. | {"type": "string"} |
samcli.json | no_input | Disable Cookiecutter prompting and accept default values defined in the cookiecutter config. | {"type": "boolean"} |
samcli.json | extra_context | Override custom parameters in the template's cookiecutter.json configuration e.g. {"customParam1": "customValue1", "customParam2":"customValue2"} | {"type": "string"} |
samcli.json | tracing | Enable AWS X-Ray tracing for application. | {"type": "boolean"} |
samcli.json | application_insights | Enable CloudWatch Application Insights monitoring for application. | {"type": "boolean"} |
samcli.json | beta_features | Enable/Disable beta features. | {"type": "boolean"} |
samcli.json | debug | Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps. | {"type": "boolean"} |
samcli.json | validate | Validate an AWS SAM Template. | {"properties": {"parameters": {"type": "object", "properties": {"template_file": {"type": "string", "default": "template.[yaml|yml|json]"}, "profile": {"type": "string"}, "region": {"type": "string"}, "beta_features": {"type": "boolean"}, "debug": {"type": "boolean"}, "lint": {"type": "boolean"}}}}, "required": ["parameters"]} |
samcli.json | parameters | Available parameters for the validate command:
* template_file:
AWS SAM template file.
* profile:
Select a specific profile from your credential file to get AWS credentials.
* region:
Set the AWS Region of the service. (e.g. us-east-1)
* beta_features:
Enable/Disable beta features.
* debug:
Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.
* lint:
Run linting validation on template through cfn-lint. Create a cfnlintrc config file to specify additional parameters. For more information, see: https://github.com/aws-cloudformation/cfn-lint | {"type": "object", "properties": {"template_file": {"type": "string", "default": "template.[yaml|yml|json]"}, "profile": {"type": "string"}, "region": {"type": "string"}, "beta_features": {"type": "boolean"}, "debug": {"type": "boolean"}, "lint": {"type": "boolean"}}} |
samcli.json | template_file | AWS SAM template file. | {"type": "string", "default": "template.[yaml|yml|json]"} |
samcli.json | profile | Select a specific profile from your credential file to get AWS credentials. | {"type": "string"} |
samcli.json | region | Set the AWS Region of the service. (e.g. us-east-1) | {"type": "string"} |
samcli.json | beta_features | Enable/Disable beta features. | {"type": "boolean"} |
samcli.json | debug | Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps. | {"type": "boolean"} |
samcli.json | lint | Run linting validation on template through cfn-lint. Create a cfnlintrc config file to specify additional parameters. For more information, see: https://github.com/aws-cloudformation/cfn-lint | {"type": "boolean"} |
samcli.json | build | Build AWS serverless function code. | {"properties": {"parameters": {"type": "object", "properties": {"hook_name": {"type": "string"}, "skip_prepare_infra": {"type": "boolean"}, "use_container": {"type": "boolean"}, "container_env_var": {"type": "string"}, "container_env_var_file": {"type": "string"}, "build_image": {"type": "string"}, "exclude": {"type": "string"}, "parallel": {"type": "boolean"}, "mount_with": {"type": "string", "default": "READ", "enum": ["READ", "WRITE"]}, "build_dir": {"type": "string", "default": ".aws-sam/build"}, "cache_dir": {"type": "string", "default": ".aws-sam/cache"}, "base_dir": {"type": "string"}, "manifest": {"type": "string"}, "cached": {"type": "boolean"}, "template_file": {"type": "string", "default": "template.[yaml|yml|json]"}, "parameter_overrides": {"type": ["array", "string"], "items": {"type": "string"}}, "skip_pull_image": {"type": "boolean"}, "docker_network": {"type": "string"}, "beta_features": {"type": "boolean"}, "debug": {"type": "boolean"}, "profile": {"type": "string"}, "region": {"type": "string"}}}}, "required": ["parameters"]} |
samcli.json | parameters | Available parameters for the build command:
* hook_name:
Hook package id to extend AWS SAM CLI commands functionality.
Example: `terraform` to extend AWS SAM CLI commands functionality to support terraform applications.
Available Hook Names: ['terraform']
* skip_prepare_infra:
Skip preparation stage when there are no infrastructure changes. Only used in conjunction with --hook-name.
* use_container:
Build functions within an AWS Lambda-like container.
* container_env_var:
Environment variables to be passed into build containers
Resource format (FuncName.VarName=Value) or Global format (VarName=Value).
Example: --container-env-var Func1.VAR1=value1 --container-env-var VAR2=value2
* container_env_var_file:
Environment variables json file (e.g., env_vars.json) to be passed to build containers.
* build_image:
Container image URIs for building functions/layers. You can specify for all functions/layers with just the image URI (--build-image public.ecr.aws/sam/build-nodejs18.x:latest). You can specify for each individual function with (--build-image FunctionLogicalID=public.ecr.aws/sam/build-nodejs18.x:latest). A combination of the two can be used. If a function does not have build image specified or an image URI for all functions, the default SAM CLI build images will be used.
* exclude:
Name of the resource(s) to exclude from AWS SAM CLI build.
* parallel:
Enable parallel builds for AWS SAM template's functions and layers.
* mount_with:
Specify mount mode for building functions/layers inside container. If it is mounted with write permissions, some files in source code directory may be changed/added by the build process. By default the source code directory is read only.
* build_dir:
Directory to store build artifacts.Note: This directory will be first removed before starting a build.
* cache_dir:
Directory to store cached artifacts. The default cache directory is .aws-sam/cache
* base_dir:
Resolve relative paths to function's source code with respect to this directory. Use this if SAM template and source code are not in same enclosing folder. By default, relative paths are resolved with respect to the SAM template's location.
* manifest:
Path to a custom dependency manifest. Example: custom-package.json
* cached:
Enable cached builds.Reuse build artifacts that have not changed from previous builds.
AWS SAM CLI evaluates if files in your project directory have changed.
Note: AWS SAM CLI does not evaluate changes made to third party modules that the project depends on.Example: Python function includes a requirements.txt file with the following entry requests=1.x and the latest request module version changes from 1.1 to 1.2, AWS SAM CLI will not pull the latest version until a non-cached build is run.
* template_file:
AWS SAM template file.
* parameter_overrides:
String that contains AWS CloudFormation parameter overrides encoded as key=value pairs.
* skip_pull_image:
Skip pulling down the latest Docker image for Lambda runtime.
* docker_network:
Name or ID of an existing docker network for AWS Lambda docker containers to connect to, along with the default bridge network. If not specified, the Lambda containers will only connect to the default bridge docker network.
* beta_features:
Enable/Disable beta features.
* debug:
Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.
* profile:
Select a specific profile from your credential file to get AWS credentials.
* region:
Set the AWS Region of the service. (e.g. us-east-1) | {"type": "object", "properties": {"hook_name": {"type": "string"}, "skip_prepare_infra": {"type": "boolean"}, "use_container": {"type": "boolean"}, "container_env_var": {"type": "string"}, "container_env_var_file": {"type": "string"}, "build_image": {"type": "string"}, "exclude": {"type": "string"}, "parallel": {"type": "boolean"}, "mount_with": {"type": "string", "default": "READ", "enum": ["READ", "WRITE"]}, "build_dir": {"type": "string", "default": ".aws-sam/build"}, "cache_dir": {"type": "string", "default": ".aws-sam/cache"}, "base_dir": {"type": "string"}, "manifest": {"type": "string"}, "cached": {"type": "boolean"}, "template_file": {"type": "string", "default": "template.[yaml|yml|json]"}, "parameter_overrides": {"type": ["array", "string"], "items": {"type": "string"}}, "skip_pull_image": {"type": "boolean"}, "docker_network": {"type": "string"}, "beta_features": {"type": "boolean"}, "debug": {"type": "boolean"}, "profile": {"type": "string"}, "region": {"type": "string"}}} |
samcli.json | hook_name | Hook package id to extend AWS SAM CLI commands functionality.
Example: `terraform` to extend AWS SAM CLI commands functionality to support terraform applications.
Available Hook Names: ['terraform'] | {"type": "string"} |
samcli.json | skip_prepare_infra | Skip preparation stage when there are no infrastructure changes. Only used in conjunction with --hook-name. | {"type": "boolean"} |
samcli.json | use_container | Build functions within an AWS Lambda-like container. | {"type": "boolean"} |
samcli.json | container_env_var | Environment variables to be passed into build containers
Resource format (FuncName.VarName=Value) or Global format (VarName=Value).
Example: --container-env-var Func1.VAR1=value1 --container-env-var VAR2=value2 | {"type": "string"} |
samcli.json | container_env_var_file | Environment variables json file (e.g., env_vars.json) to be passed to build containers. | {"type": "string"} |
samcli.json | build_image | Container image URIs for building functions/layers. You can specify for all functions/layers with just the image URI (--build-image public.ecr.aws/sam/build-nodejs18.x:latest). You can specify for each individual function with (--build-image FunctionLogicalID=public.ecr.aws/sam/build-nodejs18.x:latest). A combination of the two can be used. If a function does not have build image specified or an image URI for all functions, the default SAM CLI build images will be used. | {"type": "string"} |
samcli.json | exclude | Name of the resource(s) to exclude from AWS SAM CLI build. | {"type": "string"} |
samcli.json | parallel | Enable parallel builds for AWS SAM template's functions and layers. | {"type": "boolean"} |
samcli.json | mount_with | Specify mount mode for building functions/layers inside container. If it is mounted with write permissions, some files in source code directory may be changed/added by the build process. By default the source code directory is read only. | {"type": "string", "default": "READ", "enum": ["READ", "WRITE"]} |
samcli.json | build_dir | Directory to store build artifacts.Note: This directory will be first removed before starting a build. | {"type": "string", "default": ".aws-sam/build"} |
samcli.json | cache_dir | Directory to store cached artifacts. The default cache directory is .aws-sam/cache | {"type": "string", "default": ".aws-sam/cache"} |
samcli.json | base_dir | Resolve relative paths to function's source code with respect to this directory. Use this if SAM template and source code are not in same enclosing folder. By default, relative paths are resolved with respect to the SAM template's location. | {"type": "string"} |
samcli.json | manifest | Path to a custom dependency manifest. Example: custom-package.json | {"type": "string"} |
samcli.json | cached | Enable cached builds.Reuse build artifacts that have not changed from previous builds.
AWS SAM CLI evaluates if files in your project directory have changed.
Note: AWS SAM CLI does not evaluate changes made to third party modules that the project depends on.Example: Python function includes a requirements.txt file with the following entry requests=1.x and the latest request module version changes from 1.1 to 1.2, AWS SAM CLI will not pull the latest version until a non-cached build is run. | {"type": "boolean"} |
samcli.json | template_file | AWS SAM template file. | {"type": "string", "default": "template.[yaml|yml|json]"} |
samcli.json | parameter_overrides | String that contains AWS CloudFormation parameter overrides encoded as key=value pairs. | {"type": ["array", "string"], "items": {"type": "string"}} |
samcli.json | skip_pull_image | Skip pulling down the latest Docker image for Lambda runtime. | {"type": "boolean"} |
samcli.json | docker_network | Name or ID of an existing docker network for AWS Lambda docker containers to connect to, along with the default bridge network. If not specified, the Lambda containers will only connect to the default bridge docker network. | {"type": "string"} |
samcli.json | beta_features | Enable/Disable beta features. | {"type": "boolean"} |
samcli.json | debug | Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps. | {"type": "boolean"} |
samcli.json | profile | Select a specific profile from your credential file to get AWS credentials. | {"type": "string"} |
samcli.json | region | Set the AWS Region of the service. (e.g. us-east-1) | {"type": "string"} |
samcli.json | local_invoke | Invoke AWS serverless functions locally. | {"properties": {"parameters": {"type": "object", "properties": {"hook_name": {"type": "string"}, "skip_prepare_infra": {"type": "boolean"}, "event": {"type": "string"}, "no_event": {"type": "boolean", "default": true}, "template_file": {"type": "string", "default": "template.[yaml|yml|json]"}, "env_vars": {"type": "string"}, "parameter_overrides": {"type": ["array", "string"], "items": {"type": "string"}}, "debug_port": {"type": "integer"}, "debugger_path": {"type": "string"}, "debug_args": {"type": "string"}, "container_env_vars": {"type": "string"}, "docker_volume_basedir": {"type": "string"}, "log_file": {"type": "string"}, "layer_cache_basedir": {"type": "string"}, "skip_pull_image": {"type": "boolean"}, "docker_network": {"type": "string"}, "force_image_build": {"type": "boolean"}, "shutdown": {"type": "boolean"}, "container_host": {"type": "string", "default": "localhost"}, "container_host_interface": {"type": "string", "default": "127.0.0.1"}, "invoke_image": {"type": "string"}, "beta_features": {"type": "boolean"}, "debug": {"type": "boolean"}, "profile": {"type": "string"}, "region": {"type": "string"}}}}, "required": ["parameters"]} |
samcli.json | parameters | Available parameters for the local invoke command:
* hook_name:
Hook package id to extend AWS SAM CLI commands functionality.
Example: `terraform` to extend AWS SAM CLI commands functionality to support terraform applications.
Available Hook Names: ['terraform']
* skip_prepare_infra:
Skip preparation stage when there are no infrastructure changes. Only used in conjunction with --hook-name.
* event:
JSON file containing event data passed to the Lambda function during invoke. If this option is not specified, no event is assumed. Pass in the value '-' to input JSON via stdin
* no_event:
DEPRECATED: By default no event is assumed.
* template_file:
AWS SAM template which references built artifacts for resources in the template. (if applicable)
* env_vars:
JSON file containing values for Lambda function's environment variables.
* parameter_overrides:
String that contains AWS CloudFormation parameter overrides encoded as key=value pairs.
* debug_port:
When specified, Lambda function container will start in debug mode and will expose this port on localhost.
* debugger_path:
Host path to a debugger that will be mounted into the Lambda container.
* debug_args:
Additional arguments to be passed to the debugger.
* container_env_vars:
JSON file containing environment variables to be set within the container environment
* docker_volume_basedir:
Specify the location basedir where the SAM template exists. If Docker is running on a remote machine, Path of the SAM template must be mounted on the Docker machine and modified to match the remote machine.
* log_file:
File to capture output logs.
* layer_cache_basedir:
Specify the location basedir where the lambda layers used by the template will be downloaded to.
* skip_pull_image:
Skip pulling down the latest Docker image for Lambda runtime.
* docker_network:
Name or ID of an existing docker network for AWS Lambda docker containers to connect to, along with the default bridge network. If not specified, the Lambda containers will only connect to the default bridge docker network.
* force_image_build:
Force rebuilding the image used for invoking functions with layers.
* shutdown:
Emulate a shutdown event after invoke completes, to test extension handling of shutdown behavior.
* container_host:
Host of locally emulated Lambda container. This option is useful when the container runs on a different host than AWS SAM CLI. For example, if one wants to run AWS SAM CLI in a Docker container on macOS, this option could specify `host.docker.internal`
* container_host_interface:
IP address of the host network interface that container ports should bind to. Use 0.0.0.0 to bind to all interfaces.
* invoke_image:
Container image URIs for invoking functions or starting api and function. One can specify the image URI used for the local function invocation (--invoke-image public.ecr.aws/sam/build-nodejs14.x:latest). One can also specify for each individual function with (--invoke-image Function1=public.ecr.aws/sam/build-nodejs14.x:latest). If a function does not have invoke image specified, the default AWS SAM CLI emulation image will be used.
* beta_features:
Enable/Disable beta features.
* debug:
Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.
* profile:
Select a specific profile from your credential file to get AWS credentials.
* region:
Set the AWS Region of the service. (e.g. us-east-1) | {"type": "object", "properties": {"hook_name": {"type": "string"}, "skip_prepare_infra": {"type": "boolean"}, "event": {"type": "string"}, "no_event": {"type": "boolean", "default": true}, "template_file": {"type": "string", "default": "template.[yaml|yml|json]"}, "env_vars": {"type": "string"}, "parameter_overrides": {"type": ["array", "string"], "items": {"type": "string"}}, "debug_port": {"type": "integer"}, "debugger_path": {"type": "string"}, "debug_args": {"type": "string"}, "container_env_vars": {"type": "string"}, "docker_volume_basedir": {"type": "string"}, "log_file": {"type": "string"}, "layer_cache_basedir": {"type": "string"}, "skip_pull_image": {"type": "boolean"}, "docker_network": {"type": "string"}, "force_image_build": {"type": "boolean"}, "shutdown": {"type": "boolean"}, "container_host": {"type": "string", "default": "localhost"}, "container_host_interface": {"type": "string", "default": "127.0.0.1"}, "invoke_image": {"type": "string"}, "beta_features": {"type": "boolean"}, "debug": {"type": "boolean"}, "profile": {"type": "string"}, "region": {"type": "string"}}} |
samcli.json | hook_name | Hook package id to extend AWS SAM CLI commands functionality.
Example: `terraform` to extend AWS SAM CLI commands functionality to support terraform applications.
Available Hook Names: ['terraform'] | {"type": "string"} |
samcli.json | skip_prepare_infra | Skip preparation stage when there are no infrastructure changes. Only used in conjunction with --hook-name. | {"type": "boolean"} |
samcli.json | event | JSON file containing event data passed to the Lambda function during invoke. If this option is not specified, no event is assumed. Pass in the value '-' to input JSON via stdin | {"type": "string"} |
samcli.json | no_event | DEPRECATED: By default no event is assumed. | {"type": "boolean", "default": true} |
samcli.json | template_file | AWS SAM template which references built artifacts for resources in the template. (if applicable) | {"type": "string", "default": "template.[yaml|yml|json]"} |
samcli.json | env_vars | JSON file containing values for Lambda function's environment variables. | {"type": "string"} |
samcli.json | parameter_overrides | String that contains AWS CloudFormation parameter overrides encoded as key=value pairs. | {"type": ["array", "string"], "items": {"type": "string"}} |
samcli.json | debug_port | When specified, Lambda function container will start in debug mode and will expose this port on localhost. | {"type": "integer"} |
samcli.json | debugger_path | Host path to a debugger that will be mounted into the Lambda container. | {"type": "string"} |
samcli.json | debug_args | Additional arguments to be passed to the debugger. | {"type": "string"} |
samcli.json | container_env_vars | JSON file containing environment variables to be set within the container environment | {"type": "string"} |
samcli.json | docker_volume_basedir | Specify the location basedir where the SAM template exists. If Docker is running on a remote machine, Path of the SAM template must be mounted on the Docker machine and modified to match the remote machine. | {"type": "string"} |
samcli.json | log_file | File to capture output logs. | {"type": "string"} |
samcli.json | layer_cache_basedir | Specify the location basedir where the lambda layers used by the template will be downloaded to. | {"type": "string"} |
samcli.json | skip_pull_image | Skip pulling down the latest Docker image for Lambda runtime. | {"type": "boolean"} |
samcli.json | docker_network | Name or ID of an existing docker network for AWS Lambda docker containers to connect to, along with the default bridge network. If not specified, the Lambda containers will only connect to the default bridge docker network. | {"type": "string"} |
samcli.json | force_image_build | Force rebuilding the image used for invoking functions with layers. | {"type": "boolean"} |
samcli.json | shutdown | Emulate a shutdown event after invoke completes, to test extension handling of shutdown behavior. | {"type": "boolean"} |
samcli.json | container_host | Host of locally emulated Lambda container. This option is useful when the container runs on a different host than AWS SAM CLI. For example, if one wants to run AWS SAM CLI in a Docker container on macOS, this option could specify `host.docker.internal` | {"type": "string", "default": "localhost"} |
samcli.json | container_host_interface | IP address of the host network interface that container ports should bind to. Use 0.0.0.0 to bind to all interfaces. | {"type": "string", "default": "127.0.0.1"} |
samcli.json | invoke_image | Container image URIs for invoking functions or starting api and function. One can specify the image URI used for the local function invocation (--invoke-image public.ecr.aws/sam/build-nodejs14.x:latest). One can also specify for each individual function with (--invoke-image Function1=public.ecr.aws/sam/build-nodejs14.x:latest). If a function does not have invoke image specified, the default AWS SAM CLI emulation image will be used. | {"type": "string"} |
samcli.json | beta_features | Enable/Disable beta features. | {"type": "boolean"} |
samcli.json | debug | Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps. | {"type": "boolean"} |
samcli.json | profile | Select a specific profile from your credential file to get AWS credentials. | {"type": "string"} |
samcli.json | region | Set the AWS Region of the service. (e.g. us-east-1) | {"type": "string"} |
samcli.json | local_start_api | Run & test AWS serverless functions locally as a HTTP API. | {"properties": {"parameters": {"type": "object", "properties": {"hook_name": {"type": "string"}, "skip_prepare_infra": {"type": "boolean"}, "host": {"type": "string", "default": "127.0.0.1"}, "port": {"type": "integer", "default": 3000}, "static_dir": {"type": "string", "default": "public"}, "template_file": {"type": "string", "default": "template.[yaml|yml|json]"}, "env_vars": {"type": "string"}, "parameter_overrides": {"type": ["array", "string"], "items": {"type": "string"}}, "debug_port": {"type": "integer"}, "debugger_path": {"type": "string"}, "debug_args": {"type": "string"}, "container_env_vars": {"type": "string"}, "docker_volume_basedir": {"type": "string"}, "log_file": {"type": "string"}, "layer_cache_basedir": {"type": "string"}, "skip_pull_image": {"type": "boolean"}, "docker_network": {"type": "string"}, "force_image_build": {"type": "boolean"}, "warm_containers": {"type": "string", "enum": ["EAGER", "LAZY"]}, "debug_function": {"type": "string"}, "shutdown": {"type": "boolean"}, "container_host": {"type": "string", "default": "localhost"}, "container_host_interface": {"type": "string", "default": "127.0.0.1"}, "invoke_image": {"type": "string"}, "beta_features": {"type": "boolean"}, "debug": {"type": "boolean"}, "profile": {"type": "string"}, "region": {"type": "string"}}}}, "required": ["parameters"]} |
samcli.json | parameters | Available parameters for the local start api command:
* hook_name:
Hook package id to extend AWS SAM CLI commands functionality.
Example: `terraform` to extend AWS SAM CLI commands functionality to support terraform applications.
Available Hook Names: ['terraform']
* skip_prepare_infra:
Skip preparation stage when there are no infrastructure changes. Only used in conjunction with --hook-name.
* host:
Local hostname or IP address to bind to (default: '127.0.0.1')
* port:
Local port number to listen on (default: '3000')
* static_dir:
Any static assets (e.g. CSS/Javascript/HTML) files located in this directory will be presented at /
* template_file:
AWS SAM template which references built artifacts for resources in the template. (if applicable)
* env_vars:
JSON file containing values for Lambda function's environment variables.
* parameter_overrides:
String that contains AWS CloudFormation parameter overrides encoded as key=value pairs.
* debug_port:
When specified, Lambda function container will start in debug mode and will expose this port on localhost.
* debugger_path:
Host path to a debugger that will be mounted into the Lambda container.
* debug_args:
Additional arguments to be passed to the debugger.
* container_env_vars:
JSON file containing environment variables to be set within the container environment
* docker_volume_basedir:
Specify the location basedir where the SAM template exists. If Docker is running on a remote machine, Path of the SAM template must be mounted on the Docker machine and modified to match the remote machine.
* log_file:
File to capture output logs.
* layer_cache_basedir:
Specify the location basedir where the lambda layers used by the template will be downloaded to.
* skip_pull_image:
Skip pulling down the latest Docker image for Lambda runtime.
* docker_network:
Name or ID of an existing docker network for AWS Lambda docker containers to connect to, along with the default bridge network. If not specified, the Lambda containers will only connect to the default bridge docker network.
* force_image_build:
Force rebuilding the image used for invoking functions with layers.
* warm_containers:
Optional. Specifies how AWS SAM CLI manages
containers for each function.
Two modes are available:
EAGER: Containers for all functions are
loaded at startup and persist between
invocations.
LAZY: Containers are only loaded when each
function is first invoked. Those containers
persist for additional invocations.
* debug_function:
Optional. Specifies the Lambda Function logicalId to apply debug options to when --warm-containers is specified. This parameter applies to --debug-port, --debugger-path, and --debug-args.
* shutdown:
Emulate a shutdown event after invoke completes, to test extension handling of shutdown behavior.
* container_host:
Host of locally emulated Lambda container. This option is useful when the container runs on a different host than AWS SAM CLI. For example, if one wants to run AWS SAM CLI in a Docker container on macOS, this option could specify `host.docker.internal`
* container_host_interface:
IP address of the host network interface that container ports should bind to. Use 0.0.0.0 to bind to all interfaces.
* invoke_image:
Container image URIs for invoking functions or starting api and function. One can specify the image URI used for the local function invocation (--invoke-image public.ecr.aws/sam/build-nodejs14.x:latest). One can also specify for each individual function with (--invoke-image Function1=public.ecr.aws/sam/build-nodejs14.x:latest). If a function does not have invoke image specified, the default AWS SAM CLI emulation image will be used.
* beta_features:
Enable/Disable beta features.
* debug:
Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.
* profile:
Select a specific profile from your credential file to get AWS credentials.
* region:
Set the AWS Region of the service. (e.g. us-east-1) | {"type": "object", "properties": {"hook_name": {"type": "string"}, "skip_prepare_infra": {"type": "boolean"}, "host": {"type": "string", "default": "127.0.0.1"}, "port": {"type": "integer", "default": 3000}, "static_dir": {"type": "string", "default": "public"}, "template_file": {"type": "string", "default": "template.[yaml|yml|json]"}, "env_vars": {"type": "string"}, "parameter_overrides": {"type": ["array", "string"], "items": {"type": "string"}}, "debug_port": {"type": "integer"}, "debugger_path": {"type": "string"}, "debug_args": {"type": "string"}, "container_env_vars": {"type": "string"}, "docker_volume_basedir": {"type": "string"}, "log_file": {"type": "string"}, "layer_cache_basedir": {"type": "string"}, "skip_pull_image": {"type": "boolean"}, "docker_network": {"type": "string"}, "force_image_build": {"type": "boolean"}, "warm_containers": {"type": "string", "enum": ["EAGER", "LAZY"]}, "debug_function": {"type": "string"}, "shutdown": {"type": "boolean"}, "container_host": {"type": "string", "default": "localhost"}, "container_host_interface": {"type": "string", "default": "127.0.0.1"}, "invoke_image": {"type": "string"}, "beta_features": {"type": "boolean"}, "debug": {"type": "boolean"}, "profile": {"type": "string"}, "region": {"type": "string"}}} |
samcli.json | hook_name | Hook package id to extend AWS SAM CLI commands functionality.
Example: `terraform` to extend AWS SAM CLI commands functionality to support terraform applications.
Available Hook Names: ['terraform'] | {"type": "string"} |
samcli.json | skip_prepare_infra | Skip preparation stage when there are no infrastructure changes. Only used in conjunction with --hook-name. | {"type": "boolean"} |
samcli.json | host | Local hostname or IP address to bind to (default: '127.0.0.1') | {"type": "string", "default": "127.0.0.1"} |
samcli.json | port | Local port number to listen on (default: '3000') | {"type": "integer", "default": 3000} |
samcli.json | static_dir | Any static assets (e.g. CSS/Javascript/HTML) files located in this directory will be presented at / | {"type": "string", "default": "public"} |
samcli.json | template_file | AWS SAM template which references built artifacts for resources in the template. (if applicable) | {"type": "string", "default": "template.[yaml|yml|json]"} |
samcli.json | env_vars | JSON file containing values for Lambda function's environment variables. | {"type": "string"} |
samcli.json | parameter_overrides | String that contains AWS CloudFormation parameter overrides encoded as key=value pairs. | {"type": ["array", "string"], "items": {"type": "string"}} |
samcli.json | debug_port | When specified, Lambda function container will start in debug mode and will expose this port on localhost. | {"type": "integer"} |
samcli.json | debugger_path | Host path to a debugger that will be mounted into the Lambda container. | {"type": "string"} |
samcli.json | debug_args | Additional arguments to be passed to the debugger. | {"type": "string"} |
samcli.json | container_env_vars | JSON file containing environment variables to be set within the container environment | {"type": "string"} |
samcli.json | docker_volume_basedir | Specify the location basedir where the SAM template exists. If Docker is running on a remote machine, Path of the SAM template must be mounted on the Docker machine and modified to match the remote machine. | {"type": "string"} |
samcli.json | log_file | File to capture output logs. | {"type": "string"} |
samcli.json | layer_cache_basedir | Specify the location basedir where the lambda layers used by the template will be downloaded to. | {"type": "string"} |
samcli.json | skip_pull_image | Skip pulling down the latest Docker image for Lambda runtime. | {"type": "boolean"} |
samcli.json | docker_network | Name or ID of an existing docker network for AWS Lambda docker containers to connect to, along with the default bridge network. If not specified, the Lambda containers will only connect to the default bridge docker network. | {"type": "string"} |
samcli.json | force_image_build | Force rebuilding the image used for invoking functions with layers. | {"type": "boolean"} |
samcli.json | warm_containers | Optional. Specifies how AWS SAM CLI manages
containers for each function.
Two modes are available:
EAGER: Containers for all functions are
loaded at startup and persist between
invocations.
LAZY: Containers are only loaded when each
function is first invoked. Those containers
persist for additional invocations. | {"type": "string", "enum": ["EAGER", "LAZY"]} |
samcli.json | debug_function | Optional. Specifies the Lambda Function logicalId to apply debug options to when --warm-containers is specified. This parameter applies to --debug-port, --debugger-path, and --debug-args. | {"type": "string"} |
samcli.json | shutdown | Emulate a shutdown event after invoke completes, to test extension handling of shutdown behavior. | {"type": "boolean"} |
samcli.json | container_host | Host of locally emulated Lambda container. This option is useful when the container runs on a different host than AWS SAM CLI. For example, if one wants to run AWS SAM CLI in a Docker container on macOS, this option could specify `host.docker.internal` | {"type": "string", "default": "localhost"} |
samcli.json | container_host_interface | IP address of the host network interface that container ports should bind to. Use 0.0.0.0 to bind to all interfaces. | {"type": "string", "default": "127.0.0.1"} |
samcli.json | invoke_image | Container image URIs for invoking functions or starting api and function. One can specify the image URI used for the local function invocation (--invoke-image public.ecr.aws/sam/build-nodejs14.x:latest). One can also specify for each individual function with (--invoke-image Function1=public.ecr.aws/sam/build-nodejs14.x:latest). If a function does not have invoke image specified, the default AWS SAM CLI emulation image will be used. | {"type": "string"} |
samcli.json | beta_features | Enable/Disable beta features. | {"type": "boolean"} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.