@gradientedge/cdk-utils 10.7.0 → 11.0.0

package/src/lib/aws/services/systems-manager/main.ts

@@ -1,115 +0,0 @@
-import { StringParameter } from 'aws-cdk-lib/aws-ssm'
-import {
-  AwsCustomResource,
-  AwsCustomResourcePolicy,
-  AwsSdkCall,
-  PhysicalResourceId,
-} from 'aws-cdk-lib/custom-resources'
-import { CommonConstruct } from '../../common/index.js'
-import { createCfnOutput } from '../../utils/index.js'
-import { SSMParameterReaderProps, SSMStringParameterProps } from './types.js'
-
-/**
- * @classdesc Provides operations on AWS Systems Manager.
- * - A new instance of this class is injected into {@link CommonConstruct} constructor.
- * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
- * @example
- * import { CommonConstruct } from '@gradientedge/cdk-utils'
- *
- * class CustomConstruct extends CommonConstruct {
- *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
- *     super(parent, id, props)
- *     this.props = props
- *     this.acmManager.writeStringToParameters('MyParameter', this, ...props)
- *   }
- * }
- * @see [CDK Systems Manager Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm-readme.html}
- */
-export class SsmManager {
-  public static SECRETS_MODIFIED_TIMESTAMP_PARAM = 'secrets-last-modified-timestamp'
-
-  /**
-   * Method to write a string parameter to the parameters store
-   * @param id scoped id of the resource
-   * @param scope scope in which this resource is defined
-   * @param props parameter props
-   */
-  public writeStringToParameters(id: string, scope: CommonConstruct, props: SSMStringParameterProps) {
-    if (!props) throw `Parameter props undefined for ${id}`
-    if (!props.parameterName) throw `Parameter parameterName undefined for ${id}`
-
-    const parameter = new StringParameter(scope, `${id}`, {
-      ...props,
-      description: `${props.description} - ${scope.props.stage} stage`,
-      parameterName: scope.resourceNameFormatter.format(props.parameterName, scope.props.resourceNameOptions?.ssm),
-    })
-
-    createCfnOutput(`${id}-parameterArn`, scope, parameter.parameterArn)
-    createCfnOutput(`${id}-parameterName`, scope, parameter.parameterName)
-
-    return parameter
-  }
-
-  /**
-   * Method to read a string parameter from the parameters store
-   * @param id scoped id of the resource
-   * @param scope scope in which this resource is defined
-   * @param parameterName parameter name to lookup
-   */
-  public readStringParameter(id: string, scope: CommonConstruct, parameterName: string) {
-    if (!parameterName || parameterName == '') throw 'Invalid parameter name'
-
-    return StringParameter.valueFromLookup(
-      scope,
-      scope.resourceNameFormatter.format(parameterName, scope.props.resourceNameOptions?.ssm)
-    )
-  }
-
-  /**
-   * Method to read a string parameter from the parameters store in a given region
-   * @param id scoped id of the resource
-   * @param scope scope in which this resource is defined
-   * @param parameterName parameter name to lookup
-   * @param region region name to lookup parameter
-   */
-  public readStringParameterFromRegion(id: string, scope: CommonConstruct, parameterName: string, region: string) {
-    if (!parameterName || parameterName == '') throw `Invalid parameter name for ${id}`
-    if (!region || region == '') throw `Invalid region for ${id}`
-
-    return new SSMParameterReader(scope, `${id}`, {
-      parameterName: scope.resourceNameFormatter.format(parameterName, scope.props.resourceNameOptions?.ssm),
-      region,
-    }).getParameterValue()
-  }
-}
-
-/**
- * @classdesc Provides utilities to read same/cross region SSM parameters
- */
-export class SSMParameterReader extends AwsCustomResource {
-  constructor(scope: CommonConstruct, name: string, props: SSMParameterReaderProps) {
-    const { parameterName, region } = props
-
-    const ssmAwsSdkCall: AwsSdkCall = {
-      action: 'getParameter',
-      parameters: {
-        Name: parameterName,
-      },
-      physicalResourceId: PhysicalResourceId.of(Date.now().toString()),
-      region,
-      service: 'SSM',
-    }
-
-    super(scope, name, {
-      onUpdate: ssmAwsSdkCall,
-      policy: AwsCustomResourcePolicy.fromSdkCalls({ resources: AwsCustomResourcePolicy.ANY_RESOURCE }),
-    })
-  }
-
-  /**
-   *
-   */
-  public getParameterValue(): string {
-    return this.getResponseField('Parameter.Value')
-  }
-}

package/src/lib/aws/services/systems-manager/types.ts

@@ -1,10 +0,0 @@
-import { StringParameterProps } from 'aws-cdk-lib/aws-ssm'
-
-/**
- */
-export interface SSMParameterReaderProps {
-  parameterName: string
-  region: string
-}
-
-export interface SSMStringParameterProps extends StringParameterProps {}

package/src/lib/aws/services/virtual-private-cloud/index.ts

@@ -1,2 +0,0 @@
-export * from './main.js'
-export * from './types.js'

package/src/lib/aws/services/virtual-private-cloud/ipv6.ts

@@ -1,61 +0,0 @@
-import { Fn } from 'aws-cdk-lib'
-import {
-  CfnEgressOnlyInternetGateway,
-  CfnSubnet,
-  CfnVPCCidrBlock,
-  ISubnet,
-  RouterType,
-  Subnet,
-  Vpc,
-} from 'aws-cdk-lib/aws-ec2'
-import _ from 'lodash'
-import { CommonConstruct } from '../../common/index.js'
-import { VpcProps } from './types.js'
-
-export class Ipv6Vpc extends Vpc {
-  public egressOnlyInternetGatewayId: string
-
-  constructor(scope: CommonConstruct, id: string, props: VpcProps) {
-    super(scope, id, props)
-
-    const cfnVpcCidrBlock = new CfnVPCCidrBlock(this, `${id}-ipv6-cidr`, {
-      amazonProvidedIpv6CidrBlock: true,
-      vpcId: this.vpcId,
-    })
-
-    const subnetIpv6CidrBlocks = Fn.cidr(Fn.select(0, this.vpcIpv6CidrBlocks), 256, '64')
-
-    _.forEach([...this.publicSubnets, ...this.privateSubnets, ...this.isolatedSubnets], (subnet, index) => {
-      subnet.node.addDependency(cfnVpcCidrBlock)
-      const cfnSubnet = subnet.node.defaultChild as CfnSubnet
-      cfnSubnet.cidrBlock = undefined
-      cfnSubnet.mapPublicIpOnLaunch = false
-      cfnSubnet.ipv6CidrBlock = Fn.select(index, subnetIpv6CidrBlocks)
-      cfnSubnet.assignIpv6AddressOnCreation = true
-      cfnSubnet.ipv6Native = true
-    })
-
-    const addDefaultIpv6Routes = (subnets: ISubnet[], gatewayId: string, routerType: RouterType) =>
-      subnets.forEach(subnet =>
-        (subnet as Subnet).addRoute(`${id}-default-route`, {
-          destinationIpv6CidrBlock: '::/0',
-          enablesInternetConnectivity: true,
-          routerId: gatewayId,
-          routerType: routerType,
-        })
-      )
-
-    if (this.internetGatewayId) {
-      addDefaultIpv6Routes(this.publicSubnets, this.internetGatewayId, RouterType.GATEWAY)
-    }
-
-    if (_.isEmpty(this.privateSubnets)) {
-      return
-    }
-
-    const egressIgw = new CfnEgressOnlyInternetGateway(this, `${id}-eigw`, { vpcId: this.vpcId })
-    this.egressOnlyInternetGatewayId = egressIgw.ref
-
-    addDefaultIpv6Routes(this.privateSubnets, egressIgw.ref, RouterType.EGRESS_ONLY_INTERNET_GATEWAY)
-  }
-}

package/src/lib/aws/services/virtual-private-cloud/main.ts

@@ -1,108 +0,0 @@
-import { Tags } from 'aws-cdk-lib'
-import { SubnetType, Vpc } from 'aws-cdk-lib/aws-ec2'
-import _ from 'lodash'
-import { CommonConstruct } from '../../common/index.js'
-import { createCfnOutput } from '../../utils/index.js'
-import { Ipv6Vpc } from './ipv6.js'
-import { VpcProps } from './types.js'
-
-/**
- */
-const CommonVpcIdentifier = 'CommonVpc'
-
-/**
- * @classdesc Provides operations on AWS VPC.
- * - A new instance of this class is injected into {@link CommonConstruct} constructor.
- * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
- * @example
- * import { CommonConstruct } from '@gradientedge/cdk-utils'
- *
- * class CustomConstruct extends CommonConstruct {
- *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
- *     super(parent, id, props)
- *     this.props = props
- *     this.vpcManager.createVpc('MyVPC', this)
- *   }
- * }
- * @see [CDK VPC Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.@aws-cdk_aws-Vpc.html}
- */
-export class VpcManager {
-  /**
-   * @summary Method to create a new vpc
-   * @param id scoped id of the resource
-   * @param scope scope in which this resource is defined
-   * @param props
-   */
-  public createVpc(id: string, scope: CommonConstruct, props: VpcProps) {
-    if (!props) throw `Vpc props undefined for ${id}`
-    if (!props.vpcName) throw `Vpc vpcName undefined for ${id}`
-
-    const vpcName = scope.resourceNameFormatter.format(props.vpcName, scope.props.resourceNameOptions?.vpc)
-    let vpc
-    if (props.isIPV6) {
-      vpc = new Ipv6Vpc(scope, `${id}`, {
-        ...props,
-        subnetConfiguration: [
-          { name: `${vpcName}-public`, subnetType: SubnetType.PUBLIC },
-          { name: `${vpcName}-private`, subnetType: SubnetType.PRIVATE_WITH_EGRESS },
-        ],
-        vpcName,
-      })
-    } else {
-      vpc = new Vpc(scope, `${id}`, {
-        ...props,
-        vpcName,
-      })
-    }
-
-    createCfnOutput(`${id}Id`, scope, vpc.vpcId)
-    createCfnOutput(`${id}PublicSubnetIds`, scope, _.map(vpc.publicSubnets, subnet => subnet.subnetId).toString())
-    createCfnOutput(`${id}PrivateSubnetIds`, scope, _.map(vpc.privateSubnets, subnet => subnet.subnetId).toString())
-    createCfnOutput(
-      `${id}PublicSubnetRouteTableIds`,
-      scope,
-      _.map(vpc.publicSubnets, subnet => subnet.routeTable.routeTableId).toString()
-    )
-    createCfnOutput(
-      `${id}PrivateSubnetRouteTableIds`,
-      scope,
-      _.map(vpc.privateSubnets, subnet => subnet.routeTable.routeTableId).toString()
-    )
-    createCfnOutput(`${id}AvailabilityZones`, scope, vpc.availabilityZones.toString())
-    createCfnOutput(`${id}DefaultSecurityGroup`, scope, vpc.vpcDefaultSecurityGroup.toString())
-
-    return vpc
-  }
-
-  /**
-   * @summary Method to create a common vpc
-   * @param id scoped id of the resource
-   * @param scope scope in which this resource is defined
-   * @param props
-   * @param vpcIdentifier optional identifier for VPC
-   */
-  public createCommonVpc(id: string, scope: CommonConstruct, props: VpcProps, vpcIdentifier?: string) {
-    const vpc = this.createVpc(id, scope, props)
-    Tags.of(vpc).add(
-      'Name',
-      scope.resourceNameFormatter.format(vpcIdentifier ?? CommonVpcIdentifier, scope.props.resourceNameOptions?.vpc)
-    )
-
-    return vpc
-  }
-
-  /**
-   * @summary Method to retrieve a common vpc
-   * @param id scoped id of the resource
-   * @param scope scope in which this resource is defined
-   * @param vpcIdentifier optional identifier for VPC
-   */
-  public retrieveCommonVpc(id: string, scope: CommonConstruct, vpcIdentifier?: string) {
-    return Vpc.fromLookup(scope, `${id}`, {
-      vpcName: scope.resourceNameFormatter.format(
-        vpcIdentifier ?? CommonVpcIdentifier,
-        scope.props.resourceNameOptions?.vpc
-      ),
-    })
-  }
-}

package/src/lib/aws/services/virtual-private-cloud/types.ts

@@ -1,5 +0,0 @@
-import * as ec2 from 'aws-cdk-lib/aws-ec2'
-
-export interface VpcProps extends ec2.VpcProps {
-  isIPV6?: boolean
-}

package/src/lib/aws/services/web-application-firewall/index.ts

@@ -1,2 +0,0 @@
-export * from './main.js'
-export * from './types.js'

package/src/lib/aws/services/web-application-firewall/main.ts

@@ -1,67 +0,0 @@
-import { CfnIPSet, CfnWebACL } from 'aws-cdk-lib/aws-wafv2'
-import { CommonConstruct } from '../../common/index.js'
-import { createCfnOutput } from '../../utils/index.js'
-import { WafIPSetProps, WafWebACLProps } from './types.js'
-
-/**
- * @classdesc Provides operations on AWS WAF.
- * - A new instance of this class is injected into {@link CommonConstruct} constructor.
- * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
- * @example
- * import { CommonConstruct } from '@gradientedge/cdk-utils'
- *
- * class CustomConstruct extends CommonConstruct {
- *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
- *     super(parent, id, props)
- *     this.props = props
- *     this.wafManager.createWebAcl('MyWebAcl', this)
- *   }
- * }
- * @see [CDK WAF Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_waf-readme.html}
- */
-export class WafManager {
-  /**
-   * @summary Method to create an ip set
-   * @param id scoped id of the resource
-   * @param scope scope in which this resource is defined
-   * @param props
-   */
-  public createIpSet(id: string, scope: CommonConstruct, props: WafIPSetProps) {
-    if (!props) throw `WAF Ip Set props undefined for ${id}`
-    if (!props.name) throw `WAF Ip Set name undefined for ${id}`
-
-    const ipSet = new CfnIPSet(scope, `${id}`, {
-      ...props,
-      description: `IP Set for ${id} - ${scope.props.stage} stage`,
-      name: scope.resourceNameFormatter.format(props.name, scope.props.resourceNameOptions?.waf),
-    })
-
-    createCfnOutput(`${id}-ipSetId`, scope, ipSet.attrId)
-    createCfnOutput(`${id}-ipSetArn`, scope, ipSet.attrArn)
-
-    return ipSet
-  }
-
-  /**
-   * @summary Method to create a web acl
-   * @param id scoped id of the resource
-   * @param scope scope in which this resource is defined
-   * @param props
-   */
-  public createWebAcl(id: string, scope: CommonConstruct, props: WafWebACLProps) {
-    if (!props) throw `WAF WebACL props undefined for ${id}`
-    if (!props.name) throw `WAF WebACL name undefined for ${id}`
-
-    const webAcl = new CfnWebACL(scope, `${id}`, {
-      ...props,
-      description: `Web Acl for ${id} - ${scope.props.stage} stage`,
-      name: scope.resourceNameFormatter.format(props.name, scope.props.resourceNameOptions?.waf),
-      tags: [{ key: 'service', value: scope.props.name }],
-    })
-
-    createCfnOutput(`${id}-webAclId`, scope, webAcl.attrId)
-    createCfnOutput(`${id}-webAclArn`, scope, webAcl.attrArn)
-
-    return webAcl
-  }
-}

package/src/lib/aws/services/web-application-firewall/types.ts

@@ -1,9 +0,0 @@
-import { CfnIPSetProps, CfnWebACLProps } from 'aws-cdk-lib/aws-wafv2'
-
-/**
- */
-export interface WafIPSetProps extends CfnIPSetProps {}
-
-/**
- */
-export interface WafWebACLProps extends CfnWebACLProps {}

package/src/lib/aws/types/index.ts

@@ -1,6 +0,0 @@
-/**
- */
-export interface TagProps {
-  key: string
-  value: string
-}

package/src/lib/aws/utils/index.ts

@@ -1,73 +0,0 @@
-import { fromEnv, fromIni } from '@aws-sdk/credential-providers'
-import { AwsCredentialIdentityProvider } from '@aws-sdk/types'
-import { CfnOutput } from 'aws-cdk-lib'
-import _ from 'lodash'
-import { CommonConstruct } from '../common/index.js'
-
-/**
- * @summary Helper method to add CloudFormation outputs from the construct
- * @param id scoped id of the resource
- * @param scope scope in which this resource is defined
- * @param value the value of the exported output
- * @param description optional description for the output
- * @param overrideId Flag which indicates whether to override the default logical id of the output
- * @returns The CloudFormation output
- */
-export function createCfnOutput(
-  id: string,
-  scope: CommonConstruct,
-  value?: string,
-  description?: string,
-  overrideId = true
-): CfnOutput {
-  const camelName = _.camelCase(id)
-  const output = new CfnOutput(scope, id, {
-    description,
-    exportName: `${scope.props.stackName}-${camelName}`,
-    value: value ?? '',
-  })
-  if (overrideId) {
-    output.overrideLogicalId(camelName)
-  }
-  return output
-}
-
-/**
- *
- */
-export function determineCredentials(): AwsCredentialIdentityProvider {
-  if (process.env.AWS_PROFILE) return fromIni()
-  return fromEnv()
-}
-
-/**
- */
-const defaultResponseObject = {
-  body: '',
-  headers: {
-    'Access-Control-Allow-Origin': '*',
-  },
-  isBase64Encoded: false,
-  statusCode: 200,
-}
-
-/**
- * @param error
- */
-export function redirectError(error: any) {
-  console.error(error, error.message, error.stack)
-  return Object.assign({}, defaultResponseObject, {
-    body: JSON.stringify(Object.assign({}, { error: error.message, success: false })),
-    statusCode: 500,
-  })
-}
-
-/**
- * @param message
- */
-export function redirectSuccess(message: any) {
-  return Object.assign({}, defaultResponseObject, {
-    body: JSON.stringify(Object.assign({}, { error: message, success: true })),
-    statusCode: 200,
-  })
-}

package/src/lib/azure/common/constants.ts

@@ -1,10 +0,0 @@
-export enum AzureRemoteBackend {
-  azurerm = 'azurerm',
-  pulumi = 'pulumi',
-  local = 'local',
-}
-
-/**
- * List of Azure resources that excludes tags
- */
-export const RESOURCES_TO_EXCLUDE_TAGS = new Set(['ApiManagementNamedValue', 'Application', 'ServicePrincipal'])

package/src/lib/azure/common/construct.ts

@@ -1,120 +0,0 @@
-import { ComponentResource, ComponentResourceOptions } from '@pulumi/pulumi'
-import { isDevStage, isPrdStage, isTestStage, isUatStage } from '../../common/index.js'
-import {
-  AzureApiManagementManager,
-  AzureAppConfigurationManager,
-  AzureAppServiceManager,
-  AzureApplicationInsightsManager,
-  AzureCosmosDbManager,
-  AzureDnsManager,
-  AzureEventgridManager,
-  AzureFunctionManager,
-  AzureKeyVaultManager,
-  AzureOperationalInsightsManager,
-  AzureMonitorManager,
-  AzureRedisManager,
-  AzureResourceGroupManager,
-  AzureServicebusManager,
-  AzureStorageManager,
-} from '../services/index.js'
-import { AzureResourceNameFormatter } from './resource-name-formatter.js'
-import { CommonAzureStackProps } from './types.js'
-
-/**
- * @classdesc Common Azure construct to use as a base for all higher level constructs using Pulumi
- * - Provides manager instances for all Azure services
- * - Handles resource naming conventions
- * - Manages common properties and utilities
- * @example
- * ```typescript
- * import { CommonAzureConstruct } from '@gradientedge/cdk-utils'
- *
- * class CustomConstruct extends CommonAzureConstruct {
- *   constructor(name: string, props: CommonAzureStackProps) {
- *     super(name, props)
- *     // provision resources using this.resourceGroupManager, etc.
- *   }
- * }
- * ```
- */
-export class CommonAzureConstruct extends ComponentResource {
-  declare props: CommonAzureStackProps
-  declare options?: ComponentResourceOptions
-  id: string
-  fullyQualifiedDomainName: string
-  apiManagementManager: AzureApiManagementManager
-  appConfigurationManager: AzureAppConfigurationManager
-  appServiceManager: AzureAppServiceManager
-  applicationInsightsManager: AzureApplicationInsightsManager
-  cosmosDbManager: AzureCosmosDbManager
-  dnsManager: AzureDnsManager
-  eventgridManager: AzureEventgridManager
-  functionManager: AzureFunctionManager
-  keyVaultManager: AzureKeyVaultManager
-  operationalInsightsManager: AzureOperationalInsightsManager
-  monitorManager: AzureMonitorManager
-  redisManager: AzureRedisManager
-  resourceGroupManager: AzureResourceGroupManager
-  resourceNameFormatter: AzureResourceNameFormatter
-  servicebusManager: AzureServicebusManager
-  storageManager: AzureStorageManager
-
-  constructor(name: string, props: CommonAzureStackProps, options?: ComponentResourceOptions) {
-    super(`azure:${name}`, name, props, options)
-    this.props = props
-    this.options = options
-    this.id = name
-
-    this.apiManagementManager = new AzureApiManagementManager()
-    this.appConfigurationManager = new AzureAppConfigurationManager()
-    this.appServiceManager = new AzureAppServiceManager()
-    this.applicationInsightsManager = new AzureApplicationInsightsManager()
-    this.cosmosDbManager = new AzureCosmosDbManager()
-    this.dnsManager = new AzureDnsManager()
-    this.eventgridManager = new AzureEventgridManager()
-    this.functionManager = new AzureFunctionManager()
-    this.keyVaultManager = new AzureKeyVaultManager()
-    this.operationalInsightsManager = new AzureOperationalInsightsManager()
-    this.monitorManager = new AzureMonitorManager()
-    this.redisManager = new AzureRedisManager()
-    this.resourceGroupManager = new AzureResourceGroupManager()
-    this.resourceNameFormatter = new AzureResourceNameFormatter(props)
-    this.servicebusManager = new AzureServicebusManager()
-    this.storageManager = new AzureStorageManager()
-
-    this.determineFullyQualifiedDomain()
-  }
-
-  /**
-   * @summary Determine the fully qualified domain name based on domainName & subDomain
-   */
-  protected determineFullyQualifiedDomain(): void {
-    this.fullyQualifiedDomainName = this.props.subDomain
-      ? `${this.props.subDomain}.${this.props.domainName}`
-      : this.props.domainName
-  }
-
-  /**
-   * @summary Utility method to determine if the initialisation is in development (dev) stage
-   * This is determined by the stage property injected via cdk context
-   */
-  public isDevelopmentStage = () => isDevStage(this.props.stage)
-
-  /**
-   * @summary Utility method to determine if the initialisation is in test (tst) stage
-   * This is determined by the stage property injected via cdk context
-   */
-  public isTestStage = () => isTestStage(this.props.stage)
-
-  /**
-   * @summary Utility method to determine if the initialisation is in uat (uat) stage
-   * This is determined by the stage property injected via cdk context
-   */
-  public isUatStage = () => isUatStage(this.props.stage)
-
-  /**
-   * @summary Utility method to determine if the initialisation is in production (prd) stage
-   * This is determined by the stage property injected via cdk context
-   */
-  public isProductionStage = () => isPrdStage(this.props.stage)
-}

package/src/lib/azure/common/index.ts

@@ -1,6 +0,0 @@
-export * from './constants.js'
-export * from './construct.js'
-export * from './resource-name-formatter.js'
-export * from './stack.js'
-export * from './tagging.js'
-export * from './types.js'

package/src/lib/azure/common/resource-name-formatter.ts

@@ -1,43 +0,0 @@
-import { AzureResourceNameFormatterProps, CommonAzureStackProps } from '../index.js'
-
-/**
- * @classdesc Formats Azure resource names according to naming conventions
- * - Applies global/resource prefixes and suffixes
- * - Automatically appends stage to resource names
- * - Supports per-resource customization via options
- */
-export class AzureResourceNameFormatter {
-  props: CommonAzureStackProps
-
-  constructor(props: CommonAzureStackProps) {
-    this.props = props
-  }
-
-  /**
-   * @summary Helper method to format azure resource name based on the provided options
-   * @param resourceName The azure resource name to format
-   * @param options Options to control the formatting of the resource name
-   * @returns The formatted Azure-compliant resource name
-   */
-  public format(resourceName: string | undefined, options?: AzureResourceNameFormatterProps): string {
-    const azureResourceNameElements = []
-
-    if (!options?.exclude) {
-      azureResourceNameElements.push(options?.globalPrefix ? this.props.globalPrefix : undefined)
-      azureResourceNameElements.push(options?.prefix ?? this.props.resourcePrefix)
-    }
-
-    azureResourceNameElements.push(resourceName || '')
-
-    if (!options?.exclude) {
-      azureResourceNameElements.push(options?.suffix ?? this.props.resourceSuffix)
-      azureResourceNameElements.push(options?.globalSuffix ? this.props.globalSuffix : undefined)
-    }
-
-    azureResourceNameElements.push(this.props.stage)
-
-    return azureResourceNameElements
-      .filter(azureResourceNameElements => azureResourceNameElements != undefined)
-      .join('-')
-  }
-}