schema stringclasses 471
values | key stringlengths 0 203 | description stringlengths 0 4.37k | object stringlengths 2 322k |
|---|---|---|---|
samcli.json | debug | Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps. | {"type": "boolean"} |
samcli.json | profile | Select a specific profile from your credential file to get AWS credentials. | {"type": "string"} |
samcli.json | region | Set the AWS Region of the service. (e.g. us-east-1) | {"type": "string"} |
samcli.json | local_generate_event | Generate events for Lambda functions. | {"properties": {"parameters": {"type": "object", "properties": {}}}, "required": ["parameters"]} |
samcli.json | parameters | Available parameters for the local generate event command:
* | {"type": "object", "properties": {}} |
samcli.json | local_start_lambda | Emulate AWS serverless functions locally. | {"properties": {"parameters": {"type": "object", "properties": {"hook_name": {"type": "string"}, "skip_prepare_infra": {"type": "boolean"}, "host": {"type": "string", "default": "127.0.0.1"}, "port": {"type": "integer", "default": 3001}, "template_file": {"type": "string", "default": "template.[yaml|yml|json]"}, "env_vars": {"type": "string"}, "parameter_overrides": {"type": ["array", "string"], "items": {"type": "string"}}, "debug_port": {"type": "integer"}, "debugger_path": {"type": "string"}, "debug_args": {"type": "string"}, "container_env_vars": {"type": "string"}, "docker_volume_basedir": {"type": "string"}, "log_file": {"type": "string"}, "layer_cache_basedir": {"type": "string"}, "skip_pull_image": {"type": "boolean"}, "docker_network": {"type": "string"}, "force_image_build": {"type": "boolean"}, "warm_containers": {"type": "string", "enum": ["EAGER", "LAZY"]}, "debug_function": {"type": "string"}, "shutdown": {"type": "boolean"}, "container_host": {"type": "string", "default": "localhost"}, "container_host_interface": {"type": "string", "default": "127.0.0.1"}, "invoke_image": {"type": "string"}, "beta_features": {"type": "boolean"}, "debug": {"type": "boolean"}, "profile": {"type": "string"}, "region": {"type": "string"}}}}, "required": ["parameters"]} |
samcli.json | parameters | Available parameters for the local start 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) | {"type": "object", "properties": {"hook_name": {"type": "string"}, "skip_prepare_infra": {"type": "boolean"}, "host": {"type": "string", "default": "127.0.0.1"}, "port": {"type": "integer", "default": 3001}, "template_file": {"type": "string", "default": "template.[yaml|yml|json]"}, "env_vars": {"type": "string"}, "parameter_overrides": {"type": ["array", "string"], "items": {"type": "string"}}, "debug_port": {"type": "integer"}, "debugger_path": {"type": "string"}, "debug_args": {"type": "string"}, "container_env_vars": {"type": "string"}, "docker_volume_basedir": {"type": "string"}, "log_file": {"type": "string"}, "layer_cache_basedir": {"type": "string"}, "skip_pull_image": {"type": "boolean"}, "docker_network": {"type": "string"}, "force_image_build": {"type": "boolean"}, "warm_containers": {"type": "string", "enum": ["EAGER", "LAZY"]}, "debug_function": {"type": "string"}, "shutdown": {"type": "boolean"}, "container_host": {"type": "string", "default": "localhost"}, "container_host_interface": {"type": "string", "default": "127.0.0.1"}, "invoke_image": {"type": "string"}, "beta_features": {"type": "boolean"}, "debug": {"type": "boolean"}, "profile": {"type": "string"}, "region": {"type": "string"}}} |
samcli.json | hook_name | Hook package id to extend AWS SAM CLI commands functionality.
Example: `terraform` to extend AWS SAM CLI commands functionality to support terraform applications.
Available Hook Names: ['terraform'] | {"type": "string"} |
samcli.json | skip_prepare_infra | Skip preparation stage when there are no infrastructure changes. Only used in conjunction with --hook-name. | {"type": "boolean"} |
samcli.json | host | Local hostname or IP address to bind to (default: '127.0.0.1') | {"type": "string", "default": "127.0.0.1"} |
samcli.json | port | Local port number to listen on (default: '3001') | {"type": "integer", "default": 3001} |
samcli.json | template_file | AWS SAM template which references built artifacts for resources in the template. (if applicable) | {"type": "string", "default": "template.[yaml|yml|json]"} |
samcli.json | env_vars | JSON file containing values for Lambda function's environment variables. | {"type": "string"} |
samcli.json | parameter_overrides | String that contains AWS CloudFormation parameter overrides encoded as key=value pairs. | {"type": ["array", "string"], "items": {"type": "string"}} |
samcli.json | debug_port | When specified, Lambda function container will start in debug mode and will expose this port on localhost. | {"type": "integer"} |
samcli.json | debugger_path | Host path to a debugger that will be mounted into the Lambda container. | {"type": "string"} |
samcli.json | debug_args | Additional arguments to be passed to the debugger. | {"type": "string"} |
samcli.json | container_env_vars | JSON file containing environment variables to be set within the container environment | {"type": "string"} |
samcli.json | docker_volume_basedir | Specify the location basedir where the SAM template exists. If Docker is running on a remote machine, Path of the SAM template must be mounted on the Docker machine and modified to match the remote machine. | {"type": "string"} |
samcli.json | log_file | File to capture output logs. | {"type": "string"} |
samcli.json | layer_cache_basedir | Specify the location basedir where the lambda layers used by the template will be downloaded to. | {"type": "string"} |
samcli.json | skip_pull_image | Skip pulling down the latest Docker image for Lambda runtime. | {"type": "boolean"} |
samcli.json | docker_network | Name or ID of an existing docker network for AWS Lambda docker containers to connect to, along with the default bridge network. If not specified, the Lambda containers will only connect to the default bridge docker network. | {"type": "string"} |
samcli.json | force_image_build | Force rebuilding the image used for invoking functions with layers. | {"type": "boolean"} |
samcli.json | warm_containers | Optional. Specifies how AWS SAM CLI manages
containers for each function.
Two modes are available:
EAGER: Containers for all functions are
loaded at startup and persist between
invocations.
LAZY: Containers are only loaded when each
function is first invoked. Those containers
persist for additional invocations. | {"type": "string", "enum": ["EAGER", "LAZY"]} |
samcli.json | debug_function | Optional. Specifies the Lambda Function logicalId to apply debug options to when --warm-containers is specified. This parameter applies to --debug-port, --debugger-path, and --debug-args. | {"type": "string"} |
samcli.json | shutdown | Emulate a shutdown event after invoke completes, to test extension handling of shutdown behavior. | {"type": "boolean"} |
samcli.json | container_host | Host of locally emulated Lambda container. This option is useful when the container runs on a different host than AWS SAM CLI. For example, if one wants to run AWS SAM CLI in a Docker container on macOS, this option could specify `host.docker.internal` | {"type": "string", "default": "localhost"} |
samcli.json | container_host_interface | IP address of the host network interface that container ports should bind to. Use 0.0.0.0 to bind to all interfaces. | {"type": "string", "default": "127.0.0.1"} |
samcli.json | invoke_image | Container image URIs for invoking functions or starting api and function. One can specify the image URI used for the local function invocation (--invoke-image public.ecr.aws/sam/build-nodejs14.x:latest). One can also specify for each individual function with (--invoke-image Function1=public.ecr.aws/sam/build-nodejs14.x:latest). If a function does not have invoke image specified, the default AWS SAM CLI emulation image will be used. | {"type": "string"} |
samcli.json | beta_features | Enable/Disable beta features. | {"type": "boolean"} |
samcli.json | debug | Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps. | {"type": "boolean"} |
samcli.json | profile | Select a specific profile from your credential file to get AWS credentials. | {"type": "string"} |
samcli.json | region | Set the AWS Region of the service. (e.g. us-east-1) | {"type": "string"} |
samcli.json | package | Package an AWS SAM application. | {"properties": {"parameters": {"type": "object", "properties": {"template_file": {"type": "string", "default": "template.[yaml|yml|json]"}, "output_template_file": {"type": "string"}, "s3_bucket": {"type": "string"}, "image_repository": {"type": "string"}, "image_repositories": {"type": "array", "items": {"type": "string"}}, "s3_prefix": {"type": "string"}, "kms_key_id": {"type": "string"}, "use_json": {"type": "boolean"}, "force_upload": {"type": "boolean"}, "resolve_s3": {"type": "boolean"}, "metadata": {"type": "string"}, "signing_profiles": {"type": "string"}, "no_progressbar": {"type": "boolean"}, "beta_features": {"type": "boolean"}, "debug": {"type": "boolean"}, "profile": {"type": "string"}, "region": {"type": "string"}}}}, "required": ["parameters"]} |
samcli.json | parameters | 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) | {"type": "object", "properties": {"template_file": {"type": "string", "default": "template.[yaml|yml|json]"}, "output_template_file": {"type": "string"}, "s3_bucket": {"type": "string"}, "image_repository": {"type": "string"}, "image_repositories": {"type": "array", "items": {"type": "string"}}, "s3_prefix": {"type": "string"}, "kms_key_id": {"type": "string"}, "use_json": {"type": "boolean"}, "force_upload": {"type": "boolean"}, "resolve_s3": {"type": "boolean"}, "metadata": {"type": "string"}, "signing_profiles": {"type": "string"}, "no_progressbar": {"type": "boolean"}, "beta_features": {"type": "boolean"}, "debug": {"type": "boolean"}, "profile": {"type": "string"}, "region": {"type": "string"}}} |
samcli.json | template_file | AWS SAM template which references built artifacts for resources in the template. (if applicable) | {"type": "string", "default": "template.[yaml|yml|json]"} |
samcli.json | 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. | {"type": "string"} |
samcli.json | s3_bucket | AWS S3 bucket where artifacts referenced in the template are uploaded. | {"type": "string"} |
samcli.json | image_repository | AWS ECR repository URI where artifacts referenced in the template are uploaded. | {"type": "string"} |
samcli.json | 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. | {"type": "array", "items": {"type": "string"}} |
samcli.json | s3_prefix | Prefix name that is added to the artifact's name when it is uploaded to the AWS S3 bucket. | {"type": "string"} |
samcli.json | 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. | {"type": "string"} |
samcli.json | use_json | Indicates whether to use JSON as the format for the output AWS CloudFormation template. YAML is used by default. | {"type": "boolean"} |
samcli.json | 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. | {"type": "boolean"} |
samcli.json | 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. | {"type": "boolean"} |
samcli.json | metadata | Map of metadata to attach to ALL the artifacts that are referenced in the template. | {"type": "string"} |
samcli.json | 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 | {"type": "string"} |
samcli.json | no_progressbar | Does not showcase a progress bar when uploading artifacts to S3 and pushing docker images to ECR | {"type": "boolean"} |
samcli.json | beta_features | Enable/Disable beta features. | {"type": "boolean"} |
samcli.json | debug | Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps. | {"type": "boolean"} |
samcli.json | profile | Select a specific profile from your credential file to get AWS credentials. | {"type": "string"} |
samcli.json | region | Set the AWS Region of the service. (e.g. us-east-1) | {"type": "string"} |
samcli.json | deploy | The sam deploy command creates a Cloudformation Stack and deploys your resources. | {"properties": {"parameters": {"type": "object", "properties": {"guided": {"type": "boolean"}, "template_file": {"type": "string", "default": "template.[yaml|yml|json]"}, "no_execute_changeset": {"type": "boolean"}, "fail_on_empty_changeset": {"type": "boolean", "default": true}, "confirm_changeset": {"type": "boolean"}, "disable_rollback": {"type": "boolean"}, "on_failure": {"type": "string", "default": "ROLLBACK", "enum": ["DELETE", "DO_NOTHING", "ROLLBACK"]}, "stack_name": {"type": "string"}, "s3_bucket": {"type": "string"}, "image_repository": {"type": "string"}, "image_repositories": {"type": "array", "items": {"type": "string"}}, "force_upload": {"type": "boolean"}, "s3_prefix": {"type": "string"}, "kms_key_id": {"type": "string"}, "role_arn": {"type": "string"}, "use_json": {"type": "boolean"}, "resolve_s3": {"type": "boolean"}, "resolve_image_repos": {"type": "boolean"}, "metadata": {"type": "string"}, "notification_arns": {"type": ["array", "string"], "items": {"type": "string"}}, "tags": {"type": "array", "items": {"type": "string"}}, "parameter_overrides": {"type": ["array", "string"], "items": {"type": "string"}}, "signing_profiles": {"type": "string"}, "no_progressbar": {"type": "boolean"}, "capabilities": {"type": ["array", "string"], "items": {"type": "string"}}, "profile": {"type": "string"}, "region": {"type": "string"}, "beta_features": {"type": "boolean"}, "debug": {"type": "boolean"}}}}, "required": ["parameters"]} |
samcli.json | parameters | 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. | {"type": "object", "properties": {"guided": {"type": "boolean"}, "template_file": {"type": "string", "default": "template.[yaml|yml|json]"}, "no_execute_changeset": {"type": "boolean"}, "fail_on_empty_changeset": {"type": "boolean", "default": true}, "confirm_changeset": {"type": "boolean"}, "disable_rollback": {"type": "boolean"}, "on_failure": {"type": "string", "default": "ROLLBACK", "enum": ["DELETE", "DO_NOTHING", "ROLLBACK"]}, "stack_name": {"type": "string"}, "s3_bucket": {"type": "string"}, "image_repository": {"type": "string"}, "image_repositories": {"type": "array", "items": {"type": "string"}}, "force_upload": {"type": "boolean"}, "s3_prefix": {"type": "string"}, "kms_key_id": {"type": "string"}, "role_arn": {"type": "string"}, "use_json": {"type": "boolean"}, "resolve_s3": {"type": "boolean"}, "resolve_image_repos": {"type": "boolean"}, "metadata": {"type": "string"}, "notification_arns": {"type": ["array", "string"], "items": {"type": "string"}}, "tags": {"type": "array", "items": {"type": "string"}}, "parameter_overrides": {"type": ["array", "string"], "items": {"type": "string"}}, "signing_profiles": {"type": "string"}, "no_progressbar": {"type": "boolean"}, "capabilities": {"type": ["array", "string"], "items": {"type": "string"}}, "profile": {"type": "string"}, "region": {"type": "string"}, "beta_features": {"type": "boolean"}, "debug": {"type": "boolean"}}} |
samcli.json | guided | Specify this flag to allow SAM CLI to guide you through the deployment using guided prompts. | {"type": "boolean"} |
samcli.json | template_file | AWS SAM template which references built artifacts for resources in the template. (if applicable) | {"type": "string", "default": "template.[yaml|yml|json]"} |
samcli.json | no_execute_changeset | Indicates whether to execute the change set. Specify this flag to view stack changes before executing the change set. | {"type": "boolean"} |
samcli.json | 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. | {"type": "boolean", "default": true} |
samcli.json | confirm_changeset | Prompt to confirm if the computed changeset is to be deployed by SAM CLI. | {"type": "boolean"} |
samcli.json | disable_rollback | Preserves the state of previously provisioned resources when an operation fails. | {"type": "boolean"} |
samcli.json | 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. | {"type": "string", "default": "ROLLBACK", "enum": ["DELETE", "DO_NOTHING", "ROLLBACK"]} |
samcli.json | stack_name | Name of the AWS CloudFormation stack. | {"type": "string"} |
samcli.json | s3_bucket | AWS S3 bucket where artifacts referenced in the template are uploaded. | {"type": "string"} |
samcli.json | image_repository | AWS ECR repository URI where artifacts referenced in the template are uploaded. | {"type": "string"} |
samcli.json | 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. | {"type": "array", "items": {"type": "string"}} |
samcli.json | 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. | {"type": "boolean"} |
samcli.json | s3_prefix | Prefix name that is added to the artifact's name when it is uploaded to the AWS S3 bucket. | {"type": "string"} |
samcli.json | 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. | {"type": "string"} |
samcli.json | role_arn | ARN of an IAM role that AWS Cloudformation assumes when executing a deployment change set. | {"type": "string"} |
samcli.json | use_json | Indicates whether to use JSON as the format for the output AWS CloudFormation template. YAML is used by default. | {"type": "boolean"} |
samcli.json | 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. | {"type": "boolean"} |
samcli.json | 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. | {"type": "boolean"} |
samcli.json | metadata | Map of metadata to attach to ALL the artifacts that are referenced in the template. | {"type": "string"} |
samcli.json | notification_arns | ARNs of SNS topics that AWS Cloudformation associates with the stack. | {"type": ["array", "string"], "items": {"type": "string"}} |
samcli.json | tags | List of tags to associate with the stack. | {"type": "array", "items": {"type": "string"}} |
samcli.json | parameter_overrides | String that contains AWS CloudFormation parameter overrides encoded as key=value pairs. | {"type": ["array", "string"], "items": {"type": "string"}} |
samcli.json | 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 | {"type": "string"} |
samcli.json | no_progressbar | Does not showcase a progress bar when uploading artifacts to S3 and pushing docker images to ECR | {"type": "boolean"} |
samcli.json | 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 | {"type": ["array", "string"], "items": {"type": "string"}} |
samcli.json | profile | Select a specific profile from your credential file to get AWS credentials. | {"type": "string"} |
samcli.json | region | Set the AWS Region of the service. (e.g. us-east-1) | {"type": "string"} |
samcli.json | beta_features | Enable/Disable beta features. | {"type": "boolean"} |
samcli.json | debug | Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps. | {"type": "boolean"} |
samcli.json | delete | The sam delete command deletes the CloudFormation
stack and all the artifacts which were created using sam deploy.
e.g. sam delete | {"properties": {"parameters": {"type": "object", "properties": {"stack_name": {"type": "string"}, "no_prompts": {"type": "boolean"}, "s3_bucket": {"type": "string"}, "s3_prefix": {"type": "string"}, "profile": {"type": "string"}, "region": {"type": "string"}, "beta_features": {"type": "boolean"}, "debug": {"type": "boolean"}}}}, "required": ["parameters"]} |
samcli.json | parameters | 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. | {"type": "object", "properties": {"stack_name": {"type": "string"}, "no_prompts": {"type": "boolean"}, "s3_bucket": {"type": "string"}, "s3_prefix": {"type": "string"}, "profile": {"type": "string"}, "region": {"type": "string"}, "beta_features": {"type": "boolean"}, "debug": {"type": "boolean"}}} |
samcli.json | stack_name | The name of the AWS CloudFormation stack you want to delete. | {"type": "string"} |
samcli.json | no_prompts | Specify this flag to allow SAM CLI to skip through the guided prompts. | {"type": "boolean"} |
samcli.json | s3_bucket | The S3 bucket path you want to delete. | {"type": "string"} |
samcli.json | s3_prefix | The S3 prefix you want to delete | {"type": "string"} |
samcli.json | profile | Select a specific profile from your credential file to get AWS credentials. | {"type": "string"} |
samcli.json | region | Set the AWS Region of the service. (e.g. us-east-1) | {"type": "string"} |
samcli.json | beta_features | Enable/Disable beta features. | {"type": "boolean"} |
samcli.json | debug | Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps. | {"type": "boolean"} |
samcli.json | logs | The sam logs commands fetches logs of Lambda Functions/CloudWatch log groups
with additional filtering by options. | {"properties": {"parameters": {"type": "object", "properties": {"name": {"type": "string"}, "stack_name": {"type": "string"}, "filter": {"type": "string"}, "tail": {"type": "boolean"}, "include_traces": {"type": "boolean"}, "cw_log_group": {"type": "string"}, "output": {"type": "string", "enum": ["json", "text"]}, "end_time": {"type": "string"}, "start_time": {"type": "string", "default": "10m ago"}, "beta_features": {"type": "boolean"}, "debug": {"type": "boolean"}, "profile": {"type": "string"}, "region": {"type": "string"}}}}, "required": ["parameters"]} |
samcli.json | parameters | 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) | {"type": "object", "properties": {"name": {"type": "string"}, "stack_name": {"type": "string"}, "filter": {"type": "string"}, "tail": {"type": "boolean"}, "include_traces": {"type": "boolean"}, "cw_log_group": {"type": "string"}, "output": {"type": "string", "enum": ["json", "text"]}, "end_time": {"type": "string"}, "start_time": {"type": "string", "default": "10m ago"}, "beta_features": {"type": "boolean"}, "debug": {"type": "boolean"}, "profile": {"type": "string"}, "region": {"type": "string"}}} |
samcli.json | 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. | {"type": "string"} |
samcli.json | stack_name | Name of the AWS CloudFormation stack that the function is a part of. | {"type": "string"} |
samcli.json | 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 | {"type": "string"} |
samcli.json | 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 | {"type": "boolean"} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.