Ability to name resources and sane default names

[perpil]

Summary

Make names of cloud resources human friendly

Feature Spec

This isn't really a spec, more of a placeholder to start the discussion. The names of the resources wing creates in the cloud are auto-generated and not human friendly. Furthermore, there doesn't seem to be a property that allows them to be set by the developer (I looked through the doc, but didn't see a name field). I'd like at the minimum to be able to specify resource names so I'm not looking in buckets like: terraform-20221125051333963700000005. Ideally there would be some automatic naming too that is more grok-able than a uuid. I'm not sure whether you need a high level entity like a project to help with this, but maybe account-region-project-stage-name.

Use Cases

Allow humans to interact with the resources and be able to programmatically generate resource names to integrate with outside tools instead of needing a mapping file.

Implementation Notes

No response

Component

No response

[Chriscbr]

Love this idea @perpil! 🙌

It would be really helpful to have a general naming utility for resources, since the naming constraints on different clouds can vary. @eladb previously suggested an API that allows name generation to be customized with different options... here's a sketch:

export class NameGenerator {
  // register a name generator for a specific scope
  // normally this will be called at the root
  public static register(scope: Construct, gen: INameGenerator) {...}

  // returns the name generator associated with the current scope
  public static of(scope: Construct): INameGenerator {..}
}

export interface INameGenerator {
  // default naming scheme
  make(resource: Construct, opts?: Options): string;

  // DNS-compatible naming (opts can be used to customize)
  makeDns(resource: Construct, opts?: Options): string;

  makeAzure(r: Construct, o?: Options): string;
  makeGcp(r: Construct, o?: Options): string;

  // ...
}

// 
export interface Options {
  readonly minLen?: number;
  readonly maxLen?: number;
  readonly lowercase?: boolean;
  readonly uppercase?: boolean;
  readonly dots?: boolean;
  readonly hyphens?: boolean;
  readonly nonalpha?: boolean;
  // ...

// usage 
const bucketName = NameGenerator.of(this).makeDns(this);

Maybe this could fit somewhere in the core of the SDK?

In cases where we can't control resource names, we could also try and fall back to tagging on AWS for example.