Class: Aws::GreengrassV2::Types::ComponentRunWith

Inherits:

Struct

• Object
• Struct
• Aws::GreengrassV2::Types::ComponentRunWith

Includes:

Structure

Defined in:

lib/aws-sdk-greengrassv2/types.rb

Overview

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

[1]: docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-user

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #posix_user ⇒ String

  The POSIX system user and, optionally, group to use to run this component on Linux core devices.

• #system_resource_limits ⇒ Types::SystemResourceLimits

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

• #windows_user ⇒ String

  The Windows user to use to run this component on Windows core devices.

Instance Attribute Details

#posix_user ⇒ String

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

[1]: docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-user

Returns:

• (String)

# File 'lib/aws-sdk-greengrassv2/types.rb', line 594

class ComponentRunWith < Struct.new(
  :posix_user,
  :system_resource_limits,
  :windows_user)
  SENSITIVE = []
  include Aws::Structure
end

#system_resource_limits ⇒ Types::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].

[1]: docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-system-resource-limits

Returns:

• (Types::SystemResourceLimits)

# File 'lib/aws-sdk-greengrassv2/types.rb', line 594

class ComponentRunWith < Struct.new(
  :posix_user,
  :system_resource_limits,
  :windows_user)
  SENSITIVE = []
  include Aws::Structure
end

#windows_user ⇒ String

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

[1]: docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-user

Returns:

• (String)

# File 'lib/aws-sdk-greengrassv2/types.rb', line 594

class ComponentRunWith < Struct.new(
  :posix_user,
  :system_resource_limits,
  :windows_user)
  SENSITIVE = []
  include Aws::Structure
end