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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-greengrassv2/lib/aws-sdk-greengrassv2/types.rb

Overview

Note:

When making an API call, you may pass ComponentRunWith data as a hash:

{
  posix_user: "NonEmptyString",
  system_resource_limits: {
    memory: 1,
    cpus: 1.0,
  },
  windows_user: "NonEmptyString",
}

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#posix_userString

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:

  • (String)


707
708
709
710
711
712
713
# File 'gems/aws-sdk-greengrassv2/lib/aws-sdk-greengrassv2/types.rb', line 707

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

#system_resource_limitsTypes::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.



707
708
709
710
711
712
713
# File 'gems/aws-sdk-greengrassv2/lib/aws-sdk-greengrassv2/types.rb', line 707

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

#windows_userString

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:

  • (String)


707
708
709
710
711
712
713
# File 'gems/aws-sdk-greengrassv2/lib/aws-sdk-greengrassv2/types.rb', line 707

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