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

Inherits:

Struct

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

Defined in:

gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #architectures ⇒ Array<String>

  The instruction set architecture that the function supports.

• #code ⇒ Types::FunctionCode

  The code for the function.

• #code_signing_config_arn ⇒ String

  To enable code signing for this function, specify the ARN of a code-signing configuration.

• #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.

• #ephemeral_storage ⇒ Types::EphemeralStorage

  The size of the function's /tmp directory in MB.

• #file_system_configs ⇒ Array<Types::FileSystemConfig>

  Connection settings for an Amazon EFS file system.

• #function_name ⇒ String

  The name or ARN of the Lambda function.

• #handler ⇒ String

  The name of the method within your code that Lambda calls to run your function.

• #image_config ⇒ Types::ImageConfig

  Container image [configuration values][1] that override the values in the container image Dockerfile.

• #kms_key_arn ⇒ String

  The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt your function's [environment variables][1].

• #layers ⇒ Array<String>

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

• #logging_config ⇒ Types::LoggingConfig

  The function's Amazon CloudWatch Logs configuration settings.

• #memory_size ⇒ Integer

  The amount of [memory available to the function][1] at runtime.

• #package_type ⇒ String

  The type of deployment package.

• #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 identifier of the function's [runtime][1].

• #snap_start ⇒ Types::SnapStart

  The function's [SnapStart][1] setting.

• #tags ⇒ Hash<String,String>

  A list of [tags][1] to apply to the function.

• #timeout ⇒ Integer

  The amount of time (in seconds) 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 [X-Ray][1].

• #vpc_config ⇒ Types::VpcConfig

  For network connectivity to Amazon Web Services resources in a VPC, specify a list of security groups and subnets in the VPC.

Instance Attribute Details

#architectures ⇒ Array<String>

The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is x86_64.

Returns:

• (Array<String>)

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

class CreateFunctionRequest < Struct.new(
  :function_name,
  :runtime,
  :role,
  :handler,
  :code,
  :description,
  :timeout,
  :memory_size,
  :publish,
  :vpc_config,
  :package_type,
  :dead_letter_config,
  :environment,
  :kms_key_arn,
  :tracing_config,
  :tags,
  :layers,
  :file_system_configs,
  :image_config,
  :code_signing_config_arn,
  :architectures,
  :ephemeral_storage,
  :snap_start,
  :logging_config)
  SENSITIVE = []
  include Aws::Structure
end

#code ⇒ Types::FunctionCode

The code for the function.

Returns:

• (Types::FunctionCode)

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

class CreateFunctionRequest < Struct.new(
  :function_name,
  :runtime,
  :role,
  :handler,
  :code,
  :description,
  :timeout,
  :memory_size,
  :publish,
  :vpc_config,
  :package_type,
  :dead_letter_config,
  :environment,
  :kms_key_arn,
  :tracing_config,
  :tags,
  :layers,
  :file_system_configs,
  :image_config,
  :code_signing_config_arn,
  :architectures,
  :ephemeral_storage,
  :snap_start,
  :logging_config)
  SENSITIVE = []
  include Aws::Structure
end

#code_signing_config_arn ⇒ String

To enable code signing for this function, specify the ARN of a code-signing configuration. A code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.

Returns:

• (String)

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

class CreateFunctionRequest < Struct.new(
  :function_name,
  :runtime,
  :role,
  :handler,
  :code,
  :description,
  :timeout,
  :memory_size,
  :publish,
  :vpc_config,
  :package_type,
  :dead_letter_config,
  :environment,
  :kms_key_arn,
  :tracing_config,
  :tags,
  :layers,
  :file_system_configs,
  :image_config,
  :code_signing_config_arn,
  :architectures,
  :ephemeral_storage,
  :snap_start,
  :logging_config)
  SENSITIVE = []
  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.

Returns:

• (Types::DeadLetterConfig)

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

class CreateFunctionRequest < Struct.new(
  :function_name,
  :runtime,
  :role,
  :handler,
  :code,
  :description,
  :timeout,
  :memory_size,
  :publish,
  :vpc_config,
  :package_type,
  :dead_letter_config,
  :environment,
  :kms_key_arn,
  :tracing_config,
  :tags,
  :layers,
  :file_system_configs,
  :image_config,
  :code_signing_config_arn,
  :architectures,
  :ephemeral_storage,
  :snap_start,
  :logging_config)
  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 1080

class CreateFunctionRequest < Struct.new(
  :function_name,
  :runtime,
  :role,
  :handler,
  :code,
  :description,
  :timeout,
  :memory_size,
  :publish,
  :vpc_config,
  :package_type,
  :dead_letter_config,
  :environment,
  :kms_key_arn,
  :tracing_config,
  :tags,
  :layers,
  :file_system_configs,
  :image_config,
  :code_signing_config_arn,
  :architectures,
  :ephemeral_storage,
  :snap_start,
  :logging_config)
  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 1080

class CreateFunctionRequest < Struct.new(
  :function_name,
  :runtime,
  :role,
  :handler,
  :code,
  :description,
  :timeout,
  :memory_size,
  :publish,
  :vpc_config,
  :package_type,
  :dead_letter_config,
  :environment,
  :kms_key_arn,
  :tracing_config,
  :tags,
  :layers,
  :file_system_configs,
  :image_config,
  :code_signing_config_arn,
  :architectures,
  :ephemeral_storage,
  :snap_start,
  :logging_config)
  SENSITIVE = []
  include Aws::Structure
end

#ephemeral_storage ⇒ Types::EphemeralStorage

The size of the function's /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10,240 MB. For more information, see Configuring ephemeral storage (console).

Returns:

• (Types::EphemeralStorage)

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

class CreateFunctionRequest < Struct.new(
  :function_name,
  :runtime,
  :role,
  :handler,
  :code,
  :description,
  :timeout,
  :memory_size,
  :publish,
  :vpc_config,
  :package_type,
  :dead_letter_config,
  :environment,
  :kms_key_arn,
  :tracing_config,
  :tags,
  :layers,
  :file_system_configs,
  :image_config,
  :code_signing_config_arn,
  :architectures,
  :ephemeral_storage,
  :snap_start,
  :logging_config)
  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 1080

class CreateFunctionRequest < Struct.new(
  :function_name,
  :runtime,
  :role,
  :handler,
  :code,
  :description,
  :timeout,
  :memory_size,
  :publish,
  :vpc_config,
  :package_type,
  :dead_letter_config,
  :environment,
  :kms_key_arn,
  :tracing_config,
  :tags,
  :layers,
  :file_system_configs,
  :image_config,
  :code_signing_config_arn,
  :architectures,
  :ephemeral_storage,
  :snap_start,
  :logging_config)
  SENSITIVE = []
  include Aws::Structure
end

#function_name ⇒ String

The name or ARN 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 1080

class CreateFunctionRequest < Struct.new(
  :function_name,
  :runtime,
  :role,
  :handler,
  :code,
  :description,
  :timeout,
  :memory_size,
  :publish,
  :vpc_config,
  :package_type,
  :dead_letter_config,
  :environment,
  :kms_key_arn,
  :tracing_config,
  :tags,
  :layers,
  :file_system_configs,
  :image_config,
  :code_signing_config_arn,
  :architectures,
  :ephemeral_storage,
  :snap_start,
  :logging_config)
  SENSITIVE = []
  include Aws::Structure
end

#handler ⇒ String

The name of the method within your code that Lambda calls to run your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Lambda programming model.

Returns:

• (String)

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

class CreateFunctionRequest < Struct.new(
  :function_name,
  :runtime,
  :role,
  :handler,
  :code,
  :description,
  :timeout,
  :memory_size,
  :publish,
  :vpc_config,
  :package_type,
  :dead_letter_config,
  :environment,
  :kms_key_arn,
  :tracing_config,
  :tags,
  :layers,
  :file_system_configs,
  :image_config,
  :code_signing_config_arn,
  :architectures,
  :ephemeral_storage,
  :snap_start,
  :logging_config)
  SENSITIVE = []
  include Aws::Structure
end

#image_config ⇒ Types::ImageConfig

Container image configuration values that override the values in the container image Dockerfile.

Returns:

• (Types::ImageConfig)

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

class CreateFunctionRequest < Struct.new(
  :function_name,
  :runtime,
  :role,
  :handler,
  :code,
  :description,
  :timeout,
  :memory_size,
  :publish,
  :vpc_config,
  :package_type,
  :dead_letter_config,
  :environment,
  :kms_key_arn,
  :tracing_config,
  :tags,
  :layers,
  :file_system_configs,
  :image_config,
  :code_signing_config_arn,
  :architectures,
  :ephemeral_storage,
  :snap_start,
  :logging_config)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_arn ⇒ String

The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt your function's environment variables. When Lambda SnapStart is activated, Lambda also uses this key is to encrypt your function's snapshot. If you deploy your function using a container image, Lambda also uses this key to encrypt your function when it's deployed. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). If you don't provide a customer managed key, Lambda uses a default service key.

Returns:

• (String)

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

class CreateFunctionRequest < Struct.new(
  :function_name,
  :runtime,
  :role,
  :handler,
  :code,
  :description,
  :timeout,
  :memory_size,
  :publish,
  :vpc_config,
  :package_type,
  :dead_letter_config,
  :environment,
  :kms_key_arn,
  :tracing_config,
  :tags,
  :layers,
  :file_system_configs,
  :image_config,
  :code_signing_config_arn,
  :architectures,
  :ephemeral_storage,
  :snap_start,
  :logging_config)
  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 1080

class CreateFunctionRequest < Struct.new(
  :function_name,
  :runtime,
  :role,
  :handler,
  :code,
  :description,
  :timeout,
  :memory_size,
  :publish,
  :vpc_config,
  :package_type,
  :dead_letter_config,
  :environment,
  :kms_key_arn,
  :tracing_config,
  :tags,
  :layers,
  :file_system_configs,
  :image_config,
  :code_signing_config_arn,
  :architectures,
  :ephemeral_storage,
  :snap_start,
  :logging_config)
  SENSITIVE = []
  include Aws::Structure
end

#logging_config ⇒ Types::LoggingConfig

The function's Amazon CloudWatch Logs configuration settings.

Returns:

• (Types::LoggingConfig)

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

class CreateFunctionRequest < Struct.new(
  :function_name,
  :runtime,
  :role,
  :handler,
  :code,
  :description,
  :timeout,
  :memory_size,
  :publish,
  :vpc_config,
  :package_type,
  :dead_letter_config,
  :environment,
  :kms_key_arn,
  :tracing_config,
  :tags,
  :layers,
  :file_system_configs,
  :image_config,
  :code_signing_config_arn,
  :architectures,
  :ephemeral_storage,
  :snap_start,
  :logging_config)
  SENSITIVE = []
  include Aws::Structure
end

#memory_size ⇒ Integer

The amount of memory available to the function at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB.

Returns:

• (Integer)

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

class CreateFunctionRequest < Struct.new(
  :function_name,
  :runtime,
  :role,
  :handler,
  :code,
  :description,
  :timeout,
  :memory_size,
  :publish,
  :vpc_config,
  :package_type,
  :dead_letter_config,
  :environment,
  :kms_key_arn,
  :tracing_config,
  :tags,
  :layers,
  :file_system_configs,
  :image_config,
  :code_signing_config_arn,
  :architectures,
  :ephemeral_storage,
  :snap_start,
  :logging_config)
  SENSITIVE = []
  include Aws::Structure
end

#package_type ⇒ String

The type of deployment package. Set to Image for container image and set to Zip for .zip file archive.

Returns:

• (String)

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

class CreateFunctionRequest < Struct.new(
  :function_name,
  :runtime,
  :role,
  :handler,
  :code,
  :description,
  :timeout,
  :memory_size,
  :publish,
  :vpc_config,
  :package_type,
  :dead_letter_config,
  :environment,
  :kms_key_arn,
  :tracing_config,
  :tags,
  :layers,
  :file_system_configs,
  :image_config,
  :code_signing_config_arn,
  :architectures,
  :ephemeral_storage,
  :snap_start,
  :logging_config)
  SENSITIVE = []
  include Aws::Structure
end

#publish ⇒ Boolean

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

Returns:

• (Boolean)

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

class CreateFunctionRequest < Struct.new(
  :function_name,
  :runtime,
  :role,
  :handler,
  :code,
  :description,
  :timeout,
  :memory_size,
  :publish,
  :vpc_config,
  :package_type,
  :dead_letter_config,
  :environment,
  :kms_key_arn,
  :tracing_config,
  :tags,
  :layers,
  :file_system_configs,
  :image_config,
  :code_signing_config_arn,
  :architectures,
  :ephemeral_storage,
  :snap_start,
  :logging_config)
  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 1080

class CreateFunctionRequest < Struct.new(
  :function_name,
  :runtime,
  :role,
  :handler,
  :code,
  :description,
  :timeout,
  :memory_size,
  :publish,
  :vpc_config,
  :package_type,
  :dead_letter_config,
  :environment,
  :kms_key_arn,
  :tracing_config,
  :tags,
  :layers,
  :file_system_configs,
  :image_config,
  :code_signing_config_arn,
  :architectures,
  :ephemeral_storage,
  :snap_start,
  :logging_config)
  SENSITIVE = []
  include Aws::Structure
end

#runtime ⇒ String

The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive.

The following list includes deprecated runtimes. For more information, see Runtime deprecation policy.

Returns:

• (String)

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

class CreateFunctionRequest < Struct.new(
  :function_name,
  :runtime,
  :role,
  :handler,
  :code,
  :description,
  :timeout,
  :memory_size,
  :publish,
  :vpc_config,
  :package_type,
  :dead_letter_config,
  :environment,
  :kms_key_arn,
  :tracing_config,
  :tags,
  :layers,
  :file_system_configs,
  :image_config,
  :code_signing_config_arn,
  :architectures,
  :ephemeral_storage,
  :snap_start,
  :logging_config)
  SENSITIVE = []
  include Aws::Structure
end

#snap_start ⇒ Types::SnapStart

The function's SnapStart setting.

Returns:

• (Types::SnapStart)

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

class CreateFunctionRequest < Struct.new(
  :function_name,
  :runtime,
  :role,
  :handler,
  :code,
  :description,
  :timeout,
  :memory_size,
  :publish,
  :vpc_config,
  :package_type,
  :dead_letter_config,
  :environment,
  :kms_key_arn,
  :tracing_config,
  :tags,
  :layers,
  :file_system_configs,
  :image_config,
  :code_signing_config_arn,
  :architectures,
  :ephemeral_storage,
  :snap_start,
  :logging_config)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

A list of tags to apply to the function.

Returns:

• (Hash<String,String>)

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

class CreateFunctionRequest < Struct.new(
  :function_name,
  :runtime,
  :role,
  :handler,
  :code,
  :description,
  :timeout,
  :memory_size,
  :publish,
  :vpc_config,
  :package_type,
  :dead_letter_config,
  :environment,
  :kms_key_arn,
  :tracing_config,
  :tags,
  :layers,
  :file_system_configs,
  :image_config,
  :code_signing_config_arn,
  :architectures,
  :ephemeral_storage,
  :snap_start,
  :logging_config)
  SENSITIVE = []
  include Aws::Structure
end

#timeout ⇒ Integer

The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see Lambda execution environment.

Returns:

• (Integer)

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

class CreateFunctionRequest < Struct.new(
  :function_name,
  :runtime,
  :role,
  :handler,
  :code,
  :description,
  :timeout,
  :memory_size,
  :publish,
  :vpc_config,
  :package_type,
  :dead_letter_config,
  :environment,
  :kms_key_arn,
  :tracing_config,
  :tags,
  :layers,
  :file_system_configs,
  :image_config,
  :code_signing_config_arn,
  :architectures,
  :ephemeral_storage,
  :snap_start,
  :logging_config)
  SENSITIVE = []
  include Aws::Structure
end

#tracing_config ⇒ Types::TracingConfig

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

Returns:

• (Types::TracingConfig)

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

class CreateFunctionRequest < Struct.new(
  :function_name,
  :runtime,
  :role,
  :handler,
  :code,
  :description,
  :timeout,
  :memory_size,
  :publish,
  :vpc_config,
  :package_type,
  :dead_letter_config,
  :environment,
  :kms_key_arn,
  :tracing_config,
  :tags,
  :layers,
  :file_system_configs,
  :image_config,
  :code_signing_config_arn,
  :architectures,
  :ephemeral_storage,
  :snap_start,
  :logging_config)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_config ⇒ Types::VpcConfig

For network connectivity to Amazon Web Services 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 access resources and the internet only through that VPC. For more information, see Configuring a Lambda function to access resources in a VPC.

Returns:

• (Types::VpcConfig)

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

class CreateFunctionRequest < Struct.new(
  :function_name,
  :runtime,
  :role,
  :handler,
  :code,
  :description,
  :timeout,
  :memory_size,
  :publish,
  :vpc_config,
  :package_type,
  :dead_letter_config,
  :environment,
  :kms_key_arn,
  :tracing_config,
  :tags,
  :layers,
  :file_system_configs,
  :image_config,
  :code_signing_config_arn,
  :architectures,
  :ephemeral_storage,
  :snap_start,
  :logging_config)
  SENSITIVE = []
  include Aws::Structure
end