Forge Object Store is now in Preview, and therefore fully supported. However, it remains under active development and may be subject to shorter deprecation windows. Preview features are suitable for early adopters in production environments.

We release preview features so partners and developers can study, test, and integrate them prior to General Availability (GA). For more details, see Forge EAP, Preview, and GA.

Use the objectStore module to enable the Forge Object Store capability. You can only define this module once per app.

See Object Store for detailed information about implementing this capability.

Adding the objectStore module to your manifest will trigger a major version upgrade. See Versioning for more details.

Properties

Property Type Required Description

Property	Type	Required	Description
`key`	`string`	Yes	A key for the module, which other modules can refer to. Must be unique within the manifest. Regex: `^[a-zA-Z0-9_-]+$`
`storageClass`	`enum`	Yes	Specifies the storage class that Forge Object Store should use. Currently, the only supported value is `standard`.

key

string

Yes

A key for the module, which other modules can refer to. Must be unique within the manifest.

Regex: ^[a-zA-Z0-9_-]+$

storageClass enum Yes Specifies the storage class that Forge Object Store should use. Currently, the only supported value is standard.

Example

1
2
modules:
  objectStore:
    - key: fos
      storageClass: standard