Class: AWSCDK::Greengrassv2::CfnDeployment::ComponentRunWithProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
greengrassv2/cfn_deployment.rb

Overview

Contains information system user and group that the AWS 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 AWS IoT Greengrass V2 Developer Guide .

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(posix_user: nil, system_resource_limits: nil, windows_user: nil) ⇒ ComponentRunWithProperty

Returns a new instance of ComponentRunWithProperty.

Parameters:

  • posix_user (String, nil) (defaults to: nil) —

    The POSIX system user and (optional) group to use to run this component.

  • system_resource_limits (AWSCDK::IResolvable, AWSCDK::Greengrassv2::CfnDeployment::SystemResourceLimitsProperty, nil) (defaults to: nil) —

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

  • windows_user (String, nil) (defaults to: nil) —

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



733
734
735
736
737
738
739
740
 
# File 'greengrassv2/cfn_deployment.rb', line 733

def initialize(posix_user: nil, system_resource_limits: nil, windows_user: nil)
  @posix_user = posix_user
  Jsii::Type.check_type(@posix_user, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "posixUser") unless @posix_user.nil?
  @system_resource_limits = system_resource_limits.is_a?(Hash) ? ::AWSCDK::Greengrassv2::CfnDeployment::SystemResourceLimitsProperty.new(**system_resource_limits.transform_keys(&:to_sym)) : system_resource_limits
  Jsii::Type.check_type(@system_resource_limits, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19ncmVlbmdyYXNzdjIuQ2ZuRGVwbG95bWVudC5TeXN0ZW1SZXNvdXJjZUxpbWl0c1Byb3BlcnR5In1dfX0=")), "systemResourceLimits") unless @system_resource_limits.nil?
  @windows_user = windows_user
  Jsii::Type.check_type(@windows_user, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "windowsUser") unless @windows_user.nil?
end

Instance Attribute Details

#posix_user ⇒ String? (readonly)

The POSIX system user and (optional) group to use to run this component.

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 AWS IoT Greengrass Core software uses the primary user for the group.

Returns:

  • (String, nil)

See Also:



748
749
750
 
# File 'greengrassv2/cfn_deployment.rb', line 748

def posix_user
  @posix_user
end

#system_resource_limits ⇒ AWSCDK::IResolvable, ... (readonly)

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

AWS IoT Greengrass supports this feature only on Linux core devices.

If you omit this parameter, the AWS IoT Greengrass Core software uses the default system resource limits that you configure on the AWS IoT Greengrass nucleus component. For more information, see Configure system resource limits for components .

Returns:

See Also:



757
758
759
 
# File 'greengrassv2/cfn_deployment.rb', line 757

def system_resource_limits
  @system_resource_limits
end

#windows_user ⇒ String? (readonly)

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 AWS IoT Greengrass Core software uses the default Windows user that you configure on the AWS IoT Greengrass nucleus component. For more information, see Configure the user and group that run components .

Returns:

  • (String, nil)

See Also:



766
767
768
 
# File 'greengrassv2/cfn_deployment.rb', line 766

def windows_user
  @windows_user
end

Class Method Details

.jsii_properties ⇒ Object 



768
769
770
771
772
773
774
 
# File 'greengrassv2/cfn_deployment.rb', line 768

def self.jsii_properties
  {
    :posix_user => "posixUser",
    :system_resource_limits => "systemResourceLimits",
    :windows_user => "windowsUser",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



776
777
778
779
780
781
782
783
784
 
# File 'greengrassv2/cfn_deployment.rb', line 776

def to_jsii
  result = {}
  result.merge!({
    "posixUser" => @posix_user,
    "systemResourceLimits" => @system_resource_limits,
    "windowsUser" => @windows_user,
  })
  result.compact
end