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

Class: Aws::Lambda::Types::UpdateFunctionCodeRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb

Overview

Note:

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

{
  function_name: "FunctionName", # required
  zip_file: "data",
  s3_bucket: "S3Bucket",
  s3_key: "S3Key",
  s3_object_version: "S3ObjectVersion",
  publish: false,
  dry_run: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#dry_runBoolean

This boolean parameter can be used to test your request to AWS Lambda to update the Lambda function and publish a version as an atomic operation. It will do all necessary computation and validation of your code but will not upload it or a publish a version. Each time this operation is invoked, the CodeSha256 hash value of the provided code will also be computed and returned in the response.

Returns:

  • (Boolean)


2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 2128

class UpdateFunctionCodeRequest < Struct.new(
  :function_name,
  :zip_file,
  :s3_bucket,
  :s3_key,
  :s3_object_version,
  :publish,
  :dry_run)
  include Aws::Structure
end

#function_nameString

The existing Lambda function name whose code you want to replace.

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 characters in length.

Returns:

  • (String)


2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 2128

class UpdateFunctionCodeRequest < Struct.new(
  :function_name,
  :zip_file,
  :s3_bucket,
  :s3_key,
  :s3_object_version,
  :publish,
  :dry_run)
  include Aws::Structure
end

#publishBoolean

This boolean parameter can be used to request AWS Lambda to update the Lambda function and publish a version as an atomic operation.

Returns:

  • (Boolean)


2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 2128

class UpdateFunctionCodeRequest < Struct.new(
  :function_name,
  :zip_file,
  :s3_bucket,
  :s3_key,
  :s3_object_version,
  :publish,
  :dry_run)
  include Aws::Structure
end

#s3_bucketString

Amazon S3 bucket name where the .zip file containing your deployment package is stored. This bucket must reside in the same AWS Region where you are creating the Lambda function.

Returns:

  • (String)


2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 2128

class UpdateFunctionCodeRequest < Struct.new(
  :function_name,
  :zip_file,
  :s3_bucket,
  :s3_key,
  :s3_object_version,
  :publish,
  :dry_run)
  include Aws::Structure
end

#s3_keyString

The Amazon S3 object (the deployment package) key name you want to upload.

Returns:

  • (String)


2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 2128

class UpdateFunctionCodeRequest < Struct.new(
  :function_name,
  :zip_file,
  :s3_bucket,
  :s3_key,
  :s3_object_version,
  :publish,
  :dry_run)
  include Aws::Structure
end

#s3_object_versionString

The Amazon S3 object (the deployment package) version you want to upload.

Returns:

  • (String)


2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 2128

class UpdateFunctionCodeRequest < Struct.new(
  :function_name,
  :zip_file,
  :s3_bucket,
  :s3_key,
  :s3_object_version,
  :publish,
  :dry_run)
  include Aws::Structure
end

#zip_fileString

The contents of your zip file containing your deployment package. If you are using the web API directly, the contents of the zip file must be base64-encoded. If you are using the AWS SDKs or the AWS CLI, the SDKs or CLI will do the encoding for you. For more information about creating a .zip file, see Execution Permissions in the AWS Lambda Developer Guide.

Returns:

  • (String)


2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 2128

class UpdateFunctionCodeRequest < Struct.new(
  :function_name,
  :zip_file,
  :s3_bucket,
  :s3_key,
  :s3_object_version,
  :publish,
  :dry_run)
  include Aws::Structure
end