CodeSettings Class

Summary

The settings to use when uploading code to Amazon Lambda
Assembly
Cake.AWS.Lambda.dll
Namespace
Cake.AWS.Lambda
Base Types
Derived Types
graph BT Type-->Base0["ClientSettings"] click Base0 "/api/Cake.AWS.Lambda/ClientSettings" Base0-->Base1["Object"] Type["CodeSettings"] class Type type-node Derived0["PublishVersionSettings"]-->Type click Derived0 "/api/Cake.AWS.Lambda/PublishVersionSettings" Derived1["UpdateFunctionCodeSettings"]-->Type click Derived1 "/api/Cake.AWS.Lambda/UpdateFunctionCodeSettings" Derived2["CreateFunctionSettings"]-->Type click Derived2 "/api/Cake.AWS.Lambda/CreateFunctionSettings"

Syntax

public abstract class CodeSettings : ClientSettings

Constructors

Name Summary
CodeSettings() Initializes a new instance of the CodeSettings class.

Properties

Name Value Summary
AccessKey string
The AWS Access Key ID
Inherited from ClientSettings
Region RegionEndpoint
The endpoints available to AWS clients.
Inherited from ClientSettings
S3Bucket string
The name of the Amazon S3 bucket where the bundled artifacts are stored.
S3Key string
The name of the Amazon S3 object that represents the bundled artifacts you want to upload.
S3Version string
A specific version of the Amazon S3 object that represents the bundled artifacts you want to upload.
SecretKey string
The AWS Secret Access Key.
Inherited from ClientSettings
SessionToken string
The AWS Session Token, if using temporary credentials.
Inherited from ClientSettings
WorkingDirectory DirectoryPath
Gets or sets the working directory for the process to be started.
ZipFile MemoryStream
The contents of your zip file containing your deployment package.
ZipPath FilePath
The path to your zip file containing your deployment package.

Extension Methods

Name Value Summary
Dump<CodeSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
Initialize<CodeSettings>(ICakeEnvironment) T
Helper method to get the AWS Credentials from environment variables
Requires the Cake.AWS.Lambda addin
IsIn<CodeSettings>(CodeSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<CodeSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<CodeSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
SetAccessKey(string) ClientSettings
Specifies the AWS Access Key to use as credentials.
Requires the Cake.AWS.Lambda addin
SetRegion(RegionEndpoint) ClientSettings
Specifies the endpoints available to AWS clients.
Requires the Cake.AWS.Lambda addin
SetRegion(string) ClientSettings
Specifies the endpoints available to AWS clients.
Requires the Cake.AWS.Lambda addin
SetSecretKey(string) ClientSettings
Specifies the AWS Secret Key to use as credentials.
Requires the Cake.AWS.Lambda addin
SetSessionToken(string) ClientSettings
Specifies the AWS Session Token to use as credentials.
Requires the Cake.AWS.Lambda addin
ThrowIfNull<CodeSettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<CodeSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin