PublishVersionSettings Class

Summary

Publishes a version of your function from the current snapshot of $LATEST. That is, AWS Lambda takes a snapshot of the function code and configuration information from $LATEST and publishes a new version. The code and configuration cannot be modified after publication.
Assembly
Cake.AWS.Lambda.dll
Namespace
Cake.AWS.Lambda
Base Types
graph BT Type-->Base0["CodeSettings"] click Base0 "/api/Cake.AWS.Lambda/CodeSettings" Base0-->Base1["ClientSettings"] click Base1 "/api/Cake.AWS.Lambda/ClientSettings" Base1-->Base2["Object"] Type["PublishVersionSettings"] class Type type-node

Syntax

public class PublishVersionSettings : CodeSettings

Constructors

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

Properties

Name Value Summary
AccessKey string
The AWS Access Key ID
Inherited from ClientSettings
CodeSha256 string
The SHA256 hash of the deployment package you want to publish. This provides validation on the code you are publishing. If you provide this parameter value must match the SHA256 of the $LATEST version for the publication to succeed.
Description string
The description for the version you are publishing. If not provided, AWS Lambda copies the description from the $LATEST version.
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.
Inherited from CodeSettings
S3Key string
The name of the Amazon S3 object that represents the bundled artifacts you want to upload.
Inherited from CodeSettings
S3Version string
A specific version of the Amazon S3 object that represents the bundled artifacts you want to upload.
Inherited from CodeSettings
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.
Inherited from CodeSettings
ZipFile MemoryStream
The contents of your zip file containing your deployment package.
Inherited from CodeSettings
ZipPath FilePath
The path to your zip file containing your deployment package.
Inherited from CodeSettings

Extension Methods

Name Value Summary
Dump<PublishVersionSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
Initialize<PublishVersionSettings>(ICakeEnvironment) T
Helper method to get the AWS Credentials from environment variables
Requires the Cake.AWS.Lambda addin
IsIn<PublishVersionSettings>(PublishVersionSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<PublishVersionSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<PublishVersionSettings>(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<PublishVersionSettings>(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<PublishVersionSettings>(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
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin