Class CcStack

CloudKitect stack component that is environment aware and provides several methods to find out the account Type it is deployed.

Examples

Default Usage

const stackProps = {
    ckApplication: 'ExampleApp',
    ckCompany: 'CloudKitect',
    ckAccountType: AccountType.UAT,
    env: {account: "ACCOUNT_ID", region: "us-east-1"}
}
new CcStackV2(app, "StackId", {
    ...stackProps
});

Compliance

It addresses the following compliance requirements

    1. Cloudformation stacks in use for defining infrastructure
      • Risk Level: Medium
      • Compliance: APRA, MAS
      • Well Architected Pillar: Reliability, Operational Excellence
    1. Termination protection for production accounts
      • Risk Level: High
      • Compliance: NIST, APRA, MAS
      • Well Architected Pillar: Reliability, Operational Excellence

Hierarchy

  • Stack
    • CcStack

Constructors

constructor

Properties

removalPolicyOverride?

Methods

deletionProtection getAccountType getApplicationName getCompany getDataClassification getRemovalPolicy isConfidential isDevelopment isDevelopmentLike isInternal isNonProduction isProduction isProductionLike isPublic isRestricted isTest isUAT shouldAddAlarms getStack getStackId

Constructors

constructor

  • new CcStack(scope, id, props): CcStack

  • Parameters

    Returns CcStack

Properties

Optional Readonly removalPolicyOverride

removalPolicyOverride?: RemovalPolicy

Methods

deletionProtection

  • deletionProtection(): boolean

  • Method to use in components with properties to control deletion protection

    Returns boolean

getAccountType

getApplicationName

  • getApplicationName(): string

  • Returns string

getCompany

  • getCompany(): string

  • Returns string

Private getDataClassification

getRemovalPolicy

  • getRemovalPolicy(): RemovalPolicy

  • Returned environment specific removal policy Retain for production and destroy for non production unless overriden by ccRemovalPolicyOverride

    Returns RemovalPolicy

isConfidential

  • isConfidential(): boolean

  • Find out if the stack handles confidential data Data is confidential should only be accessed by authorized users

    Returns boolean

isDevelopment

  • isDevelopment(): boolean

  • Find out if the stack is running in development

    Returns boolean

isDevelopmentLike

  • isDevelopmentLike(): boolean

  • Find out if the stack is running in a production like environment such as dev or test

    Returns boolean

isInternal

  • isInternal(): boolean

  • Find out if the stack handles internal data Data is strictly for internal use only, by company employees

    Returns boolean

isNonProduction

  • isNonProduction(): boolean

  • Find out if the stack is running in a non production environment such as dev, test, uat

    Returns boolean

isProduction

  • isProduction(): boolean

  • Find out if the stack is running in production

    Returns boolean

isProductionLike

  • isProductionLike(): boolean

  • Find out if the stack is running in a production like environment such as uat and prod

    Returns boolean

isPublic

  • isPublic(): boolean

  • Find out if the stack handles public data Data is publicly available without any authentication requirement

    Returns boolean

isRestricted

  • isRestricted(): boolean

  • Find out if the stack handles restricted data Data is restricted to only executives and even restricted to internal employees

    Returns boolean

isTest

  • isTest(): boolean

  • Find out if the stack is running in test

    Returns boolean

isUAT

  • isUAT(): boolean

  • Find out if the stack is running in a uat environment

    Returns boolean

shouldAddAlarms

  • shouldAddAlarms(alarmProps): boolean

  • Method to determine if alarms should be added or not Alarms are added for production environments only. This property can be overridden by waDoNotAddDefaultAlarms

    Parameters

    Returns boolean

Static getStack

  • getStack(construct): CcStack

  • Parameters

    • construct: Construct

    Returns CcStack

Static getStackId

  • getStackId(id, prefix?): string

  • Parameters

    • id: string
    • Optional prefix: string

    Returns string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc