/AWS1/CL_GG2COMPONENTRUNWITH¶
Contains information system user and group that the IoT Greengrass Core software uses to run component processes on the core device. For more information, see Configure the user and group that run components in the IoT Greengrass V2 Developer Guide.
CONSTRUCTOR
¶
IMPORTING¶
Optional arguments:¶
iv_posixuser
TYPE /AWS1/GG2NONEMPTYSTRING
/AWS1/GG2NONEMPTYSTRING
¶
The POSIX system user and, optionally, group to use to run this component on Linux core devices. The user, and group if specified, must exist on each Linux core device. Specify the user and group separated by a colon (
:
) in the following format:user:group
. The group is optional. If you don't specify a group, the IoT Greengrass Core software uses the primary user for the group.If you omit this parameter, the IoT Greengrass Core software uses the default system user and group that you configure on the Greengrass nucleus component. For more information, see Configure the user and group that run components.
io_systemresourcelimits
TYPE REF TO /AWS1/CL_GG2SYSTEMRESRCLIMITS
/AWS1/CL_GG2SYSTEMRESRCLIMITS
¶
The system resource limits to apply to this component's process on the core device. IoT Greengrass currently supports this feature on only Linux core devices.
If you omit this parameter, the IoT Greengrass Core software uses the default system resource limits that you configure on the Greengrass nucleus component. For more information, see Configure system resource limits for components.
iv_windowsuser
TYPE /AWS1/GG2NONEMPTYSTRING
/AWS1/GG2NONEMPTYSTRING
¶
The Windows user to use to run this component on Windows core devices. The user must exist on each Windows core device, and its name and password must be in the LocalSystem account's Credentials Manager instance.
If you omit this parameter, the IoT Greengrass Core software uses the default Windows user that you configure on the Greengrass nucleus component. For more information, see Configure the user and group that run components.
Queryable Attributes¶
posixUser¶
The POSIX system user and, optionally, group to use to run this component on Linux core devices. The user, and group if specified, must exist on each Linux core device. Specify the user and group separated by a colon (
:
) in the following format:user:group
. The group is optional. If you don't specify a group, the IoT Greengrass Core software uses the primary user for the group.If you omit this parameter, the IoT Greengrass Core software uses the default system user and group that you configure on the Greengrass nucleus component. For more information, see Configure the user and group that run components.
Accessible with the following methods¶
Method | Description |
---|---|
GET_POSIXUSER() |
Getter for POSIXUSER, with configurable default |
ASK_POSIXUSER() |
Getter for POSIXUSER w/ exceptions if field has no value |
HAS_POSIXUSER() |
Determine if POSIXUSER has a value |
systemResourceLimits¶
The system resource limits to apply to this component's process on the core device. IoT Greengrass currently supports this feature on only Linux core devices.
If you omit this parameter, the IoT Greengrass Core software uses the default system resource limits that you configure on the Greengrass nucleus component. For more information, see Configure system resource limits for components.
Accessible with the following methods¶
Method | Description |
---|---|
GET_SYSTEMRESOURCELIMITS() |
Getter for SYSTEMRESOURCELIMITS |
windowsUser¶
The Windows user to use to run this component on Windows core devices. The user must exist on each Windows core device, and its name and password must be in the LocalSystem account's Credentials Manager instance.
If you omit this parameter, the IoT Greengrass Core software uses the default Windows user that you configure on the Greengrass nucleus component. For more information, see Configure the user and group that run components.
Accessible with the following methods¶
Method | Description |
---|---|
GET_WINDOWSUSER() |
Getter for WINDOWSUSER, with configurable default |
ASK_WINDOWSUSER() |
Getter for WINDOWSUSER w/ exceptions if field has no value |
HAS_WINDOWSUSER() |
Determine if WINDOWSUSER has a value |