You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Greengrass::Types::FunctionConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing FunctionConfiguration as input to an Aws::Client method, you can use a vanilla Hash:

{
  encoding_type: "binary", # accepts binary, json
  environment: {
    access_sysfs: false,
    execution: {
      isolation_mode: "GreengrassContainer", # accepts GreengrassContainer, NoContainer
      run_as: {
        gid: 1,
        uid: 1,
      },
    },
    resource_access_policies: [
      {
        permission: "ro", # accepts ro, rw
        resource_id: "__string", # required
      },
    ],
    variables: {
      "__string" => "__string",
    },
  },
  exec_args: "__string",
  executable: "__string",
  memory_size: 1,
  pinned: false,
  timeout: 1,
}

The configuration of the Lambda function.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#encoding_type ⇒ String

The expected encoding type of the input payload for the function. The default is \'\'json\'\'.

Possible values:

  • binary
  • json

Returns:

  • (String) —

    The expected encoding type of the input payload for the function.

#environment ⇒ Types::FunctionConfigurationEnvironment

The environment configuration of the function.

Returns:

#exec_args ⇒ String

The execution arguments.

Returns:

  • (String) —

    The execution arguments.

#executable ⇒ String

The name of the function executable.

Returns:

  • (String) —

    The name of the function executable.

#memory_size ⇒ Integer

The memory size, in KB, which the function requires. This setting is not applicable and should be cleared when you run the Lambda function without containerization.

Returns:

  • (Integer) —

    The memory size, in KB, which the function requires.

#pinned ⇒ Boolean

True if the function is pinned. Pinned means the function is long-lived and starts when the core starts.

Returns:

  • (Boolean) —

    True if the function is pinned.

#timeout ⇒ Integer

The allowed function execution time, after which Lambda should terminate the function. This timeout still applies to pinned Lambda functions for each request.

Returns:

  • (Integer) —

    The allowed function execution time, after which Lambda should terminate the function.