Package software.amazon.awssdk.services.greengrassv2.model

Interface ComponentRunWith.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ComponentRunWith.Builder,ComponentRunWith>, SdkBuilder<ComponentRunWith.Builder,ComponentRunWith>, SdkPojo

Enclosing class:

ComponentRunWith

public static interface ComponentRunWith.Builder
extends SdkPojo, CopyableBuilder<ComponentRunWith.Builder,ComponentRunWith>

Method Summary

Modifier and Type	Method	Description
ComponentRunWith.Builder	posixUser(String posixUser)	The POSIX system user and, optionally, group to use to run this component on Linux core devices.
default ComponentRunWith.Builder	systemResourceLimits(Consumer<SystemResourceLimits.Builder> systemResourceLimits)	The system resource limits to apply to this component's process on the core device.
ComponentRunWith.Builder	systemResourceLimits(SystemResourceLimits systemResourceLimits)	The system resource limits to apply to this component's process on the core device.
ComponentRunWith.Builder	windowsUser(String windowsUser)	The Windows user to use to run this component on Windows core devices.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Detail

posixUser

ComponentRunWith.Builder posixUser(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

systemResourceLimits

ComponentRunWith.Builder systemResourceLimits(SystemResourceLimits 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

systemResourceLimits

default ComponentRunWith.Builder systemResourceLimits(Consumer<SystemResourceLimits.Builder> 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.

This is a convenience method that creates an instance of the SystemResourceLimits.Builder avoiding the need to create one manually via SystemResourceLimits.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to systemResourceLimits(SystemResourceLimits).

Parameters:

systemResourceLimits - a consumer that will call methods on SystemResourceLimits.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

systemResourceLimits(SystemResourceLimits)

windowsUser

ComponentRunWith.Builder windowsUser(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.