Class: Aws::GreengrassV2::Types::LambdaExecutionParameters

Inherits:

Struct

• Object
• Struct
• Aws::GreengrassV2::Types::LambdaExecutionParameters

Defined in:

gems/aws-sdk-greengrassv2/lib/aws-sdk-greengrassv2/types.rb

Overview

Contains parameters for a Lambda function that runs on IoT Greengrass.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #environment_variables ⇒ Hash<String,String>

  The map of environment variables that are available to the Lambda function when it runs.

• #event_sources ⇒ Array<Types::LambdaEventSource>

  The list of event sources to which to subscribe to receive work messages.

• #exec_args ⇒ Array<String>

  The list of arguments to pass to the Lambda function when it runs.

• #input_payload_encoding_type ⇒ String

  The encoding type that the Lambda function supports.

• #linux_process_params ⇒ Types::LambdaLinuxProcessParams

  The parameters for the Linux process that contains the Lambda function.

• #max_idle_time_in_seconds ⇒ Integer

  The maximum amount of time in seconds that a non-pinned Lambda function can idle before the IoT Greengrass Core software stops its process.

• #max_instances_count ⇒ Integer

  The maximum number of instances that a non-pinned Lambda function can run at the same time.

• #max_queue_size ⇒ Integer

  The maximum size of the message queue for the Lambda function component.

• #pinned ⇒ Boolean

  Whether or not the Lambda function is pinned, or long-lived.

• #status_timeout_in_seconds ⇒ Integer

  The interval in seconds at which a pinned (also known as long-lived) Lambda function component sends status updates to the Lambda manager component.

• #timeout_in_seconds ⇒ Integer

  The maximum amount of time in seconds that the Lambda function can process a work item.

Instance Attribute Details

#environment_variables ⇒ Hash<String,String>

The map of environment variables that are available to the Lambda function when it runs.

Returns:

• (Hash<String,String>)

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

class LambdaExecutionParameters < Struct.new(
  :event_sources,
  :max_queue_size,
  :max_instances_count,
  :max_idle_time_in_seconds,
  :timeout_in_seconds,
  :status_timeout_in_seconds,
  :pinned,
  :input_payload_encoding_type,
  :exec_args,
  :environment_variables,
  :linux_process_params)
  SENSITIVE = []
  include Aws::Structure
end

#event_sources ⇒ Array<Types::LambdaEventSource>

The list of event sources to which to subscribe to receive work messages. The Lambda function runs when it receives a message from an event source. You can subscribe this function to local publish/subscribe messages and Amazon Web Services IoT Core MQTT messages.

Returns:

• (Array<Types::LambdaEventSource>)

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

class LambdaExecutionParameters < Struct.new(
  :event_sources,
  :max_queue_size,
  :max_instances_count,
  :max_idle_time_in_seconds,
  :timeout_in_seconds,
  :status_timeout_in_seconds,
  :pinned,
  :input_payload_encoding_type,
  :exec_args,
  :environment_variables,
  :linux_process_params)
  SENSITIVE = []
  include Aws::Structure
end

#exec_args ⇒ Array<String>

The list of arguments to pass to the Lambda function when it runs.

Returns:

• (Array<String>)

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

class LambdaExecutionParameters < Struct.new(
  :event_sources,
  :max_queue_size,
  :max_instances_count,
  :max_idle_time_in_seconds,
  :timeout_in_seconds,
  :status_timeout_in_seconds,
  :pinned,
  :input_payload_encoding_type,
  :exec_args,
  :environment_variables,
  :linux_process_params)
  SENSITIVE = []
  include Aws::Structure
end

#input_payload_encoding_type ⇒ String

The encoding type that the Lambda function supports.

Default: json

Returns:

• (String)

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

class LambdaExecutionParameters < Struct.new(
  :event_sources,
  :max_queue_size,
  :max_instances_count,
  :max_idle_time_in_seconds,
  :timeout_in_seconds,
  :status_timeout_in_seconds,
  :pinned,
  :input_payload_encoding_type,
  :exec_args,
  :environment_variables,
  :linux_process_params)
  SENSITIVE = []
  include Aws::Structure
end

#linux_process_params ⇒ Types::LambdaLinuxProcessParams

The parameters for the Linux process that contains the Lambda function.

Returns:

• (Types::LambdaLinuxProcessParams)

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

class LambdaExecutionParameters < Struct.new(
  :event_sources,
  :max_queue_size,
  :max_instances_count,
  :max_idle_time_in_seconds,
  :timeout_in_seconds,
  :status_timeout_in_seconds,
  :pinned,
  :input_payload_encoding_type,
  :exec_args,
  :environment_variables,
  :linux_process_params)
  SENSITIVE = []
  include Aws::Structure
end

#max_idle_time_in_seconds ⇒ Integer

The maximum amount of time in seconds that a non-pinned Lambda function can idle before the IoT Greengrass Core software stops its process.

Returns:

• (Integer)

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

class LambdaExecutionParameters < Struct.new(
  :event_sources,
  :max_queue_size,
  :max_instances_count,
  :max_idle_time_in_seconds,
  :timeout_in_seconds,
  :status_timeout_in_seconds,
  :pinned,
  :input_payload_encoding_type,
  :exec_args,
  :environment_variables,
  :linux_process_params)
  SENSITIVE = []
  include Aws::Structure
end

#max_instances_count ⇒ Integer

The maximum number of instances that a non-pinned Lambda function can run at the same time.

Returns:

• (Integer)

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

class LambdaExecutionParameters < Struct.new(
  :event_sources,
  :max_queue_size,
  :max_instances_count,
  :max_idle_time_in_seconds,
  :timeout_in_seconds,
  :status_timeout_in_seconds,
  :pinned,
  :input_payload_encoding_type,
  :exec_args,
  :environment_variables,
  :linux_process_params)
  SENSITIVE = []
  include Aws::Structure
end

#max_queue_size ⇒ Integer

The maximum size of the message queue for the Lambda function component. The IoT Greengrass core stores messages in a FIFO (first-in-first-out) queue until it can run the Lambda function to consume each message.

Returns:

• (Integer)

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

class LambdaExecutionParameters < Struct.new(
  :event_sources,
  :max_queue_size,
  :max_instances_count,
  :max_idle_time_in_seconds,
  :timeout_in_seconds,
  :status_timeout_in_seconds,
  :pinned,
  :input_payload_encoding_type,
  :exec_args,
  :environment_variables,
  :linux_process_params)
  SENSITIVE = []
  include Aws::Structure
end

#pinned ⇒ Boolean

Whether or not the Lambda function is pinned, or long-lived.

• A pinned Lambda function starts when IoT Greengrass starts and keeps running in its own container.

• A non-pinned Lambda function starts only when it receives a work item and exists after it idles for maxIdleTimeInSeconds. If the function has multiple work items, the IoT Greengrass Core software creates multiple instances of the function.

Default: true

Returns:

• (Boolean)

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

class LambdaExecutionParameters < Struct.new(
  :event_sources,
  :max_queue_size,
  :max_instances_count,
  :max_idle_time_in_seconds,
  :timeout_in_seconds,
  :status_timeout_in_seconds,
  :pinned,
  :input_payload_encoding_type,
  :exec_args,
  :environment_variables,
  :linux_process_params)
  SENSITIVE = []
  include Aws::Structure
end

#status_timeout_in_seconds ⇒ Integer

The interval in seconds at which a pinned (also known as long-lived) Lambda function component sends status updates to the Lambda manager component.

Returns:

• (Integer)

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

class LambdaExecutionParameters < Struct.new(
  :event_sources,
  :max_queue_size,
  :max_instances_count,
  :max_idle_time_in_seconds,
  :timeout_in_seconds,
  :status_timeout_in_seconds,
  :pinned,
  :input_payload_encoding_type,
  :exec_args,
  :environment_variables,
  :linux_process_params)
  SENSITIVE = []
  include Aws::Structure
end

#timeout_in_seconds ⇒ Integer

The maximum amount of time in seconds that the Lambda function can process a work item.

Returns:

• (Integer)

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

class LambdaExecutionParameters < Struct.new(
  :event_sources,
  :max_queue_size,
  :max_instances_count,
  :max_idle_time_in_seconds,
  :timeout_in_seconds,
  :status_timeout_in_seconds,
  :pinned,
  :input_payload_encoding_type,
  :exec_args,
  :environment_variables,
  :linux_process_params)
  SENSITIVE = []
  include Aws::Structure
end