Package software.amazon.awscdk.services.greengrassv2

Interface CfnDeployment.ComponentRunWithProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDeployment.ComponentRunWithProperty.Jsii$Proxy

Enclosing class:

CfnDeployment

@Stability(Stable)
public static interface CfnDeployment.ComponentRunWithProperty
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.greengrassv2.*;
 ComponentRunWithProperty componentRunWithProperty = ComponentRunWithProperty.builder()
         .posixUser("posixUser")
         .systemResourceLimits(SystemResourceLimitsProperty.builder()
                 .cpus(123)
                 .memory(123)
                 .build())
         .windowsUser("windowsUser")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDeployment.ComponentRunWithProperty.Builder	A builder for CfnDeployment.ComponentRunWithProperty
static final class	CfnDeployment.ComponentRunWithProperty.Jsii$Proxy	An implementation for CfnDeployment.ComponentRunWithProperty

Method Summary

Modifier and Type	Method	Description
static CfnDeployment.ComponentRunWithProperty.Builder	builder()
default String	getPosixUser()	The POSIX system user and (optional) group to use to run this component.
default Object	getSystemResourceLimits()	The system resource limits to apply to this component's process on the core device.
default String	getWindowsUser()	The Windows user to use to run this component on Windows core devices.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPosixUser

@Stability(Stable)
@Nullable
default String getPosixUser()

The POSIX system user and (optional) group to use to run this component.

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.

getSystemResourceLimits

@Stability(Stable)
@Nullable
default Object getSystemResourceLimits()

The system resource limits to apply to this component's process on the core device.

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 .

getWindowsUser

@Stability(Stable)
@Nullable
default String getWindowsUser()

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

builder

@Stability(Stable)
static CfnDeployment.ComponentRunWithProperty.Builder builder()

Returns:

a CfnDeployment.ComponentRunWithProperty.Builder of CfnDeployment.ComponentRunWithProperty