AliasSettings Class

Summary

Using this API you can update the function version to which the alias points and the alias description.
Assembly
Cake.AWS.Lambda.dll
Namespace
Cake.AWS.Lambda
Base Types
graph BT Type-->Base0["ClientSettings"] click Base0 "/api/Cake.AWS.Lambda/ClientSettings" Base0-->Base1["Object"] Type["AliasSettings"] class Type type-node

Syntax

public class AliasSettings : ClientSettings

Constructors

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

Properties

Name Value Summary
AccessKey string
The AWS Access Key ID
Inherited from ClientSettings
Description string
Gets and sets the alias Description.
Name string
Gets and sets the alias name
Region RegionEndpoint
The endpoints available to AWS clients.
Inherited from ClientSettings
SecretKey string
The AWS Secret Access Key.
Inherited from ClientSettings
SessionToken string
The AWS Session Token, if using temporary credentials.
Inherited from ClientSettings
Version string
Gets and sets the Lambda function version to which the alias points.

Extension Methods

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