Class EnvironmentVariablesService

This class is used to return environment variables that are available in the runtime of the current Lambda invocation. These variables can be a mix of runtime environment variables set by AWS and variables that can be set by the developer additionally.

Implements

See

Hierarchy

EnvironmentVariablesService
- EnvironmentVariablesService

Implements

ConfigServiceInterface

Index

Constructors

constructor

new EnvironmentVariablesService(): EnvironmentVariablesService
Returns EnvironmentVariablesService

Inherited from EnvironmentVariablesService.constructor

Properties

`Protected` serviceNameVariable

serviceNameVariable: string

See

https://awslabs.github.io/aws-lambda-powertools-typescript/latest/#environment-variables

Methods

get

get(name: string): string
It returns the value of an environment variable that has given name.

Returns
Parameters
- name: string
Returns string
Implementation of ConfigServiceInterface.get

Inherited from EnvironmentVariablesService.get
- Defined in commons/lib/config/EnvironmentVariablesService.d.ts:28

getAwsRegion

getAwsRegion(): string
It returns the value of the AWS_REGION environment variable.

Returns

Returns string
- Defined in logger/src/config/EnvironmentVariablesService.ts:36

getCurrentEnvironment

getCurrentEnvironment(): string
It returns the value of the ENVIRONMENT environment variable.

Returns

Returns string
Implementation of ConfigServiceInterface.getCurrentEnvironment
- Defined in logger/src/config/EnvironmentVariablesService.ts:45

getFunctionMemory

getFunctionMemory(): number
It returns the value of the AWS_LAMBDA_FUNCTION_MEMORY_SIZE environment variable.

Returns

Returns number
- Defined in logger/src/config/EnvironmentVariablesService.ts:54

getFunctionName

getFunctionName(): string
It returns the value of the AWS_LAMBDA_FUNCTION_NAME environment variable.

Returns

Returns string
- Defined in logger/src/config/EnvironmentVariablesService.ts:65

getFunctionVersion

getFunctionVersion(): string
It returns the value of the AWS_LAMBDA_FUNCTION_VERSION environment variable.

Returns

Returns string
- Defined in logger/src/config/EnvironmentVariablesService.ts:74

getLogEvent

getLogEvent(): boolean
It returns the value of the POWERTOOLS_LOGGER_LOG_EVENT environment variable.

Returns

Returns boolean
Implementation of ConfigServiceInterface.getLogEvent
- Defined in logger/src/config/EnvironmentVariablesService.ts:83

getLogLevel

getLogLevel(): string
It returns the value of the LOG_LEVEL environment variable.

Returns

Returns string
Implementation of ConfigServiceInterface.getLogLevel
- Defined in logger/src/config/EnvironmentVariablesService.ts:94

getSampleRateValue

getSampleRateValue(): undefined | number
It returns the value of the POWERTOOLS_LOGGER_SAMPLE_RATE environment variable.

Returns

Returns undefined | number
Implementation of ConfigServiceInterface.getSampleRateValue
- Defined in logger/src/config/EnvironmentVariablesService.ts:103

getServiceName

getServiceName(): string
It returns the value of the POWERTOOLS_SERVICE_NAME environment variable.

Returns

Returns string
Implementation of ConfigServiceInterface.getServiceName

Inherited from EnvironmentVariablesService.getServiceName
- Defined in commons/lib/config/EnvironmentVariablesService.d.ts:34

getXrayTraceId

getXrayTraceId(): undefined | string
It returns the value of the _X_AMZN_TRACE_ID environment variable.

The AWS X-Ray Trace data available in the environment variable has this format: Root=1-5759e988-bd862e3fe1be46a994272793;Parent=557abcec3ee5a047;Sampled=1,

The actual Trace ID is: 1-5759e988-bd862e3fe1be46a994272793.

Returns

Returns undefined | string
Inherited from EnvironmentVariablesService.getXrayTraceId
- Defined in commons/lib/config/EnvironmentVariablesService.d.ts:45

isDevMode

isDevMode(): boolean
It returns true if the POWERTOOLS_DEV environment variable is set to truthy value.

Returns

Returns boolean
Implementation of ConfigServiceInterface.isDevMode
- Defined in logger/src/config/EnvironmentVariablesService.ts:114

isValueTrue

isValueTrue(value: string): boolean
It returns true if the string value represents a boolean true value.

Returns
boolean
Parameters
- value: string
Returns boolean
Implementation of ConfigServiceInterface.isValueTrue
- Defined in logger/src/config/EnvironmentVariablesService.ts:126

Class EnvironmentVariablesService

Implements

See

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns EnvironmentVariablesService

Properties

Protected serviceNameVariable

See

Methods

get

Returns

Parameters

name: string

Returns string

getAwsRegion

Returns

Returns string

getCurrentEnvironment

Returns

Returns string

getFunctionMemory

Returns

Returns number

getFunctionName

Returns

Returns string

getFunctionVersion

Returns

Returns string

getLogEvent

Returns

Returns boolean

getLogLevel

Returns

Returns string

getSampleRateValue

Returns

Returns undefined | number

getServiceName

Returns

Returns string

getXrayTraceId

Returns

Returns undefined | string

isDevMode

Returns

Returns boolean

isValueTrue

Returns

Parameters

value: string

Returns boolean

Settings

Member Visibility

Theme

`Protected` serviceNameVariable