Class: Aws::Lambda::Types::CreateFunctionRequest

Inherits:

Struct

Object
Struct
Aws::Lambda::Types::CreateFunctionRequest

show all

Includes:: Structure

Defined in:: lib/aws-sdk-lambda/types.rb

Overview

Note:

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

{
  function_name: "FunctionName", # required
  runtime: "nodejs", # required, 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
  role: "RoleArn", # required
  handler: "Handler", # required
  code: { # required
    zip_file: "data",
    s3_bucket: "S3Bucket",
    s3_key: "S3Key",
    s3_object_version: "S3ObjectVersion",
  },
  description: "Description",
  timeout: 1,
  memory_size: 1,
  publish: false,
  vpc_config: {
    subnet_ids: ["SubnetId"],
    security_group_ids: ["SecurityGroupId"],
  },
  dead_letter_config: {
    target_arn: "ResourceArn",
  },
  environment: {
    variables: {
      "EnvironmentVariableName" => "EnvironmentVariableValue",
    },
  },
  kms_key_arn: "KMSKeyArn",
  tracing_config: {
    mode: "Active", # accepts Active, PassThrough
  },
  tags: {
    "TagKey" => "TagValue",
  },
}

Instance Attribute Summary collapse

#code ⇒ Types::FunctionCode

The code for the function.
#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.
#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 KMS key used to encrypt your function’s environment variables.
#memory_size ⇒ Integer

The amount of memory that your function has access to.
#publish ⇒ Boolean

Set to true to publish the first version of the function during creation.
#role ⇒ String

The Amazon Resource Name (ARN) of the function’s [execution role].
#runtime ⇒ String

The runtime version for the function.
#tags ⇒ Hash<String,String>

The list of tags (key-value pairs) assigned to the new 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

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

Instance Attribute Details

#code ⇒ `Types::FunctionCode`

The code for the function.

Returns:

(Types::FunctionCode)

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

class CreateFunctionRequest < Struct.new(
  :function_name,
  :runtime,
  :role,
  :handler,
  :code,
  :description,
  :timeout,
  :memory_size,
  :publish,
  :vpc_config,
  :dead_letter_config,
  :environment,
  :kms_key_arn,
  :tracing_config,
  :tags)
  include Aws::Structure
end

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

class CreateFunctionRequest < Struct.new(
  :function_name,
  :runtime,
  :role,
  :handler,
  :code,
  :description,
  :timeout,
  :memory_size,
  :publish,
  :vpc_config,
  :dead_letter_config,
  :environment,
  :kms_key_arn,
  :tracing_config,
  :tags)
  include Aws::Structure
end

#description ⇒ `String`

A description of the function.

Returns:

(String)

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

class CreateFunctionRequest < Struct.new(
  :function_name,
  :runtime,
  :role,
  :handler,
  :code,
  :description,
  :timeout,
  :memory_size,
  :publish,
  :vpc_config,
  :dead_letter_config,
  :environment,
  :kms_key_arn,
  :tracing_config,
  :tags)
  include Aws::Structure
end

#environment ⇒ `Types::Environment`

Environment variables that are accessible from function code during execution.

Returns:

(Types::Environment)

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

class CreateFunctionRequest < Struct.new(
  :function_name,
  :runtime,
  :role,
  :handler,
  :code,
  :description,
  :timeout,
  :memory_size,
  :publish,
  :vpc_config,
  :dead_letter_config,
  :environment,
  :kms_key_arn,
  :tracing_config,
  :tags)
  include Aws::Structure
end

#function_name ⇒ `String`

The name of the lambda function.

**Name formats**

**Function name** - ‘MyFunction`.
**Function ARN** - ‘arn:aws:lambda:us-west-2:123456789012:function:MyFunction`.
**Partial ARN** - ‘123456789012:function:MyFunction`.

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 578

class CreateFunctionRequest < Struct.new(
  :function_name,
  :runtime,
  :role,
  :handler,
  :code,
  :description,
  :timeout,
  :memory_size,
  :publish,
  :vpc_config,
  :dead_letter_config,
  :environment,
  :kms_key_arn,
  :tracing_config,
  :tags)
  include Aws::Structure
end

#handler ⇒ `String`

The name of the method within your code that Lambda calls to execute your function. For more information, see [Programming Model].

[1]: docs.aws.amazon.com/lambda/latest/dg/programming-model-v2.html

Returns:

(String)

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

class CreateFunctionRequest < Struct.new(
  :function_name,
  :runtime,
  :role,
  :handler,
  :code,
  :description,
  :timeout,
  :memory_size,
  :publish,
  :vpc_config,
  :dead_letter_config,
  :environment,
  :kms_key_arn,
  :tracing_config,
  :tags)
  include Aws::Structure
end

#kms_key_arn ⇒ `String`

The ARN of the KMS key used to encrypt your function’s environment variables. If not provided, AWS Lambda will use a default service key.

Returns:

(String)

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

class CreateFunctionRequest < Struct.new(
  :function_name,
  :runtime,
  :role,
  :handler,
  :code,
  :description,
  :timeout,
  :memory_size,
  :publish,
  :vpc_config,
  :dead_letter_config,
  :environment,
  :kms_key_arn,
  :tracing_config,
  :tags)
  include Aws::Structure
end

#memory_size ⇒ `Integer`

The amount of memory that your function has access to. Increasing the function’s memory also increases it’s CPU allocation. 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 578

class CreateFunctionRequest < Struct.new(
  :function_name,
  :runtime,
  :role,
  :handler,
  :code,
  :description,
  :timeout,
  :memory_size,
  :publish,
  :vpc_config,
  :dead_letter_config,
  :environment,
  :kms_key_arn,
  :tracing_config,
  :tags)
  include Aws::Structure
end

#publish ⇒ `Boolean`

Set to true to publish the first version of the function during creation.

Returns:

(Boolean)

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

class CreateFunctionRequest < Struct.new(
  :function_name,
  :runtime,
  :role,
  :handler,
  :code,
  :description,
  :timeout,
  :memory_size,
  :publish,
  :vpc_config,
  :dead_letter_config,
  :environment,
  :kms_key_arn,
  :tracing_config,
  :tags)
  include Aws::Structure
end

#role ⇒ `String`

The Amazon Resource Name (ARN) of the function’s [execution role].

[1]: docs.aws.amazon.com/lambda/latest/dg/intro-permission-model.html#lambda-intro-execution-role

Returns:

(String)

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

class CreateFunctionRequest < Struct.new(
  :function_name,
  :runtime,
  :role,
  :handler,
  :code,
  :description,
  :timeout,
  :memory_size,
  :publish,
  :vpc_config,
  :dead_letter_config,
  :environment,
  :kms_key_arn,
  :tracing_config,
  :tags)
  include Aws::Structure
end

#runtime ⇒ `String`

The runtime version for the function.

Returns:

(String)

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

class CreateFunctionRequest < Struct.new(
  :function_name,
  :runtime,
  :role,
  :handler,
  :code,
  :description,
  :timeout,
  :memory_size,
  :publish,
  :vpc_config,
  :dead_letter_config,
  :environment,
  :kms_key_arn,
  :tracing_config,
  :tags)
  include Aws::Structure
end

#tags ⇒ `Hash<String,String>`

The list of tags (key-value pairs) assigned to the new function. For more information, see [Tagging Lambda Functions] in the **AWS Lambda Developer Guide**.

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

Returns:

(Hash<String,String>)

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

class CreateFunctionRequest < Struct.new(
  :function_name,
  :runtime,
  :role,
  :handler,
  :code,
  :description,
  :timeout,
  :memory_size,
  :publish,
  :vpc_config,
  :dead_letter_config,
  :environment,
  :kms_key_arn,
  :tracing_config,
  :tags)
  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 578

class CreateFunctionRequest < Struct.new(
  :function_name,
  :runtime,
  :role,
  :handler,
  :code,
  :description,
  :timeout,
  :memory_size,
  :publish,
  :vpc_config,
  :dead_letter_config,
  :environment,
  :kms_key_arn,
  :tracing_config,
  :tags)
  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 578

class CreateFunctionRequest < Struct.new(
  :function_name,
  :runtime,
  :role,
  :handler,
  :code,
  :description,
  :timeout,
  :memory_size,
  :publish,
  :vpc_config,
  :dead_letter_config,
  :environment,
  :kms_key_arn,
  :tracing_config,
  :tags)
  include Aws::Structure
end

#vpc_config ⇒ `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. These must belong to the same VPC. You must provide at least one security group and one subnet ID.

Returns:

(Types::VpcConfig)

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

class CreateFunctionRequest < Struct.new(
  :function_name,
  :runtime,
  :role,
  :handler,
  :code,
  :description,
  :timeout,
  :memory_size,
  :publish,
  :vpc_config,
  :dead_letter_config,
  :environment,
  :kms_key_arn,
  :tracing_config,
  :tags)
  include Aws::Structure
end

Class: Aws::Lambda::Types::CreateFunctionRequest

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#code ⇒ Types::FunctionCode

#dead_letter_config ⇒ Types::DeadLetterConfig

#description ⇒ String

#environment ⇒ Types::Environment

#function_name ⇒ String

#handler ⇒ String

#kms_key_arn ⇒ String

#memory_size ⇒ Integer

#publish ⇒ Boolean

#role ⇒ String

#runtime ⇒ String

#tags ⇒ Hash<String,String>

#timeout ⇒ Integer

#tracing_config ⇒ Types::TracingConfig

#vpc_config ⇒ Types::VpcConfig

#code ⇒ `Types::FunctionCode`

#dead_letter_config ⇒ `Types::DeadLetterConfig`

#description ⇒ `String`

#environment ⇒ `Types::Environment`

#function_name ⇒ `String`

#handler ⇒ `String`

#kms_key_arn ⇒ `String`

#memory_size ⇒ `Integer`

#publish ⇒ `Boolean`

#role ⇒ `String`

#runtime ⇒ `String`

#tags ⇒ `Hash<String,String>`

#timeout ⇒ `Integer`

#tracing_config ⇒ `Types::TracingConfig`

#vpc_config ⇒ `Types::VpcConfig`