compartment
=None, description=None) compartment_model.compartment(name, tags
Define an IPM compartment. Convenience constructor for CompartmentDef
.
Parameters
name: str
-
The name of the compartment. This will be converted to a
CompartmentName
usingCompartmentName.parse
. tags: list[str] = None
-
An optional list of tags to associate with this compartment.
description: str = None
-
An optional description of the compartment.
Returns
CompartmentDef
-
The compartment definition.