This content is part of a third party extension that is not supported by the Cake project.
For more information about this extension see Cake.AWS.Lambda.
Summary
The settings to use when uploading code to Amazon Lambda
- Assembly
- Cake
.AWS .Lambda .dll - Namespace
- Cake
.AWS .Lambda - Base Types
-
- Object
- ClientSettings
- 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["CreateFunctionSettings"]-->Type
click Derived1 "/api/Cake.AWS.Lambda/CreateFunctionSettings"
Derived2["UpdateFunctionCodeSettings"]-->Type
click Derived2 "/api/Cake.AWS.Lambda/UpdateFunctionCodeSettings"
Syntax
public abstract class CodeSettings : ClientSettingsConstructors
| 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 |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator addin
|
| Initialize |
T |
Helper method to get the AWS Credentials from environment variables
Requires the Cake.AWS.Lambda addin
|
| IsIn |
bool |
Checks if the source is contained in a list
From EnumerableExtensions
Requires the Cake.Incubator addin
|
| NotNull |
void |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp addin
|
| NotNull |
void |
Throws an exception if the specified parameter's value is null.
From IssuesArgumentChecks
Requires the Cake.Issues addin
|
| SetAccessKey |
ClientSettings |
Specifies the AWS Access Key to use as credentials.
Requires the Cake.AWS.Lambda addin
|
| SetRegion |
ClientSettings |
Specifies the endpoints available to AWS clients.
Requires the Cake.AWS.Lambda addin
|
| SetRegion |
ClientSettings |
Specifies the endpoints available to AWS clients.
Requires the Cake.AWS.Lambda addin
|
| SetSecretKey |
ClientSettings |
Specifies the AWS Secret Key to use as credentials.
Requires the Cake.AWS.Lambda addin
|
| SetSessionToken |
ClientSettings |
Specifies the AWS Session Token to use as credentials.
Requires the Cake.AWS.Lambda addin
|
| ThrowIfNull |
T |
Throws a
System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
| ThrowIfNull |
T |
Throws a
System.ArgumentNullException if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
| ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|
| To |
string |
Returns the string value or a
Not set> markup suitable for Spectre.Console.
From StringExtensions
Requires the Cake.Issues addin
|