Class EnvironmentVariablesService

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.

See

Hierarchy

  • EnvironmentVariablesService

Implements

Constructors

constructor

Properties

devModeVariable serviceNameVariable

Methods

get getServiceName getXrayTraceId getXrayTraceSampled isDevMode isValueTrue

Constructors

constructor

Properties

Protected devModeVariable

devModeVariable: string = 'POWERTOOLS_DEV'

See

https://docs.powertools.aws.dev/lambda/typescript/latest/#environment-variables

Protected serviceNameVariable

serviceNameVariable: string = 'POWERTOOLS_SERVICE_NAME'

Methods

get

getServiceName

getXrayTraceId

  • 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 undefined | string

getXrayTraceSampled

  • It returns true if the Sampled flag is set in 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,

    Returns boolean

isDevMode

isValueTrue

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc