Class MdaaDefaultResourceNaming

constructor

• new MdaaDefaultResourceNaming(
      props: MdaaResourceNamingConfig,
  ): MdaaDefaultResourceNaming

  Parameters

  • props: MdaaResourceNamingConfig

  Returns MdaaDefaultResourceNaming

Readonlyprops

exportName

• exportName(path: string): string

  Generates a export name in the format of :::<module_name>

  Parameters

  • path: string

  Returns string

resourceName

• resourceName(resourceNameSuffix?: string, maxLength?: number): string

  Generates a resource name in the format of ---<module_name>

  Parameters

  • OptionalresourceNameSuffix: string

    Optional naming suffix to be added to the generated resource name. Useful when multiple resources of the same type are created within the same stack.

  • OptionalmaxLength: number

    Should be used to truncate the generated resource names to a specified length. The result should still be unique and stable. Caution: Known bug - names exactly equal to maxLength are unnecessarily truncated with hash suffix (should use > instead of >=). Left unfixed to prevent breaking existing deployments that rely on this behavior. Cosmetic issue only - does not affect infrastructure functionality.

  Returns string

ssmDomainPath

• ssmDomainPath(path: string, lowerCase?: boolean): string

  Generates a ssm param name in the format of ///

  Parameters

  • path: string
  • lowerCase: boolean = true

  Returns string

ssmEnvPath

• ssmEnvPath(path: string, lowerCase?: boolean): string

  Generates a ssm param name in the format of ////

  Parameters

  • path: string
  • lowerCase: boolean = true

  Returns string

ssmOrgPath

• ssmOrgPath(path: string, lowerCase?: boolean): string

  Generates a ssm param name in the format of //

  Parameters

  • path: string
  • lowerCase: boolean = true

  Returns string

ssmPath

• ssmPath(path: string, includeModuleName?: boolean, lowerCase?: boolean): string

  Generates a ssm param name in the format of ////<module_name>

  Parameters

  • path: string
  • includeModuleName: boolean = true
  • lowerCase: boolean = true

  Returns string

stackName

• stackName(stackNameSuffix?: string): string

  Generates a stack name in the format of ---<module_name>. Sanitizes non-alpha numeric characters and replaces underscores with '-'

  Parameters

  • OptionalstackNameSuffix: string

  Returns string

withDomain

• withDomain(domain: string): IMdaaResourceNaming

  Parameters

  • domain: string

  Returns IMdaaResourceNaming

withEnv

• withEnv(env: string): IMdaaResourceNaming

  Parameters

  • env: string

  Returns IMdaaResourceNaming

withModuleName

• withModuleName(moduleName: string): IMdaaResourceNaming

  Returns this naming object but with a new moduleName

  Parameters

  • moduleName: string

    The new module name

  Returns IMdaaResourceNaming

withOrg

• withOrg(org: string): IMdaaResourceNaming

  Parameters

  • org: string

  Returns IMdaaResourceNaming

withSuffix

• withSuffix(suffix: string): IMdaaResourceNaming

  Parameters

  • suffix: string

  Returns IMdaaResourceNaming