ComponentRunWith - Amazon IoT Greengrass
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

ComponentRunWith

Contains information system user and group that the Amazon 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 Amazon IoT Greengrass V2 Developer Guide.

Contents

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 Amazon IoT Greengrass Core software uses the primary user for the group.

If you omit this parameter, the Amazon 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.

Type: String

Length Constraints: Minimum length of 1.

Required: No

systemResourceLimits

The system resource limits to apply to this component's process on the core device. Amazon IoT Greengrass currently supports this feature on only Linux core devices.

If you omit this parameter, the Amazon 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.

Type: SystemResourceLimits object

Required: No

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 Amazon 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.

Type: String

Length Constraints: Minimum length of 1.

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: