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

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

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

Overview

Note:

When passing UpdateFunctionConfigurationRequest as input to an Aws::Client method, you can use a vanilla 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, java8, python2.7, python3.6, dotnetcore1.0, nodejs4.3-edge
  dead_letter_config: {
    target_arn: "ResourceArn",
  },
  kms_key_arn: "KMSKeyArn",
  tracing_config: {
    mode: "Active", # accepts Active, PassThrough
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#dead_letter_configTypes::DeadLetterConfig

The parent object that contains the target ARN (Amazon Resource Name) of an Amazon SQS queue or Amazon SNS topic.

Returns:

  • (Types::DeadLetterConfig)

    The parent object that contains the target ARN (Amazon Resource Name) of an Amazon SQS queue or Amazon SNS topic.

#descriptionString

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

Returns:

  • (String)

    A short user-defined function description.

#environmentTypes::Environment

The parent object that contains your environment\'s configuration settings.

Returns:

  • (Types::Environment)

    The parent object that contains your environment\'s configuration settings.

#function_nameString

The name of the Lambda function.

You can specify a function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). AWS Lambda also allows you to specify a partial ARN (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

Returns:

  • (String)

    The name of the Lambda function.

#handlerString

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)

    The function that Lambda calls to begin executing your function.

#kms_key_arnString

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)

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

#memory_sizeInteger

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)

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

#roleString

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

Returns:

  • (String)

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

#runtimeString

The runtime environment for the Lambda function.

To use the Python runtime v3.6, set the value to \"python3.6\". To use the Python runtime v2.7, set the value to \"python2.7\". To use the Node.js runtime v6.10, set the value to \"nodejs6.10\". To use the Node.js runtime v4.3, set the value to \"nodejs4.3\". To use the Python runtime v3.6, set the value to \"python3.6\".

Node v0.10.42 is currently marked as deprecated. You must migrate existing functions to the newer Node.js runtime versions available on AWS Lambda (nodejs4.3 or nodejs6.10) as soon as possible. You can request a one-time extension until June 30, 2017 by going to the Lambda console and following the instructions provided. Failure to do so will result in an invalid parameter error being returned. Note that you will have to follow this procedure for each region that contains functions written in the Node v0.10.42 runtime.

Possible values:

  • nodejs
  • nodejs4.3
  • nodejs6.10
  • java8
  • python2.7
  • python3.6
  • dotnetcore1.0
  • nodejs4.3-edge

Returns:

  • (String)

    The runtime environment for the Lambda function.

#timeoutInteger

The function execution time at which AWS Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.

Returns:

  • (Integer)

    The function execution time at which AWS Lambda should terminate the function.

#tracing_configTypes::TracingConfig

The parent object that contains your function\'s tracing settings.

Returns:

#vpc_configTypes::VpcConfig

If your Lambda function accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and one subnet ID.

Returns:

  • (Types::VpcConfig)

    If your Lambda function accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs.