ClientSettings Class

Summary

The settings to use when connecting to Amazon Lambda
Assembly
Cake.AWS.Lambda.dll
Namespace
Cake.AWS.Lambda
Base Types
  • Object
Derived Types
graph BT Type-->Base0["Object"] Type["ClientSettings"] class Type type-node Derived0["AliasSettings"]-->Type click Derived0 "/api/Cake.AWS.Lambda/AliasSettings" Derived1["CodeSettings"]-->Type click Derived1 "/api/Cake.AWS.Lambda/CodeSettings"

Syntax

public abstract class ClientSettings

Constructors

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

Properties

Name Value Summary
AccessKey string
The AWS Access Key ID
Region RegionEndpoint
The endpoints available to AWS clients.
SecretKey string
The AWS Secret Access Key.
SessionToken string
The AWS Session Token, if using temporary credentials.

Extension Methods

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