Class: Aws::Lambda::Types::UpdateFunctionConfigurationRequest

Inherits:

Struct

• Object
• Struct
• Aws::Lambda::Types::UpdateFunctionConfigurationRequest

Includes:

Structure

Defined in:

lib/aws-sdk-lambda/types.rb

Overview

Note:

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

{
  function_name: "FunctionName", # required
  role: "RoleArn",
  handler: "Handler",
  description: "Description",
  timeout: 1,
  memory_size: 1,
  vpc_config: {
    subnet_ids: ["SubnetId"],
    security_group_ids: ["SecurityGroupId"],
  },
  environment: {
    variables: {
      "EnvironmentVariableName" => "EnvironmentVariableValue",
    },
  },
  runtime: "nodejs", # accepts nodejs, nodejs4.3, nodejs6.10, nodejs8.10, java8, python2.7, python3.6, python3.7, dotnetcore1.0, dotnetcore2.0, dotnetcore2.1, nodejs4.3-edge, go1.x, ruby2.5, provided
  dead_letter_config: {
    target_arn: "ResourceArn",
  },
  kms_key_arn: "KMSKeyArn",
  tracing_config: {
    mode: "Active", # accepts Active, PassThrough
  },
  revision_id: "String",
  layers: ["LayerVersionArn"],
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #dead_letter_config ⇒ Types::DeadLetterConfig

  A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing.

• #description ⇒ String

  A short user-defined function description.

• #environment ⇒ Types::Environment

  The parent object that contains your environment’s configuration settings.

• #function_name ⇒ String

  The name of the Lambda function.

• #handler ⇒ String

  The function that Lambda calls to begin executing your function.

• #kms_key_arn ⇒ String

  The Amazon Resource Name (ARN) of the KMS key used to encrypt your function’s environment variables.

• #layers ⇒ Array<String>

  A list of [function layers] to add to the function’s execution environment.

• #memory_size ⇒ Integer

  The amount of memory, in MB, your Lambda function is given.

• #revision_id ⇒ String

  Only update the function if the revision ID matches the ID specified.

• #role ⇒ String

  The Amazon Resource Name (ARN) of the IAM role that Lambda will assume when it executes your function.

• #runtime ⇒ String

  The runtime version for the function.

• #timeout ⇒ Integer

  The amount of time that Lambda allows a function to run before terminating it.

• #tracing_config ⇒ Types::TracingConfig

  Set ‘Mode` to `Active` to sample and trace a subset of incoming requests with AWS X-Ray.

• #vpc_config ⇒ Types::VpcConfig

  Specify security groups and subnets in a VPC to which your Lambda function needs access.

Instance Attribute Details

#dead_letter_config ⇒ Types::DeadLetterConfig

A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see [Dead Letter Queues].

[1]: docs.aws.amazon.com/lambda/latest/dg/dlq.html

Returns:

• (Types::DeadLetterConfig)

# File 'lib/aws-sdk-lambda/types.rb', line 2919

class UpdateFunctionConfigurationRequest < Struct.new(
  :function_name,
  :role,
  :handler,
  :description,
  :timeout,
  :memory_size,
  :vpc_config,
  :environment,
  :runtime,
  :dead_letter_config,
  :kms_key_arn,
  :tracing_config,
  :revision_id,
  :layers)
  include Aws::Structure
end

#description ⇒ String

A short user-defined function description. AWS Lambda does not use this value. Assign a meaningful description as you see fit.

Returns:

• (String)

# File 'lib/aws-sdk-lambda/types.rb', line 2919

class UpdateFunctionConfigurationRequest < Struct.new(
  :function_name,
  :role,
  :handler,
  :description,
  :timeout,
  :memory_size,
  :vpc_config,
  :environment,
  :runtime,
  :dead_letter_config,
  :kms_key_arn,
  :tracing_config,
  :revision_id,
  :layers)
  include Aws::Structure
end

#environment ⇒ Types::Environment

The parent object that contains your environment’s configuration settings.

Returns:

• (Types::Environment)

# File 'lib/aws-sdk-lambda/types.rb', line 2919

class UpdateFunctionConfigurationRequest < Struct.new(
  :function_name,
  :role,
  :handler,
  :description,
  :timeout,
  :memory_size,
  :vpc_config,
  :environment,
  :runtime,
  :dead_letter_config,
  :kms_key_arn,
  :tracing_config,
  :revision_id,
  :layers)
  include Aws::Structure
end

#function_name ⇒ String

The name of the Lambda function.

**Name formats**

• **Function name** - ‘my-function`.

• **Function ARN** - ‘arn:aws:lambda:us-west-2:123456789012:function:my-function`.

• **Partial ARN** - ‘123456789012:function:my-function`.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

Returns:

• (String)

# File 'lib/aws-sdk-lambda/types.rb', line 2919

class UpdateFunctionConfigurationRequest < Struct.new(
  :function_name,
  :role,
  :handler,
  :description,
  :timeout,
  :memory_size,
  :vpc_config,
  :environment,
  :runtime,
  :dead_letter_config,
  :kms_key_arn,
  :tracing_config,
  :revision_id,
  :layers)
  include Aws::Structure
end

#handler ⇒ String

The function that Lambda calls to begin executing your function. For Node.js, it is the ‘module-name.export` value in your function.

Returns:

• (String)

# File 'lib/aws-sdk-lambda/types.rb', line 2919

class UpdateFunctionConfigurationRequest < Struct.new(
  :function_name,
  :role,
  :handler,
  :description,
  :timeout,
  :memory_size,
  :vpc_config,
  :environment,
  :runtime,
  :dead_letter_config,
  :kms_key_arn,
  :tracing_config,
  :revision_id,
  :layers)
  include Aws::Structure
end

#kms_key_arn ⇒ String

The Amazon Resource Name (ARN) of the KMS key used to encrypt your function’s environment variables. If you elect to use the AWS Lambda default service key, pass in an empty string (“”) for this parameter.

Returns:

• (String)

# File 'lib/aws-sdk-lambda/types.rb', line 2919

class UpdateFunctionConfigurationRequest < Struct.new(
  :function_name,
  :role,
  :handler,
  :description,
  :timeout,
  :memory_size,
  :vpc_config,
  :environment,
  :runtime,
  :dead_letter_config,
  :kms_key_arn,
  :tracing_config,
  :revision_id,
  :layers)
  include Aws::Structure
end

#layers ⇒ Array<String>

A list of [function layers] to add to the function’s execution environment.

[1]: docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html

Returns:

• (Array<String>)

# File 'lib/aws-sdk-lambda/types.rb', line 2919

class UpdateFunctionConfigurationRequest < Struct.new(
  :function_name,
  :role,
  :handler,
  :description,
  :timeout,
  :memory_size,
  :vpc_config,
  :environment,
  :runtime,
  :dead_letter_config,
  :kms_key_arn,
  :tracing_config,
  :revision_id,
  :layers)
  include Aws::Structure
end

#memory_size ⇒ Integer

The amount of memory, in MB, your Lambda function is given. AWS Lambda uses this memory size to infer the amount of CPU allocated to your function. Your function use-case determines your CPU and memory requirements. For example, a database operation might need less memory compared to an image processing function. The default value is 128 MB. The value must be a multiple of 64 MB.

Returns:

• (Integer)

# File 'lib/aws-sdk-lambda/types.rb', line 2919

class UpdateFunctionConfigurationRequest < Struct.new(
  :function_name,
  :role,
  :handler,
  :description,
  :timeout,
  :memory_size,
  :vpc_config,
  :environment,
  :runtime,
  :dead_letter_config,
  :kms_key_arn,
  :tracing_config,
  :revision_id,
  :layers)
  include Aws::Structure
end

#revision_id ⇒ String

Only update the function if the revision ID matches the ID specified. Use this option to avoid modifying a function that has changed since you last read it.

Returns:

• (String)

# File 'lib/aws-sdk-lambda/types.rb', line 2919

class UpdateFunctionConfigurationRequest < Struct.new(
  :function_name,
  :role,
  :handler,
  :description,
  :timeout,
  :memory_size,
  :vpc_config,
  :environment,
  :runtime,
  :dead_letter_config,
  :kms_key_arn,
  :tracing_config,
  :revision_id,
  :layers)
  include Aws::Structure
end

#role ⇒ String

The Amazon Resource Name (ARN) of the IAM role that Lambda will assume when it executes your function.

Returns:

• (String)

# File 'lib/aws-sdk-lambda/types.rb', line 2919

class UpdateFunctionConfigurationRequest < Struct.new(
  :function_name,
  :role,
  :handler,
  :description,
  :timeout,
  :memory_size,
  :vpc_config,
  :environment,
  :runtime,
  :dead_letter_config,
  :kms_key_arn,
  :tracing_config,
  :revision_id,
  :layers)
  include Aws::Structure
end

#runtime ⇒ String

The runtime version for the function.

Returns:

• (String)

# File 'lib/aws-sdk-lambda/types.rb', line 2919

class UpdateFunctionConfigurationRequest < Struct.new(
  :function_name,
  :role,
  :handler,
  :description,
  :timeout,
  :memory_size,
  :vpc_config,
  :environment,
  :runtime,
  :dead_letter_config,
  :kms_key_arn,
  :tracing_config,
  :revision_id,
  :layers)
  include Aws::Structure
end

#timeout ⇒ Integer

The amount of time that Lambda allows a function to run before terminating it. The default is 3 seconds. The maximum allowed value is 900 seconds.

Returns:

• (Integer)

# File 'lib/aws-sdk-lambda/types.rb', line 2919

class UpdateFunctionConfigurationRequest < Struct.new(
  :function_name,
  :role,
  :handler,
  :description,
  :timeout,
  :memory_size,
  :vpc_config,
  :environment,
  :runtime,
  :dead_letter_config,
  :kms_key_arn,
  :tracing_config,
  :revision_id,
  :layers)
  include Aws::Structure
end

#tracing_config ⇒ Types::TracingConfig

Set ‘Mode` to `Active` to sample and trace a subset of incoming requests with AWS X-Ray.

Returns:

• (Types::TracingConfig)

# File 'lib/aws-sdk-lambda/types.rb', line 2919

class UpdateFunctionConfigurationRequest < Struct.new(
  :function_name,
  :role,
  :handler,
  :description,
  :timeout,
  :memory_size,
  :vpc_config,
  :environment,
  :runtime,
  :dead_letter_config,
  :kms_key_arn,
  :tracing_config,
  :revision_id,
  :layers)
  include Aws::Structure
end

#vpc_config ⇒ Types::VpcConfig

Specify security groups and subnets in a VPC to which your Lambda function needs access.

Returns:

• (Types::VpcConfig)

# File 'lib/aws-sdk-lambda/types.rb', line 2919

class UpdateFunctionConfigurationRequest < Struct.new(
  :function_name,
  :role,
  :handler,
  :description,
  :timeout,
  :memory_size,
  :vpc_config,
  :environment,
  :runtime,
  :dead_letter_config,
  :kms_key_arn,
  :tracing_config,
  :revision_id,
  :layers)
  include Aws::Structure
end