API Reference

Constructs

VersionOutputs

Construct for creating version outputs in CloudFormation and SSM Parameter Store.

Initializers

import { VersionOutputs } from 'cdk-devops'

new VersionOutputs(scope: Construct, id: string, props: VersionOutputsProps)

Name	Type	Description
`scope`	`constructs.Construct`	No description.
`id`	`string`	No description.
`props`	`VersionOutputsProps`	No description.

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: string

`props`^Required

Type: VersionOutputsProps

Methods

Name	Description
`toString`	Returns a string representation of this construct.

`toString`

public toString(): string

Returns a string representation of this construct.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.

`isConstruct`

import { VersionOutputs } from 'cdk-devops'

VersionOutputs.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

`x`^Required

Type: any

Any object.

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`versionInfo`	`VersionInfo`	The version information.
`outputs`	`{[ key: string ]: aws-cdk-lib.CfnOutput}`	CloudFormation outputs (if enabled).
`parameters`	`{[ key: string ]: aws-cdk-lib.aws_ssm.StringParameter}`	SSM Parameters (if enabled).

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`versionInfo`^Required

public readonly versionInfo: VersionInfo;

Type: VersionInfo

The version information.

`outputs`^Optional

public readonly outputs: {[ key: string ]: CfnOutput};

Type: {[ key: string ]: aws-cdk-lib.CfnOutput}

CloudFormation outputs (if enabled).

`parameters`^Optional

public readonly parameters: {[ key: string ]: StringParameter};

Type: {[ key: string ]: aws-cdk-lib.aws_ssm.StringParameter}

SSM Parameters (if enabled).

Structs

BuildNumberConfig

Build number configuration.

Initializer

import { BuildNumberConfig } from 'cdk-devops'

const buildNumberConfig: BuildNumberConfig = { ... }

Properties

Name	Type	Description
`envVar`	`string`	Environment variable to read build number from.

`envVar`^Optional

public readonly envVar: string;

Type: string
Default: 'BUILD_NUMBER'

Environment variable to read build number from.

CloudFormationOnlyOptions

Options for CloudFormation-only output configuration.

Initializer

import { CloudFormationOnlyOptions } from 'cdk-devops'

const cloudFormationOnlyOptions: CloudFormationOnlyOptions = { ... }

Properties

Name	Type	Description
`exportName`	`string`	Export name for cross-stack references.
`format`	`string`	Output format.
`stackOutputName`	`string`	Stack output name.

`exportName`^Optional

public readonly exportName: string;

Type: string

Export name for cross-stack references.

`format`^Optional

public readonly format: string;

Type: string
Default: 'plain'

Output format.

`stackOutputName`^Optional

public readonly stackOutputName: string;

Type: string

Stack output name.

CloudFormationOutputConfig

CloudFormation output configuration.

Initializer

import { CloudFormationOutputConfig } from 'cdk-devops'

const cloudFormationOutputConfig: CloudFormationOutputConfig = { ... }

Properties

Name	Type	Description
`enabled`	`boolean`	Whether to create CloudFormation outputs.
`export`	`boolean`	Whether to export the outputs for cross-stack references.
`exportNameTemplate`	`string`	Export name template (supports {version}, {environment}, etc.).

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean
Default: true

Whether to create CloudFormation outputs.

`export`^Optional

public readonly export: boolean;

Type: boolean
Default: false

Whether to export the outputs for cross-stack references.

`exportNameTemplate`^Optional

public readonly exportNameTemplate: string;

Type: string

Export name template (supports {version}, {environment}, etc.).

CommitCountConfig

Commit count configuration.

Initializer

import { CommitCountConfig } from 'cdk-devops'

const commitCountConfig: CommitCountConfig = { ... }

Properties

Name	Type	Description
`mode`	`string`	Commit counting mode - 'all': Count all commits - 'branch': Count commits on current branch - 'since-tag': Count commits since last tag.
`padding`	`number`	Padding for commit count (e.g., 5 means '00042').

`mode`^Optional

public readonly mode: string;

Type: string
Default: 'all'

Commit counting mode - 'all': Count all commits - 'branch': Count commits on current branch - 'since-tag': Count commits since last tag.

`padding`^Optional

public readonly padding: number;

Type: number
Default: 0

Padding for commit count (e.g., 5 means '00042').

ComputationContext

Context for version computation.

Initializer

import { ComputationContext } from 'cdk-devops'

const computationContext: ComputationContext = { ... }

Properties

Name	Type	Description
`environment`	`string`	Environment/stage name.
`gitInfo`	`GitInfo`	Git information.
`buildNumber`	`string`	Build number.
`deploymentTime`	`string`	Deployment timestamp.
`packageVersion`	`string`	Package version from package.json.
`pipelineVersion`	`string`	Pipeline version/execution ID.
`repositoryUrl`	`string`	Repository URL.

`environment`^Required

public readonly environment: string;

Type: string

Environment/stage name.

`gitInfo`^Required

public readonly gitInfo: GitInfo;

Type: GitInfo

Git information.

`buildNumber`^Optional

public readonly buildNumber: string;

Type: string

Build number.

`deploymentTime`^Optional

public readonly deploymentTime: string;

Type: string

Deployment timestamp.

`packageVersion`^Optional

public readonly packageVersion: string;

Type: string

Package version from package.json.

`pipelineVersion`^Optional

public readonly pipelineVersion: string;

Type: string

Pipeline version/execution ID.

`repositoryUrl`^Optional

public readonly repositoryUrl: string;

Type: string

Repository URL.

GitInfo

Git repository information.

Initializer

import { GitInfo } from 'cdk-devops'

const gitInfo: GitInfo = { ... }

Properties

Name	Type	Description
`branch`	`string`	Current branch name.
`commitCount`	`number`	Total commit count.
`commitHash`	`string`	Full commit hash.
`shortCommitHash`	`string`	Short commit hash (typically 8 characters).
`commitsSinceTag`	`number`	Commit count since last tag.
`tag`	`string`	Git tag (if on a tagged commit).

`branch`^Required

public readonly branch: string;

Type: string

Current branch name.

`commitCount`^Required

public readonly commitCount: number;

Type: number

Total commit count.

`commitHash`^Required

public readonly commitHash: string;

Type: string

Full commit hash.

`shortCommitHash`^Required

public readonly shortCommitHash: string;

Type: string

Short commit hash (typically 8 characters).

`commitsSinceTag`^Optional

public readonly commitsSinceTag: number;

Type: number

Commit count since last tag.

`tag`^Optional

public readonly tag: string;

Type: string

Git tag (if on a tagged commit).

GitInfoProps

Props for creating GitInfo.

Initializer

import { GitInfoProps } from 'cdk-devops'

const gitInfoProps: GitInfoProps = { ... }

Properties

Name	Type	Description
`branch`	`string`	Current branch name.
`commitCount`	`number`	Total commit count.
`commitHash`	`string`	Full commit hash.
`commitsSinceTag`	`number`	Commit count since last tag.
`tag`	`string`	Git tag (if on a tagged commit).

`branch`^Required

public readonly branch: string;

Type: string

Current branch name.

`commitCount`^Required

public readonly commitCount: number;

Type: number

Total commit count.

`commitHash`^Required

public readonly commitHash: string;

Type: string

Full commit hash.

`commitsSinceTag`^Optional

public readonly commitsSinceTag: number;

Type: number

Commit count since last tag.

`tag`^Optional

public readonly tag: string;

Type: string

Git tag (if on a tagged commit).

GitTagConfig

Git tag configuration for version extraction.

Initializer

import { GitTagConfig } from 'cdk-devops'

const gitTagConfig: GitTagConfig = { ... }

Properties

Name	Type	Description
`countCommitsSince`	`boolean`	Whether to count commits since the last tag.
`pattern`	`string`	Pattern to match git tags.
`prefix`	`string`	Prefix to strip from git tags (e.g., 'v' for tags like 'v1.2.3').

`countCommitsSince`^Optional

public readonly countCommitsSince: boolean;

Type: boolean
Default: true

Whether to count commits since the last tag.

`pattern`^Optional

public readonly pattern: string;

Type: string
Default: '..*'

Pattern to match git tags.

`prefix`^Optional

public readonly prefix: string;

Type: string
Default: 'v'

Prefix to strip from git tags (e.g., 'v' for tags like 'v1.2.3').

HierarchicalParametersOptions

Options for hierarchical parameter configuration.

Initializer

import { HierarchicalParametersOptions } from 'cdk-devops'

const hierarchicalParametersOptions: HierarchicalParametersOptions = { ... }

Properties

Name	Type	Description
`format`	`string`	Output format.
`includeCloudFormation`	`boolean`	Whether to include CloudFormation outputs.

`format`^Optional

public readonly format: string;

Type: string
Default: 'plain'

Output format.

`includeCloudFormation`^Optional

public readonly includeCloudFormation: boolean;

Type: boolean
Default: false

Whether to include CloudFormation outputs.

PackageJsonConfig

Package.json version configuration.

Initializer

import { PackageJsonConfig } from 'cdk-devops'

const packageJsonConfig: PackageJsonConfig = { ... }

Properties

Name	Type	Description
`includePrerelease`	`boolean`	Whether to include prerelease identifiers.

`includePrerelease`^Optional

public readonly includePrerelease: boolean;

Type: boolean
Default: true

Whether to include prerelease identifiers.

ParameterStoreOutputConfig

SSM Parameter Store output configuration.

Initializer

import { ParameterStoreOutputConfig } from 'cdk-devops'

const parameterStoreOutputConfig: ParameterStoreOutputConfig = { ... }

Properties

Name	Type	Description
`basePath`	`string`	Base path for parameters (e.g., '/myapp/version').
`description`	`string`	Description for the parameter.
`enabled`	`boolean`	Whether to create SSM parameters.
`splitParameters`	`boolean`	Whether to split version info into separate parameters.

`basePath`^Optional

public readonly basePath: string;

Type: string

Base path for parameters (e.g., '/myapp/version').

`description`^Optional

public readonly description: string;

Type: string

Description for the parameter.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean
Default: true

Whether to create SSM parameters.

`splitParameters`^Optional

public readonly splitParameters: boolean;

Type: boolean
Default: false

Whether to split version info into separate parameters.

StandardOutputOptions

Options for standard output configuration.

Initializer

import { StandardOutputOptions } from 'cdk-devops'

const standardOutputOptions: StandardOutputOptions = { ... }

Properties

Name	Type	Description
`format`	`string`	Output format.
`parameterName`	`string`	Parameter name template.

`format`^Optional

public readonly format: string;

Type: string
Default: 'plain'

Output format.

`parameterName`^Optional

public readonly parameterName: string;

Type: string
Default: '/{stackName}/version'

Parameter name template.

VersionInfoProps

Props for creating VersionInfo.

Initializer

import { VersionInfoProps } from 'cdk-devops'

const versionInfoProps: VersionInfoProps = { ... }

Properties

Name	Type	Description
`environment`	`string`	Environment/stage name.
`gitInfo`	`GitInfo`	Git information.
`version`	`string`	Computed version string.
`buildNumber`	`string`	Build number.
`deploymentTime`	`string`	Deployment timestamp.
`deploymentUser`	`string`	Deployment username.
`packageVersion`	`string`	Package version from package.json.
`pipelineVersion`	`string`	Pipeline version/execution ID.
`repositoryUrl`	`string`	Repository URL.

`environment`^Required

public readonly environment: string;

Type: string

Environment/stage name.

`gitInfo`^Required

public readonly gitInfo: GitInfo;

Type: GitInfo

Git information.

`version`^Required

public readonly version: string;

Type: string

Computed version string.

`buildNumber`^Optional

public readonly buildNumber: string;

Type: string

Build number.

`deploymentTime`^Optional

public readonly deploymentTime: string;

Type: string

Deployment timestamp.

`deploymentUser`^Optional

public readonly deploymentUser: string;

Type: string

Deployment username.

`packageVersion`^Optional

public readonly packageVersion: string;

Type: string

Package version from package.json.

`pipelineVersion`^Optional

public readonly pipelineVersion: string;

Type: string

Pipeline version/execution ID.

`repositoryUrl`^Optional

public readonly repositoryUrl: string;

Type: string

Repository URL.

VersioningConfig

Versioning configuration.

Initializer

import { VersioningConfig } from 'cdk-devops'

const versioningConfig: VersioningConfig = { ... }

Properties

Name	Type	Description
`outputs`	`VersioningOutputsConfig`	Output configuration.
`strategy`	`IVersioningStrategy`	Versioning strategy.
`enabled`	`boolean`	Whether versioning is enabled.
`stageOverrides`	`{[ key: string ]: VersioningConfig}`	Stage-specific configuration overrides.

`outputs`^Required

public readonly outputs: VersioningOutputsConfig;

Type: VersioningOutputsConfig

Output configuration.

`strategy`^Required

public readonly strategy: IVersioningStrategy;

Type: IVersioningStrategy

Versioning strategy.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean
Default: true

Whether versioning is enabled.

`stageOverrides`^Optional

public readonly stageOverrides: {[ key: string ]: VersioningConfig};

Type: {[ key: string ]: VersioningConfig}

Stage-specific configuration overrides.

VersioningOutputsConfig

Output configuration for version information.

Initializer

import { VersioningOutputsConfig } from 'cdk-devops'

const versioningOutputsConfig: VersioningOutputsConfig = { ... }

Properties

Name	Type	Description
`cloudFormation`	`CloudFormationOutputConfig`	CloudFormation output configuration.
`parameterStore`	`ParameterStoreOutputConfig`	SSM Parameter Store configuration.

`cloudFormation`^Optional

public readonly cloudFormation: CloudFormationOutputConfig;

Type: CloudFormationOutputConfig

CloudFormation output configuration.

`parameterStore`^Optional

public readonly parameterStore: ParameterStoreOutputConfig;

Type: ParameterStoreOutputConfig

SSM Parameter Store configuration.

VersioningStrategyComponents

Components that can be included in a versioning strategy.

Initializer

import { VersioningStrategyComponents } from 'cdk-devops'

const versioningStrategyComponents: VersioningStrategyComponents = { ... }

Properties

Name	Type	Description
`buildNumber`	`BuildNumberConfig`	Build number configuration.
`commitCount`	`CommitCountConfig`	Commit count configuration.
`gitTag`	`GitTagConfig`	Git tag configuration.
`packageJson`	`PackageJsonConfig`	Package.json version configuration.

`buildNumber`^Optional

public readonly buildNumber: BuildNumberConfig;

Type: BuildNumberConfig

Build number configuration.

`commitCount`^Optional

public readonly commitCount: CommitCountConfig;

Type: CommitCountConfig

Commit count configuration.

`gitTag`^Optional

public readonly gitTag: GitTagConfig;

Type: GitTagConfig

Git tag configuration.

`packageJson`^Optional

public readonly packageJson: PackageJsonConfig;

Type: PackageJsonConfig

Package.json version configuration.

VersionOutputsProps

Props for VersionOutputs construct.

Initializer

import { VersionOutputsProps } from 'cdk-devops'

const versionOutputsProps: VersionOutputsProps = { ... }

Properties

Name	Type	Description
`versionInfo`	`VersionInfo`	Version information to output.
`cloudFormation`	`CloudFormationOutputConfig`	CloudFormation output configuration.
`metadataKey`	`string`	Metadata key.
`outputPrefix`	`string`	Prefix for output names.
`parameterStore`	`ParameterStoreOutputConfig`	SSM Parameter Store configuration.

`versionInfo`^Required

public readonly versionInfo: VersionInfo;

Type: VersionInfo

Version information to output.

`cloudFormation`^Optional

public readonly cloudFormation: CloudFormationOutputConfig;

Type: CloudFormationOutputConfig
Default: CloudFormation outputs enabled

CloudFormation output configuration.

`metadataKey`^Optional

public readonly metadataKey: string;

Type: string
Default: 'Version'

Metadata key.

`outputPrefix`^Optional

public readonly outputPrefix: string;

Type: string
Default: 'Version'

Prefix for output names.

`parameterStore`^Optional

public readonly parameterStore: ParameterStoreOutputConfig;

Type: ParameterStoreOutputConfig
Default: Parameter Store disabled

SSM Parameter Store configuration.

Classes

CompositeComputation

Composite computation strategy that replaces template variables.

Initializers

import { CompositeComputation } from 'cdk-devops'

new CompositeComputation(strategy: IVersioningStrategy)

Name	Type	Description
`strategy`	`IVersioningStrategy`	No description.

`strategy`^Required

Type: IVersioningStrategy

Methods

Name	Description
`compute`	Compute version by replacing template variables in format string.

`compute`

public compute(context: ComputationContext): string

Compute version by replacing template variables in format string.

`context`^Required

Type: ComputationContext

GitInfoHelper

Helper class for working with Git information.

Initializers

import { GitInfoHelper } from 'cdk-devops'

new GitInfoHelper()

Name	Type	Description

Static Functions

Name	Description
`create`	Create GitInfo from individual components.
`fromEnvironment`	Create GitInfo from environment variables (CI/CD context).
`isMainBranch`	Check if on a main branch.
`isTaggedRelease`	Check if on a tagged release.
`shortenHash`	Shorten a git commit hash to 8 characters.

`create`

import { GitInfoHelper } from 'cdk-devops'

GitInfoHelper.create(props: GitInfoProps)

Create GitInfo from individual components.

`props`^Required

Type: GitInfoProps

`fromEnvironment`

import { GitInfoHelper } from 'cdk-devops'

GitInfoHelper.fromEnvironment()

Create GitInfo from environment variables (CI/CD context).

`isMainBranch`

import { GitInfoHelper } from 'cdk-devops'

GitInfoHelper.isMainBranch(branch: string)

Check if on a main branch.

`branch`^Required

Type: string

`isTaggedRelease`

import { GitInfoHelper } from 'cdk-devops'

GitInfoHelper.isTaggedRelease(gitInfo: GitInfo)

Check if on a tagged release.

`gitInfo`^Required

Type: GitInfo

`shortenHash`

import { GitInfoHelper } from 'cdk-devops'

GitInfoHelper.shortenHash(hash: string, length?: number)

Shorten a git commit hash to 8 characters.

`hash`^Required

Type: string

`length`^Optional

Type: number

VersionComputationStrategy

Abstract base class for version computation strategies.

Initializers

import { VersionComputationStrategy } from 'cdk-devops'

new VersionComputationStrategy()

Name	Type	Description

Methods

Name	Description
`compute`	Compute version string from context.

`compute`

public compute(context: ComputationContext): string

Compute version string from context.

`context`^Required

Type: ComputationContext

VersionComputer

Main version computer class.

Initializers

import { VersionComputer } from 'cdk-devops'

new VersionComputer(strategy: IVersioningStrategy)

Name	Type	Description
`strategy`	`IVersioningStrategy`	No description.

`strategy`^Required

Type: IVersioningStrategy

Methods

Name	Description
`compute`	Compute version from context.
`computeVersionString`	Compute version string only (without creating VersionInfo).

`compute`

public compute(context: ComputationContext): VersionInfo

Compute version from context.

`context`^Required

Type: ComputationContext

`computeVersionString`

public computeVersionString(context: ComputationContext): string

Compute version string only (without creating VersionInfo).

`context`^Required

Type: ComputationContext

VersionInfo

Implements: IVersionInfo

Version information for deployments.

Methods

Name	Description
`displayVersion`	Get display version (prefers tag if available).
`exportName`	Get export name from template.
`isMainBranch`	Check if deployed from main branch.
`isTaggedRelease`	Check if this is a tagged release.
`parameterName`	Get SSM parameter name from template.
`toJson`	Convert to JSON string.
`toObject`	Convert to plain object.

`displayVersion`

public displayVersion(): string

Get display version (prefers tag if available).

`exportName`

public exportName(template: string): string

Get export name from template.

`template`^Required

Type: string

`isMainBranch`

public isMainBranch(): boolean

Check if deployed from main branch.

`isTaggedRelease`

public isTaggedRelease(): boolean

Check if this is a tagged release.

`parameterName`

public parameterName(template: string): string

Get SSM parameter name from template.

`template`^Required

Type: string

`toJson`

public toJson(): string

Convert to JSON string.

`toObject`

public toObject(): IVersionInfo

Convert to plain object.

Static Functions

Name	Description
`compare`	Compare two version infos.
`create`	Create VersionInfo from props.
`fromEnvironment`	Create VersionInfo from environment variables.
`fromJson`	Create VersionInfo from JSON string.

`compare`

import { VersionInfo } from 'cdk-devops'

VersionInfo.compare(a: VersionInfo, b: VersionInfo)

Compare two version infos.

`a`^Required

Type: VersionInfo

`b`^Required

Type: VersionInfo

`create`

import { VersionInfo } from 'cdk-devops'

VersionInfo.create(props: VersionInfoProps)

Create VersionInfo from props.

`props`^Required

Type: VersionInfoProps

`fromEnvironment`

import { VersionInfo } from 'cdk-devops'

VersionInfo.fromEnvironment(version: string, environment: string)

Create VersionInfo from environment variables.

`version`^Required

Type: string

`environment`^Required

Type: string

`fromJson`

import { VersionInfo } from 'cdk-devops'

VersionInfo.fromJson(json: string)

Create VersionInfo from JSON string.

`json`^Required

Type: string

Properties

Name	Type	Description
`branch`	`string`	Git branch name.
`commitCount`	`number`	Total commit count.
`commitHash`	`string`	Git commit hash.
`deploymentTime`	`string`	Deployment timestamp.
`deploymentUser`	`string`	Deployment username.
`environment`	`string`	Environment/stage name.
`shortCommitHash`	`string`	Git commit hash (short form, typically 8 characters).
`version`	`string`	Computed version string.
`buildNumber`	`string`	Build number (if available).
`packageVersion`	`string`	Package version from package.json (if available).
`pipelineVersion`	`string`	Pipeline version/execution ID.
`repositoryUrl`	`string`	Repository URL.
`tag`	`string`	Git tag (if available).

`branch`^Required

public readonly branch: string;

Type: string

Git branch name.

`commitCount`^Required

public readonly commitCount: number;

Type: number

Total commit count.

`commitHash`^Required

public readonly commitHash: string;

Type: string

Git commit hash.

`deploymentTime`^Required

public readonly deploymentTime: string;

Type: string

Deployment timestamp.

`deploymentUser`^Required

public readonly deploymentUser: string;

Type: string

Deployment username.

`environment`^Required

public readonly environment: string;

Type: string

Environment/stage name.

`shortCommitHash`^Required

public readonly shortCommitHash: string;

Type: string

Git commit hash (short form, typically 8 characters).

`version`^Required

public readonly version: string;

Type: string

Computed version string.

`buildNumber`^Optional

public readonly buildNumber: string;

Type: string

Build number (if available).

`packageVersion`^Optional

public readonly packageVersion: string;

Type: string

Package version from package.json (if available).

`pipelineVersion`^Optional

public readonly pipelineVersion: string;

Type: string

Pipeline version/execution ID.

`repositoryUrl`^Optional

public readonly repositoryUrl: string;

Type: string

Repository URL.

`tag`^Optional

public readonly tag: string;

Type: string

Git tag (if available).

VersionInfoBuilder

Builder for VersionInfo.

Initializers

import { VersionInfoBuilder } from 'cdk-devops'

new VersionInfoBuilder()

Name	Type	Description

Methods

Name	Description
`buildVersionInfo`	Build the VersionInfo instance.
`withBuildNumber`	Set build number.
`withDeploymentTime`	Set deployment time.
`withDeploymentUser`	Set deployment username.
`withEnvironment`	Set environment.
`withGitInfo`	Set git information.
`withPackageVersion`	Set package version.
`withPipelineVersion`	Set pipeline version.
`withRepositoryUrl`	Set repository URL.
`withVersion`	Set version string.

`buildVersionInfo`

public buildVersionInfo(): VersionInfo

Build the VersionInfo instance.

`withBuildNumber`

public withBuildNumber(buildNumber?: string): VersionInfoBuilder

Set build number.

`buildNumber`^Optional

Type: string

`withDeploymentTime`

public withDeploymentTime(deploymentTime?: string): VersionInfoBuilder

Set deployment time.

`deploymentTime`^Optional

Type: string

`withDeploymentUser`

public withDeploymentUser(deploymentUser?: string): VersionInfoBuilder

Set deployment username.

`deploymentUser`^Optional

Type: string

`withEnvironment`

public withEnvironment(environment: string): VersionInfoBuilder

Set environment.

`environment`^Required

Type: string

`withGitInfo`

public withGitInfo(gitInfo: GitInfo): VersionInfoBuilder

Set git information.

`gitInfo`^Required

Type: GitInfo

`withPackageVersion`

public withPackageVersion(packageVersion?: string): VersionInfoBuilder

Set package version.

`packageVersion`^Optional

Type: string

`withPipelineVersion`

public withPipelineVersion(pipelineVersion?: string): VersionInfoBuilder

Set pipeline version.

`pipelineVersion`^Optional

Type: string

`withRepositoryUrl`

public withRepositoryUrl(repositoryUrl?: string): VersionInfoBuilder

Set repository URL.

`repositoryUrl`^Optional

Type: string

`withVersion`

public withVersion(version: string): VersionInfoBuilder

Set version string.

`version`^Required

Type: string

VersioningOutputsFactory

Factory class for creating versioning output configurations.

Initializers

import { VersioningOutputsFactory } from 'cdk-devops'

new VersioningOutputsFactory()

Name	Type	Description

Static Functions

Name	Description
`cloudFormationOnly`	CloudFormation-only output configuration.
`hierarchicalParameters`	Hierarchical Parameter Store configuration.
`minimal`	Minimal output configuration with only CloudFormation outputs.
`standard`	Standard output configuration with CloudFormation and Parameter Store.

`cloudFormationOnly`

import { VersioningOutputsFactory } from 'cdk-devops'

VersioningOutputsFactory.cloudFormationOnly(options?: CloudFormationOnlyOptions)

CloudFormation-only output configuration.

`options`^Optional

Type: CloudFormationOnlyOptions

`hierarchicalParameters`

import { VersioningOutputsFactory } from 'cdk-devops'

VersioningOutputsFactory.hierarchicalParameters(basePath: string, options?: HierarchicalParametersOptions)

Hierarchical Parameter Store configuration.

`basePath`^Required

Type: string

`options`^Optional

Type: HierarchicalParametersOptions

`minimal`

import { VersioningOutputsFactory } from 'cdk-devops'

VersioningOutputsFactory.minimal()

Minimal output configuration with only CloudFormation outputs.

`standard`

import { VersioningOutputsFactory } from 'cdk-devops'

VersioningOutputsFactory.standard(options?: StandardOutputOptions)

Standard output configuration with CloudFormation and Parameter Store.

`options`^Optional

Type: StandardOutputOptions

VersioningStrategy

Implements: IVersioningStrategy

Versioning strategy implementation.

Static Functions

Name	Description
`buildNumber`	Strategy using build number and commit information Format: build-{commit-count}-{commit-hash:8}.
`commitCount`	Strategy using commit count Format: 0.0.{commit-count}.
`commitHash`	Strategy using commit hash Format: {commit-hash:8}.
`create`	Create a custom versioning strategy.
`gitTag`	Strategy using git tags as version source Format: {git-tag} or {git-tag}-{commit-count} if not on a tag.
`gitTagWithDevVersions`	Strategy combining git tag with commit count for non-tagged commits Format: {git-tag} or {git-tag}-dev.{commit-count}.
`packageJson`	Strategy using package.json version Format: {package-version}.
`packageWithBranch`	Strategy combining package version with branch and commit info Format: {package-version}-{branch}.{commit-count}.
`semanticWithPatch`	Semantic versioning strategy with automatic patch increment Format: {package-version}.{commit-count}.

`buildNumber`

import { VersioningStrategy } from 'cdk-devops'

VersioningStrategy.buildNumber(config?: BuildNumberConfig)

Strategy using build number and commit information Format: build-{commit-count}-{commit-hash:8}.

`config`^Optional

Type: BuildNumberConfig

`commitCount`

import { VersioningStrategy } from 'cdk-devops'

VersioningStrategy.commitCount(config?: CommitCountConfig)

Strategy using commit count Format: 0.0.{commit-count}.

`config`^Optional

Type: CommitCountConfig

`commitHash`

import { VersioningStrategy } from 'cdk-devops'

VersioningStrategy.commitHash()

Strategy using commit hash Format: {commit-hash:8}.

`create`

import { VersioningStrategy } from 'cdk-devops'

VersioningStrategy.create(format: string, components?: VersioningStrategyComponents)

Create a custom versioning strategy.

`format`^Required

Type: string

`components`^Optional

Type: VersioningStrategyComponents

`gitTag`

import { VersioningStrategy } from 'cdk-devops'

VersioningStrategy.gitTag(config?: GitTagConfig)

Strategy using git tags as version source Format: {git-tag} or {git-tag}-{commit-count} if not on a tag.

`config`^Optional

Type: GitTagConfig

`gitTagWithDevVersions`

import { VersioningStrategy } from 'cdk-devops'

VersioningStrategy.gitTagWithDevVersions(config?: GitTagConfig)

Strategy combining git tag with commit count for non-tagged commits Format: {git-tag} or {git-tag}-dev.{commit-count}.

`config`^Optional

Type: GitTagConfig

`packageJson`

import { VersioningStrategy } from 'cdk-devops'

VersioningStrategy.packageJson(config?: PackageJsonConfig)

Strategy using package.json version Format: {package-version}.

`config`^Optional

Type: PackageJsonConfig

`packageWithBranch`

import { VersioningStrategy } from 'cdk-devops'

VersioningStrategy.packageWithBranch(config?: PackageJsonConfig)

Strategy combining package version with branch and commit info Format: {package-version}-{branch}.{commit-count}.

`config`^Optional

Type: PackageJsonConfig

`semanticWithPatch`

import { VersioningStrategy } from 'cdk-devops'

VersioningStrategy.semanticWithPatch(config?: PackageJsonConfig)

Semantic versioning strategy with automatic patch increment Format: {package-version}.{commit-count}.

`config`^Optional

Type: PackageJsonConfig

Properties

Name	Type	Description
`components`	`VersioningStrategyComponents`	Strategy components configuration.
`format`	`string`	Format string for version computation Supports placeholders: {git-tag}, {package-version}, {commit-count}, {commit-hash}, {branch}, {build-number}.

`components`^Required

public readonly components: VersioningStrategyComponents;

Type: VersioningStrategyComponents

Strategy components configuration.

`format`^Required

public readonly format: string;

Type: string

Format string for version computation Supports placeholders: {git-tag}, {package-version}, {commit-count}, {commit-hash}, {branch}, {build-number}.

Protocols

IVersionInfo

Implemented By: VersionInfo, IVersionInfo

Version information interface.

Properties

Name	Type	Description
`branch`	`string`	Git branch name.
`commitCount`	`number`	Total commit count.
`commitHash`	`string`	Git commit hash.
`deploymentTime`	`string`	Deployment timestamp.
`deploymentUser`	`string`	Deployment username.
`environment`	`string`	Environment/stage name.
`shortCommitHash`	`string`	Git commit hash (short form, typically 8 characters).
`version`	`string`	Computed version string.
`buildNumber`	`string`	Build number (if available).
`packageVersion`	`string`	Package version from package.json (if available).
`pipelineVersion`	`string`	Pipeline version/execution ID.
`repositoryUrl`	`string`	Repository URL.
`tag`	`string`	Git tag (if available).

`branch`^Required

public readonly branch: string;

Type: string

Git branch name.

`commitCount`^Required

public readonly commitCount: number;

Type: number

Total commit count.

`commitHash`^Required

public readonly commitHash: string;

Type: string

Git commit hash.

`deploymentTime`^Required

public readonly deploymentTime: string;

Type: string

Deployment timestamp.

`deploymentUser`^Required

public readonly deploymentUser: string;

Type: string

Deployment username.

`environment`^Required

public readonly environment: string;

Type: string

Environment/stage name.

`shortCommitHash`^Required

public readonly shortCommitHash: string;

Type: string

Git commit hash (short form, typically 8 characters).

`version`^Required

public readonly version: string;

Type: string

Computed version string.

`buildNumber`^Optional

public readonly buildNumber: string;

Type: string

Build number (if available).

`packageVersion`^Optional

public readonly packageVersion: string;

Type: string

Package version from package.json (if available).

`pipelineVersion`^Optional

public readonly pipelineVersion: string;

Type: string

Pipeline version/execution ID.

`repositoryUrl`^Optional

public readonly repositoryUrl: string;

Type: string

Repository URL.

`tag`^Optional

public readonly tag: string;

Type: string

Git tag (if available).

IVersioningStrategy

Implemented By: VersioningStrategy, IVersioningStrategy

Versioning strategy interface.

Properties

Name	Type	Description
`components`	`VersioningStrategyComponents`	Strategy components configuration.
`format`	`string`	Format string for version computation Supports placeholders: {git-tag}, {package-version}, {commit-count}, {commit-hash}, {branch}, {build-number}.

`components`^Required

public readonly components: VersioningStrategyComponents;

Type: VersioningStrategyComponents

Strategy components configuration.

`format`^Required

public readonly format: string;

Type: string

Format string for version computation Supports placeholders: {git-tag}, {package-version}, {commit-count}, {commit-hash}, {branch}, {build-number}.

FilesExpand file tree

API.md

Latest commit

History

API.md

File metadata and controls

API Reference

Constructs

VersionOutputs

Initializers

scopeRequired

idRequired

propsRequired

Methods

toString

Static Functions

isConstruct

xRequired

Properties

nodeRequired

versionInfoRequired

outputsOptional

parametersOptional

Structs

BuildNumberConfig

Initializer

Properties

envVarOptional

CloudFormationOnlyOptions

Initializer

Properties

exportNameOptional

formatOptional

stackOutputNameOptional

CloudFormationOutputConfig

Initializer

Properties

enabledOptional

exportOptional

exportNameTemplateOptional

CommitCountConfig

Initializer

Properties

modeOptional

paddingOptional

ComputationContext

Initializer

Properties

environmentRequired

gitInfoRequired

buildNumberOptional

deploymentTimeOptional

packageVersionOptional

pipelineVersionOptional

repositoryUrlOptional

GitInfo

Initializer

Properties

branchRequired

commitCountRequired

commitHashRequired

shortCommitHashRequired

commitsSinceTagOptional

tagOptional

GitInfoProps

Initializer

Properties

branchRequired

commitCountRequired

commitHashRequired

commitsSinceTagOptional

tagOptional

GitTagConfig

Initializer

Properties

countCommitsSinceOptional

patternOptional

prefixOptional

HierarchicalParametersOptions

Initializer

`scope`^Required

`id`^Required

`props`^Required

`toString`

`isConstruct`

`x`^Required

`node`^Required

`versionInfo`^Required

`outputs`^Optional

`parameters`^Optional

`envVar`^Optional

`exportName`^Optional

`format`^Optional

`stackOutputName`^Optional

`enabled`^Optional

`export`^Optional

`exportNameTemplate`^Optional

`mode`^Optional

`padding`^Optional

`environment`^Required

`gitInfo`^Required

`buildNumber`^Optional

`deploymentTime`^Optional

`packageVersion`^Optional

`pipelineVersion`^Optional

`repositoryUrl`^Optional

`branch`^Required

`commitCount`^Required

`commitHash`^Required

`shortCommitHash`^Required

`commitsSinceTag`^Optional

`tag`^Optional

`branch`^Required

`commitCount`^Required

`commitHash`^Required

`commitsSinceTag`^Optional

`tag`^Optional

`countCommitsSince`^Optional

`pattern`^Optional

`prefix`^Optional

`format`^Optional

`includeCloudFormation`^Optional

`includePrerelease`^Optional

`basePath`^Optional

`description`^Optional

`enabled`^Optional

`splitParameters`^Optional

`format`^Optional

`parameterName`^Optional

`environment`^Required

`gitInfo`^Required

`version`^Required

`buildNumber`^Optional

`deploymentTime`^Optional

`deploymentUser`^Optional

`packageVersion`^Optional

`pipelineVersion`^Optional

`repositoryUrl`^Optional

`outputs`^Required

`strategy`^Required

`enabled`^Optional

`stageOverrides`^Optional

`cloudFormation`^Optional

`parameterStore`^Optional

`buildNumber`^Optional

`commitCount`^Optional

`gitTag`^Optional

`packageJson`^Optional

`versionInfo`^Required

`cloudFormation`^Optional

`metadataKey`^Optional

`outputPrefix`^Optional

`parameterStore`^Optional

`strategy`^Required