schema stringclasses 471
values | key stringlengths 0 203 | description stringlengths 0 4.37k | object stringlengths 2 322k |
|---|---|---|---|
config_schema.json | az_blacklist | List of Availablilty Zones ID's to exclude when generating availability zones | {"items": {"examples": ["usw2-laz1-az1", "use2-az2"], "pattern": "(afs1-az1|afs1-az2|afs1-az3|afs1-los1-az1|ape1-az1|ape1-az2|ape1-az3|apne1-az1|apne1-az2|apne1-az4|apne1-tpe1-az1|apne2-az1|apne2-az2|apne2-az3|apne2-az4|apne3-az1|apne3-az2|apne3-az3|aps1-az1|aps1-az2|aps1-az3|aps1-ccu1-az1|aps1-del1-az1|aps2-az1|aps2-a... |
config_schema.json | items | Availability Zone ID, eg.: 'use1-az1' | {"examples": ["usw2-laz1-az1", "use2-az2"], "pattern": "(afs1-az1|afs1-az2|afs1-az3|afs1-los1-az1|ape1-az1|ape1-az2|ape1-az3|apne1-az1|apne1-az2|apne1-az4|apne1-tpe1-az1|apne2-az1|apne2-az2|apne2-az3|apne2-az4|apne3-az1|apne3-az2|apne3-az3|aps1-az1|aps1-az2|aps1-az3|aps1-ccu1-az1|aps1-del1-az1|aps2-az1|aps2-az2|aps2-az... |
config_schema.json | build_submodules | Build Lambda zips recursively for submodules, set to false to disable | {"examples": [true, false], "type": "boolean"} |
config_schema.json | lambda_source_path | Path relative to the project root containing Lambda zip files, default is 'lambda_functions/source' | {"examples": ["functions/source"], "type": "string"} |
config_schema.json | lambda_zip_path | Path relative to the project root to place Lambda zip files | {"examples": ["functions/packages"], "type": "string"} |
config_schema.json | name | Project name, used as s3 key prefix when uploading objects | {"examples": ["my-project-name"], "pattern": "^[a-z0-9-/]*$", "type": "string"} |
config_schema.json | org_id | Organization ID to use when launching CFN Stacks. starts with o-. It is found on Organization Settings page | {"type": "string"} |
config_schema.json | owner | email address for project owner (not used at present) | {"examples": ["Bob.Slydell@example.com"], "type": "string"} |
config_schema.json | package_lambda | Package Lambda functions into zips before uploading to s3, set to false to disable | {"examples": [true, false], "type": "boolean"} |
config_schema.json | parameters | Parameter key-values to pass to CloudFormation, parameters provided in global config take precedence | {"additionalProperties": {"anyOf": [{"items": {"anyOf": [{"type": "integer"}, {"type": "string"}]}, "type": "array"}, {"type": "boolean"}, {"type": "integer"}, {"type": "string"}]}, "type": "object"} |
config_schema.json | posthooks | hooks to execute after executing tests | {"items": {}, "type": "array"} |
config_schema.json | prehooks | hooks to execute prior to executing tests | {"items": {}, "type": "array"} |
config_schema.json | regions | List of AWS regions | {"items": {"examples": ["us-east-1"], "pattern": "^(ap|eu|us|sa|ca|cn|af|me|il|us-gov)-(central|south|north|east|west|southeast|southwest|northeast|northwest)-[0-9]$", "type": "string"}, "type": "array"} |
config_schema.json | items | AWS Region name | {"examples": ["us-east-1"], "pattern": "^(ap|eu|us|sa|ca|cn|af|me|il|us-gov)-(central|south|north|east|west|southeast|southwest|northeast|northwest)-[0-9]$", "type": "string"} |
config_schema.json | role_name | Role name to use when launching CFN Stacks. | {"type": "string"} |
config_schema.json | s3_bucket | Name of S3 bucket to upload project to, if left out a bucket will be auto-generated | {"examples": ["my-s3-bucket-name"], "pattern": "^[a-z0-9-]*$", "type": "string"} |
config_schema.json | s3_enable_sig_v2 | Enable (deprecated) sigv2 access to auto-generated buckets | {"examples": [true, false], "type": "boolean"} |
config_schema.json | s3_object_acl | ACL for uploaded s3 objects | {"default": "private", "examples": ["bucket-owner-read", "private"], "pattern": "^(bucket-owner-full-control|bucket-owner-read|authenticated-read|aws-exec-read|public-read-write|public-read|private)$", "type": "string"} |
config_schema.json | s3_regional_buckets | Enable regional auto-buckets. | {"examples": [true, false], "type": "boolean"} |
config_schema.json | shorten_stack_name | Shorten stack names generated for tests, set to true to enable | {"examples": [true, false], "type": "boolean"} |
config_schema.json | tags | Tags to apply to CloudFormation template | {"additionalProperties": {"type": "string"}, "examples": [{"CostCenter": "1001"}], "type": "object"} |
config_schema.json | template | path to template file relative to the project config file path | {"examples": ["cloudformation_templates/"], "type": "string"} |
config_schema.json | TestConfig | Test specific configuration section. | {"additionalProperties": false, "properties": {"artifact_regions": {"items": {"examples": ["us-east-1"], "pattern": "^(ap|eu|us|sa|ca|cn|af|me|il|us-gov)-(central|south|north|east|west|southeast|southwest|northeast|northwest)-[0-9]$", "type": "string"}, "type": "array"}, "auth": {"additionalProperties": {"type": "strin... |
config_schema.json | artifact_regions | List of AWS regions where artifacts need to be copied. This helps same region artifact bucket access to resources | {"items": {"examples": ["us-east-1"], "pattern": "^(ap|eu|us|sa|ca|cn|af|me|il|us-gov)-(central|south|north|east|west|southeast|southwest|northeast|northwest)-[0-9]$", "type": "string"}, "type": "array"} |
config_schema.json | items | AWS Region name | {"examples": ["us-east-1"], "pattern": "^(ap|eu|us|sa|ca|cn|af|me|il|us-gov)-(central|south|north|east|west|southeast|southwest|northeast|northwest)-[0-9]$", "type": "string"} |
config_schema.json | auth | AWS authentication section | {"additionalProperties": {"type": "string"}, "examples": [{"cn-northwest-1": "china-profile", "default": "my-default-profile", "us-east-2": "specific-profile-for-us-east-2"}], "type": "object"} |
config_schema.json | az_blacklist | List of Availablilty Zones ID's to exclude when generating availability zones | {"items": {"examples": ["usw2-laz1-az1", "use2-az2"], "pattern": "(afs1-az1|afs1-az2|afs1-az3|afs1-los1-az1|ape1-az1|ape1-az2|ape1-az3|apne1-az1|apne1-az2|apne1-az4|apne1-tpe1-az1|apne2-az1|apne2-az2|apne2-az3|apne2-az4|apne3-az1|apne3-az2|apne3-az3|aps1-az1|aps1-az2|aps1-az3|aps1-ccu1-az1|aps1-del1-az1|aps2-az1|aps2-a... |
config_schema.json | items | Availability Zone ID, eg.: 'use1-az1' | {"examples": ["usw2-laz1-az1", "use2-az2"], "pattern": "(afs1-az1|afs1-az2|afs1-az3|afs1-los1-az1|ape1-az1|ape1-az2|ape1-az3|apne1-az1|apne1-az2|apne1-az4|apne1-tpe1-az1|apne2-az1|apne2-az2|apne2-az3|apne2-az4|apne3-az1|apne3-az2|apne3-az3|aps1-az1|aps1-az2|aps1-az3|aps1-ccu1-az1|aps1-del1-az1|aps2-az1|aps2-az2|aps2-az... |
config_schema.json | parameters | Parameter key-values to pass to CloudFormation, parameters provided in global config take precedence | {"additionalProperties": {"anyOf": [{"items": {"anyOf": [{"type": "integer"}, {"type": "string"}]}, "type": "array"}, {"type": "boolean"}, {"type": "integer"}, {"type": "string"}]}, "default": {}, "type": "object"} |
config_schema.json | posthooks | hooks to execute after executing tests | {"items": {}, "type": "array"} |
config_schema.json | prehooks | hooks to execute prior to executing tests | {"items": {}, "type": "array"} |
config_schema.json | regions | List of AWS regions | {"items": {"examples": ["us-east-1"], "pattern": "^(ap|eu|us|sa|ca|cn|af|me|il|us-gov)-(central|south|north|east|west|southeast|southwest|northeast|northwest)-[0-9]$", "type": "string"}, "type": "array"} |
config_schema.json | items | AWS Region name | {"examples": ["us-east-1"], "pattern": "^(ap|eu|us|sa|ca|cn|af|me|il|us-gov)-(central|south|north|east|west|southeast|southwest|northeast|northwest)-[0-9]$", "type": "string"} |
config_schema.json | role_name | Role name to use when launching CFN Stacks. | {"type": "string"} |
config_schema.json | s3_bucket | Name of S3 bucket to upload project to, if left out a bucket will be auto-generated | {"examples": ["my-s3-bucket-name"], "pattern": "^[a-z0-9-]*$", "type": "string"} |
config_schema.json | s3_regional_buckets | Enable regional auto-buckets. | {"examples": [true, false], "type": "boolean"} |
config_schema.json | stack_name | Cloudformation Stack Name | {"type": "string"} |
config_schema.json | stack_name_prefix | Prefix to apply to generated CFN Stack Name | {"type": "string"} |
config_schema.json | stack_name_suffix | Suffix to apply to generated CFN Stack Name | {"type": "string"} |
config_schema.json | tags | Tags to apply to CloudFormation template | {"additionalProperties": {"type": "string"}, "examples": [{"CostCenter": "1001"}], "type": "object"} |
config_schema.json | template | path to template file relative to the project config file path | {"examples": ["cloudformation_templates/"], "type": "string"} |
cryproj.53.schema.json | cvars | CVar name | {"type": "string", "default": "sys_target_platforms", "enum": ["a_poseAlignerDebugDraw", "a_poseAlignerEnable", "a_poseAlignerForceLock", "a_poseAlignerForceNoIntersections", "a_poseAlignerForceNoRootOffset", "a_poseAlignerForceTargetSmoothing", "a_poseAlignerForceWeightOne", "ac_ColliderModeAI", "ac_ColliderModePlayer... |
cryproj.53.schema.json | commands | Console command name | {"type": "string", "default": "", "enum": ["_TestFormatMessage", "ai_CheckGoalpipes", "ai_commTest", "ai_commTestStop", "ai_DebugAgent", "ai_debugMNMAgentType", "ai_dumpCheckpoints", "ai_MNMCalculateAccessibility", "ai_MNMComputeConnectedIslands", "ai_NavigationReloadConfig", "ai_Recorder_Start", "ai_Recorder_Stop", "a... |
cryproj.53.schema.json | value | The default value of the CVar | {"type": "string", "default": "pc,ps4,xboxone,linux"} |
cryproj.53.schema.json | items | This indicates where the assets are stored | {"type": "string", "default": "Assets", "examples": ["Assets"]} |
cryproj.53.schema.json | items | This indicates where the code is stored | {"type": "string", "default": "Code", "examples": ["Code"]} |
cryproj.53.schema.json | name | This indicates the project name | {"type": "string", "default": "", "examples": ["MyFancyProject"]} |
cryproj.53.schema.json | engine | This indicates which engine version will be used | {"type": "string", "default": "", "examples": ["engine-5.4"], "enum": ["engine-5.3"]} |
cryproj.53.schema.json | path | Required plugin's name | {"type": "string", "examples": ["CryDefaultEntities", "CrySensorSystem", "CryPerceptionSystem", "CryUserAnalytics", "CryOSVR", "CryOculusVR", "CryOpenVR", "CryLobby"]} |
cryproj.53.schema.json | type | EPluginType::Native if it's a C++ plugin, EPluginType::Managed if it's a C# one | {"type": "string", "default": "", "examples": ["EPluginType::Native", "EPluginType::Managed"], "enum": ["EPluginType::Native", "EPluginType::Managed"]} |
cryproj.53.schema.json | value | Arguments that has to be passed to the command. Leave empty if it has not parameters | {"type": "string", "default": ""} |
mtad.json | MTA deployment descriptor schema v3.3. Contains Cloud Foundry specific types and parameters. | {"$schema": "http://json-schema.org/draft-07/schema#", "definitions": {"generic-memory": {"type": "string", "pattern": "^[1-9][0-9]*(M|MB|G|GB|m|mb|g|gb)$"}, "module-type": {"type": "string", "anyOf": [{"enum": ["application", "binary", "business-logging", "com.sap.application.content", "com.sap.html5.application-conte... | |
mtad.json | app-name | The name of the application in the Cloud Foundry environment to be deployed for this module, based on the module name. | {"type": "string"} |
mtad.json | buildpack | The name or the URL of a custom buildpack required by the application. | {"type": "string"} |
mtad.json | buildpacks | An array of buildpacks. If a buildpack parameter already exists, it will be overwritten by the buildpacks listed in the buildpacks parameter, so that you have to include it in the array. | {} |
mtad.json | command | A custom command required to start the application. | {"type": "string"} |
mtad.json | create-service-broker | Specifies whether [true|false] a service broker should be registered for the application module; default value is: false. | {"type": "boolean"} |
mtad.json | dependency-type | Defines the memory allocated to the application. | {"type": "string", "enum": ["hard", "soft"]} |
mtad.json | disk-quota | The disk space that will be available to the application. This parameter requires a unit of measurement M, MB, G, or GB in upper or lower case. | {} |
mtad.json | docker | Creates a module from a docker image. When using a docker image parameter, we do not need to specify the module in the MANIFEST.mf file.When uploading a docker image, the content of a module is not needed. | {} |
mtad.json | domain | The domain on which the application will be available later. | {"type": "string"} |
mtad.json | domains | The domains on which the application will be available later. The resulting application routes will be the Cartesian product of the domains and hosts. That is, a separate route for each host is constructed on each domain. | {} |
mtad.json | enable-ssh | Enables use of SSH within an application. Supported for the Diego container runtime environment only. | {"type": "boolean"} |
mtad.json | health-check-type | Defines how the module will be monitored for availability. | {"type": "string", "enum": ["port", "process", "http"]} |
mtad.json | health-check-timeout | The timeout is the amount of time (in seconds) allowed to elapse between starting up an app and the first healthy response. | {"type": "integer"} |
mtad.json | health-check-invocation-timeout | The timeout in seconds for individual health check requests for http and port health checks. | {"type": "integer"} |
mtad.json | health-check-http-endpoint | A http health check defaults to using '/' as its endpoint, but you can specify a custom endpoint. | {"type": "string", "pattern": "^/.+"} |
mtad.json | host | The hostname or subdomain where an application is available later. | {"type": "string"} |
mtad.json | hosts | The hostnames or subdomain where an application is available later. | {} |
mtad.json | idle-domain | The idle domain on which the idle application will be available during blue-green deploy. | {"type": "string"} |
mtad.json | idle-domains | The domains on which the idle application will be available during blue-green deploy. The resulting application routes will be the Cartesian product of the domains and hosts. That is, a separate route for each host is constructed on each domain. | {} |
mtad.json | idle-host | The hostname or subdomain where the idle application will be available during blue-green deploy. | {"type": "string"} |
mtad.json | idle-hosts | The hostnames or subdomain where the idle application will be available during blue-green deploy. | {} |
mtad.json | instances | The number of application instances that will be started during the deployment. | {"type": "number", "minimum": 0} |
mtad.json | keep-existing | Defines the application attributes which will be kept after the deployment or blue-green deployment has finished. The supported attributes which could be kept are application environment, application bindings and application routes. If not specified, the default values are false, which indicates that each application a... | {} |
mtad.json | keep-existing-routes | When specified on module level, it indicates if the existing routes of the module's corresponding application should be kept even if they are not defined within the deployment and/or extension descriptors.When specified on global level, under the parameters section of the descriptor, it indicates if the existing routes... | {"type": "boolean"} |
mtad.json | memory | Defines the memory allocated to the application. | {} |
mtad.json | no-route | Defines if a route should be assigned to the application. | {"type": "boolean"} |
mtad.json | no-start | Start/do not start the application during deployment. This parameter setting overrides the command-line option --no-start. If you explicitly set the no-start to false for the module foo in the example provided, then the module foo is started on deployment, even if you also specify the command-line option --no-start wit... | {"type": "boolean"} |
mtad.json | restart-on-env-change | Specifies whether an application should be restarted if an environment variable has been changed in one of the following categories: vcap-application, vcap-services, user-provided. If you set these parameters to false, the changes in environment are not consumable by a running instances of the application. If your appl... | {} |
mtad.json | routes | A parameter that lists multiple HTTP routes. It is a combination of the old parameters host, domain, port and route-path, which encompasses the full addresses to which to bind a module. In case the new routes parameter and the old ones are available, the routes value is used and the values of the old parameters are ign... | {} |
mtad.json | service-broker-name | The name of the service broker in the Cloud Foundry environment to be created and registered for the specified application module. | {"type": "string"} |
mtad.json | service-broker-password | The password used for authentication by the XS controller at the service broker when performing service-related requests. The parameter is mandatory if create-service-broker: true. | {"type": "string"} |
mtad.json | service-broker-space-scoped | Makes the service plans of the broker visible only within the targeted space. | {"type": "boolean"} |
mtad.json | service-broker-url | Specifies the value of the service broker universal resource locator (URL) to register; service requests are sent to this URL. The parameter is mandatory if create-service-broker: true. | {"type": "string"} |
mtad.json | service-broker-user | The name of the user required for authentication by the XS controller at the service broker when performing service-related requests. The parameter is mandatory if create-service-broker: true. | {"type": "string"} |
mtad.json | stack | Use this parameter to define which prebuilt root file system (rootfs) you want to use. | {"type": "string"} |
mtad.json | tasks | Specify tasks, which are available for execution in the current droplet of the application. Also provide use of environment variables which are specified with the env scope. | {} |
mtad.json | upload-timeout | The application upload timeout in seconds. | {"type": "number", "minimum": 0} |
mtad.json | name | The task name. | {"type": "string"} |
mtad.json | command | The command to be executed. | {"type": "string"} |
mtad.json | memory | Defines the memory that is available to the Cloud Foundry task. | {} |
mtad.json | disk-quota | Defines the disk space that is available to the Cloud Foundry task. | {} |
mtad.json | image | An image parameter is a docker image from the Docker Hub or somewhere else. eg. cloudfoundry/test-app | {"type": "string"} |
mtad.json | username | The username is optional, but if a Docker image from a private repository is uploaded, then it is mandatory. | {"type": "string"} |
mtad.json | password | The password is optional, but if a Docker image from a private repository is uploaded, then it is mandatory. | {"type": "string"} |
mtad.json | env | Keep the existing environment | {"type": "boolean"} |
mtad.json | service-bindings | Keep the existing Service bindings | {"type": "boolean"} |
mtad.json | routes | Keep the existing routes | {"type": "boolean"} |
mtad.json | vcap-application | Restart on vcap-application env change | {"type": "boolean"} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.