Skip to main content
Version: Latest

Custom Parameters

An Application Developer has the option to customize their a9s Data Service Instances, and their related Service Bindings, by providing additional configuration parameters in the corresponding Cloud Foundry CLI commands. In the context of the a9s Data Services, these configuration parameters are called custom parameters.

These custom parameters have to be provided in a valid JSON object, containing the service-specific configuration settings, either in-line or in a file. But they don't have to be used, as there are sane defaults in place that fit the Service Plan well.

info

The availability of some of the custom parameters may have been disabled by the Platform Operator. Furthermore, The Platform Operator can configure that the value of a custom parameter is redacted when it contains sensitive information.

Service Instance Parameters​

Setting a Custom Parameter for a Service Instance​

Custom parameters are passed on to a Service Instance by using the -c option of the cf CLI commands cf create-service and cf update-service. For more information, see Managing service instances with the cf CLI or the help pages of the mentioned CLI commands, e.g. cf create-service -h.

Example

The following command

cf update-service my-instance -c '{"my_custom_parameter": "value"}'

would set the custom parameter named my_custom_parameter to the value value for the Service Instance my-instance.

Getting a Custom Parameter for a Service Instance​

There are two options to retrieve and display the custom parameters that have been set for a Service Instance:

  1. Using the latest Cloud Foundry CLI v8
  2. Query the Cloud Foundry API v3

Service Binding Parameters​

Setting a Custom Parameter for a Service Binding​

Custom parameters are passed on to a Service Binding by using the -c option of the cf CLI commands cf bind-service and cf create-service-key. For more information, see Delivering service credentials to an app and Managing service keys, or the help pages of the mentioned CLI commands, e.g. cf bind-service -h.

Example

The following command

cf create-service-key my-instance my-key -c '{"my_custom_parameter": "value"}'

would set the custom parameter named my_custom_parameter to the value value for the Service Binding my-key of the Service Instance my-instance.

Getting a Custom Parameter for a Service Binding​

The following option can be used to retrieve and display the custom parameters that have been set for a Service Binding:

info

You can only retrieve the custom parameters of a Service Binding that have been created in version v66.0.0 or later.

a9s Data Services Specific Parameters​

See the a9s Data Service specific documentation for further details:

*Redis is a registered trademark of Redis Ltd. Any rights therein are reserved to Redis Ltd. Any use by anynines GmbH is for referential purposes only and does not indicate any sponsorship, endorsement or affiliation between Redis and anynines GmbH.