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

Inherits:

Struct

• Object
• Struct
• Aws::Greengrass::Types::FunctionConfiguration

Defined in:

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

Overview

Note:

When making an API call, you may pass FunctionConfiguration data as a 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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #encoding_type ⇒ String

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

• #environment ⇒ Types::FunctionConfigurationEnvironment

  The environment configuration of the function.

• #exec_args ⇒ String

  The execution arguments.

• #executable ⇒ String

  The name of the function executable.

• #memory_size ⇒ Integer

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

• #pinned ⇒ Boolean

  True if the function is pinned.

• #timeout ⇒ Integer

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

Instance Attribute Details

#encoding_type ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/types.rb', line 2387

class FunctionConfiguration < Struct.new(
  :encoding_type,
  :environment,
  :exec_args,
  :executable,
  :memory_size,
  :pinned,
  :timeout)
  SENSITIVE = []
  include Aws::Structure
end

#environment ⇒ Types::FunctionConfigurationEnvironment

The environment configuration of the function.

Returns:

• (Types::FunctionConfigurationEnvironment)

# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/types.rb', line 2387

class FunctionConfiguration < Struct.new(
  :encoding_type,
  :environment,
  :exec_args,
  :executable,
  :memory_size,
  :pinned,
  :timeout)
  SENSITIVE = []
  include Aws::Structure
end

#exec_args ⇒ String

The execution arguments.

Returns:

• (String)

# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/types.rb', line 2387

class FunctionConfiguration < Struct.new(
  :encoding_type,
  :environment,
  :exec_args,
  :executable,
  :memory_size,
  :pinned,
  :timeout)
  SENSITIVE = []
  include Aws::Structure
end

#executable ⇒ String

The name of the function executable.

Returns:

• (String)

# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/types.rb', line 2387

class FunctionConfiguration < Struct.new(
  :encoding_type,
  :environment,
  :exec_args,
  :executable,
  :memory_size,
  :pinned,
  :timeout)
  SENSITIVE = []
  include Aws::Structure
end

#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)

# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/types.rb', line 2387

class FunctionConfiguration < Struct.new(
  :encoding_type,
  :environment,
  :exec_args,
  :executable,
  :memory_size,
  :pinned,
  :timeout)
  SENSITIVE = []
  include Aws::Structure
end

#pinned ⇒ Boolean

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

Returns:

• (Boolean)

# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/types.rb', line 2387

class FunctionConfiguration < Struct.new(
  :encoding_type,
  :environment,
  :exec_args,
  :executable,
  :memory_size,
  :pinned,
  :timeout)
  SENSITIVE = []
  include Aws::Structure
end

#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)

# File 'gems/aws-sdk-greengrass/lib/aws-sdk-greengrass/types.rb', line 2387

class FunctionConfiguration < Struct.new(
  :encoding_type,
  :environment,
  :exec_args,
  :executable,
  :memory_size,
  :pinned,
  :timeout)
  SENSITIVE = []
  include Aws::Structure
end