Supported Parameters

Module Parameters

Parameter	Description	Default Value	Example Value
app-name	The name of the application	The module name with or without a name-space prefix	example-app
buildpack	The buildpack or URL of a custom buildpack to be used when staging the application	n/a	java_buildpack
command	A custom command to start the application that will be used during staging	n/a	node index.js
create-service-broker	Specifies whether a service broker should be registered for the application module	false	true / false
disk-quota	The disk space that will be available to the application. This parameter requires a unit of measurement M, MB, G or GB	The default for the CF instance	512M
domain / domains	The domain(s) on which the application will be available later. The resulting application routes will be the Cartesian product of the domains and hosts	${default-domain}	domain-name / ["domain-one", "domain-two"]
enable-ssh	Enables use of SSH within an application. Supported for the Diego container runtime environment only	false	true / false
health-check-type	The application health check type	http	port / http / process
health-check-timeout	The application health check timeout in seconds	n/a	120
health-check-http-endpoint	If the health-check-type parameter is set to http, the controller will do a GET request to this endpoint. The application will be considered as healthy if the response is 200 OK.	If health-check-type is set to http, the default value is /, otherwise there is no default value	/ping
host / hosts	The hostname(s) or subdomain(s) where an application is available later	${default-host}	example-host / ["somehost", "alternativehost"]
instances	The number of application instances that will be started during the deployment	The default for the CF instance	5
memory	The memory limit for each instance of an application. This parameter requires a unit of measurement M, MB, G or GB	The default for the CF instance	1G
no-start	If set to true the application will not be started during deployment.	false	true / false
route-path	The context path which will be part of the application default URI	n/a	/myapp
service-broker-name	The name of the service broker in the Cloud Foundry environment to be created and registered for the specified application module	The application's name	example-app
service-broker-url	Specifies the value of the service broker universal resource locator (URL) to register	n/a	${default-url}
service-broker-user	The name of the user required for authentication by the controller at the service broker when performing service-related requests	n/a	${generated-user}
service-broker-password	The password used for authentication by the controller at the service broker when performing service-related requests	n/a	${generated-password}
service-broker-space-scoped	If set to true the service broker will be scoped to only the target space	false	true / false
upload-timeout	The application upload timeout in seconds	3600	1800

Resource Parameters

Parameter	Description	Default Value	Example Value
service	The type of the created service	n/a	postgresql
service-alternatives	If a default service offering does not exist for the current org/space or creating a service to it fails (with a specific error), service alternatives are used; The order of service alternatives is considered	n/a	["alt-service", "alt-service-2"]
service-name	The name of the service instance	The resource name with or without a name-space prefix	example-service
service-plan	The plan of the created service	n/a	v9.6-dev
service-key-name	Used when consuming an existing service key. Specifies the name of the service key	The name of the resource	my-service-key
shared	An optional parameter, which if set to true, allows you to consume one and the same service between different MTAs in a given space	false	true / false

Placeholders

Parameter	Description	Example Value
authorization-url	The authorization URL as specified in the cloud controller's /v2/info endpoint	https://login.cf.example.com
controller-url	The URL of the cloud controller	https://api.cf.example.com
default-domain	The default domain (configured in the Cloud Foundry environment)	cfapps.example.com
default-host	The default host name, composed based on the deploy target and the module name, which ensures uniqueness	trial-a007007-node-hello-world
default-uri	The default URI, composed as ${host}.${domain}	someapp.cfapps.example.com
default-url	The default URL, composed as ${protocol}://${default-uri}	http://someapp.cfapps.example.com
deploy-url	The MultiApps Controller URL for the Cloud Foundry environment	http://deploy-service.cfapps.example.com
generated-password	A generated password that is composed of 16 characters that may contain upper and lower case letters, digits and special characters (_, -, @, $, &, #, *)	IG@zGg#2g-cvMvsW
generated-user	A generated user id that is composed of 16 characters that may contain upper and lower case letters, digits and special characters (_, -, @, $, &, #, *)	uYi$d41TzM1-Dm6f
org	Name of the target organization	example-org
space	Name of the target space	example-space
user	Name of the CF user executing the deployment	user@example.com