Class LambdaSharpAppConfig

The LambdaSharpAppConfig class is used to deserialize the settings for the LambdaSharpAppClient instance.

Inheritance

System.Object

LambdaSharpAppConfig

Namespace: LambdaSharp.App.Config

Assembly: LambdaSharp.App.dll

Syntax

public sealed class LambdaSharpAppConfig

Properties

ApiKey

The ApiKey property holds the API key for the app API.

Declaration

public string ApiKey { get; set; }

Property Value

Type	Description
System.String	The API key for the app API.

ApiUrl

The ApiUrl property holds the URL for the app API.

Declaration

public string ApiUrl { get; set; }

Property Value

Type	Description
System.String	The URL of the app API.

AppEventSource

The AppEventSource property holds the configured event source value, or null when not set.

Declaration

public string AppEventSource { get; set; }

Property Value

Type	Description
System.String	Configured event source name for the app instance, or null.

AppFramework

The AppFramework property describes the application execution framework.

Declaration

public string AppFramework { get; set; }

Property Value

Type	Description
System.String	The application framework.

AppId

The AppId property describes the application identifier.

Declaration

public string AppId { get; set; }

Property Value

Type	Description
System.String	The application id.

AppInstanceId

The AppInstanceId property describes app instance identifier.

Declaration

public string AppInstanceId { get; set; }

Property Value

Type	Description
System.String	The app assembly version GUID.

AppName

The AppName property describes the application name.

Declaration

public string AppName { get; set; }

Property Value

Type	Description
System.String	The application name.

AppVersionId

The AppVersionId property describes app assembly version identifier.

Declaration

public string AppVersionId { get; set; }

Property Value

Type	Description
System.String	The app assembly version GUID.

DeploymentTier

The DeploymentTier property describes the LambdaSharp deployment tier name. This property is empty for the default deployment tier.

Declaration

public string DeploymentTier { get; set; }

Property Value

Type	Description
System.String	The LambdaSharp deployment tier name.

Examples

Sample deployment tier name:

MyTier

DevMode

The DevMode property describes if the app API is running in dev mode (default: Disabled).

Declaration

public string DevMode { get; set; }

Property Value

Type	Description
System.String	The dev mode setting.

EventBusApiKey

The EventBusApiKey property holds the API key for the event bus API.

Declaration

public string EventBusApiKey { get; set; }

Property Value

Type	Description
System.String	The URL of the app API.

EventBusUrl

The EventBusUrl property holds the URL for the app event bus.

Declaration

public string EventBusUrl { get; set; }

Property Value

Type	Description
System.String	The URL of the app API.

GitBranch

The Git branch from which the function was built form.

Declaration

public string GitBranch { get; set; }

Property Value

Type	Description
System.String	The Git branch from the source code repository.

GitSha

The Git SHA from which the function was built from.

Declaration

public string GitSha { get; set; }

Property Value

Type	Description
System.String	The Git SHA from the source code repository.

ModuleId

The ModuleId property describes the stack name of the deployed LambdaSharp module.

Declaration

public string ModuleId { get; set; }

Property Value

Type	Description
System.String	The stack name of the deployed LambdaSharp module.

Examples

Sample module ID:

DevTier-MyAcmeModule

ModuleInfo

The ModuleInfo property describes the LambdaSharp module name, version, and origin.

Declaration

public string ModuleInfo { get; set; }

Property Value

Type	Description
System.String	The LambdaSharp module name and version.

Examples

Sample module name and version:

My.AcmeModule:1.0-Dev@origin

Methods

GetApiKey()

The GetApiKey() method return the API key for the app API depending on the status of dev mode.

Declaration

public string GetApiKey()

Returns

Type	Description
System.String	The app API key.

GetEventBusApiKey()

The GetEventBusApiKey() method return the API key for the event bus API depending on the status of dev mode.

Declaration

public string GetEventBusApiKey()

Returns

Type	Description
System.String	The event bus API key.

GetModuleFullName()

The GetModuleFullName() method return the module full name from the ModuleInfo property.

Declaration

public string GetModuleFullName()

Returns

Type	Description
System.String

GetModuleOrigin()

The GetModuleFullName() method return the module origin from the ModuleInfo property.

Declaration

public string GetModuleOrigin()

Returns

Type	Description
System.String

IsDevModeEnabled()

Determines if the developer mode is enabled.

Declaration

public bool IsDevModeEnabled()

Returns

Type	Description
System.Boolean	true when developer mode is enabled