Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Generate sam init schema #5560

Merged
merged 11 commits into from
Jul 21, 2023
144 changes: 142 additions & 2 deletions schema/samcli.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,149 @@
"properties": {
"parameters": {
"title": "Parameters for the init command",
"description": "Available parameters for the init command:\n",
"description": "Available parameters for the init command:\n* no_interactive:\nDisable interactive prompting for init parameters. (fail if any required values are missing)\n* architecture:\nArchitectures for Lambda functions.\u001b[1m\n\nArchitectures: ['arm64', 'x86_64']\u001b[0m\n* location:\nTemplate location (git, mercurial, http(s), zip, path).\n* runtime:\nLambda runtime for application.\u001b[1m\n\nRuntimes: 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\u001b[0m\n* package_type:\nLambda deployment package type.\u001b[1m\n\nPackage Types: Zip, Image\u001b[0m\n* base_image:\nLambda base image for deploying IMAGE based package type.\u001b[1m\n\nBase images: amazon/go1.x-base, amazon/go-provided.al2-base, amazon/java8.al2-base, amazon/nodejs18.x-base, amazon/nodejs12.x-base, amazon/python3.7-base, amazon/ruby3.2-base, amazon/python3.8-base, amazon/python3.10-base, amazon/java17-base, amazon/dotnet6-base, amazon/java8-base, amazon/python3.11-base, amazon/nodejs14.x-base, amazon/nodejs16.x-base, amazon/ruby2.7-base, amazon/python3.9-base, amazon/java11-base\u001b[0m\n* dependency_manager:\nDependency manager for Lambda runtime.\u001b[1m\n\nDependency managers: bundler, maven, mod, gradle, npm, pip, cli-package\u001b[0m\n* output_dir:\nDirectory to initialize AWS SAM application.\n* name:\nName of AWS SAM Application.\n* app_template:\nIdentifier of the managed application template to be used. Alternatively, run '$sam init' without options for an interactive workflow.\n* no_input:\nDisable Cookiecutter prompting and accept default values defined in the cookiecutter config.\n* extra_context:\nOverride custom parameters in the template's cookiecutter.json configuration e.g. {\"customParam1\": \"customValue1\", \"customParam2\":\"customValue2\"}\n* tracing:\nEnable AWS X-Ray tracing for application.\n* application_insights:\nEnable CloudWatch Application Insights monitoring for application.\n* beta_features:\nEnable/Disable beta features.\n* debug:\nTurn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.",
"type": "object",
"properties": {}
"properties": {
"no_interactive": {
"title": "no_interactive",
"type": "boolean",
"description": "Disable interactive prompting for init parameters. (fail if any required values are missing)"
},
"architecture": {
"title": "architecture",
"type": "string",
"description": "Architectures for Lambda functions.\u001b[1m\n\nArchitectures: ['arm64', 'x86_64']\u001b[0m",
Leo10Gama marked this conversation as resolved.
Show resolved Hide resolved
"enum": [
"arm64",
"x86_64"
]
},
"location": {
"title": "location",
"type": "string",
"description": "Template location (git, mercurial, http(s), zip, path)."
},
"runtime": {
"title": "runtime",
"type": "string",
"description": "Lambda runtime for application.\u001b[1m\n\nRuntimes: 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\u001b[0m",
"enum": [
"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": {
"title": "package_type",
"type": "string",
"description": "Lambda deployment package type.\u001b[1m\n\nPackage Types: Zip, Image\u001b[0m",
"enum": [
"Zip",
"Image"
]
},
"base_image": {
"title": "base_image",
"type": "string",
"description": "Lambda base image for deploying IMAGE based package type.\u001b[1m\n\nBase images: amazon/go1.x-base, amazon/go-provided.al2-base, amazon/java8.al2-base, amazon/nodejs18.x-base, amazon/nodejs12.x-base, amazon/python3.7-base, amazon/ruby3.2-base, amazon/python3.8-base, amazon/python3.10-base, amazon/java17-base, amazon/dotnet6-base, amazon/java8-base, amazon/python3.11-base, amazon/nodejs14.x-base, amazon/nodejs16.x-base, amazon/ruby2.7-base, amazon/python3.9-base, amazon/java11-base\u001b[0m",
"enum": [
"amazon/go1.x-base",
"amazon/go-provided.al2-base",
"amazon/java8.al2-base",
"amazon/nodejs18.x-base",
"amazon/nodejs12.x-base",
"amazon/python3.7-base",
"amazon/ruby3.2-base",
"amazon/python3.8-base",
"amazon/python3.10-base",
"amazon/java17-base",
"amazon/dotnet6-base",
"amazon/java8-base",
"amazon/python3.11-base",
"amazon/nodejs14.x-base",
"amazon/nodejs16.x-base",
"amazon/ruby2.7-base",
"amazon/python3.9-base",
"amazon/java11-base"
]
},
"dependency_manager": {
"title": "dependency_manager",
"type": "string",
"description": "Dependency manager for Lambda runtime.\u001b[1m\n\nDependency managers: bundler, maven, mod, gradle, npm, pip, cli-package\u001b[0m",
"enum": [
"bundler",
"maven",
"mod",
"gradle",
"npm",
"pip",
"cli-package"
]
},
"output_dir": {
"title": "output_dir",
"type": "string",
"description": "Directory to initialize AWS SAM application.",
"default": "."
},
"name": {
"title": "name",
"type": "string",
"description": "Name of AWS SAM Application."
},
"app_template": {
"title": "app_template",
"type": "string",
"description": "Identifier of the managed application template to be used. Alternatively, run '$sam init' without options for an interactive workflow."
},
"no_input": {
"title": "no_input",
"type": "boolean",
"description": "Disable Cookiecutter prompting and accept default values defined in the cookiecutter config."
},
"extra_context": {
"title": "extra_context",
"type": "string",
"description": "Override custom parameters in the template's cookiecutter.json configuration e.g. {\"customParam1\": \"customValue1\", \"customParam2\":\"customValue2\"}"
},
"tracing": {
"title": "tracing",
"type": "boolean",
"description": "Enable AWS X-Ray tracing for application."
},
"application_insights": {
"title": "application_insights",
"type": "boolean",
"description": "Enable CloudWatch Application Insights monitoring for application."
},
"beta_features": {
"title": "beta_features",
"type": "boolean",
"description": "Enable/Disable beta features."
},
"debug": {
"title": "debug",
"type": "boolean",
"description": "Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps."
}
}
}
},
"required": [
Expand Down
Loading