Options
All
  • Public
  • Public/Protected
  • All
Menu

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

https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-runtime

see

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

Hierarchy

Index

Constructors

Properties

serviceNameVariable: string

Methods

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

    Parameters

    • name: string

    Returns string

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

    Returns string

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

Generated using TypeDoc