description:
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


description:
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


description: Directory to initialize AWS SAM application.


key: name

description: Name of AWS SAM Application.


description: Identifier of the managed application template to be used. Alternatively, run '$sam init' without options for an interactive workflow.


description: Disable Cookiecutter prompting and accept default values defined in the cookiecutter config.

type: boolean


description: Override custom parameters in the template's cookiecutter.json configuration e.g. {"customParam1": "customValue1", "customParam2":"customValue2"}


key: tracing

description: Enable AWS X-Ray tracing for application.


description: Enable CloudWatch Application Insights monitoring for application.


description: Enable/Disable beta features.


key: debug

description: Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.


key: validate

description: Validate an AWS SAM Template.

type: object


key: parameters

description:
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


description: AWS SAM template file.


key: profile

description: Select a specific profile from your credential file to get AWS credentials.


key: region

description: Set the AWS Region of the service. (e.g. us-east-1)


key: lint

description: 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


key: build

description: Build AWS serverless function code.

default: READ

enum: READ WRITE

default: .aws-sam/build

default: .aws-sam/cache

type: array string


description:
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)


description:
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']


description: Skip preparation stage when there are no infrastructure changes. Only used in conjunction with --hook-name.


description: Build functions within an AWS Lambda-like container.


description:
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


description: Environment variables json file (e.g., env_vars.json) to be passed to build containers.


description: 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.


key: exclude

description: Name of the resource(s) to exclude from AWS SAM CLI build.


key: parallel

description: Enable parallel builds for AWS SAM template's functions and layers.


description: 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.


description: Directory to store build artifacts.Note: This directory will be first removed before starting a build.


description: Directory to store cached artifacts. The default cache directory is .aws-sam/cache


description: 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.


key: manifest

description: Path to a custom dependency manifest. Example: custom-package.json


key: cached

description:
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.


description: AWS SAM template file.


description: String that contains AWS CloudFormation parameter overrides encoded as key=value pairs.


description: Skip pulling down the latest Docker image for Lambda runtime.


description: 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.


description: Enable/Disable beta features.


description: Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.


description: Select a specific profile from your credential file to get AWS credentials.


description: Set the AWS Region of the service. (e.g. us-east-1)


description: Invoke AWS serverless functions locally.

type: integer

default: localhost


description:
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)


description:
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']


description: Skip preparation stage when there are no infrastructure changes. Only used in conjunction with --hook-name.


key: event

description: 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


description: DEPRECATED: By default no event is assumed.


description: AWS SAM template which references built artifacts for resources in the template. (if applicable)


description: JSON file containing values for Lambda function's environment variables.


description: When specified, Lambda function container will start in debug mode and will expose this port on localhost.


description: Host path to a debugger that will be mounted into the Lambda container.


description: Additional arguments to be passed to the debugger.


description: JSON file containing environment variables to be set within the container environment


description: 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.


description: File to capture output logs.


description: Specify the location basedir where the lambda layers used by the template will be downloaded to.


description: Skip pulling down the latest Docker image for Lambda runtime.


description: 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.


description: Force rebuilding the image used for invoking functions with layers.


key: shutdown

description: Emulate a shutdown event after invoke completes, to test extension handling of shutdown behavior.


description: 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`


description: IP address of the host network interface that container ports should bind to. Use 0.0.0.0 to bind to all interfaces.


description: 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.


description: Enable/Disable beta features.


description: Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.


description: Select a specific profile from your credential file to get AWS credentials.


description: Set the AWS Region of the service. (e.g. us-east-1)


description: Run & test AWS serverless functions locally as a HTTP API.

default: public

enum: EAGER LAZY


description:
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)


description:
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']


description: Skip preparation stage when there are no infrastructure changes. Only used in conjunction with --hook-name.


key: host

description: Local hostname or IP address to bind to (default: '127.0.0.1')


key: port

description: Local port number to listen on (default: '3000')


description: Any static assets (e.g. CSS/Javascript/HTML) files located in this directory will be presented at /


description: AWS SAM template which references built artifacts for resources in the template. (if applicable)


description: JSON file containing values for Lambda function's environment variables.


description: String that contains AWS CloudFormation parameter overrides encoded as key=value pairs.


description: When specified, Lambda function container will start in debug mode and will expose this port on localhost.


description: Host path to a debugger that will be mounted into the Lambda container.


description: Additional arguments to be passed to the debugger.


description: JSON file containing environment variables to be set within the container environment


description: 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.


description: File to capture output logs.


description: Specify the location basedir where the lambda layers used by the template will be downloaded to.


description: Skip pulling down the latest Docker image for Lambda runtime.


description: 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.


description: Force rebuilding the image used for invoking functions with layers.


description:
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.


description: 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.


description: Emulate a shutdown event after invoke completes, to test extension handling of shutdown behavior.


description: 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`


description: IP address of the host network interface that container ports should bind to. Use 0.0.0.0 to bind to all interfaces.


description: 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.


description: Enable/Disable beta features.


description: Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.


description: Select a specific profile from your credential file to get AWS credentials.


description: Set the AWS Region of the service. (e.g. us-east-1)


description: Generate events for Lambda functions.


description:
Available parameters for the local generate event command:
*


description: Emulate AWS serverless functions locally.


description:
Available parameters for the local start lambda 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: '3001')
* 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)


description:
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']


description: Skip preparation stage when there are no infrastructure changes. Only used in conjunction with --hook-name.


description: Local hostname or IP address to bind to (default: '127.0.0.1')


description: Local port number to listen on (default: '3001')


description: AWS SAM template which references built artifacts for resources in the template. (if applicable)


description: JSON file containing values for Lambda function's environment variables.


description: String that contains AWS CloudFormation parameter overrides encoded as key=value pairs.


description: When specified, Lambda function container will start in debug mode and will expose this port on localhost.


description: Host path to a debugger that will be mounted into the Lambda container.


description: Additional arguments to be passed to the debugger.


description: JSON file containing environment variables to be set within the container environment


description: 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.


description: File to capture output logs.


description: Specify the location basedir where the lambda layers used by the template will be downloaded to.


description: Skip pulling down the latest Docker image for Lambda runtime.


description: 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.


description: Force rebuilding the image used for invoking functions with layers.


description:
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.


description: 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.


description: Emulate a shutdown event after invoke completes, to test extension handling of shutdown behavior.


description: 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`


description: IP address of the host network interface that container ports should bind to. Use 0.0.0.0 to bind to all interfaces.


description: 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.


description: Enable/Disable beta features.


description: Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.


description: Select a specific profile from your credential file to get AWS credentials.


description: Set the AWS Region of the service. (e.g. us-east-1)


key: package

description: Package an AWS SAM application.

type: array


description:
Available parameters for the package command:
* template_file:
AWS SAM template which references built artifacts for resources in the template. (if applicable)
* output_template_file:
The path to the file where the command writes the output AWS CloudFormation template. If you don't specify a path, the command writes the template to the standard output.
* s3_bucket:
AWS S3 bucket where artifacts referenced in the template are uploaded.
* image_repository:
AWS ECR repository URI where artifacts referenced in the template are uploaded.
* image_repositories:
Mapping of Function Logical ID to AWS ECR Repository URI.

Example: Function_Logical_ID=ECR_Repo_Uri
This option can be specified multiple times.
* s3_prefix:
Prefix name that is added to the artifact's name when it is uploaded to the AWS S3 bucket.
* kms_key_id:
The ID of an AWS KMS key that is used to encrypt artifacts that are at rest in the AWS S3 bucket.
* use_json:
Indicates whether to use JSON as the format for the output AWS CloudFormation template. YAML is used by default.
* force_upload:
Indicates whether to override existing files in the S3 bucket. Specify this flag to upload artifacts even if they match existing artifacts in the S3 bucket.
* resolve_s3:
Automatically resolve AWS S3 bucket for non-guided deployments. Enabling this option will also create a managed default AWS S3 bucket for you. If one does not provide a --s3-bucket value, the managed bucket will be used. Do not use --guided with this option.
* metadata:
Map of metadata to attach to ALL the artifacts that are referenced in the template.
* signing_profiles:
A string that contains Code Sign configuration parameters as FunctionOrLayerNameToSign=SigningProfileName:SigningProfileOwner Since signing profile owner is optional, it could also be written as FunctionOrLayerNameToSign=SigningProfileName
* no_progressbar:
Does not showcase a progress bar when uploading artifacts to S3 and pushing docker images to ECR
* 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)


description: AWS SAM template which references built artifacts for resources in the template. (if applicable)


description: The path to the file where the command writes the output AWS CloudFormation template. If you don't specify a path, the command writes the template to the standard output.


description: AWS S3 bucket where artifacts referenced in the template are uploaded.


description: AWS ECR repository URI where artifacts referenced in the template are uploaded.


description:
Mapping of Function Logical ID to AWS ECR Repository URI.

Example: Function_Logical_ID=ECR_Repo_Uri
This option can be specified multiple times.


description: Prefix name that is added to the artifact's name when it is uploaded to the AWS S3 bucket.


description: The ID of an AWS KMS key that is used to encrypt artifacts that are at rest in the AWS S3 bucket.


description: Indicates whether to use JSON as the format for the output AWS CloudFormation template. YAML is used by default.


description: Indicates whether to override existing files in the S3 bucket. Specify this flag to upload artifacts even if they match existing artifacts in the S3 bucket.


description: Automatically resolve AWS S3 bucket for non-guided deployments. Enabling this option will also create a managed default AWS S3 bucket for you. If one does not provide a --s3-bucket value, the managed bucket will be used. Do not use --guided with this option.


key: metadata

description: Map of metadata to attach to ALL the artifacts that are referenced in the template.


description: A string that contains Code Sign configuration parameters as FunctionOrLayerNameToSign=SigningProfileName:SigningProfileOwner Since signing profile owner is optional, it could also be written as FunctionOrLayerNameToSign=SigningProfileName


description: Does not showcase a progress bar when uploading artifacts to S3 and pushing docker images to ECR


description: Enable/Disable beta features.


key: debug

description: Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.


description: Select a specific profile from your credential file to get AWS credentials.


description: Set the AWS Region of the service. (e.g. us-east-1)


key: deploy

description: The sam deploy command creates a Cloudformation Stack and deploys your resources.

default: ROLLBACK

enum: DELETE DO_NOTHING ROLLBACK


key: parameters

description:
Available parameters for the deploy command:
* guided:
Specify this flag to allow SAM CLI to guide you through the deployment using guided prompts.
* template_file:
AWS SAM template which references built artifacts for resources in the template. (if applicable)
* no_execute_changeset:
Indicates whether to execute the change set. Specify this flag to view stack changes before executing the change set.
* fail_on_empty_changeset:
Specify whether AWS SAM CLI should return a non-zero exit code if there are no changes to be made to the stack. Defaults to a non-zero exit code.
* confirm_changeset:
Prompt to confirm if the computed changeset is to be deployed by SAM CLI.
* disable_rollback:
Preserves the state of previously provisioned resources when an operation fails.
* on_failure:
Provide an action to determine what will happen when a stack fails to create. Three actions are available:

- ROLLBACK: This will rollback a stack to a previous known good state.

- DELETE: The stack will rollback to a previous state if one exists, otherwise the stack will be deleted.

- DO_NOTHING: The stack will not rollback or delete, this is the same as disabling rollback.

Default behaviour is ROLLBACK.

This option is mutually exclusive with --disable-rollback/--no-disable-rollback. You can provide
--on-failure or --disable-rollback/--no-disable-rollback but not both at the same time.
* stack_name:
Name of the AWS CloudFormation stack.
* s3_bucket:
AWS S3 bucket where artifacts referenced in the template are uploaded.
* image_repository:
AWS ECR repository URI where artifacts referenced in the template are uploaded.
* image_repositories:
Mapping of Function Logical ID to AWS ECR Repository URI.

Example: Function_Logical_ID=ECR_Repo_Uri
This option can be specified multiple times.
* force_upload:
Indicates whether to override existing files in the S3 bucket. Specify this flag to upload artifacts even if they match existing artifacts in the S3 bucket.
* s3_prefix:
Prefix name that is added to the artifact's name when it is uploaded to the AWS S3 bucket.
* kms_key_id:
The ID of an AWS KMS key that is used to encrypt artifacts that are at rest in the AWS S3 bucket.
* role_arn:
ARN of an IAM role that AWS Cloudformation assumes when executing a deployment change set.
* use_json:
Indicates whether to use JSON as the format for the output AWS CloudFormation template. YAML is used by default.
* resolve_s3:
Automatically resolve AWS S3 bucket for non-guided deployments. Enabling this option will also create a managed default AWS S3 bucket for you. If one does not provide a --s3-bucket value, the managed bucket will be used. Do not use --guided with this option.
* resolve_image_repos:
Automatically create and delete ECR repositories for image-based functions in non-guided deployments. A companion stack containing ECR repos for each function will be deployed along with the template stack. Automatically created image repositories will be deleted if the corresponding functions are removed.
* metadata:
Map of metadata to attach to ALL the artifacts that are referenced in the template.
* notification_arns:
ARNs of SNS topics that AWS Cloudformation associates with the stack.
* tags:
List of tags to associate with the stack.
* parameter_overrides:
String that contains AWS CloudFormation parameter overrides encoded as key=value pairs.
* signing_profiles:
A string that contains Code Sign configuration parameters as FunctionOrLayerNameToSign=SigningProfileName:SigningProfileOwner Since signing profile owner is optional, it could also be written as FunctionOrLayerNameToSign=SigningProfileName
* no_progressbar:
Does not showcase a progress bar when uploading artifacts to S3 and pushing docker images to ECR
* capabilities:
List of capabilities that one must specify before AWS Cloudformation can create certain stacks.

Accepted Values: CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_RESOURCE_POLICY, CAPABILITY_AUTO_EXPAND.

Learn more at: https://docs.aws.amazon.com/serverlessrepo/latest/devguide/acknowledging-application-capabilities.html
* 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.


key: guided

description: Specify this flag to allow SAM CLI to guide you through the deployment using guided prompts.


description: AWS SAM template which references built artifacts for resources in the template. (if applicable)


description: Indicates whether to execute the change set. Specify this flag to view stack changes before executing the change set.


description: Specify whether AWS SAM CLI should return a non-zero exit code if there are no changes to be made to the stack. Defaults to a non-zero exit code.


description: Prompt to confirm if the computed changeset is to be deployed by SAM CLI.


description: Preserves the state of previously provisioned resources when an operation fails.


description:
Provide an action to determine what will happen when a stack fails to create. Three actions are available:

- ROLLBACK: This will rollback a stack to a previous known good state.

- DELETE: The stack will rollback to a previous state if one exists, otherwise the stack will be deleted.

- DO_NOTHING: The stack will not rollback or delete, this is the same as disabling rollback.

Default behaviour is ROLLBACK.

This option is mutually exclusive with --disable-rollback/--no-disable-rollback. You can provide
--on-failure or --disable-rollback/--no-disable-rollback but not both at the same time.


description: Name of the AWS CloudFormation stack.


description: AWS S3 bucket where artifacts referenced in the template are uploaded.


description: AWS ECR repository URI where artifacts referenced in the template are uploaded.


description:
Mapping of Function Logical ID to AWS ECR Repository URI.

Example: Function_Logical_ID=ECR_Repo_Uri
This option can be specified multiple times.


description: Indicates whether to override existing files in the S3 bucket. Specify this flag to upload artifacts even if they match existing artifacts in the S3 bucket.


description: Prefix name that is added to the artifact's name when it is uploaded to the AWS S3 bucket.


description: The ID of an AWS KMS key that is used to encrypt artifacts that are at rest in the AWS S3 bucket.


description: ARN of an IAM role that AWS Cloudformation assumes when executing a deployment change set.


description: Indicates whether to use JSON as the format for the output AWS CloudFormation template. YAML is used by default.


description: Automatically resolve AWS S3 bucket for non-guided deployments. Enabling this option will also create a managed default AWS S3 bucket for you. If one does not provide a --s3-bucket value, the managed bucket will be used. Do not use --guided with this option.


description: Automatically create and delete ECR repositories for image-based functions in non-guided deployments. A companion stack containing ECR repos for each function will be deployed along with the template stack. Automatically created image repositories will be deleted if the corresponding functions are removed.


description: Map of metadata to attach to ALL the artifacts that are referenced in the template.


description: ARNs of SNS topics that AWS Cloudformation associates with the stack.


key: tags

description: List of tags to associate with the stack.


description: String that contains AWS CloudFormation parameter overrides encoded as key=value pairs.


description: A string that contains Code Sign configuration parameters as FunctionOrLayerNameToSign=SigningProfileName:SigningProfileOwner Since signing profile owner is optional, it could also be written as FunctionOrLayerNameToSign=SigningProfileName


description: Does not showcase a progress bar when uploading artifacts to S3 and pushing docker images to ECR


key: capabilities

description:
List of capabilities that one must specify before AWS Cloudformation can create certain stacks.

Accepted Values: CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_RESOURCE_POLICY, CAPABILITY_AUTO_EXPAND.

Learn more at: https://docs.aws.amazon.com/serverlessrepo/latest/devguide/acknowledging-application-capabilities.html


key: profile

description: Select a specific profile from your credential file to get AWS credentials.


key: region

description: Set the AWS Region of the service. (e.g. us-east-1)


description: Enable/Disable beta features.


description: Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.


key: delete

description:
The sam delete command deletes the CloudFormation
stack and all the artifacts which were created using sam deploy.

e.g. sam delete


description:
Available parameters for the delete command:
* stack_name:
The name of the AWS CloudFormation stack you want to delete.
* no_prompts:
Specify this flag to allow SAM CLI to skip through the guided prompts.
* s3_bucket:
The S3 bucket path you want to delete.
* s3_prefix:
The S3 prefix you want to delete
* 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.


description: The name of the AWS CloudFormation stack you want to delete.


description: Specify this flag to allow SAM CLI to skip through the guided prompts.


description: The S3 bucket path you want to delete.


description: The S3 prefix you want to delete


key: logs

description:
The sam logs commands fetches logs of Lambda Functions/CloudWatch log groups
with additional filtering by options.

default: 10m ago


description:
Available parameters for the logs command:
* name:
The name of the resource for which to fetch logs. If this resource is a part of an AWS CloudFormation stack, this can be the LogicalID of the resource in the CloudFormation/SAM template. Multiple names can be provided by repeating the parameter again. If resource is in a nested stack, name can be prepended by nested stack name to pull logs from that resource (NestedStackLogicalId/ResourceLogicalId). If it is not provided and no --cw-log-group have been given, it will scan given stack and find all supported resources, and start pulling log information from them.
* stack_name:
Name of the AWS CloudFormation stack that the function is a part of.
* filter:
You can specify an expression to quickly find logs that match terms, phrases or values in your log events. This could be a simple keyword (e.g. "error") or a pattern supported by AWS CloudWatch Logs. See the AWS CloudWatch Logs documentation for the syntax https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html
* tail:
Tail events. This will ignore the end time argument and continue to fetch events as they become available. If option --tail is provided without a --name, one will be pulled from all possible resources
* include_traces:
Include the XRay traces in the log output.
* cw_log_group:
Additional CloudWatch Log group names that are not auto-discovered based upon --name parameter. When provided, it will only tail the given CloudWatch Log groups. If you want to tail log groups related to resources, please also provide their names as well
* output:
The formatting style of the command output. Following options are available:

TEXT: Prints information as regular text with some formatting (default option)

JSON: Prints each line as JSON without formatting
* end_time:
Fetch events up to this time. Time can be relative values like '5mins ago', 'tomorrow' or formatted timestamp like '2018-01-01 10:10:10'
* start_time:
Fetch events starting at this time. Time can be relative values like '5mins ago', 'yesterday' or formatted timestamp like '2018-01-01 10:10:10'. Defaults to '10mins ago'.
* 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)


key: name

description: The name of the resource for which to fetch logs. If this resource is a part of an AWS CloudFormation stack, this can be the LogicalID of the resource in the CloudFormation/SAM template. Multiple names can be provided by repeating the parameter again. If resource is in a nested stack, name can be prepended by nested stack name to pull logs from that resource (NestedStackLogicalId/ResourceLogicalId). If it is not provided and no --cw-log-group have been given, it will scan given stack and find all supported resources, and start pulling log information from them.


description: Name of the AWS CloudFormation stack that the function is a part of.


key: filter

description: You can specify an expression to quickly find logs that match terms, phrases or values in your log events. This could be a simple keyword (e.g. "error") or a pattern supported by AWS CloudWatch Logs. See the AWS CloudWatch Logs documentation for the syntax https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html


key: tail

description: Tail events. This will ignore the end time argument and continue to fetch events as they become available. If option --tail is provided without a --name, one will be pulled from all possible resources


description: Include the XRay traces in the log output.


description: Additional CloudWatch Log group names that are not auto-discovered based upon --name parameter. When provided, it will only tail the given CloudWatch Log groups. If you want to tail log groups related to resources, please also provide their names as well


key: output

description:
The formatting style of the command output. Following options are available:

TEXT: Prints information as regular text with some formatting (default option)

JSON: Prints each line as JSON without formatting

enum: json text


description: Fetch events up to this time. Time can be relative values like '5mins ago', 'tomorrow' or formatted timestamp like '2018-01-01 10:10:10'


description: Fetch events starting at this time. Time can be relative values like '5mins ago', 'yesterday' or formatted timestamp like '2018-01-01 10:10:10'. Defaults to '10mins ago'.


description: Enable/Disable beta features.


description: Select a specific profile from your credential file to get AWS credentials.


description: Set the AWS Region of the service. (e.g. us-east-1)


key: publish

description:
Use this command to publish a packaged AWS SAM template to
the AWS Serverless Application Repository to share within your team,
across your organization, or with the community at large.

This command expects the template's Metadata section to contain an
AWS::ServerlessRepo::Application section with application metadata
for publishing. For more details on this metadata section, see
https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-template-publishing-applications.html

Examples
--------
To publish an application
$ sam publish -t packaged.yaml --region <region>


description:
Available parameters for the publish command:
* template_file:
AWS SAM template which references built artifacts for resources in the template. (if applicable)
* semantic_version:
Optional. The value provided here overrides SemanticVersion in the template metadata.
* 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.


description: AWS SAM template which references built artifacts for resources in the template. (if applicable)


description: Optional. The value provided here overrides SemanticVersion in the template metadata.


description: Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.


key: traces

description:
Use this command to fetch AWS X-Ray traces generated by your stack.

Run the following command to fetch X-Ray traces by ID.
$ sam traces --trace-id tracing-id-1 --trace-id tracing-id-2

Run the following command to tail X-Ray traces as they become available.
$ sam traces --tail


description:
Available parameters for the traces command:
* trace_id:
Fetch specific trace by providing its id
* tail:
Tail events. This will ignore the end time argument and continue to fetch events as they become available.
* output:
The formatting style of the command output. Following options are available:

TEXT: Prints information as regular text with some formatting (default option)

JSON: Prints each line as JSON without formatting
* end_time:
Fetch events up to this time. Time can be relative values like '5mins ago', 'tomorrow' or formatted timestamp like '2018-01-01 10:10:10'
* start_time:
Fetch events starting at this time. Time can be relative values like '5mins ago', 'yesterday' or formatted timestamp like '2018-01-01 10:10:10'. Defaults to '10mins ago'.
* 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)


description: Fetch specific trace by providing its id


description: Tail events. This will ignore the end time argument and continue to fetch events as they become available.


key: sync

description: NEW! Sync an AWS SAM Project to AWS.

enum: AWS::ApiGateway::RestApi AWS::ApiGatewayV2::Api AWS::Lambda::Function AWS::Lambda::LayerVersion AWS::Serverless::Api AWS::Serverless::Function AWS::Serverless::HttpApi AWS::Serverless::LayerVersion AWS::Serverless::StateMachine AWS::StepFunctions::StateMachine


description:
Available parameters for the sync command:
* template_file:
AWS SAM template file.
* code:
Sync ONLY code resources. This includes Lambda Functions, API Gateway, and Step Functions.
* watch:
Watch local files and automatically sync with cloud.
* resource_id:
Sync code for all the resources with the ID. To sync a resource within a nested stack, use the following pattern {ChildStack}/{logicalId}.
* resource:
Sync code for all resources of the given resource type. Accepted values are ['AWS::Serverless::Function', 'AWS::Lambda::Function', 'AWS::Serverless::LayerVersion', 'AWS::Lambda::LayerVersion', 'AWS::Serverless::Api', 'AWS::ApiGateway::RestApi', 'AWS::Serverless::HttpApi', 'AWS::ApiGatewayV2::Api', 'AWS::Serverless::StateMachine', 'AWS::StepFunctions::StateMachine']
* dependency_layer:
Separate dependencies of individual function into a Lambda layer for improved performance.
* skip_deploy_sync:
This option will skip the initial infrastructure deployment if it is not required by comparing the local template with the template deployed in cloud.
* stack_name:
Name of the AWS CloudFormation stack.
* 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.
* use_container:
Build functions within an AWS Lambda-like container.
* 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.
* image_repository:
AWS ECR repository URI where artifacts referenced in the template are uploaded.
* image_repositories:
Mapping of Function Logical ID to AWS ECR Repository URI.

Example: Function_Logical_ID=ECR_Repo_Uri
This option can be specified multiple times.
* s3_bucket:
AWS S3 bucket where artifacts referenced in the template are uploaded.
* s3_prefix:
Prefix name that is added to the artifact's name when it is uploaded to the AWS S3 bucket.
* kms_key_id:
The ID of an AWS KMS key that is used to encrypt artifacts that are at rest in the AWS S3 bucket.
* role_arn:
ARN of an IAM role that AWS Cloudformation assumes when executing a deployment change set.
* parameter_overrides:
String that contains AWS CloudFormation parameter overrides encoded as key=value pairs.
* 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)
* metadata:
Map of metadata to attach to ALL the artifacts that are referenced in the template.
* notification_arns:
ARNs of SNS topics that AWS Cloudformation associates with the stack.
* tags:
List of tags to associate with the stack.
* capabilities:
List of capabilities that one must specify before AWS Cloudformation can create certain stacks.

Accepted Values: CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_RESOURCE_POLICY, CAPABILITY_AUTO_EXPAND.

Learn more at: https://docs.aws.amazon.com/serverlessrepo/latest/devguide/acknowledging-application-capabilities.html


description: AWS SAM template file.


key: code

description: Sync ONLY code resources. This includes Lambda Functions, API Gateway, and Step Functions.


key: watch

description: Watch local files and automatically sync with cloud.


description: Sync code for all the resources with the ID. To sync a resource within a nested stack, use the following pattern {ChildStack}/{logicalId}.


key: resource

description: Sync code for all resources of the given resource type. Accepted values are ['AWS::Serverless::Function', 'AWS::Lambda::Function', 'AWS::Serverless::LayerVersion', 'AWS::Lambda::LayerVersion', 'AWS::Serverless::Api', 'AWS::ApiGateway::RestApi', 'AWS::Serverless::HttpApi', 'AWS::ApiGatewayV2::Api', 'AWS::Serverless::StateMachine', 'AWS::StepFunctions::StateMachine']


description: Separate dependencies of individual function into a Lambda layer for improved performance.


description: This option will skip the initial infrastructure deployment if it is not required by comparing the local template with the template deployed in cloud.


description: Name of the AWS CloudFormation stack.


description: 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.


description: Build functions within an AWS Lambda-like container.


description: 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.


description: AWS ECR repository URI where artifacts referenced in the template are uploaded.


description:
Mapping of Function Logical ID to AWS ECR Repository URI.

Example: Function_Logical_ID=ECR_Repo_Uri
This option can be specified multiple times.


description: AWS S3 bucket where artifacts referenced in the template are uploaded.


description: Prefix name that is added to the artifact's name when it is uploaded to the AWS S3 bucket.


description: The ID of an AWS KMS key that is used to encrypt artifacts that are at rest in the AWS S3 bucket.


description: ARN of an IAM role that AWS Cloudformation assumes when executing a deployment change set.


description: String that contains AWS CloudFormation parameter overrides encoded as key=value pairs.


description: Enable/Disable beta features.


key: debug

description: Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.


description: Select a specific profile from your credential file to get AWS credentials.


description: Set the AWS Region of the service. (e.g. us-east-1)


key: metadata

description: Map of metadata to attach to ALL the artifacts that are referenced in the template.


description: ARNs of SNS topics that AWS Cloudformation associates with the stack.


key: tags

description: List of tags to associate with the stack.


key: capabilities

description:
List of capabilities that one must specify before AWS Cloudformation can create certain stacks.

Accepted Values: CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_RESOURCE_POLICY, CAPABILITY_AUTO_EXPAND.

Learn more at: https://docs.aws.amazon.com/serverlessrepo/latest/devguide/acknowledging-application-capabilities.html


description:
This command generates the required AWS infrastructure resources to connect to your CI/CD system.
This step must be run for each deployment stage in your pipeline, prior to running the sam pipeline init command.

default: iam

enum: iam oidc


key: parameters

description:
Available parameters for the pipeline bootstrap command:
* interactive:
Disable interactive prompting for bootstrap parameters, and fail if any required arguments are missing.
* stage:
The name of the corresponding deployment stage. It is used as a suffix for the created AWS infrastructure resources.
* pipeline_user:
The Amazon Resource Name (ARN) of the IAM user having its access key ID and secret access key shared with the CI/CD system. It is used to grant this IAM user permission to access the corresponding AWS account. If not provided, the command will create one along with the access key ID and secret access key credentials.
* pipeline_execution_role:
The ARN of the IAM role to be assumed by the pipeline user to operate on this stage. Provide it only if you want to use your own role, otherwise this command will create one.
* cloudformation_execution_role:
The ARN of the IAM role to be assumed by the AWS CloudFormation service while deploying the application's stack. Provide only if you want to use your own role, otherwise the command will create one.
* bucket:
The ARN of the Amazon S3 bucket to hold the AWS SAM artifacts.
* create_image_repository:
If set to true and no ECR image repository is provided, this command will create an ECR image repository to hold the container images of Lambda functions having an Image package type.
* image_repository:
The ARN of an Amazon ECR image repository to hold the container images of Lambda functions or layers that have a package type of Image. If provided, the --create-image-repository options is ignored. If not provided and --create-image-repository is specified, the command will create one.
* confirm_changeset:
Prompt to confirm if the resources are to be deployed.
* permissions_provider:
Choose a permissions provider to assume the pipeline execution role. Default is to use an IAM User.
* oidc_provider_url:
The URL of the OIDC provider.
* oidc_client_id:
The client ID configured to use with the OIDC provider.
* github_org:
The GitHub organization that the repository belongs to. If there is no organization enter the Username of the repository owner instead Only used if using GitHub Actions OIDC for user permissions
* github_repo:
The name of the GitHub Repository that deployments will occur from. Only used if using GitHub Actions OIDC for permissions
* deployment_branch:
The name of the branch that deployments will occur from. Only used if using GitHub Actions OIDC for permissions
* oidc_provider:
The name of the CI/CD system that will be used for OIDC permissions Currently supported CI/CD systems are : GitLab, GitHub and Bitbucket
* gitlab_group:
The GitLab group that the repository belongs to. Only used if using GitLab OIDC for permissions
* gitlab_project:
The GitLab project name. Only used if using GitLab OIDC for permissions
* bitbucket_repo_uuid:
The UUID of the Bitbucket repository. Only used if using Bitbucket OIDC for permissions. Found at https://bitbucket.org/<WORKSPACE>/<REPOSITORY>/admin/addon/admin/pipelines/openid-connect
* cicd_provider:
The CICD platform for the SAM Pipeline
* 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)


key: interactive

description: Disable interactive prompting for bootstrap parameters, and fail if any required arguments are missing.


key: stage

description: The name of the corresponding deployment stage. It is used as a suffix for the created AWS infrastructure resources.


description: The Amazon Resource Name (ARN) of the IAM user having its access key ID and secret access key shared with the CI/CD system. It is used to grant this IAM user permission to access the corresponding AWS account. If not provided, the command will create one along with the access key ID and secret access key credentials.


description: The ARN of the IAM role to be assumed by the pipeline user to operate on this stage. Provide it only if you want to use your own role, otherwise this command will create one.


description: The ARN of the IAM role to be assumed by the AWS CloudFormation service while deploying the application's stack. Provide only if you want to use your own role, otherwise the command will create one.


key: bucket

description: The ARN of the Amazon S3 bucket to hold the AWS SAM artifacts.


description: If set to true and no ECR image repository is provided, this command will create an ECR image repository to hold the container images of Lambda functions having an Image package type.


description: The ARN of an Amazon ECR image repository to hold the container images of Lambda functions or layers that have a package type of Image. If provided, the --create-image-repository options is ignored. If not provided and --create-image-repository is specified, the command will create one.


description: Prompt to confirm if the resources are to be deployed.


description: Choose a permissions provider to assume the pipeline execution role. Default is to use an IAM User.


description: The URL of the OIDC provider.


description: The client ID configured to use with the OIDC provider.


description: The GitHub organization that the repository belongs to. If there is no organization enter the Username of the repository owner instead Only used if using GitHub Actions OIDC for user permissions


description: The name of the GitHub Repository that deployments will occur from. Only used if using GitHub Actions OIDC for permissions


description: The name of the branch that deployments will occur from. Only used if using GitHub Actions OIDC for permissions


description: The name of the CI/CD system that will be used for OIDC permissions Currently supported CI/CD systems are : GitLab, GitHub and Bitbucket


description: The GitLab group that the repository belongs to. Only used if using GitLab OIDC for permissions


description: The GitLab project name. Only used if using GitLab OIDC for permissions


description: The UUID of the Bitbucket repository. Only used if using Bitbucket OIDC for permissions. Found at https://bitbucket.org/<WORKSPACE>/<REPOSITORY>/admin/addon/admin/pipelines/openid-connect


description: The CICD platform for the SAM Pipeline


description: Enable/Disable beta features.


description: Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.


key: profile

description: Select a specific profile from your credential file to get AWS credentials.


key: region

description: Set the AWS Region of the service. (e.g. us-east-1)


description:
This command generates a pipeline configuration file that your CI/CD system can use to deploy
serverless applications using AWS SAM.

Before using sam pipeline init, you must bootstrap the necessary resources for each stage in your pipeline.
You can do this by running sam pipeline init --bootstrap to be guided through the setup and configuration
file generation process, or refer to resources you have previously created with the sam pipeline bootstrap command.


description:
Available parameters for the pipeline init command:
* bootstrap:
Enable interactive mode that walks the user through creating necessary AWS infrastructure resources.
* beta_features:
Enable/Disable beta features.
* debug:
Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.


key: bootstrap

description: Enable interactive mode that walks the user through creating necessary AWS infrastructure resources.


description:
Get a list of resources that will be deployed to CloudFormation.

If a stack name is provided, the corresponding physical IDs of each
resource will be mapped to the logical ID of each resource.


description:
Available parameters for the list resources command:
* parameter_overrides:
String that contains AWS CloudFormation parameter overrides encoded as key=value pairs.
* stack_name:
Name of corresponding deployed stack.(Not including a stack name will only show local resources defined in the template.)
* output:
Output the results from the command in a given output format (json or table).
* 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.


description: String that contains AWS CloudFormation parameter overrides encoded as key=value pairs.


description: Name of corresponding deployed stack.(Not including a stack name will only show local resources defined in the template.)


key: output

description: Output the results from the command in a given output format (json or table).

default: table

enum: json table


description: AWS SAM template file.


description: Get the stack outputs as defined in the SAM/CloudFormation template.


description:
Available parameters for the list stack outputs command:
* stack_name:
Name of corresponding deployed stack.
* output:
Output the results from the command in a given output format (json or table).
* 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.


description: Name of corresponding deployed stack.


description:
Get a summary of the cloud endpoints in the stack.

This command will show both the cloud and local endpoints that can
be used with sam local and sam sync. Currently the endpoint resources
are Lambda functions and API Gateway API resources.


description:
Available parameters for the list endpoints command:
* parameter_overrides:
String that contains AWS CloudFormation parameter overrides encoded as key=value pairs.
* stack_name:
Name of corresponding deployed stack.(Not including a stack name will only show local resources defined in the template.)
* output:
Output the results from the command in a given output format (json or table).
* 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.


description: Enable/Disable beta features.


key: docs

description: NEW! Open the documentation in a browser.


description:
Available parameters for the docs command:
*


description: Invoke or send an event to resources in the cloud.


description:
Available parameters for the remote invoke command:
* stack_name:
Name of the stack to get the resource information from
* event:
The event that will be sent to the resource. The target parameter will depend on the resource type. For instance: 'Payload' for Lambda which can be passed as a JSON string
* event_file:
The file that contains the event that will be sent to the resource.
* output:
Output the results from the command in a given output format. The text format prints a readable AWS API response. The json format prints the full AWS API response.
* parameter:
Additional parameters that can be passed to invoke the resource.
The following additional parameters can be used to invoke a lambda resource and get a buffered response: InvocationType='Event'|'RequestResponse'|'DryRun', LogType='None'|'Tail', ClientContext='base64-encoded string' Qualifier='string'. The following additional parameters can be used to invoke a lambda resource with response streaming: InvocationType='RequestResponse'|'DryRun', LogType='None'|'Tail', ClientContext='base64-encoded string', Qualifier='string'.
* 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)


description: Name of the stack to get the resource information from


key: event

description: The event that will be sent to the resource. The target parameter will depend on the resource type. For instance: 'Payload' for Lambda which can be passed as a JSON string


description: The file that contains the event that will be sent to the resource.


description: Output the results from the command in a given output format. The text format prints a readable AWS API response. The json format prints the full AWS API response.

default: text


key: parameter

description:
Additional parameters that can be passed to invoke the resource.
The following additional parameters can be used to invoke a lambda resource and get a buffered response: InvocationType='Event'|'RequestResponse'|'DryRun', LogType='None'|'Tail', ClientContext='base64-encoded string' Qualifier='string'. The following additional parameters can be used to invoke a lambda resource with response streaming: InvocationType='RequestResponse'|'DryRun', LogType='None'|'Tail', ClientContext='base64-encoded string', Qualifier='string'.


description: Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.


description: Select a specific profile from your credential file to get AWS credentials.


description: Set the AWS Region of the service. (e.g. us-east-1)


key: tabs

description: At its most basic, a blueprint has tabs. A tab has a handle, a display name, and an array of sections. Since Statamic 4


description: The handle (name) of a section. This one is on you.


key: display

description: The displayed text.


key: sections

description: The Sections of the Tab


key: instructions

description: Some instructions


description: At its most basic, a blueprint has sections. A section has a handle, a display name, and an array of fields. Until Statamic 3


key: fields

description: Here you define the fields of this section.

type: object string


key: handle

description: The field's template variable.


key: field

description: The definition of a single field.


key: array

description: This fieldtype is used to manage key: value array data in the right situation.

const: array

enum: dynamic keyed

type: object array


key: assets

description: The assets fieldtype is used to manage and relate files with your entries.

const: assets

enum: grid list

default: list


key: bard

description: Bard is our recommended fieldtype for creating long form content from the control panel.

const: bard

enum: h2 h3 bold italic unorderedlist orderedlist removeformat quote anchor image table

enum: fixed floating

default: fixed


description: Enable to always show the "Add Set" button.


key: sets

description: Sets are configurable blocks of fields that can be inserted anywhere in your Bard content.


key: buttons

description: Choose which buttons to show in the toolbar.


key: container

description: Choose which asset container to use for this field.


description: Save HTML instead of structured data. This simplifies but limits control of your template markup.


description: Choose which style of toolbar you prefer.


description: Set rel="noopener" on all links.


description: Set rel="noreferrer" on all links.


description: Set target="_blank" on all links.


description: Entries from these collections will be available in the link selector. Leaving this empty will make all entries available.


description: Show estimated reading time at the bottom of the field.


key: fullscreen

description: Enable to toggle into fullscreen mode.


description: Allow Source Mode


description: Enable Input Rules


description: Enables Markdown-style shortcuts when typing content.


description: The button group fieldtype is a multiple choice input where you only get one choice.


key: options

description: Set the array keys and their optional labels.


key: default

description: Set the default value.


key: checkboxes

description: The checkboxes fieldtype is a multiple choice input.

const: checkboxes

default: false


key: code

description: If your content involves code snippets, this is the fieldtype for you.

const: code

enum: light material

enum: clike css diff go haml handlebars htmlmixed less markdown gfm nginx text/x-java javascript jsx text/x-objectivec php python ruby scss shell sql twig vue xml yaml-frontmatter

enum: tabs spaces

default: default

enum: default sublime vim


key: theme

description: Choose your preferred theme.


key: mode

description: Choose language for syntax highlighting.


description: Set your preferred type of indentation.


description: Set your preferred indentation size (in spaces).


description: Choose preferred set of keyboard shortcuts.


description: Show Line Numbers


description: Enable Line Wrapping


key: collections

description: This fieldtype is used to view and select from a list of Collections.

const: collections


description: Set a maximum number of selectable items.


description: Choose your preferred UI style.


key: color

description: This fieldtype is a highly configurable color picker with simple and advanced UI modes, support for alpha channel, rgba, hsla, hsva, and more.

const: color

enum: classic nano

default: HEXA

enum: HEXA RGBA HSLA HSVA CMYK

default: hex

enum: hex rgba hsla hsva cmyk


key: swatches

description: Pre-define colors that can be selected from a list. Supports all color mode formats.


description: Choose between a classic and a simpler nano (mini) theme. Default: classic.


description: Disables the alpha slider, preventing adjustments to opacity.


description: Set which color mode you wish to be the default. Default: hex.


description: Choose which color modes you want to enable in the UI. Available choices: hex, rgba, hsla, hsva, and cmyk. Default: hex.


key: date

description: Work with dates, times, and ranges with a variety of user interface options that make you really enjoy basically just picking numbers from a table.

format: date

format: date-time

enum: single range

default: single

const: date


key: columns

description: Show multiple months at one time, in columns and rows. Default: 1.


description: Set the earliest selectable date in YYYY-MM-DD format.


key: format

description: How the date should be stored, using the PHP date format. Default: 'Y-m-d' or 'Y-m-d H:m'


description: Enable to stretch the calendar out like Stretch Armstrong, using the maximum amount of available horizontal space. Default: false


key: inline

description: Always show the calendar instead of the text input and dropdown UI. Default: false.


description: Choose between single or range. Range mode disables the time picker. Default: single.


key: rows


description: Enable/disable the timepicker. Default: false.


description: Makes the time field visible and non-dismissible. Default: false.


key: form

description: The Form fieldtype is gives your users a way to pick a form to include along with the current entry.

const: form


key: grid

description: The grid fieldtype is a meta fieldtype, a fieldtype that serves as a container for more fieldtypes.

const: grid

enum: table stacked


key: fields

description: A list of fields, each of which create their own column.


description: The Grid is displayed as a table by default. If you have a large number of columns it can get pretty crowded. Choose stacked mode to group rows similar to Replicator. When Sneak Peek is enabled, Grids automatically toggle into stacked mode.


description: The minimum number of required rows.


description: The maximum number of rows allowed. Once reached the Add Row button will disappear.


description: The Add Row button's label.


key: reorderable

description: The minimum number of required rows.


key: hidden

description: The hidden field is perfect for setting default data when creating new entries.

const: hidden


key: html

description: If you've ever wanted to add a little HTML to your blueprint, this is the way to do it.

const: html


description: Store whatever HTML you want — it's up to you.


key: import

description: Importing Fieldsets. They serve to create reusable sets of fields, just like v2.


key: integer

description: The integer fieldtype is a text-style input that only accepts integers (numbers) and has increment and decrement controls.

const: integer

type: string integer


key: link

description: For when you want to create a link to a URL or entry, this fieldtype is here for you.

const: link


key: list

description: For when you want to manage a simple YAML list, this fieldtype is here for you.

const: list


key: markdown

description: Write Markdown with the help of formatting buttons, assets integration, fullscreen mode, a Markdown cheatsheet, and HTML preview mode.

const: markdown


key: container

description: Set the name of an asset container to enable browsing, uploading, and inserting assets.


key: restrict

description: If true, navigation within the asset browser will be disabled. Your users will be restricted to specified the container and folder. Default: false.


description: Automatically convert line breaks to <br> tags. Default: true.


description: Automatically links any URLs in the text. Default: false.


description: Escapes inline HTML markup. For example, <div> will be replaced with <div>. Default: true.


key: smartypants

description: Automatically convert straight quotes into curly quotes, dashes into en/em-dashes, and other similar text transformations. Default: false.


key: default

description: Set the default value.


key: radio

description: The radio fieldtype is a multiple choice input where you only get one choice.

const: radio


key: options

description: Sets of key/value pairs define the values and labels of the radio options.


key: inline

description: Show the radio buttons next to each other in a row instead of stacked vertically. Default: false


key: range

description: Range fields let the user choose a numeric value which must be no less than a given value, and no more than another.

const: range


key: step

description: The minimum size between values.


key: min

description: The minimum, left-most value.


key: max

description: The maximum, right-most value.


description: Set the default value.


key: replicator

description: The Replicator is a meta fieldtype giving you the ability to define sets of fields that you can dynamically piece together in whatever order and arrangement you imagine.

const: replicator


key: revealer

description: The revealer is a simple button that reveals conditional fields without saving any additional data.

const: revealer


key: select

description: Give your users a list of options to choose from.

const: select

type: array object


key: clearable

description: Allow deselecting any chosen option and making null a possible value. Default: false.


description: A set of key/value pairs that define the values and labels. If you don't define the keys, the value and label will be the same.


key: placeholder

description: Set the non-selectable placeholder text. Default: none.


description: Set the default option key. Default: none.


key: multiple

description: Allow multiple selections. Default: false.


key: searchable

description: Enable search with suggestions by typing in the select box. Default: true.


key: taggable

description: Use a "tag" style UI when selecting multiples. Default: false.


description: Add newly created options to the list. Default: false.


key: structures

description: Use this fieldtype to create a one-way relationship with one or more structures in your site.

const: structures


key: table

description: This fieldtype gives you a way to create flexible tabular data.

const: table


description: Users can enter “taggable” values, which are formatted automatically into a YAML list format.

const: taggable


key: template

description: This is generally used as a "system" field to control an entry's template.

const: template


key: terms

description: Taxonomies are usually relationships established on the collection-configuration level.

const: terms


key: text

description: A text field that has the ability to morph into an intergalactic dragon and devour entire planets!

const: text

enum: color date email hidden month number password tel text time url week


key: textarea

description: A long textarea field that functions like a swimming pool for letters and numbers on a hot day.

const: textarea

type: integer string


key: time

description: The original time field from the set of Kiefer Sutherland's hit drama "24".

const: time


key: toggle

description: A nice little toggle switch generally used to manage settings-type variables.

const: toggle


description: The User Group fieldtype gives your users a way to pick one or more User Groups to attach to the current entry.


description: The User Role fieldtype gives your users a way to pick one or more User Groups to attach to the current entry.


key: users

description: The most common use for the Users fieldtype is to set the "author" for entries, but it's not the only use.

const: users

const: current


key: yaml

description: This field is a code fieldtype that gets saved as YAML instead of a string.

const: yaml


key: display

description: The label shown above the field.


key: icon

description: The icon


key: instructions

description: Shown under the field's display label, like this very text. Markdown is supported.


description: Where the instructions should be positioned relative to the field. Options: Above or Below.

enum: above below


key: listable

description: Controls whether the field should be shown in control panel listings.

pattern: hidden


key: required

description: Control whether or not this field is required.


key: validate

description: The validation rules for that field


key: antlers

description: Enable Antlers parsing in this field's content.


key: $schema

description: The URI of the JSON schema corresponding to the version of the external property file format.

format: uri


key: version

description: The SARIF format version of this external properties object.


key: guid

description: A stable, unique identifier for this external properties object, in the form of a GUID.


key: runGuid

description: A stable, unique identifier for the run associated with this external properties object, in the form of a GUID.


key: conversion

description: A conversion object that will be merged with an external run.


key: graphs

description: An array of graph objects that will be merged with an external run.


key: externalizedProperties

description: Key/value pairs that provide additional information that will be merged with an external run.


key: artifacts

description: An array of artifact objects that will be merged with an external run.


key: invocations

description: Describes the invocation of the analysis tool that will be merged with an external run.


key: logicalLocations

description: An array of logical locations such as namespaces, types or functions that will be merged with an external run.


key: threadFlowLocations

description: An array of threadFlowLocation objects that will be merged with an external run.


key: results

description: An array of result objects that will be merged with an external run.


key: taxonomies

description: Tool taxonomies that will be merged with an external run.


key: driver

description: The analysis tool object that will be merged with an external run.


key: extensions

description: Tool extensions that will be merged with an external run.


key: policies

description: Tool policies that will be merged with an external run.


key: translations

description: Tool translations that will be merged with an external run.


key: addresses

description: Addresses that will be merged with with an external run.


key: webRequests

description: Requests that will be merged with an external run.


key: webResponses

description: Responses that will be merged with an external run.


key: properties

description: Key/value pairs that provide additional information about the external properties.


key: version

description: The version of the component configuration file format.


key: components

description: An array of Visual Studio component names


description: CI configuration for Amdocs Bill Experience projects

required: address credentials

default: BB-Checkmarx

enum: job global

default: job

required: channel branch registry credentials

required: path publish updates

required: file properties

required: channel branch repository credentials

required: channel branch

enum: maven npm local

default: maven

default: .ci-cache/<type>

required: type enabled

enum: npm maven mvn

default: mvn

examples: bx-maven-settings bx-npm-settings

enum: Postgres Postgis Redis Mssql Mysql Mongodb Elasticsearch


key: branchPattern

description: Regular expression for validating branch names


key: timeout

description: Timeout in seconds


key: credentials

description: Jenkins credentials ID


key: binaryRepository

description: Binary repository details


key: address

description: Repository URL


description: Jenkins credentials ID for connecting to this repository


key: enabled

description: Sets whether the scan should be run


Specifies in which branches this stage will be executed


key: groupId

description: Fully qualified team name for the project


key: preset

description: Scan preset for the project


key: sourceEncoding

description: Language encoding ID associated to the source code character encoding (5: Multi-Language Scan)


key: serverUrl

description: Checkmarx Server URL or IP address


key: credentialsId

description: Jenkins credentials ID


key: useOwnServerCredentials

description: Enables the use of the default server credentials or disables and provides server and credentials that override the defaults


key: projectName

description: Unique project name. Will be inferred from the repository name if not provided


key: exclusionsSetting

description: Specifies which exclusions settings to use: global (Jenkins global settings) or job (current pipeline)


key: excludeFolders

description: Comma separated list of folders to be excluded from the CxSAST scan


key: filterPattern

description: Defines the include/exclude wildcard patterns. Does not have effect when "exclusionsSetting" is set to "global"


key: hideDebugLogs

description: Sets whether debug logs are visible in the job output


key: waitForResultsEnabled

description: Sets whether the scan should be executed synchronously (default). The Synchronous mode allows viewing scan results in Jenkins


key: vulnerabilityThresholdEnabled

description: Sets whether the scan should fail if the number of vulnerabilities is above the configured thresholds. This option is only available if the waitForResultsEnabled parameter is enabled


key: highThreshold

description: Sets the maximum number of High vulnerabilities allowed


key: mediumThreshold

description: Sets the maximum number of Medium vulnerabilities allowed


key: lowThreshold

description: Sets the maximum number of Low vulnerabilities allowed


description: Waits for analysis result and breaks the build when the project fails for some quality gates


description: Indicates whether sonnar server supports branch analysis, to provide dedicated parameters.


description: Indicates what branches static analysis will be performed.


key: image

description: Prebuilt Docker image for running scan into it. If not specified, it will use the same image used for main build.


key: timeout

description: Seconds to wait for the result of the quality gate. Only applies when breaks_build is set to true


key: exclusions

description: Comma separated list of wildcard patterns defining files to be excluded from the SonarQube scan


key: when

description: Condition that should be met to run this step


key: steps

description: List of steps to run


key: failFast

description: Forces parallel stages to all be aborted when one of them fails


key: parallel

description: List of stages to be executed in parallel


Stage name in the Jenkins pipeline


key: releaseChannel

description: Release channel name


key: releaseChannelBranch

description: Indicates on which branches the artifact will be published


key: dockerfile

description: Dockerfile path


description: Path to Dockerfile used to generate the docker image


description: Image name for the generated docker image. Cannot include tag. Tag will be automatically generated based on project version.


key: publish

description: Docker publishing information. If not present, no images will be published


description: Configuration for running vulnerability scans on published Docker images


key: enabled

description: Whether the vulnerability scan step should be run


key: args

description: List of build args (--build-arg) to pass in docker build


key: key

description: ARG name


key: env

description: Environment variable whose value will be used to set the ARG


key: value

description: Value of the ARG


key: registry

description: Docker registry. Must include protocol (http|https) and port


key: credentials

description: Jenkins credentials ID for publishing into the specified Docker registry


key: path

description: Path to the folder with all required chart config files


key: updates

description: Updates that must be done before packing Helm chart. It's a list of objects that specifies which updates must be done on which files


description: Helm chart publishing configuration. If not present, no charts will be published


key: file

description: Name (including path from Helm object path) of the file to be updated. Only supports yaml files


key: properties

description: A list of properties to update. It can be updated with a fixed value or environment variable


description: Yaml property (full path) to be updated


description: Environment variable whose value will be used to update the property


description: Value to update the given property


key: repository

description: Helm chart repository. Must include protocol, host, port (if needed) and path


description: Jenkins credentials Id for this repository for uploading the chart


description: Package publish configuration.


description: NPM registry (env variable or registry URL)


description: Maven repository for deploying releases


description: Maven repository for deploying snapshots


key: params

description: Optional params for npm publish or mvn deploy command.


key: type

description: Cache type


description: Sets whether this cache type is enabled


key: source

description: Location of the cache in the Jenkins workspace


key: target

description: Location of the cache directory inside the Docker container


key: project

description: Project properties


key: name

description: Project's name (used by Jenkins, Docker and Sonar)


description: Project type


key: settings

description: ID of a managed maven or npm Jenkins file


key: docker

description: Specifies how to build the Docker container (from an existing image or from a local Dockerfile)


key: image

description: Prebuilt Docker image (has precedence over dockerfile)


key: dockerfile

description: Path to a local Dockerfile


key: branch

description: Describes on which branch names a build will be run


description: Disables branch name validation


description: Whether Jenkins workspace should be cleaned after the build


description: Commit age threshold. Disables automated builds older than this parameter. When 0, this feature is disabled


key: checkmarx

description: Adds a Static Analysis stage for CheckMarx. See https://www.jenkins.io/doc/pipeline/steps/checkmarx/ for all the configuration options.


Adds a Static Analysis stage for Sonar.


key: cache

description: Cache configuration for projects built inside Docker containers


key: items

description: List of cache types


key: services

description: Additional services required by the project or application.


key: environment

description: Custom environment variables to be added to the pipeline


key: jenkinsEnvironment

description: Jenkins environment variables that are passed to the Docker container


key: stages

description: Defines the stages and steps required to build the project.


Stage name in the Jenkins pipeline


key: output

description: Describes artifacts generated after all the stages have been run


key: package

description: Configuration for publishing NPM or Maven packages