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

Inherits:
Struct
  • Object
show all
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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#encoding_typeString

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

Returns:

  • (String)


2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
# 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

#environmentTypes::FunctionConfigurationEnvironment

The environment configuration of the function.



2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
# 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_argsString

The execution arguments.

Returns:

  • (String)


2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
# 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

#executableString

The name of the function executable.

Returns:

  • (String)


2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
# 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_sizeInteger

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)


2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
# 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

#pinnedBoolean

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

Returns:

  • (Boolean)


2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
# 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

#timeoutInteger

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)


2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
# 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