Repository files navigation

Terraform module which creates name format for AWS resources

This module is to help you create resources in AWS using Terrafom to create names according to the rules.Please refer toExamples for examples of usage.In the following, I will explain the usage and structure in a simple way.

module"namer" {source="../../"prefix=["namer","prod"]}module"namer_with_additional_identifier_verb" {source="../../"with_additional_identifier_verb=trueprefix=["namer","prod"]}..."Name" =format(module.namer.subnet,"bastion","pub", each.key)..."Name" =format(module.namer_with_additional_identifier_verb.ec2_instance,"rest","auth")

The overall output should look something like this

# delimiter = "-"# Default${resource_name}-${prefix}-${identifier}# With Optional Resource Number# with_additional_identifier_verb = true${resource_name}-${prefix}-${identifier}-${additional_identifier}

We'll discuss each element in more detail below.

This element is the name of the resource provided by AWS.

This module uses abbreviated resource names, which can be found and changed in [local.tf] (./local.tf).

This element is a user-definable prefix value and can provide multiple values in an array.

# delimiter = "-"# ["poc", "dev"]prefix="poc-dev"# ["terraform", "prod"]prefix="terraform-prod"

This element is an identifier, with one or two arguments.

ex)${service_name},${subnet_name}-${route_type}

You can see how many arguments it has in [outputs.tf] (./outputs.tf).

This is an optionally available element, enabled by adding thewith_additional_identifier_verb = true option.

This is an identifier to use when you need to create multiple resources with the same name.If this is not the case, we recommend not using it.

Below shows the result of adding this option when getting the name of an ec2_instance.

# delimiter = "-"# prefix = ["terraform", "qa"]# identifier = ["rest"]# region = "ap-northeast-2"# with_additional_identifier_verb = true-> ec2-terraform-qa-rest-an2-%s

For more usage examples, seeexamples/complete/.

• Complete
• Simple

No modules.

[
  "project",
  "environment"
]