Class CfnDeployment.ComponentRunWithProperty
Contains information system user and group that the AWS IoT Greengrass Core software uses to run component processes on the core device.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.GreengrassV2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class ComponentRunWithProperty : Object, CfnDeployment.IComponentRunWithProperty
Syntax (vb)
Public Class ComponentRunWithProperty
Inherits Object
Implements CfnDeployment.IComponentRunWithProperty
Remarks
For more information, see Configure the user and group that run components in the AWS IoT Greengrass V2 Developer Guide .
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.GreengrassV2;
var componentRunWithProperty = new ComponentRunWithProperty {
PosixUser = "posixUser",
SystemResourceLimits = new SystemResourceLimitsProperty {
Cpus = 123,
Memory = 123
},
WindowsUser = "windowsUser"
};
Synopsis
Constructors
ComponentRunWithProperty() |
Properties
PosixUser | The POSIX system user and (optional) group to use to run this component. |
SystemResourceLimits | The system resource limits to apply to this component's process on the core device. |
WindowsUser | The Windows user to use to run this component on Windows core devices. |
Constructors
ComponentRunWithProperty()
public ComponentRunWithProperty()
Properties
PosixUser
The POSIX system user and (optional) group to use to run this component.
public string PosixUser { get; set; }
Property Value
System.String
Remarks
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 AWS IoT Greengrass Core software uses the primary user for the group.
SystemResourceLimits
The system resource limits to apply to this component's process on the core device.
public object SystemResourceLimits { get; set; }
Property Value
System.Object
Remarks
AWS IoT Greengrass supports this feature only on Linux core devices.
If you omit this parameter, the AWS IoT Greengrass Core software uses the default system resource limits that you configure on the AWS IoT Greengrass nucleus component. For more information, see Configure system resource limits for components .
WindowsUser
The Windows user to use to run this component on Windows core devices.
public string WindowsUser { get; set; }
Property Value
System.String
Remarks
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 AWS IoT Greengrass Core software uses the default Windows user that you configure on the AWS IoT Greengrass nucleus component. For more information, see Configure the user and group that run components .