Skip to content

Latest commit

 

History

History
64 lines (48 loc) · 2.75 KB

README.md

File metadata and controls

64 lines (48 loc) · 2.75 KB
Raw

TalisCdkStack

TalisCdkStackProps

Properties for any custom Talis CDK Stack, these are on top of the default CDK Stack props.

Property Type Required Description
vpcId string Optional ID of the VPC to deploy stack components into
deploymentEnvironment TalisDeploymentEnvironment Required The environment this stack is being deployed into
app string Required application name
release string Required release version in format -
env? Environment Optional The AWS environment (account/region) where this stack will be deployed

TalisCdkStack

A base stack on top of the default CDK Stack on which to build a custom Talis App CDK Stack, provides helper methods and variables for referencing commonly used components including environment based removal policies and vpc resolution.

const app = new cdk.App();
const props: TalisCdkStackProps = {
  deploymentEnvironment: TalisDeploymentEnvironment.TEST,
};
const stack = new TalisCdkStack(app, "my-stack", props);

// Get the removal policy for the stacks environment
// Returns a CDK Removal Policy
stack.getRemovalPolicyForTalisDeploymentEnvironment(
  props.deploymentEnvironment,
);

It also adds the following tags to all taggable resources created within the construct:

  • tfs-app
  • tfs-environment
  • tfs-release
  • tfs-region
  • tfs-service

The values of the tags are resolved from the TalisCdkStackProps passed to the construct.

TalisDeploymentEnvironment

Helper constants to allow us to map and reference our deployment environments

Key Description
DEVELOPMENT Local development environment
TEST Environments spun up for running tests
BUILD Environments spun up for running builds
STAGING Staging environment
PRODUCTION Production Environment
ONDEMAND On-Demand Environment
PREVIEW Preview Environment

TalisRegions

Helper constants to allow us to more easily map our product regions to AWS regions.

Key Description
CANADA ca-central-1
EU eu-west-1