Cloud deployment JVM parameters
This table lists JVM parameters that are relevant for cloud deployments. The values specified for these parameters control the deployment mode for WFM and the configuration of features included in this guide. These parameters are passed to either the application sever, job scheduler, or both.
| Parameter | Description | Allowed values | Default value | Application server/job scheduler |
|---|---|---|---|---|
| aws.accessKeyId | Your access key ID as part of your AWS credentials. This parameter is only required if your deployment is not on AWS and you want to use Amazon S3. For more information see File handling and JVM parameters for the Amazon S3 file service. | Your access key ID. | empty | Both |
| aws.region | The AWS region for your deployment. This parameter is only required if your deployment is not on AWS and you want to use Amazon S3. For more information see File handling and JVM parameters for the Amazon S3 file service. | Your AWS region. | empty | Both |
| aws.secretKey | Your secret key as part of your AWS credentials. This parameter is only required if your deployment is not on AWS and you want to use Amazon S3. For more information see File handling and JVM parameters for the Amazon S3 file service. | Your secret key. | empty | Both |
| wb.cloud.provider | Specifies the cloud environment where WFM is deployed. | aws, gov-cloud, or empty | empty | Both |
| wb.running.inside.container | Specifies if WFM is running in a container-based deployment. This parameter must be set to true in GovCloud or Commercial Cloud mode. | true, false | false | Both |
| wb.storage.s3.dataBucket | Specifies the name of the Amazon S3 data bucket to be used with WFM. An S3 data bucket must be specified when operating WFM in either Commercial Cloud or GovCloud mode. | The name of an S3 data bucket | empty | Both |
| wb.tenant.aws.kms.alias | Specifies the AWS KMS alias. In AWS KMS, an alias is a display name for a customer master key. This parameter must be specified in GovCloud or Commercial Cloud mode. | The name of the alias created as part of tenant creation | empty | Both |
| wb.tenant.id | Specifies the tenant ID. The tenant ID is a unique identifier that represents the customer and customer environment. This parameter must be specified in GovCloud or Commercial Cloud mode. | A valid tenant ID | default | Both |
workbrain.security.audit.enabled |
When set to true, enables the audit log. Note that the audit log is always enabled when WFM is operated in GovCloud mode. | true, false | false | Application server |