software.amazon.awssdk.services.greengrassv2.model

Class ComponentRunWith

java.lang.Object

software.amazon.awssdk.services.greengrassv2.model.ComponentRunWith

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ComponentRunWith.Builder,ComponentRunWith>

@Generated(value="software.amazon.awssdk:codegen")
public final class ComponentRunWith
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ComponentRunWith.Builder,ComponentRunWith>

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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ComponentRunWith.Builder

Method Summary

Modifier and Type	Method and Description
static ComponentRunWith.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	posixUser() The POSIX system user and, optionally, group to use to run this component on Linux core devices.
List<SdkField<?>>	sdkFields()
static Class<? extends ComponentRunWith.Builder>	serializableBuilderClass()
SystemResourceLimits	systemResourceLimits() The system resource limits to apply to this component's process on the core device.
ComponentRunWith.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	windowsUser() The Windows user to use to run this component on Windows core devices.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

posixUser

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

Returns:

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.

systemResourceLimits

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

Returns:

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.

windowsUser

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

Returns:

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.

toBuilder

public ComponentRunWith.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ComponentRunWith.Builder,ComponentRunWith>

builder

public static ComponentRunWith.Builder builder()

serializableBuilderClass

public static Class<? extends ComponentRunWith.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo