Defined in: src/types/resource-name-types.ts:11

Represents the core components used to generate AWS resource names.

Naming convention: <stage>-<service>-<resource>

This structure is generic so any project can pass its own service name and resource type without being restricted to a fixed set.

Properties

region?

optional region: Region

Defined in: src/types/resource-name-types.ts:44

Optional AWS region identifier, useful for resources that need regional identification or for cross-region resource management.

Examples

'us-east-1'

'eu-west-1'

---

resource

resource: string

Defined in: src/types/resource-name-types.ts:35

The type of the resource being named.

Examples: 'table', 'queue', 'bucket', 'function'.

---

service

service: string

Defined in: src/types/resource-name-types.ts:28

The logical name of the service or domain that owns this resource.

Examples

'orders'

'billing'

---

stage

stage: string

Defined in: src/types/resource-name-types.ts:20

The environment or stage in which the resource exists. Placed first in the generated name for clarity and grouping.

Examples

'dev'

'staging'

'prod'

---

suffix?

optional suffix: string

Defined in: src/types/resource-name-types.ts:54

Optional suffix to append to the resource name for additional uniqueness or identification purposes.

Examples

'v2'

'backup'

'temp'