schema stringclasses 471
values | key stringlengths 0 203 | description stringlengths 0 4.37k | object stringlengths 2 322k |
|---|---|---|---|
samcli.json | include_traces | Include the XRay traces in the log output. | {"type": "boolean"} |
samcli.json | 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 | {"type": "string"} |
samcli.json | 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 | {"type": "string", "enum": ["json", "text"]} |
samcli.json | 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' | {"type": "string"} |
samcli.json | 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'. | {"type": "string", "default": "10m ago"} |
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 | publish | 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> | {"properties": {"parameters": {"type": "object", "properties": {"template_file": {"type": "string", "default": "template.[yaml|yml|json]"}, "semantic_version": {"type": "string"}, "profile": {"type": "string"}, "region": {"type": "string"}, "beta_features": {"type": "boolean"}, "debug": {"type": "boolean"}}}}, "required": ["parameters"]} |
samcli.json | parameters | 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. | {"type": "object", "properties": {"template_file": {"type": "string", "default": "template.[yaml|yml|json]"}, "semantic_version": {"type": "string"}, "profile": {"type": "string"}, "region": {"type": "string"}, "beta_features": {"type": "boolean"}, "debug": {"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 | semantic_version | Optional. The value provided here overrides SemanticVersion in the template metadata. | {"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 | traces | 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 | {"properties": {"parameters": {"type": "object", "properties": {"trace_id": {"type": "string"}, "tail": {"type": "boolean"}, "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 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) | {"type": "object", "properties": {"trace_id": {"type": "string"}, "tail": {"type": "boolean"}, "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 | trace_id | Fetch specific trace by providing its id | {"type": "string"} |
samcli.json | tail | Tail events. This will ignore the end time argument and continue to fetch events as they become available. | {"type": "boolean"} |
samcli.json | 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 | {"type": "string", "enum": ["json", "text"]} |
samcli.json | 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' | {"type": "string"} |
samcli.json | 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'. | {"type": "string", "default": "10m ago"} |
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 | sync | NEW! Sync an AWS SAM Project to AWS. | {"properties": {"parameters": {"type": "object", "properties": {"template_file": {"type": "string", "default": "template.[yaml|yml|json]"}, "code": {"type": "boolean"}, "watch": {"type": "boolean"}, "resource_id": {"type": "string"}, "resource": {"type": "string", "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"]}, "dependency_layer": {"type": "boolean", "default": true}, "skip_deploy_sync": {"type": "boolean", "default": true}, "stack_name": {"type": "string"}, "base_dir": {"type": "string"}, "use_container": {"type": "boolean"}, "build_image": {"type": "string"}, "image_repository": {"type": "string"}, "image_repositories": {"type": "array", "items": {"type": "string"}}, "s3_bucket": {"type": "string"}, "s3_prefix": {"type": "string"}, "kms_key_id": {"type": "string"}, "role_arn": {"type": "string"}, "parameter_overrides": {"type": ["array", "string"], "items": {"type": "string"}}, "beta_features": {"type": "boolean"}, "debug": {"type": "boolean"}, "profile": {"type": "string"}, "region": {"type": "string"}, "metadata": {"type": "string"}, "notification_arns": {"type": ["array", "string"], "items": {"type": "string"}}, "tags": {"type": "array", "items": {"type": "string"}}, "capabilities": {"type": ["array", "string"], "default": ["CAPABILITY_NAMED_IAM", "CAPABILITY_AUTO_EXPAND"], "items": {"type": "string"}}}}}, "required": ["parameters"]} |
samcli.json | parameters | 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 | {"type": "object", "properties": {"template_file": {"type": "string", "default": "template.[yaml|yml|json]"}, "code": {"type": "boolean"}, "watch": {"type": "boolean"}, "resource_id": {"type": "string"}, "resource": {"type": "string", "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"]}, "dependency_layer": {"type": "boolean", "default": true}, "skip_deploy_sync": {"type": "boolean", "default": true}, "stack_name": {"type": "string"}, "base_dir": {"type": "string"}, "use_container": {"type": "boolean"}, "build_image": {"type": "string"}, "image_repository": {"type": "string"}, "image_repositories": {"type": "array", "items": {"type": "string"}}, "s3_bucket": {"type": "string"}, "s3_prefix": {"type": "string"}, "kms_key_id": {"type": "string"}, "role_arn": {"type": "string"}, "parameter_overrides": {"type": ["array", "string"], "items": {"type": "string"}}, "beta_features": {"type": "boolean"}, "debug": {"type": "boolean"}, "profile": {"type": "string"}, "region": {"type": "string"}, "metadata": {"type": "string"}, "notification_arns": {"type": ["array", "string"], "items": {"type": "string"}}, "tags": {"type": "array", "items": {"type": "string"}}, "capabilities": {"type": ["array", "string"], "default": ["CAPABILITY_NAMED_IAM", "CAPABILITY_AUTO_EXPAND"], "items": {"type": "string"}}}} |
samcli.json | template_file | AWS SAM template file. | {"type": "string", "default": "template.[yaml|yml|json]"} |
samcli.json | code | Sync ONLY code resources. This includes Lambda Functions, API Gateway, and Step Functions. | {"type": "boolean"} |
samcli.json | watch | Watch local files and automatically sync with cloud. | {"type": "boolean"} |
samcli.json | 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}. | {"type": "string"} |
samcli.json | 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'] | {"type": "string", "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"]} |
samcli.json | dependency_layer | Separate dependencies of individual function into a Lambda layer for improved performance. | {"type": "boolean", "default": true} |
samcli.json | 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. | {"type": "boolean", "default": true} |
samcli.json | stack_name | Name of the AWS CloudFormation stack. | {"type": "string"} |
samcli.json | base_dir | Resolve relative paths to function's source code with respect to this directory. Use this if SAM template and source code are not in same enclosing folder. By default, relative paths are resolved with respect to the SAM template's location. | {"type": "string"} |
samcli.json | use_container | Build functions within an AWS Lambda-like container. | {"type": "boolean"} |
samcli.json | build_image | Container image URIs for building functions/layers. You can specify for all functions/layers with just the image URI (--build-image public.ecr.aws/sam/build-nodejs18.x:latest). You can specify for each individual function with (--build-image FunctionLogicalID=public.ecr.aws/sam/build-nodejs18.x:latest). A combination of the two can be used. If a function does not have build image specified or an image URI for all functions, the default SAM CLI build images will be used. | {"type": "string"} |
samcli.json | 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_bucket | AWS S3 bucket where artifacts referenced in the template are uploaded. | {"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 | role_arn | ARN of an IAM role that AWS Cloudformation assumes when executing a deployment change set. | {"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 | 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 | 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 | 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"], "default": ["CAPABILITY_NAMED_IAM", "CAPABILITY_AUTO_EXPAND"], "items": {"type": "string"}} |
samcli.json | pipeline_bootstrap | 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. | {"properties": {"parameters": {"type": "object", "properties": {"interactive": {"type": "boolean", "default": true}, "stage": {"type": "string"}, "pipeline_user": {"type": "string"}, "pipeline_execution_role": {"type": "string"}, "cloudformation_execution_role": {"type": "string"}, "bucket": {"type": "string"}, "create_image_repository": {"type": "boolean"}, "image_repository": {"type": "string"}, "confirm_changeset": {"type": "boolean", "default": true}, "permissions_provider": {"type": "string", "default": "iam", "enum": ["iam", "oidc"]}, "oidc_provider_url": {"type": "string"}, "oidc_client_id": {"type": "string"}, "github_org": {"type": "string"}, "github_repo": {"type": "string"}, "deployment_branch": {"type": "string"}, "oidc_provider": {"type": "string", "enum": ["bitbucket-pipelines", "github-actions", "gitlab"]}, "gitlab_group": {"type": "string"}, "gitlab_project": {"type": "string"}, "bitbucket_repo_uuid": {"type": "string"}, "cicd_provider": {"type": "string"}, "beta_features": {"type": "boolean"}, "debug": {"type": "boolean"}, "profile": {"type": "string"}, "region": {"type": "string"}}}}, "required": ["parameters"]} |
samcli.json | parameters | 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) | {"type": "object", "properties": {"interactive": {"type": "boolean", "default": true}, "stage": {"type": "string"}, "pipeline_user": {"type": "string"}, "pipeline_execution_role": {"type": "string"}, "cloudformation_execution_role": {"type": "string"}, "bucket": {"type": "string"}, "create_image_repository": {"type": "boolean"}, "image_repository": {"type": "string"}, "confirm_changeset": {"type": "boolean", "default": true}, "permissions_provider": {"type": "string", "default": "iam", "enum": ["iam", "oidc"]}, "oidc_provider_url": {"type": "string"}, "oidc_client_id": {"type": "string"}, "github_org": {"type": "string"}, "github_repo": {"type": "string"}, "deployment_branch": {"type": "string"}, "oidc_provider": {"type": "string", "enum": ["bitbucket-pipelines", "github-actions", "gitlab"]}, "gitlab_group": {"type": "string"}, "gitlab_project": {"type": "string"}, "bitbucket_repo_uuid": {"type": "string"}, "cicd_provider": {"type": "string"}, "beta_features": {"type": "boolean"}, "debug": {"type": "boolean"}, "profile": {"type": "string"}, "region": {"type": "string"}}} |
samcli.json | interactive | Disable interactive prompting for bootstrap parameters, and fail if any required arguments are missing. | {"type": "boolean", "default": true} |
samcli.json | stage | The name of the corresponding deployment stage. It is used as a suffix for the created AWS infrastructure resources. | {"type": "string"} |
samcli.json | 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. | {"type": "string"} |
samcli.json | 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. | {"type": "string"} |
samcli.json | 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. | {"type": "string"} |
samcli.json | bucket | The ARN of the Amazon S3 bucket to hold the AWS SAM artifacts. | {"type": "string"} |
samcli.json | 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. | {"type": "boolean"} |
samcli.json | 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. | {"type": "string"} |
samcli.json | confirm_changeset | Prompt to confirm if the resources are to be deployed. | {"type": "boolean", "default": true} |
samcli.json | permissions_provider | Choose a permissions provider to assume the pipeline execution role. Default is to use an IAM User. | {"type": "string", "default": "iam", "enum": ["iam", "oidc"]} |
samcli.json | oidc_provider_url | The URL of the OIDC provider. | {"type": "string"} |
samcli.json | oidc_client_id | The client ID configured to use with the OIDC provider. | {"type": "string"} |
samcli.json | 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 | {"type": "string"} |
samcli.json | github_repo | The name of the GitHub Repository that deployments will occur from. Only used if using GitHub Actions OIDC for permissions | {"type": "string"} |
samcli.json | deployment_branch | The name of the branch that deployments will occur from. Only used if using GitHub Actions OIDC for permissions | {"type": "string"} |
samcli.json | 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 | {"type": "string", "enum": ["bitbucket-pipelines", "github-actions", "gitlab"]} |
samcli.json | gitlab_group | The GitLab group that the repository belongs to. Only used if using GitLab OIDC for permissions | {"type": "string"} |
samcli.json | gitlab_project | The GitLab project name. Only used if using GitLab OIDC for permissions | {"type": "string"} |
samcli.json | 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 | {"type": "string"} |
samcli.json | cicd_provider | The CICD platform for the SAM Pipeline | {"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 | pipeline_init | 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. | {"properties": {"parameters": {"type": "object", "properties": {"bootstrap": {"type": "boolean"}, "beta_features": {"type": "boolean"}, "debug": {"type": "boolean"}}}}, "required": ["parameters"]} |
samcli.json | parameters | 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. | {"type": "object", "properties": {"bootstrap": {"type": "boolean"}, "beta_features": {"type": "boolean"}, "debug": {"type": "boolean"}}} |
samcli.json | bootstrap | Enable interactive mode that walks the user through creating necessary AWS infrastructure resources. | {"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 | list_resources | 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. | {"properties": {"parameters": {"type": "object", "properties": {"parameter_overrides": {"type": ["array", "string"], "items": {"type": "string"}}, "stack_name": {"type": "string"}, "output": {"type": "string", "default": "table", "enum": ["json", "table"]}, "template_file": {"type": "string", "default": "template.[yaml|yml|json]"}, "profile": {"type": "string"}, "region": {"type": "string"}, "beta_features": {"type": "boolean"}, "debug": {"type": "boolean"}}}}, "required": ["parameters"]} |
samcli.json | parameters | 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. | {"type": "object", "properties": {"parameter_overrides": {"type": ["array", "string"], "items": {"type": "string"}}, "stack_name": {"type": "string"}, "output": {"type": "string", "default": "table", "enum": ["json", "table"]}, "template_file": {"type": "string", "default": "template.[yaml|yml|json]"}, "profile": {"type": "string"}, "region": {"type": "string"}, "beta_features": {"type": "boolean"}, "debug": {"type": "boolean"}}} |
samcli.json | parameter_overrides | String that contains AWS CloudFormation parameter overrides encoded as key=value pairs. | {"type": ["array", "string"], "items": {"type": "string"}} |
samcli.json | stack_name | Name of corresponding deployed stack.(Not including a stack name will only show local resources defined in the template.) | {"type": "string"} |
samcli.json | output | Output the results from the command in a given output format (json or table). | {"type": "string", "default": "table", "enum": ["json", "table"]} |
samcli.json | template_file | AWS SAM template file. | {"type": "string", "default": "template.[yaml|yml|json]"} |
samcli.json | profile | Select a specific profile from your credential file to get AWS credentials. | {"type": "string"} |
samcli.json | region | Set the AWS Region of the service. (e.g. us-east-1) | {"type": "string"} |
samcli.json | beta_features | Enable/Disable beta features. | {"type": "boolean"} |
samcli.json | debug | Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps. | {"type": "boolean"} |
samcli.json | list_stack_outputs | Get the stack outputs as defined in the SAM/CloudFormation template. | {"properties": {"parameters": {"type": "object", "properties": {"stack_name": {"type": "string"}, "output": {"type": "string", "default": "table", "enum": ["json", "table"]}, "profile": {"type": "string"}, "region": {"type": "string"}, "beta_features": {"type": "boolean"}, "debug": {"type": "boolean"}}}}, "required": ["parameters"]} |
samcli.json | parameters | 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. | {"type": "object", "properties": {"stack_name": {"type": "string"}, "output": {"type": "string", "default": "table", "enum": ["json", "table"]}, "profile": {"type": "string"}, "region": {"type": "string"}, "beta_features": {"type": "boolean"}, "debug": {"type": "boolean"}}} |
samcli.json | stack_name | Name of corresponding deployed stack. | {"type": "string"} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.