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

Inherits:

Struct

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

show all

Defined in:: gems/aws-sdk-lambda/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, nodejs10.x, nodejs12.x, java8, java8.al2, java11, python2.7, python3.6, python3.7, python3.8, dotnetcore1.0, dotnetcore2.0, dotnetcore2.1, dotnetcore3.1, nodejs4.3-edge, go1.x, ruby2.5, ruby2.7, provided, provided.al2
  dead_letter_config: {
    target_arn: "ResourceArn",
  },
  kms_key_arn: "KMSKeyArn",
  tracing_config: {
    mode: "Active", # accepts Active, PassThrough
  },
  revision_id: "String",
  layers: ["LayerVersionArn"],
  file_system_configs: [
    {
      arn: "FileSystemArn", # required
      local_mount_path: "LocalMountPath", # required
    },
  ],
}

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#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 description of the function.
#environment ⇒ Types::Environment
Environment variables that are accessible from function code during execution.
#file_system_configs ⇒ Array<Types::FileSystemConfig>
Connection settings for an Amazon EFS file system.
#function_name ⇒ String
The name of the Lambda function.
#handler ⇒ String
The name of the method within your code that Lambda calls to execute your function.
#kms_key_arn ⇒ String
The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables.
#layers ⇒ Array<String>
A list of [function layers][1] to add to the function's execution environment.
#memory_size ⇒ Integer
The amount of memory that your function has access to.
#revision_id ⇒ String
Only update the function if the revision ID matches the ID that's specified.
#role ⇒ String
The Amazon Resource Name (ARN) of the function's execution role.
#runtime ⇒ String
The identifier of the function's [runtime][1].
#timeout ⇒ Integer
The amount of time that Lambda allows a function to run before stopping 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
For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC.

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.

Returns:

(Types::DeadLetterConfig)

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

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,
  :file_system_configs)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ `String`

A description of the function.

Returns:

(String)

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

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,
  :file_system_configs)
  SENSITIVE = []
  include Aws::Structure
end

#environment ⇒ `Types::Environment`

Environment variables that are accessible from function code during execution.

Returns:

(Types::Environment)

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

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,
  :file_system_configs)
  SENSITIVE = []
  include Aws::Structure
end

#file_system_configs ⇒ `Array<Types::FileSystemConfig>`

Connection settings for an Amazon EFS file system.

Returns:

(Array<Types::FileSystemConfig>)

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

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,
  :file_system_configs)
  SENSITIVE = []
  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 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 5277

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,
  :file_system_configs)
  SENSITIVE = []
  include Aws::Structure
end

#handler ⇒ `String`

The name of the method within your code that Lambda calls to execute your function. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Programming Model.

Returns:

(String)

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

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,
  :file_system_configs)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_arn ⇒ `String`

The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key.

Returns:

(String)

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

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,
  :file_system_configs)
  SENSITIVE = []
  include Aws::Structure
end

#layers ⇒ `Array<String>`

A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.

Returns:

(Array<String>)

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

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,
  :file_system_configs)
  SENSITIVE = []
  include Aws::Structure
end

#memory_size ⇒ `Integer`

The amount of memory that your function has access to. Increasing the function's memory also increases its CPU allocation. The default value is 128 MB. The value must be a multiple of 64 MB.

Returns:

(Integer)

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

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,
  :file_system_configs)
  SENSITIVE = []
  include Aws::Structure
end

#revision_id ⇒ `String`

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

Returns:

(String)

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

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,
  :file_system_configs)
  SENSITIVE = []
  include Aws::Structure
end

#role ⇒ `String`

The Amazon Resource Name (ARN) of the function's execution role.

Returns:

(String)

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

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,
  :file_system_configs)
  SENSITIVE = []
  include Aws::Structure
end

#runtime ⇒ `String`

The identifier of the function's runtime.

Returns:

(String)

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

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,
  :file_system_configs)
  SENSITIVE = []
  include Aws::Structure
end

#timeout ⇒ `Integer`

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

Returns:

(Integer)

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

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,
  :file_system_configs)
  SENSITIVE = []
  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 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 5277

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,
  :file_system_configs)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_config ⇒ `Types::VpcConfig`

For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can only access resources and the internet through that VPC. For more information, see VPC Settings.

Returns:

(Types::VpcConfig)

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

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,
  :file_system_configs)
  SENSITIVE = []
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#dead_letter_config ⇒ Types::DeadLetterConfig

#description ⇒ String

#environment ⇒ Types::Environment

#file_system_configs ⇒ Array<Types::FileSystemConfig>

#function_name ⇒ String

#handler ⇒ String

#kms_key_arn ⇒ String

#layers ⇒ Array<String>

#memory_size ⇒ Integer

#revision_id ⇒ String

#role ⇒ String

#runtime ⇒ String

#timeout ⇒ Integer

#tracing_config ⇒ Types::TracingConfig

#vpc_config ⇒ Types::VpcConfig

#dead_letter_config ⇒ `Types::DeadLetterConfig`

#description ⇒ `String`

#environment ⇒ `Types::Environment`

#file_system_configs ⇒ `Array<Types::FileSystemConfig>`

#function_name ⇒ `String`

#handler ⇒ `String`

#kms_key_arn ⇒ `String`

#layers ⇒ `Array<String>`

#memory_size ⇒ `Integer`

#revision_id ⇒ `String`

#role ⇒ `String`

#runtime ⇒ `String`

#timeout ⇒ `Integer`

#tracing_config ⇒ `Types::TracingConfig`

#vpc_config ⇒ `Types::VpcConfig`