samcli.json

title: AWS SAM CLI samconfig schema

title: Config version

type: number

title: Environment

title: Init command

description: Initialize an AWS SAM application.

title: Parameters for the init command

description:
Available parameters for the init command:
* no_interactive:
Disable interactive prompting for init parameters. (fail if any required values are missing)
* architecture:
Architectures for Lambda functions.

Architectures: ['arm64', 'x86_64']
* location:
Template location (git, mercurial, http(s), zip, path).
* runtime:
Lambda runtime for application.

Runtimes: dotnet6, go1.x, java17, java11, java8.al2, java8, nodejs18.x, nodejs16.x, nodejs14.x, nodejs12.x, provided, provided.al2, python3.9, python3.8, python3.7, python3.11, python3.10, ruby3.2, ruby2.7
* package_type:
Lambda deployment package type.

Package Types: Zip, Image
* base_image:
Lambda base image for deploying IMAGE based package type.

Base images: amazon/dotnet6-base, amazon/go-provided.al2-base, amazon/go1.x-base, amazon/java11-base, amazon/java17-base, amazon/java8-base, amazon/java8.al2-base, amazon/nodejs12.x-base, amazon/nodejs14.x-base, amazon/nodejs16.x-base, amazon/nodejs18.x-base, amazon/python3.10-base, amazon/python3.11-base, amazon/python3.7-base, amazon/python3.8-base, amazon/python3.9-base, amazon/ruby2.7-base, amazon/ruby3.2-base
* dependency_manager:
Dependency manager for Lambda runtime.

Dependency managers: bundler, cli-package, gradle, maven, mod, npm, pip
* output_dir:
Directory to initialize AWS SAM application.
* name:
Name of AWS SAM Application.
* app_template:
Identifier of the managed application template to be used. Alternatively, run '$sam init' without options for an interactive workflow.
* no_input:
Disable Cookiecutter prompting and accept default values defined in the cookiecutter config.
* extra_context:
Override custom parameters in the template's cookiecutter.json configuration e.g. {"customParam1": "customValue1", "customParam2":"customValue2"}
* tracing:
Enable AWS X-Ray tracing for application.
* application_insights:
Enable CloudWatch Application Insights monitoring for application.
* beta_features:
Enable/Disable beta features.
* debug:
Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.

title: no_interactive

description: Disable interactive prompting for init parameters. (fail if any required values are missing)

title: architecture

description:
Architectures for Lambda functions.

Architectures: ['arm64', 'x86_64']

title: location

description: Template location (git, mercurial, http(s), zip, path).

title: runtime

title: package_type

description:
Lambda deployment package type.

Package Types: Zip, Image

enum: Image Zip

title: base_image

title: dependency_manager

description:
Dependency manager for Lambda runtime.

Dependency managers: bundler, cli-package, gradle, maven, mod, npm, pip

enum: bundler cli-package gradle maven mod npm pip

title: output_dir

description: Directory to initialize AWS SAM application.

title: name

description: Name of AWS SAM Application.

title: app_template

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

title: no_input

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

title: extra_context

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

title: tracing

description: Enable AWS X-Ray tracing for application.

title: application_insights

description: Enable CloudWatch Application Insights monitoring for application.

title: beta_features

description: Enable/Disable beta features.

title: debug

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

title: Validate command

description: Validate an AWS SAM Template.

title: Parameters for the validate command

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

title: template_file

description: AWS SAM template file.

title: profile

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

title: region

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

title: beta_features

description: Enable/Disable beta features.

title: debug

title: lint

title: Build command

description: Build AWS serverless function code.

title: Parameters for the build command

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)

title: hook_name

title: skip_prepare_infra

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

title: use_container

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

title: container_env_var

title: container_env_var_file

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

title: build_image

title: exclude

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

title: parallel

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

title: mount_with

default: READ

enum: READ WRITE

title: build_dir

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

default: .aws-sam/build

title: cache_dir

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

default: .aws-sam/cache

title: base_dir

title: manifest

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

title: cached

title: template_file

description: AWS SAM template file.

title: parameter_overrides

type: array string

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

title: skip_pull_image

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

title: docker_network

title: beta_features

description: Enable/Disable beta features.

title: debug

title: profile

title: region

title: Local Invoke command

description: Invoke AWS serverless functions locally.

title: Parameters for the local invoke command

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)

title: hook_name

title: skip_prepare_infra

title: event

title: no_event

description: DEPRECATED: By default no event is assumed.

title: template_file

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

title: env_vars

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

title: parameter_overrides

title: debug_port

type: integer

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

title: debugger_path

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

title: debug_args

description: Additional arguments to be passed to the debugger.

title: container_env_vars

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

title: docker_volume_basedir

title: log_file

description: File to capture output logs.

title: layer_cache_basedir

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

title: skip_pull_image

title: docker_network

title: force_image_build

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

title: shutdown

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

title: container_host

default: localhost

title: container_host_interface

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

title: invoke_image

title: beta_features

description: Enable/Disable beta features.

title: debug

title: profile

title: region

title: Local Start Api command

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

title: Parameters for the local start api command

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)

title: hook_name

title: skip_prepare_infra

title: host

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

title: port

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

title: static_dir

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

default: public

title: template_file

title: env_vars

title: parameter_overrides

title: debug_port

title: debugger_path

title: debug_args

title: container_env_vars

title: docker_volume_basedir

title: log_file

description: File to capture output logs.

title: layer_cache_basedir

title: skip_pull_image

title: docker_network

title: force_image_build

title: warm_containers

title: debug_function

title: shutdown

title: container_host

title: container_host_interface

title: invoke_image

title: beta_features

description: Enable/Disable beta features.

title: debug

title: profile

title: region

title: Local Generate Event command

description: Generate events for Lambda functions.

title: Parameters for the local generate event command

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

title: Local Start Lambda command

description: Emulate AWS serverless functions locally.

title: Parameters for the local start lambda command

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)

title: hook_name

title: skip_prepare_infra

title: host

title: port

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

title: template_file

title: env_vars

title: parameter_overrides

title: debug_port

title: debugger_path

title: debug_args

title: container_env_vars

title: docker_volume_basedir

title: log_file

description: File to capture output logs.

title: layer_cache_basedir

title: skip_pull_image

title: docker_network

title: force_image_build

title: warm_containers

title: debug_function

title: shutdown

title: container_host

title: container_host_interface

title: invoke_image

title: beta_features

description: Enable/Disable beta features.

title: debug

title: profile

title: region

title: Package command

description: Package an AWS SAM application.

title: Parameters for the package command

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)

title: template_file

title: output_template_file

title: s3_bucket

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

title: image_repository

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

title: image_repositories

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.

title: s3_prefix

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

title: kms_key_id

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

title: use_json

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

title: force_upload

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.

title: resolve_s3

title: metadata

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

title: signing_profiles

title: no_progressbar

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

title: beta_features

description: Enable/Disable beta features.

title: debug

title: profile

title: region

title: Deploy command

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

title: Parameters for the deploy command

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.

title: guided

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

title: template_file

title: no_execute_changeset

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

title: fail_on_empty_changeset

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.

title: confirm_changeset

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

title: disable_rollback

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

title: on_failure

title: stack_name

description: Name of the AWS CloudFormation stack.

title: s3_bucket

title: image_repository

title: image_repositories

title: force_upload

title: s3_prefix

title: kms_key_id

title: role_arn

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

title: use_json

title: resolve_s3

title: resolve_image_repos

title: metadata

title: notification_arns

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

title: tags

description: List of tags to associate with the stack.

title: parameter_overrides

title: signing_profiles

title: no_progressbar

title: capabilities

title: profile

title: region

title: beta_features

description: Enable/Disable beta features.

title: debug

title: Delete command

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

e.g. sam delete

title: Parameters for the delete command

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.

title: stack_name

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

title: no_prompts

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

title: s3_bucket

description: The S3 bucket path you want to delete.

title: s3_prefix

description: The S3 prefix you want to delete

title: profile

title: region

title: beta_features

description: Enable/Disable beta features.

title: debug

title: Logs command

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

title: Parameters for the logs command

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)

title: name

title: stack_name

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

title: filter

title: tail

title: include_traces

description: Include the XRay traces in the log output.

title: cw_log_group

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

title: end_time

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'

title: start_time

title: beta_features

description: Enable/Disable beta features.

title: debug

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

title: profile

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

title: region

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

title: Publish command

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>

title: Parameters for the publish command

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.

title: template_file

title: semantic_version

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

title: profile

title: region

title: beta_features

description: Enable/Disable beta features.

title: debug

title: Traces command

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

title: Parameters for the traces command

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)

title: trace_id

description: Fetch specific trace by providing its id

title: tail

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

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

title: end_time

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'

title: start_time

title: beta_features

description: Enable/Disable beta features.

title: debug

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

title: profile

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

title: region

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

title: Sync command

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

title: Parameters for the sync command

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

title: template_file

description: AWS SAM template file.

title: code

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

title: watch

description: Watch local files and automatically sync with cloud.

title: resource_id

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

title: resource

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

title: dependency_layer

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

title: skip_deploy_sync

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.

title: stack_name

description: Name of the AWS CloudFormation stack.

title: base_dir

title: use_container

title: build_image

title: image_repository

title: image_repositories

title: s3_bucket

title: s3_prefix

title: kms_key_id

title: role_arn

title: parameter_overrides

title: beta_features

description: Enable/Disable beta features.

title: debug

title: profile

title: region

title: metadata

title: notification_arns

title: tags

title: capabilities

title: Pipeline Bootstrap command

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.

title: Parameters for the pipeline bootstrap command

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)

title: interactive

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

title: stage

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

title: pipeline_user

title: pipeline_execution_role

title: cloudformation_execution_role

title: bucket

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

title: create_image_repository

title: image_repository

title: confirm_changeset

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

title: permissions_provider

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

title: oidc_provider_url

description: The URL of the OIDC provider.

title: oidc_client_id

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

title: github_org

title: github_repo

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

title: deployment_branch

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

title: oidc_provider

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

title: gitlab_group

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

title: gitlab_project

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

title: bitbucket_repo_uuid

title: cicd_provider

description: The CICD platform for the SAM Pipeline

title: beta_features

description: Enable/Disable beta features.

title: debug

title: profile

title: region

title: Pipeline Init command

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.

title: Parameters for the pipeline init 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.

title: bootstrap

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

title: beta_features

description: Enable/Disable beta features.

title: debug

title: List Resources command

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.

title: Parameters for the list resources command

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.

title: parameter_overrides

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

title: stack_name

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

title: output

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

title: template_file

description: AWS SAM template file.

title: profile

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

title: region

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

title: beta_features

description: Enable/Disable beta features.

title: debug

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

title: List Stack Outputs command

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

title: Parameters for the list stack outputs command

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.

title: stack_name

description: Name of corresponding deployed stack.

title: output

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

title: profile

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

title: region

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

title: beta_features

description: Enable/Disable beta features.

title: debug

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

title: List Endpoints command

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.

title: Parameters for the list endpoints command

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.

title: parameter_overrides

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

title: stack_name

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

title: output

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

title: template_file

description: AWS SAM template file.

title: profile

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

title: region

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

title: beta_features

description: Enable/Disable beta features.

title: debug

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

title: Docs command

description: NEW! Open the documentation in a browser.

title: Parameters for the docs command

description:
Available parameters for the docs command:
*

title: Remote Invoke command

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

title: Parameters for the remote invoke command

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)

title: stack_name

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

title: event

title: event_file

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

title: output

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.

title: parameter

title: beta_features

description: Enable/Disable beta features.

title: debug

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

title: profile

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

title: region

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


servicehub.service.schema.json

type: string

description: The name of the host that should activate the service.

description: A non-empty value will cause this service to be activated on a dedicated host with this ID. All services with the same host / hostId combination will run in the same host process such that they may share global data. If unspecified or empty, a service will share its host process with other services that require the same host and also leave this field empty. If specified, the value must not have spaces in it.

type: boolean

description: A value of 'true' will allow a client to specify a host group when requesting this service.

type: object

description: Host-specific parameters that describe how to activate this service.

required: assemblyPath fullClassName

description: The path to the assembly that carries the service entrypoint class, relative to this file.

description: The full name of the class to instantiate (that accepts a Stream in its constructor) when a new client requests this service.

description: The path that the AppDomain hosting the service should be configured to consider the ApplicationBase, relative to this file.

description: The config file used to initialize the service's AppDomain. It may be omitted if the config file has the same name (+.config) as the service assembly, and resides in the same directory. It is also possible to have the service without the config file.

required: scriptPath constructorFunction

description: The path to the .js file to 'require', relative to this file.

description: The name of the constructor function to use (that accepts a stream) when a new client requests this service.

description: Defines the version of the service.

required: host entryPoint

title: Microsoft ServiceHub Service


statamic.blueprint.schema.json

title: A Statamic Blueprint JSON Schema

title: The 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.

description: The displayed text.

description: The Sections of the Tab

type: array

description: The displayed text.

description: Some instructions

$ref: #/$defs/fields

title: The Sections

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

description: The displayed text.

description: Here you define the fields of this section.

description: The field's template variable.

description: The definition of a single field.

type: object string

$ref: #/$defs/array

$ref: #/$defs/assets

$ref: #/$defs/bard

$ref: #/$defs/checkboxes

$ref: #/$defs/code

$ref: #/$defs/collections

$ref: #/$defs/color

$ref: #/$defs/date

$ref: #/$defs/entries

$ref: #/$defs/form

$ref: #/$defs/grid

$ref: #/$defs/hidden

$ref: #/$defs/html

$ref: #/$defs/integer

$ref: #/$defs/link

$ref: #/$defs/list

$ref: #/$defs/markdown

$ref: #/$defs/radio

$ref: #/$defs/range

$ref: #/$defs/replicator

$ref: #/$defs/revealer

$ref: #/$defs/section

$ref: #/$defs/select

$ref: #/$defs/sites

$ref: #/$defs/slug

$ref: #/$defs/structures

$ref: #/$defs/table

$ref: #/$defs/taxonomies

$ref: #/$defs/taggable

$ref: #/$defs/template

$ref: #/$defs/terms

$ref: #/$defs/text

$ref: #/$defs/textarea

$ref: #/$defs/time

$ref: #/$defs/toggle

$ref: #/$defs/users

$ref: #/$defs/video

$ref: #/$defs/yaml

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

$ref: #/$defs/display

$ref: #/$defs/icon

$ref: #/$defs/listable

$ref: #/$defs/required

$ref: #/$defs/localizable

$ref: #/$defs/validate

const: array

enum: dynamic keyed

type: object array

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

const: assets

enum: grid list

default: list

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

const: bard

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

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

description: Choose which buttons to show in the toolbar.

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

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.

enum: fixed floating

default: fixed

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.

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.

description: Set the array keys and their optional labels.

description: Set the default value.

description: The checkboxes fieldtype is a multiple choice input.

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

description: Choose your preferred theme.

description: Choose language for syntax highlighting.

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

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

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

description: Set a maximum number of selectable items.

description: Choose your preferred UI style.

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

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.

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.

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

description: Set the earliest selectable date in YYYY-MM-DD 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

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.

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

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

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

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

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.

description: The minimum number of required rows.

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

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

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

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

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

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

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

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

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

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.

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

description: Set the default value.

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

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

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

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

description: The minimum size between values.

description: The minimum, left-most value.

description: The maximum, right-most value.

description: Set the default value.

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.

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

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

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.

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

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

description: Allow multiple selections. Default: false.

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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

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

description: The label shown above the field.

description: The icon

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.

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

description: Control whether or not this field is required.

description: The validation rules for that field

enum: accepted active_url required alpha alpha_dash alpha_num array bail boolean confirmed current_password date declined dimensions distinct email enum exclude file filled image integer ip ipv4 ipv6 json nullable numeric password present prohibited string timezone url uuid

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


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

format: uri

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

title: SARIF External Property File Schema Version 2.1.0-rtm.5 JSON Schema


title: CrowdSec Parser

$ref: #/$defs/data

description: If node is successful and onsuccess equals next_stage, event is moved to the next stage

description: If true, enables the debug. Default is false.

description:
nodes is a list of parser nodes, allowing you to build
trees. Each subnode must be valid, and if any of the subnodes
succeed, the whole node is considered successful.

$ref: #/$defs/statics

description: description of the parser usage

$ref: #/$defs/stash

$ref: #/$defs/grok

description:
Non mandatory format version for the parser. configuration
file. New features, may not be understood by old crowdsec
version, filling this correctly ensures that crowdsec supports
all the required parser features.

description:
The mandatory name of the node. If not present, node will be
skipped at runtime. It is used for example in debug log to help
you track things.

description:
filter must be a valid expr expression that will be evaluated
against the event.  If filter evaluation returns true or is
absent, node will be processed.  If filter returns false or a
non-boolean, node won't be processed.

description:
A valid grok pattern can be set up using the "pattern" field, or
a named grok used through the name "field". This applies either
on an valid expr "expression" or on directly on a field
"apply_on"

description: Duration after which cache elements expire

description: Maximum size of the cache

pattern: ^(string|regexp)$

description:
The type is mandatory if you want to evaluate the data in
the file, and should be regex for valid (re2) regular
expression per line or string for string per line. The
regexps will be compiled, the strings will be loaded into
a list and both will be kept in memory. Without specifying
a type, the file will be downloaded and stored as file and
not in memory.

description: destination to store the downloaded file to

pattern: ^(LRU|LFU|ARC)$

description: Strategy for cache behavior. See https://pkg.go.dev/github.com/bluele/gcache

description: url to download file from

description:
data allows user to specify an external source of data. This
section is only relevant when cscli is used to install parser
from hub, as it will download the source_url and store it to
dest_file. When the parser is not installed from the hub,
CrowdSec won't download the URL, but the file must exist for the
parser to be loaded correctly.

description:
pattern_syntax allows user to define named capture group
expressions for future use in grok patterns. Regexp must be a
valid RE2 expression.

required: name key value

description: The caching strategy to be used : LFU, LRU or ARC (see gcache doc for details). Defaults to LRU.

pattern: ^(LFU|LRU|ARC)$

description: The expression that defines the string that will be used as a key.

description: The name of the stash. Distinct parsers can manipulate the same cache

description: The time to leave of items. Default strategy is LRU.

description: The maximum size of the cache.

description:
The stash section allows a parser to capture data, that can be
later accessed/populated via GetFromStash and SetInStash expr
helpers. Each list item defines a capture directive that is
stored in a separate cache (string:string), with its own maximum
size, eviction rules etc.

description:
Statics is a list of directives that will be evaluated when the
node is considered successful. Each entry of the list is
composed of a target (where to write) and a source (what data to
write).


vsconfig.json

description: The version of the component configuration file format.

description: An array of Visual Studio component names

title: JSON schema for Visual Studio component configuration files


description: Regular expression for validating branch names

description: Timeout in seconds

description: Jenkins credentials ID

description: Binary repository details

description: Repository URL

$ref: #/definitions/credentials

description: Jenkins credentials ID for connecting to this repository

required: address credentials

title: CheckMarx

description: Sets whether the scan should be run

$ref: #/definitions/branchPattern

description: Specifies in which branches this stage will be executed

description: Fully qualified team name for the project

description: Scan preset for the project

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

description: Checkmarx Server URL or IP address

default: BB-Checkmarx

description: Jenkins credentials ID

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

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

enum: job global

default: job

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

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

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

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

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

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

description: Sets the maximum number of High vulnerabilities allowed

description: Sets the maximum number of Medium vulnerabilities allowed

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.

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

$ref: #/definitions/timeout

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

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

title: When

description: Condition that should be met to run this step

title: Branch

description: List of steps to run

title: Steps

title: Stage

$ref: #/definitions/steps

$ref: #/definitions/when

title: Fail Fast

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

title: Parallel Stage

$ref: #/definitions/failFast

description: List of stages to be executed in parallel

$ref: #/definitions/singleStage

description: Stage name in the Jenkins pipeline

title: Parallel

$ref: #/definitions/parallelStage

description: Release channel name

description: Indicates on which branches the artifact will be published

description: Dockerfile path

$ref: #/definitions/dockerfile

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.

$ref: #/definitions/outputDockerPublish

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

description: Configuration for running vulnerability scans on published Docker images

title: Vulnerability scan

description: Whether the vulnerability scan step should be run

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

title: Docker build args

$ref: #/definitions/outputDockerBuildArgs

$ref: #/definitions/dockerReleaseChannel

description: ARG name

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

description: Value of the ARG

$ref: #/definitions/releaseChannel

$ref: #/definitions/releaseChannelBranch

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

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

required: channel branch registry credentials

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

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

$ref: #/definitions/outputHelmUpdates

$ref: #/definitions/outputHelmPublish

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

required: path publish updates

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

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

required: file properties

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

$ref: #/definitions/helmReleaseChannel

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

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

description: Cache type

description: Sets whether this cache type is enabled

description: Location of the cache in the Jenkins workspace

description: Location of the cache directory inside the Docker container

description: CI configuration for Amdocs Bill Experience projects

description: Project properties

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

description: Project type

description: ID of a managed maven or npm Jenkins file

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

description: Prebuilt Docker image (has precedence over dockerfile)

description: Path to a local Dockerfile

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

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

description: Adds a Static Analysis stage for Sonar.

description: Cache configuration for projects built inside Docker containers

description: List of cache types

description: Additional services required by the project or application.

enum: Postgres Postgis Redis Mssql Mysql Mongodb Elasticsearch

description: Custom environment variables to be added to the pipeline

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

title: Stages

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

description: Stage name in the Jenkins pipeline

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

description: Configuration for publishing NPM or Maven packages

description: Configuration for generating a Docker image

description: Configuration for generating a Helm chart

description: List of artifacts to archive (wildcards allowed). Check out https://www.jenkins.io/doc/pipeline/steps/core/#archiveartifacts-archive-the-artifacts

description: Build timeout in seconds


samt.json

description: Path to the source directory, defaults to ./src

format: uri-reference

description: The default repositories to use if no repository is specified for a plugin

description: The url to the maven repository to use, defaults to https://repo.maven.apache.org/maven2

description: A local plugin, should most likely not be used in production

required: type path

const: local

description: A maven plugin in POM-like notation, will be downloaded from the provided repository

required: type groupId artifactId version

const: maven

description: A maven plugin in gradle-like notation, will be downloaded from the provided repository

required: type dependency

const: gradle

description: Which SAMT generators to use