Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.GreengrassV2.Types.ComponentRunWith

Description

Documentation

data ComponentRunWith Source #

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: newComponentRunWith smart constructor.

Constructors

ComponentRunWith'

Fields

posixUser :: Maybe Text
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 :: Maybe 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.
windowsUser :: Maybe Text
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.

Instances

Instances details

FromJSON ComponentRunWith Source #
Instance details Defined in Amazonka.GreengrassV2.Types.ComponentRunWith Methods parseJSON :: Value -> Parser ComponentRunWith # parseJSONList :: Value -> Parser [ComponentRunWith] #
ToJSON ComponentRunWith Source #
Instance details Defined in Amazonka.GreengrassV2.Types.ComponentRunWith Methods toJSON :: ComponentRunWith -> Value # toEncoding :: ComponentRunWith -> Encoding # toJSONList :: [ComponentRunWith] -> Value # toEncodingList :: [ComponentRunWith] -> Encoding #
Generic ComponentRunWith Source #
Instance details Defined in Amazonka.GreengrassV2.Types.ComponentRunWith Associated Types type Rep ComponentRunWith :: Type -> Type # Methods from :: ComponentRunWith -> Rep ComponentRunWith x # to :: Rep ComponentRunWith x -> ComponentRunWith #
Read ComponentRunWith Source #
Instance details Defined in Amazonka.GreengrassV2.Types.ComponentRunWith Methods readsPrec :: Int -> ReadS ComponentRunWith # readList :: ReadS [ComponentRunWith] # readPrec :: ReadPrec ComponentRunWith # readListPrec :: ReadPrec [ComponentRunWith] #
Show ComponentRunWith Source #
Instance details Defined in Amazonka.GreengrassV2.Types.ComponentRunWith Methods showsPrec :: Int -> ComponentRunWith -> ShowS # show :: ComponentRunWith -> String # showList :: [ComponentRunWith] -> ShowS #
NFData ComponentRunWith Source #
Instance details Defined in Amazonka.GreengrassV2.Types.ComponentRunWith Methods rnf :: ComponentRunWith -> () #
Eq ComponentRunWith Source #
Instance details Defined in Amazonka.GreengrassV2.Types.ComponentRunWith Methods (==) :: ComponentRunWith -> ComponentRunWith -> Bool # (/=) :: ComponentRunWith -> ComponentRunWith -> Bool #
Hashable ComponentRunWith Source #
Instance details Defined in Amazonka.GreengrassV2.Types.ComponentRunWith Methods hashWithSalt :: Int -> ComponentRunWith -> Int # hash :: ComponentRunWith -> Int #
type Rep ComponentRunWith Source #
Instance details Defined in Amazonka.GreengrassV2.Types.ComponentRunWith type Rep ComponentRunWith = D1 ('MetaData "ComponentRunWith" "Amazonka.GreengrassV2.Types.ComponentRunWith" "amazonka-greengrassv2-2.0-CXiJQl197i43YI1Cz5IpiZ" 'False) (C1 ('MetaCons "ComponentRunWith'" 'PrefixI 'True) (S1 ('MetaSel ('Just "posixUser") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "systemResourceLimits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SystemResourceLimits)) :: S1 ('MetaSel ('Just "windowsUser") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newComponentRunWith :: ComponentRunWith Source #

Create a value of ComponentRunWith with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:posixUser:ComponentRunWith', componentRunWith_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.

$sel:systemResourceLimits:ComponentRunWith', componentRunWith_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.

$sel:windowsUser:ComponentRunWith', componentRunWith_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.

componentRunWith_posixUser :: Lens' ComponentRunWith (Maybe Text) Source #

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.

componentRunWith_systemResourceLimits :: Lens' ComponentRunWith (Maybe SystemResourceLimits) Source #

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.

componentRunWith_windowsUser :: Lens' ComponentRunWith (Maybe Text) Source #

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.