Skip to content

Latest commit

 

History

History
1892 lines (1139 loc) · 64 KB

API.md

File metadata and controls

1892 lines (1139 loc) · 64 KB
Raw

API Reference

Constructs

ExpressStack

A CDK Express Pipeline Stack that belongs to an ExpressStage.

Initializers 

import { ExpressStack } from 'cdk-express-pipeline'

new ExpressStack(scope: Construct, id: string, stage: ExpressStage, stackProps?: StackProps)
Name Type Description
scope constructs.Construct The parent of this stack, usually an App but could be any construct.
id string The stack identifier which will be used to construct the final id as a combination of the wave, stage and stack id.
stage ExpressStage The stage that the stack belongs to.
stackProps aws-cdk-lib.StackProps Stack properties.
scopeRequired
  • Type: constructs.Construct

The parent of this stack, usually an App but could be any construct.

idRequired
  • Type: string

The stack identifier which will be used to construct the final id as a combination of the wave, stage and stack id.

stageRequired

The stage that the stack belongs to.

stackPropsOptional
  • Type: aws-cdk-lib.StackProps

Stack properties.

Methods

Name Description
toString Returns a string representation of this construct.
addDependency Add a dependency between this stack and another stack.
addMetadata Adds an arbitary key-value pair, with information you want to record about the stack.
addTransform Add a Transform to this stack. A Transform is a macro that AWS CloudFormation uses to process your template.
exportStringListValue Create a CloudFormation Export for a string list value.
exportValue Create a CloudFormation Export for a string value.
formatArn Creates an ARN from components.
getLogicalId Allocates a stack-unique CloudFormation-compatible logical identity for a specific resource.
regionalFact Look up a fact value for the given fact for the region of this stack.
renameLogicalId Rename a generated logical identities.
reportMissingContextKey Indicate that a context key was expected.
resolve Resolve a tokenized value in the context of the current stack.
splitArn Splits the provided ARN into its components.
toJsonString Convert an object, potentially containing tokens, to a JSON string.
toYamlString Convert an object, potentially containing tokens, to a YAML string.
addExpressDependency Add a dependency between this stack and another ExpressStack.
expressDependencies The ExpressStack dependencies of the stack.
toString 
public toString(): string

Returns a string representation of this construct.

addDependency 
public addDependency(target: Stack, reason?: string): void

Add a dependency between this stack and another stack.

This can be used to define dependencies between any two stacks within an app, and also supports nested stacks.

targetRequired
  • Type: aws-cdk-lib.Stack
reasonOptional
  • Type: string
addMetadata 
public addMetadata(key: string, value: any): void

Adds an arbitary key-value pair, with information you want to record about the stack.

These get translated to the Metadata section of the generated template.

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

keyRequired
  • Type: string
valueRequired
  • Type: any
addTransform 
public addTransform(transform: string): void

Add a Transform to this stack. A Transform is a macro that AWS CloudFormation uses to process your template.

Duplicate values are removed when stack is synthesized.

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html

Example

declare const stack: Stack;

stack.addTransform('AWS::Serverless-2016-10-31')
transformRequired
  • Type: string

The transform to add.

exportStringListValue 
public exportStringListValue(exportedValue: any, options?: ExportValueOptions): string[]

Create a CloudFormation Export for a string list value.

Returns a string list representing the corresponding Fn.importValue() expression for this Export. The export expression is automatically wrapped with an Fn::Join and the import value with an Fn::Split, since CloudFormation can only export strings. You can control the name for the export by passing the name option.

If you don't supply a value for name, the value you're exporting must be a Resource attribute (for example: bucket.bucketName) and it will be given the same name as the automatic cross-stack reference that would be created if you used the attribute in another Stack.

One of the uses for this method is to remove the relationship between two Stacks established by automatic cross-stack references. It will temporarily ensure that the CloudFormation Export still exists while you remove the reference from the consuming stack. After that, you can remove the resource and the manual export.

See exportValue for an example of this process.

exportedValueRequired
  • Type: any
optionsOptional
  • Type: aws-cdk-lib.ExportValueOptions
exportValue 
public exportValue(exportedValue: any, options?: ExportValueOptions): string

Create a CloudFormation Export for a string value.

Returns a string representing the corresponding Fn.importValue() expression for this Export. You can control the name for the export by passing the name option.

If you don't supply a value for name, the value you're exporting must be a Resource attribute (for example: bucket.bucketName) and it will be given the same name as the automatic cross-stack reference that would be created if you used the attribute in another Stack.

One of the uses for this method is to remove the relationship between two Stacks established by automatic cross-stack references. It will temporarily ensure that the CloudFormation Export still exists while you remove the reference from the consuming stack. After that, you can remove the resource and the manual export.

Example

Here is how the process works. Let's say there are two stacks, producerStack and consumerStack, and producerStack has a bucket called bucket, which is referenced by consumerStack (perhaps because an AWS Lambda Function writes into it, or something like that).

It is not safe to remove producerStack.bucket because as the bucket is being deleted, consumerStack might still be using it.

Instead, the process takes two deployments:

Deployment 1: break the relationship

  • Make sure consumerStack no longer references bucket.bucketName (maybe the consumer stack now uses its own bucket, or it writes to an AWS DynamoDB table, or maybe you just remove the Lambda Function altogether).
  • In the ProducerStack class, call this.exportValue(this.bucket.bucketName). This will make sure the CloudFormation Export continues to exist while the relationship between the two stacks is being broken.
  • Deploy (this will effectively only change the consumerStack, but it's safe to deploy both).

Deployment 2: remove the bucket resource

  • You are now free to remove the bucket resource from producerStack.
  • Don't forget to remove the exportValue() call as well.
  • Deploy again (this time only the producerStack will be changed -- the bucket will be deleted).
exportedValueRequired
  • Type: any
optionsOptional
  • Type: aws-cdk-lib.ExportValueOptions
formatArn 
public formatArn(components: ArnComponents): string

Creates an ARN from components.

If partition, region or account are not specified, the stack's partition, region and account will be used.

If any component is the empty string, an empty string will be inserted into the generated ARN at the location that component corresponds to.

The ARN will be formatted as follows:

arn:{partition}:{service}:{region}:{account}:{resource}{sep}{resource-name}

The required ARN pieces that are omitted will be taken from the stack that the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope can be 'undefined'.

componentsRequired
  • Type: aws-cdk-lib.ArnComponents
getLogicalId 
public getLogicalId(element: CfnElement): string

Allocates a stack-unique CloudFormation-compatible logical identity for a specific resource.

This method is called when a CfnElement is created and used to render the initial logical identity of resources. Logical ID renames are applied at this stage.

This method uses the protected method allocateLogicalId to render the logical ID for an element. To modify the naming scheme, extend the Stack class and override this method.

elementRequired
  • Type: aws-cdk-lib.CfnElement

The CloudFormation element for which a logical identity is needed.

regionalFact 
public regionalFact(factName: string, defaultValue?: string): string

Look up a fact value for the given fact for the region of this stack.

Will return a definite value only if the region of the current stack is resolved. If not, a lookup map will be added to the stack and the lookup will be done at CDK deployment time.

What regions will be included in the lookup map is controlled by the @aws-cdk/core:target-partitions context value: it must be set to a list of partitions, and only regions from the given partitions will be included. If no such context key is set, all regions will be included.

This function is intended to be used by construct library authors. Application builders can rely on the abstractions offered by construct libraries and do not have to worry about regional facts.

If defaultValue is not given, it is an error if the fact is unknown for the given region.

factNameRequired
  • Type: string
defaultValueOptional
  • Type: string
renameLogicalId 
public renameLogicalId(oldId: string, newId: string): void

Rename a generated logical identities.

To modify the naming scheme strategy, extend the Stack class and override the allocateLogicalId method.

oldIdRequired
  • Type: string
newIdRequired
  • Type: string
reportMissingContextKey 
public reportMissingContextKey(report: MissingContext): void

Indicate that a context key was expected.

Contains instructions which will be emitted into the cloud assembly on how the key should be supplied.

reportRequired
  • Type: aws-cdk-lib.cloud_assembly_schema.MissingContext

The set of parameters needed to obtain the context.

resolve 
public resolve(obj: any): any

Resolve a tokenized value in the context of the current stack.

objRequired
  • Type: any
splitArn 
public splitArn(arn: string, arnFormat: ArnFormat): ArnComponents

Splits the provided ARN into its components.

Works both if 'arn' is a string like 'arn:aws:s3:::bucket', and a Token representing a dynamic CloudFormation expression (in which case the returned components will also be dynamic CloudFormation expressions, encoded as Tokens).

arnRequired
  • Type: string

the ARN to split into its components.

arnFormatRequired
  • Type: aws-cdk-lib.ArnFormat

the expected format of 'arn' - depends on what format the service 'arn' represents uses.

toJsonString 
public toJsonString(obj: any, space?: number): string

Convert an object, potentially containing tokens, to a JSON string.

objRequired
  • Type: any
spaceOptional
  • Type: number
toYamlString 
public toYamlString(obj: any): string

Convert an object, potentially containing tokens, to a YAML string.

objRequired
  • Type: any
addExpressDependency 
public addExpressDependency(target: ExpressStack, reason?: string): void

Add a dependency between this stack and another ExpressStack.

This can be used to define dependencies between any two stacks within an

targetRequired
reasonOptional
  • Type: string
expressDependencies 
public expressDependencies(): ExpressStack[]

The ExpressStack dependencies of the stack.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isStack Return whether the given object is a Stack.
of Looks up the first stack scope in which construct is defined.
isConstruct 
import { ExpressStack } from 'cdk-express-pipeline'

ExpressStack.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.

isStack 
import { ExpressStack } from 'cdk-express-pipeline'

ExpressStack.isStack(x: any)

Return whether the given object is a Stack.

We do attribute detection since we can't reliably use 'instanceof'.

xRequired
  • Type: any
of 
import { ExpressStack } from 'cdk-express-pipeline'

ExpressStack.of(construct: IConstruct)

Looks up the first stack scope in which construct is defined.

Fails if there is no stack up the tree.

constructRequired
  • Type: constructs.IConstruct

The construct to start the search from.

Properties

Name Type Description
node constructs.Node The tree node.
account string The AWS account into which this stack will be deployed.
artifactId string The ID of the cloud assembly artifact for this stack.
availabilityZones string[] Returns the list of AZs that are available in the AWS environment (account/region) associated with this stack.
bundlingRequired boolean Indicates whether the stack requires bundling or not.
dependencies aws-cdk-lib.Stack[] Return the stacks this stack depends on.
environment string The environment coordinates in which this stack is deployed.
nested boolean Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.
notificationArns string[] Returns the list of notification Amazon Resource Names (ARNs) for the current stack.
partition string The partition in which this stack is defined.
region string The AWS region into which this stack will be deployed (e.g. us-west-2).
stackId string The ID of the stack.
stackName string The concrete CloudFormation physical stack name.
synthesizer aws-cdk-lib.IStackSynthesizer Synthesis method for this stack.
tags aws-cdk-lib.TagManager Tags to be applied to the stack.
templateFile string The name of the CloudFormation template file emitted to the output directory during synthesis.
templateOptions aws-cdk-lib.ITemplateOptions Options for CloudFormation template (like version, transform, description).
urlSuffix string The Amazon domain suffix for the region in which this stack is defined.
nestedStackParent aws-cdk-lib.Stack If this is a nested stack, returns it's parent stack.
nestedStackResource aws-cdk-lib.CfnResource If this is a nested stack, this represents its AWS::CloudFormation::Stack resource.
terminationProtection boolean Whether termination protection is enabled for this stack.
id string The stack identifier which is a combination of the wave, stage and stack id.
stage ExpressStage The stage that the stack belongs to.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

accountRequired 
public readonly account: string;
  • Type: string

The AWS account into which this stack will be deployed.

This value is resolved according to the following rules:

  1. The value provided to env.account when the stack is defined. This can either be a concrete account (e.g. 585695031111) or the Aws.ACCOUNT_ID token.
  2. Aws.ACCOUNT_ID, which represents the CloudFormation intrinsic reference { "Ref": "AWS::AccountId" } encoded as a string token.

Preferably, you should use the return value as an opaque string and not attempt to parse it to implement your logic. If you do, you must first check that it is a concrete value an not an unresolved token. If this value is an unresolved token (Token.isUnresolved(stack.account) returns true), this implies that the user wishes that this stack will synthesize into a account-agnostic template. In this case, your code should either fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or implement some other region-agnostic behavior.

artifactIdRequired 
public readonly artifactId: string;
  • Type: string

The ID of the cloud assembly artifact for this stack.

availabilityZonesRequired 
public readonly availabilityZones: string[];
  • Type: string[]

Returns the list of AZs that are available in the AWS environment (account/region) associated with this stack.

If the stack is environment-agnostic (either account and/or region are tokens), this property will return an array with 2 tokens that will resolve at deploy-time to the first two availability zones returned from CloudFormation's Fn::GetAZs intrinsic function.

If they are not available in the context, returns a set of dummy values and reports them as missing, and let the CLI resolve them by calling EC2 DescribeAvailabilityZones on the target environment.

To specify a different strategy for selecting availability zones override this method.

bundlingRequiredRequired 
public readonly bundlingRequired: boolean;
  • Type: boolean

Indicates whether the stack requires bundling or not.

dependenciesRequired
  • Deprecated: Use expressDependencies() instead of dependencies to get the dependencies of an ExpressStack.
public readonly dependencies: Stack[];
  • Type: aws-cdk-lib.Stack[]

Return the stacks this stack depends on.

environmentRequired 
public readonly environment: string;
  • Type: string

The environment coordinates in which this stack is deployed.

In the form aws://account/region. Use stack.account and stack.region to obtain the specific values, no need to parse.

You can use this value to determine if two stacks are targeting the same environment.

If either stack.account or stack.region are not concrete values (e.g. Aws.ACCOUNT_ID or Aws.REGION) the special strings unknown-account and/or unknown-region will be used respectively to indicate this stack is region/account-agnostic.

nestedRequired 
public readonly nested: boolean;
  • Type: boolean

Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

notificationArnsRequired 
public readonly notificationArns: string[];
  • Type: string[]

Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

partitionRequired 
public readonly partition: string;
  • Type: string

The partition in which this stack is defined.

regionRequired 
public readonly region: string;
  • Type: string

The AWS region into which this stack will be deployed (e.g. us-west-2).

This value is resolved according to the following rules:

  1. The value provided to env.region when the stack is defined. This can either be a concrete region (e.g. us-west-2) or the Aws.REGION token.
  2. Aws.REGION, which is represents the CloudFormation intrinsic reference { "Ref": "AWS::Region" } encoded as a string token.

Preferably, you should use the return value as an opaque string and not attempt to parse it to implement your logic. If you do, you must first check that it is a concrete value an not an unresolved token. If this value is an unresolved token (Token.isUnresolved(stack.region) returns true), this implies that the user wishes that this stack will synthesize into a region-agnostic template. In this case, your code should either fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or implement some other region-agnostic behavior.

stackIdRequired 
public readonly stackId: string;
  • Type: string

The ID of the stack.

Example

// After resolving, looks like
'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
stackNameRequired 
public readonly stackName: string;
  • Type: string

The concrete CloudFormation physical stack name.

This is either the name defined explicitly in the stackName prop or allocated based on the stack's location in the construct tree. Stacks that are directly defined under the app use their construct id as their stack name. Stacks that are defined deeper within the tree will use a hashed naming scheme based on the construct path to ensure uniqueness.

If you wish to obtain the deploy-time AWS::StackName intrinsic, you can use Aws.STACK_NAME directly.

synthesizerRequired 
public readonly synthesizer: IStackSynthesizer;
  • Type: aws-cdk-lib.IStackSynthesizer

Synthesis method for this stack.

tagsRequired 
public readonly tags: TagManager;
  • Type: aws-cdk-lib.TagManager

Tags to be applied to the stack.

templateFileRequired 
public readonly templateFile: string;
  • Type: string

The name of the CloudFormation template file emitted to the output directory during synthesis.

Example value: MyStack.template.json

templateOptionsRequired 
public readonly templateOptions: ITemplateOptions;
  • Type: aws-cdk-lib.ITemplateOptions

Options for CloudFormation template (like version, transform, description).

urlSuffixRequired 
public readonly urlSuffix: string;
  • Type: string

The Amazon domain suffix for the region in which this stack is defined.

nestedStackParentOptional 
public readonly nestedStackParent: Stack;
  • Type: aws-cdk-lib.Stack

If this is a nested stack, returns it's parent stack.

nestedStackResourceOptional 
public readonly nestedStackResource: CfnResource;
  • Type: aws-cdk-lib.CfnResource

If this is a nested stack, this represents its AWS::CloudFormation::Stack resource.

undefined for top-level (non-nested) stacks.

terminationProtectionRequired 
public readonly terminationProtection: boolean;
  • Type: boolean

Whether termination protection is enabled for this stack.

idRequired 
public readonly id: string;
  • Type: string

The stack identifier which is a combination of the wave, stage and stack id.

stageRequired 
public readonly stage: ExpressStage;

The stage that the stack belongs to.

Structs

CdkExpressPipelineProps

Initializer 

import { CdkExpressPipelineProps } from 'cdk-express-pipeline'

const cdkExpressPipelineProps: CdkExpressPipelineProps = { ... }

Properties

Name Type Description
separator string Separator between the wave, stage and stack ids that are concatenated to form the stack id.
waves ExpressWave[] The waves in the pipeline.
separatorOptional 
public readonly separator: string;
  • Type: string
  • Default: __

Separator between the wave, stage and stack ids that are concatenated to form the stack id.

wavesOptional 
public readonly waves: ExpressWave[];

The waves in the pipeline.

ExpressWaveProps

Initializer 

import { ExpressWaveProps } from 'cdk-express-pipeline'

const expressWaveProps: ExpressWaveProps = { ... }

Properties

Name Type Description
id string No description.
separator string Separator between the wave, stage and stack ids that are concatenated to form the stack id.
idRequired 
public readonly id: string;
  • Type: string
separatorOptional 
public readonly separator: string;
  • Type: string
  • Default: _

Separator between the wave, stage and stack ids that are concatenated to form the stack id.

Classes

CdkExpressPipeline

A CDK Express Pipeline that defines the order in which the stacks are deployed.

Initializers 

import { CdkExpressPipeline } from 'cdk-express-pipeline'

new CdkExpressPipeline(props?: CdkExpressPipelineProps)
Name Type Description
props CdkExpressPipelineProps No description.
propsOptional

Methods

Name Description
addWave Add a wave to the pipeline.
synth Synthesize the pipeline which creates the dependencies between the stacks in the correct order.
addWave 
public addWave(id: string): ExpressWave

Add a wave to the pipeline.

idRequired
  • Type: string

The wave identifier.

synth 
public synth(waves?: ExpressWave[], print?: boolean): void

Synthesize the pipeline which creates the dependencies between the stacks in the correct order.

wavesOptional

The waves to synthesize.

printOptional
  • Type: boolean

Whether to print the order of deployment to the console.

Properties

Name Type Description
waves ExpressWave[] No description.
wavesRequired 
public readonly waves: ExpressWave[];

CdkExpressPipelineLegacy

A CDK Express Pipeline that defines the order in which the stacks are deployed.

This is the legacy version of the pipeline that uses the Stack class, for plug and play compatibility with existing CDK projects that can not use the ExpressStack class. For new projects, use the CdkExpressPipeline class.

Initializers 

import { CdkExpressPipelineLegacy } from 'cdk-express-pipeline'

new CdkExpressPipelineLegacy(waves?: IExpressWaveLegacy[])
Name Type Description
waves IExpressWaveLegacy[] No description.
wavesOptional

Methods

Name Description
addWave Add a wave to the pipeline.
synth Synthesize the pipeline which creates the dependencies between the stacks in the correct order.
addWave 
public addWave(id: string): ExpressWaveLegacy

Add a wave to the pipeline.

idRequired
  • Type: string

The wave identifier.

synth 
public synth(waves?: IExpressWaveLegacy[], print?: boolean): void

Synthesize the pipeline which creates the dependencies between the stacks in the correct order.

wavesOptional

The waves to synthesize.

printOptional
  • Type: boolean

Whether to print the order of deployment to the console.

Properties

Name Type Description
waves IExpressWaveLegacy[] No description.
wavesRequired 
public readonly waves: IExpressWaveLegacy[];

ExpressStage

A CDK Express Pipeline Stage that belongs to an ExpressWave.

Initializers 

import { ExpressStage } from 'cdk-express-pipeline'

new ExpressStage(id: string, wave: ExpressWave, stacks?: ExpressStack[])
Name Type Description
id string The stage identifier.
wave ExpressWave The wave that the stage belongs to.
stacks ExpressStack[] The ExpressStacks in the stage.
idRequired
  • Type: string

The stage identifier.

waveRequired

The wave that the stage belongs to.

stacksOptional

The ExpressStacks in the stage.

Properties

Name Type Description
id string The stage identifier.
stacks ExpressStack[] The stacks in the stage.
wave ExpressWave The wave that the stage belongs to.
idRequired 
public readonly id: string;
  • Type: string

The stage identifier.

stacksRequired 
public readonly stacks: ExpressStack[];

The stacks in the stage.

waveRequired 
public readonly wave: ExpressWave;

The wave that the stage belongs to.

ExpressStageLegacy

A stage that holds stacks.

Initializers 

import { ExpressStageLegacy } from 'cdk-express-pipeline'

new ExpressStageLegacy(id: string, stacks?: Stack[])
Name Type Description
id string No description.
stacks aws-cdk-lib.Stack[] No description.
idRequired
  • Type: string
stacksOptional
  • Type: aws-cdk-lib.Stack[]

Methods

Name Description
addStack Add a stack to the stage.
addStack 
public addStack(stack: Stack): Stack

Add a stack to the stage.

stackRequired
  • Type: aws-cdk-lib.Stack

The stack to add.

Properties

Name Type Description
id string No description.
stacks aws-cdk-lib.Stack[] No description.
idRequired 
public readonly id: string;
  • Type: string
stacksRequired 
public readonly stacks: Stack[];
  • Type: aws-cdk-lib.Stack[]

ExpressWave

A CDK Express Pipeline Wave that contains ExpressStages.

Initializers 

import { ExpressWave } from 'cdk-express-pipeline'

new ExpressWave(id: string, separator?: string)
Name Type Description
id string The wave identifier.
separator string Separator between the wave, stage and stack ids that are concatenated to form the stack id.
idRequired
  • Type: string

The wave identifier.

separatorOptional
  • Type: string

Separator between the wave, stage and stack ids that are concatenated to form the stack id.

Default: '_'.

Methods

Name Description
addStage Add an ExpressStage to the wave.
addStage 
public addStage(id: string): ExpressStage

Add an ExpressStage to the wave.

idRequired
  • Type: string

Properties

Name Type Description
id string The wave identifier.
separator string Separator between the wave, stage and stack ids that are concatenated to form the final stack id.
stages ExpressStage[] The ExpressStages in the wave.
idRequired 
public readonly id: string;
  • Type: string

The wave identifier.

separatorRequired 
public readonly separator: string;
  • Type: string

Separator between the wave, stage and stack ids that are concatenated to form the final stack id.

stagesRequired 
public readonly stages: ExpressStage[];

The ExpressStages in the wave.

ExpressWaveLegacy

A wave that holds stages.

Initializers 

import { ExpressWaveLegacy } from 'cdk-express-pipeline'

new ExpressWaveLegacy(id: string, stages?: IExpressStageLegacy[])
Name Type Description
id string No description.
stages IExpressStageLegacy[] No description.
idRequired
  • Type: string
stagesOptional

Methods

Name Description
addStage Add a stage to the wave.
addStage 
public addStage(id: string): ExpressStageLegacy

Add a stage to the wave.

idRequired
  • Type: string

The stage identifier.

Properties

Name Type Description
id string No description.
stages IExpressStageLegacy[] No description.
idRequired 
public readonly id: string;
  • Type: string
stagesRequired 
public readonly stages: IExpressStageLegacy[];

Protocols

IExpressStack

Methods

Name Description
addExpressDependency Add a dependency between this stack and another ExpressStack.
expressDependencies The ExpressStack dependencies of the stack.
addExpressDependency 
public addExpressDependency(target: ExpressStack, reason?: string): void

Add a dependency between this stack and another ExpressStack.

This can be used to define dependencies between any two stacks within an

targetRequired

The ExpressStack to depend on.

reasonOptional
  • Type: string

The reason for the dependency.

expressDependencies 
public expressDependencies(): ExpressStack[]

The ExpressStack dependencies of the stack.

Properties

Name Type Description
id string The stack identifier which is a combination of the wave, stage and stack id.
stage ExpressStage The stage that the stack belongs to.
idRequired 
public readonly id: string;
  • Type: string

The stack identifier which is a combination of the wave, stage and stack id.

stageRequired 
public readonly stage: ExpressStage;

The stage that the stack belongs to.

IExpressStage

Properties

Name Type Description
id string The stage identifier.
stacks ExpressStack[] The stacks in the stage.
wave ExpressWave The wave that the stage belongs to.
idRequired 
public readonly id: string;
  • Type: string

The stage identifier.

stacksRequired 
public readonly stacks: ExpressStack[];

The stacks in the stage.

waveRequired 
public readonly wave: ExpressWave;

The wave that the stage belongs to.

IExpressStageLegacy

Properties

Name Type Description
id string No description.
stacks aws-cdk-lib.Stack[] No description.
idRequired 
public readonly id: string;
  • Type: string
stacksRequired 
public readonly stacks: Stack[];
  • Type: aws-cdk-lib.Stack[]

IExpressWave

Methods

Name Description
addStage Add an ExpressStage to the wave.
addStage 
public addStage(id: string): ExpressStage

Add an ExpressStage to the wave.

idRequired
  • Type: string

The ExpressStage identifier.

Properties

Name Type Description
id string The wave identifier.
separator string Separator between the wave, stage and stack ids that are concatenated to form the final stack id.
stages ExpressStage[] The ExpressStages in the wave.
idRequired 
public readonly id: string;
  • Type: string

The wave identifier.

separatorRequired 
public readonly separator: string;
  • Type: string

Separator between the wave, stage and stack ids that are concatenated to form the final stack id.

stagesRequired 
public readonly stages: ExpressStage[];

The ExpressStages in the wave.

IExpressWaveLegacy

Properties

Name Type Description
id string No description.
stages IExpressStageLegacy[] No description.
idRequired 
public readonly id: string;
  • Type: string
stagesRequired 
public readonly stages: IExpressStageLegacy[];