Skip to main content

defaults

sdlc-cdk-lib v1.0.0


sdlc-cdk-lib / modules/sdlc-aws-cdk-lib/src-types/defaults

modules/sdlc-aws-cdk-lib/src-types/defaults

Interfaces

AlarmConfig

Defined in: modules/sdlc-aws-cdk-lib/src-types/defaults/index.ts:8

CloudWatch alarm configuration for monitoring deployments.

Properties

errorThreshold

> readonly errorThreshold: number

Defined in: modules/sdlc-aws-cdk-lib/src-types/defaults/index.ts:9

evaluationPeriods

> readonly evaluationPeriods: number

Defined in: modules/sdlc-aws-cdk-lib/src-types/defaults/index.ts:10

period

> readonly period: Duration

Defined in: modules/sdlc-aws-cdk-lib/src-types/defaults/index.ts:11


LambdaDefaults

Defined in: modules/sdlc-aws-cdk-lib/src-types/defaults/index.ts:17

Lambda function resource defaults.

Properties

logRetentionDays

> readonly logRetentionDays: number

Defined in: modules/sdlc-aws-cdk-lib/src-types/defaults/index.ts:20

memorySize

> readonly memorySize: number

Defined in: modules/sdlc-aws-cdk-lib/src-types/defaults/index.ts:19

timeout

> readonly timeout: Duration

Defined in: modules/sdlc-aws-cdk-lib/src-types/defaults/index.ts:18


SdlcConfig

Defined in: modules/sdlc-aws-cdk-lib/src-types/defaults/index.ts:30

Deployment strategy configuration including infrastructure, deployment, monitoring, and resource defaults for each SDLC core environment.

This unified configuration can be extended for additional resource types beyond Lambda functions (e.g., ECS, EC2, etc.).

Properties

account

> readonly account: string

Defined in: modules/sdlc-aws-cdk-lib/src-types/defaults/index.ts:32

alarm

> readonly alarm: AlarmConfig

Defined in: modules/sdlc-aws-cdk-lib/src-types/defaults/index.ts:42

description

> readonly description: string

Defined in: modules/sdlc-aws-cdk-lib/src-types/defaults/index.ts:37

duration

> readonly duration: string

Defined in: modules/sdlc-aws-cdk-lib/src-types/defaults/index.ts:39

lambda

> readonly lambda: LambdaDefaults

Defined in: modules/sdlc-aws-cdk-lib/src-types/defaults/index.ts:45

region

> readonly region: string

Defined in: modules/sdlc-aws-cdk-lib/src-types/defaults/index.ts:33

releaseStrategy

> readonly releaseStrategy: ReleaseStrategy

Defined in: modules/sdlc-aws-cdk-lib/src-types/defaults/index.ts:36

trafficShift

> readonly trafficShift: string

Defined in: modules/sdlc-aws-cdk-lib/src-types/defaults/index.ts:38

Variables

SDLC_CONFIG

> const SDLC_CONFIG: Record<SdlcCore, SdlcConfig>

Defined in: modules/sdlc-aws-cdk-lib/src-types/defaults/index.ts:56

Complete SDLC configuration by core environment.

Consolidates AWS account, deployment strategy, monitoring thresholds, and resource defaults into a single configuration per environment.

See

DEPLOYMENT.md for detailed information about deployment strategies

Functions

getAlarmConfig()

> getAlarmConfig(sdlcCore): AlarmConfig

Defined in: modules/sdlc-aws-cdk-lib/src-types/defaults/index.ts:152

Parameters

sdlcCore

SdlcCore

Returns

AlarmConfig

Deprecated

Use getSdlcCoreConfig(sdlcCore).alarm instead


getDeploymentStrategy()

> getDeploymentStrategy(sdlc): SdlcConfig

Defined in: modules/sdlc-aws-cdk-lib/src-types/defaults/index.ts:145

Parameters

sdlc

Sdlc

Returns

SdlcConfig

Deprecated

Use getSdlcConfig(sdlc).deploymentConfig instead


getLambdaDefaults()

> getLambdaDefaults(sdlcCore): LambdaDefaults

Defined in: modules/sdlc-aws-cdk-lib/src-types/defaults/index.ts:159

Parameters

sdlcCore

SdlcCore

Returns

LambdaDefaults

Deprecated

Use getSdlcCoreConfig(sdlcCore).lambda instead


getLambdaDeploymentConfig()

> getLambdaDeploymentConfig(config): ILambdaDeploymentConfig

Defined in: modules/sdlc-aws-cdk-lib/src-types/defaults/index.ts:174

Map generic release strategy to Lambda-specific deployment configuration.

This allows other resource types (ECS, EC2) to have their own mapping from the generic RELEASE_STRATEGY to their specific deployment configs.

Parameters

config

SdlcConfig

The SDLC configuration

Returns

ILambdaDeploymentConfig

The Lambda deployment configuration


getSdlcConfig()

> getSdlcConfig(sdlc): SdlcConfig

Defined in: modules/sdlc-aws-cdk-lib/src-types/defaults/index.ts:123

Get complete SDLC configuration for a specific environment.

Maps full SDLC environments (dev, test, qa, staging, preprod, prod) to their corresponding SDLC_CORE environment (dev, staging, prod) and returns the complete configuration.

Parameters

sdlc

Sdlc

The SDLC environment

Returns

SdlcConfig

The complete SDLC configuration for the corresponding SDLC_CORE


getSdlcCoreConfig()

> getSdlcCoreConfig(sdlcCore): SdlcConfig

Defined in: modules/sdlc-aws-cdk-lib/src-types/defaults/index.ts:134

Get SDLC configuration for a specific SDLC_CORE environment.

Parameters

sdlcCore

SdlcCore

The SDLC core environment (dev, staging, prod)

Returns

SdlcConfig

The complete SDLC configuration