MDAA TS Docs
    Preparing search index...

    Interface IMdaaResourceNaming

    interface IMdaaResourceNaming {
        props: MdaaResourceNamingConfig;
        exportName(path: string): string;
        resourceName(resourceNameSuffix?: string, maxLength?: number): string;
        ssmDomainPath(path: string, lowerCase?: boolean): string;
        ssmEnvPath(path: string, lowerCase?: boolean): string;
        ssmOrgPath(path: string, lowerCase?: boolean): string;
        ssmPath(
            path: string,
            includeModuleName?: boolean,
            lowerCase?: boolean,
        ): string;
        stackName(stackName?: string): string;
        withDomain(domain: string): IMdaaResourceNaming;
        withEnv(env: string): IMdaaResourceNaming;
        withModuleName(moduleName: string): IMdaaResourceNaming;
        withOrg(org: string): IMdaaResourceNaming;
        withResourceType(resourceType: MdaaResourceType): IMdaaResourceNaming;
        withSuffix(suffix: string): IMdaaResourceNaming;
    }

    Implemented by

    Index

    Properties

    props

    Methods

    exportName resourceName ssmDomainPath ssmEnvPath ssmOrgPath ssmPath stackName withDomain withEnv withModuleName withOrg withResourceType withSuffix

    Properties

    props: MdaaResourceNamingConfig

    Configuration properties containing organizational context and CDK node access for the naming implementation

    Methods

    • Parameters

      • OptionalresourceNameSuffix: string
      • OptionalmaxLength: number

      Returns string

    • Parameters

      • path: string
      • OptionallowerCase: boolean

      Returns string

    • Parameters

      • path: string
      • OptionallowerCase: boolean

      Returns string

    • Parameters

      • path: string
      • OptionallowerCase: boolean

      Returns string

    • Parameters

      • path: string
      • OptionalincludeModuleName: boolean
      • OptionallowerCase: boolean

      Returns string

    • Parameters

      • OptionalstackName: string

      Returns string

    Settings

    Member Visibility

    On This Page

    Properties
    Methods