Class: Aws::GreengrassV2::Types::ComponentDeploymentSpecification

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

Overview

Note:

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

{
  component_version: "ComponentVersionString",
  configuration_update: {
    merge: "ComponentConfigurationString",
    reset: ["ComponentConfigurationPath"],
  },
  run_with: {
    posix_user: "NonEmptyString",
    system_resource_limits: {
      memory: 1,
      cpus: 1.0,
    },
    windows_user: "NonEmptyString",
  },
}

Contains information about a component to deploy.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#component_version ⇒ String

The version of the component.

Returns:

  • (String) 


512
513
514
515
516
517
518
 
# File 'lib/aws-sdk-greengrassv2/types.rb', line 512

class ComponentDeploymentSpecification < Struct.new(
  :component_version,
  :configuration_update,
  :run_with)
  SENSITIVE = []
  include Aws::Structure
end

#configuration_update ⇒ Types::ComponentConfigurationUpdate

The configuration updates to deploy for the component. You can define reset updates and merge updates. A reset updates the keys that you specify to the default configuration for the component. A merge updates the core device's component configuration with the keys and values that you specify. The IoT Greengrass Core software applies reset updates before it applies merge updates. For more information, see [Update component configurations] in the *IoT Greengrass V2 Developer Guide*.

[1]: docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html

Returns:



512
513
514
515
516
517
518
 
# File 'lib/aws-sdk-greengrassv2/types.rb', line 512

class ComponentDeploymentSpecification < Struct.new(
  :component_version,
  :configuration_update,
  :run_with)
  SENSITIVE = []
  include Aws::Structure
end

#run_with ⇒ Types::ComponentRunWith

The system user and group that the IoT Greengrass Core software uses to run component processes on the core device. If you omit this parameter, the IoT Greengrass Core software uses the system user and group that you configure for 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

Returns:



512
513
514
515
516
517
518
 
# File 'lib/aws-sdk-greengrassv2/types.rb', line 512

class ComponentDeploymentSpecification < Struct.new(
  :component_version,
  :configuration_update,
  :run_with)
  SENSITIVE = []
  include Aws::Structure
end