Interface LzaLambdaProps

LzaLambdaProps properties

Hierarchy

  • LzaLambdaProps

Properties

assetPath cloudWatchLogKmsKey? cloudWatchLogRemovalPolicy? cloudWatchLogRetentionInDays description? environmentEncryptionKmsKey? environmentVariables? functionName? handler? memorySize? nagSuppressionPrefix role? roleInitialPolicy? timeOut?

Properties

Readonly assetPath

assetPath: string

LZA Custom resource lambda asset folder path including the /dist folder

Optional Readonly cloudWatchLogKmsKey

cloudWatchLogKmsKey?: IKey

Custom resource lambda log group encryption key, when undefined default AWS managed key will be used

Optional Readonly cloudWatchLogRemovalPolicy

cloudWatchLogRemovalPolicy?: RemovalPolicy

Determine the removal policy of CloudWatch log group for the lambda.

Default

RemovalPolicy.Destroy

Readonly cloudWatchLogRetentionInDays

cloudWatchLogRetentionInDays: number

Custom resource lambda cloudwatch log retention in days

Optional Readonly description

description?: string

A description of the custom resource lambda function.

Optional Readonly environmentEncryptionKmsKey

environmentEncryptionKmsKey?: IKey

Custom resource lambda environment encryption key, when undefined default AWS managed key will be used

Optional Readonly environmentVariables

environmentVariables?: {
    [key: string]: any;
}[]

A name value object list for lambda environment variables

Example

[{ solution: 'accelerator', author: 'tsd' }]

Optional Readonly functionName

functionName?: string

A name for the function.

Default

  • AWS CloudFormation generates a unique physical ID and uses that ID for the function's name.

Optional Readonly handler

handler?: string

The name of the method within lambda code that custom resource lambda calls to execute the function. The format includes the file name.

Default

'index.handler'

Optional Readonly memorySize

memorySize?: number

The amount of memory, in MB, that is allocated to custom resource Lambda function. Lambda uses this value to proportionally allocate the amount of CPU power.

Default

256

Readonly nagSuppressionPrefix

nagSuppressionPrefix: string

Prefix for nag suppression

Optional Readonly role

role?: Role | IRole

Custom resource lambda execution role. This is the role that will be assumed by the function upon execution.

Default

A unique role will be generated for this lambda function.

Optional Readonly roleInitialPolicy

roleInitialPolicy?: PolicyStatement[]

Initial policy statements to add to the created custom resource Lambda Role.

Optional Readonly timeOut

timeOut?: Duration

Custom resource lambda function execution time (in seconds) after which Lambda terminates the function.

Default

3 seconds

Settings

Member Visibility

Theme

Generated using TypeDoc