docs(outputs): Adjusted outputs module name in examples (#13)

examples/custom_ini_github/main.tf

@@ -1,4 +1,4 @@
-module "asa" {
+module "ark-survival-ascended" {
   source = "TheSudoYT/ark-survival-ascended/aws"
 
   # Infrastructure inputs

examples/custom_ini_github/outputs.tf

@@ -1,89 +1,89 @@
 output "backup_s3_bucket_name" {
-  value       = module.asa.backup_s3_bucket_name
+  value       = module.ark-survival-ascended.backup_s3_bucket_name
   description = "The ID of the S3 bucket created for backups if enabled."
 }
 
 output "backup_s3_bucket_arn" {
-  value       = module.asa.backup_s3_bucket_arn
+  value       = module.ark-survival-ascended.backup_s3_bucket_arn
   description = "The ARN of the S3 bucket created for backups if enabled."
 }
 
 output "ssh_key_name" {
-  value       = module.asa.ssh_key_name
+  value       = module.ark-survival-ascended.ssh_key_name
   description = "The name of the SSH key generated by Terraform."
 }
 
 output "server_using_custom_gameusersettingsini" {
-  value       = module.asa.server_using_custom_gameusersettingsini
+  value       = module.ark-survival-ascended.server_using_custom_gameusersettingsini
   description = "Is the server using custom GameUserSettings.ini."
 }
 
 output "server_using_custom_gameini" {
-  value       = module.asa.server_using_custom_gameini
+  value       = module.ark-survival-ascended.server_using_custom_gameini
   description = "Is the server using custom Game.ini."
 }
 
 output "server_is_password_protected" {
-  value       = module.asa.server_is_password_protected
+  value       = module.ark-survival-ascended.server_is_password_protected
   description = "Is the server password protected."
 }
 
 output "join_password" {
-  value       = module.asa.join_password
+  value       = module.ark-survival-ascended.join_password
   description = "The server join password required to join."
 }
 
 output "max_players" {
-  value       = module.asa.max_players
+  value       = module.ark-survival-ascended.max_players
   description = "The configured max players."
 }
 
 output "steam_query_port" {
-  value       = module.asa.steam_query_port
+  value       = module.ark-survival-ascended.steam_query_port
   description = "The configured steam query port."
 }
 
 output "game_client_port" {
-  value       = module.asa.game_client_port
+  value       = module.ark-survival-ascended.game_client_port
   description = "The configured game client port."
 }
 
 output "admin_commands_password" {
-  value       = module.asa.admin_commands_password
+  value       = module.ark-survival-ascended.admin_commands_password
   description = "The configured admin command password."
 }
 
 output "session_name" {
-  value       = module.asa.session_name
+  value       = module.ark-survival-ascended.session_name
   description = "The configured session name."
 }
 
 output "custom_ini_s3_bucket_name" {
-  value       =  module.asa.custom_ini_s3_bucket_name
+  value       =  module.ark-survival-ascended.custom_ini_s3_bucket_name
   description = "The ID of the S3 bucket that was created if use custom ini with s3 was configured."
 }
 
 output "custom_gameusersettings_file_name" {
-  value       = module.asa.custom_gameusersettings_file_name
+  value       = module.ark-survival-ascended.custom_gameusersettings_file_name
   description = "The custom gameusersettings file name that was uploaded to s3 if use custom GUS ini with s3 was configured."
 }
 
 output "vpc_id" {
-  value       = module.asa.vpc_id
+  value       = module.ark-survival-ascended.vpc_id
   description = "The ID of the VPC created by Terraform."
 }
 
 output "subnet_id" {
-  value       = module.asa.subnet_id
+  value       = module.ark-survival-ascended.subnet_id
   description = "The subnet ID of the subnet created by Terraform."
 }
 
 output "security_group_id" {
-  value       = module.asa.security_group_id
+  value       = module.ark-survival-ascended.security_group_id
   description = "The security group ID of the security group created by Terraform."
 }
 
 output "ark_server_public_ip" {
-  value       = module.asa.ark_server_public_ip
+  value       = module.ark-survival-ascended.ark_server_public_ip
   description = "The public IP address of the Ark server to connect on."
 }

examples/custom_ini_with_s3/main.tf

@@ -1,4 +1,4 @@
-module "asa" {
+module "ark-survival-ascended" {
   source = "TheSudoYT/ark-survival-ascended/aws"
 
   # Infrastructure inputs

examples/custom_ini_with_s3/outputs.tf

@@ -1,89 +1,89 @@
 output "backup_s3_bucket_name" {
-  value       = module.asa.backup_s3_bucket_name
+  value       = module.ark-survival-ascended.backup_s3_bucket_name
   description = "The ID of the S3 bucket created for backups if enabled."
 }
 
 output "backup_s3_bucket_arn" {
-  value       = module.asa.backup_s3_bucket_arn
+  value       = module.ark-survival-ascended.backup_s3_bucket_arn
   description = "The ARN of the S3 bucket created for backups if enabled."
 }
 
 output "ssh_key_name" {
-  value       = module.asa.ssh_key_name
+  value       = module.ark-survival-ascended.ssh_key_name
   description = "The name of the SSH key generated by Terraform."
 }
 
 output "server_using_custom_gameusersettingsini" {
-  value       = module.asa.server_using_custom_gameusersettingsini
+  value       = module.ark-survival-ascended.server_using_custom_gameusersettingsini
   description = "Is the server using custom GameUserSettings.ini."
 }
 
 output "server_using_custom_gameini" {
-  value       = module.asa.server_using_custom_gameini
+  value       = module.ark-survival-ascended.server_using_custom_gameini
   description = "Is the server using custom Game.ini."
 }
 
 output "server_is_password_protected" {
-  value       = module.asa.server_is_password_protected
+  value       = module.ark-survival-ascended.server_is_password_protected
   description = "Is the server password protected."
 }
 
 output "join_password" {
-  value       = module.asa.join_password
+  value       = module.ark-survival-ascended.join_password
   description = "The server join password required to join."
 }
 
 output "max_players" {
-  value       = module.asa.max_players
+  value       = module.ark-survival-ascended.max_players
   description = "The configured max players."
 }
 
 output "steam_query_port" {
-  value       = module.asa.steam_query_port
+  value       = module.ark-survival-ascended.steam_query_port
   description = "The configured steam query port."
 }
 
 output "game_client_port" {
-  value       = module.asa.game_client_port
+  value       = module.ark-survival-ascended.game_client_port
   description = "The configured game client port."
 }
 
 output "admin_commands_password" {
-  value       = module.asa.admin_commands_password
+  value       = module.ark-survival-ascended.admin_commands_password
   description = "The configured admin command password."
 }
 
 output "session_name" {
-  value       = module.asa.session_name
+  value       = module.ark-survival-ascended.session_name
   description = "The configured session name."
 }
 
 output "custom_ini_s3_bucket_name" {
-  value       =  module.asa.custom_ini_s3_bucket_name
+  value       =  module.ark-survival-ascended.custom_ini_s3_bucket_name
   description = "The ID of the S3 bucket that was created if use custom ini with s3 was configured."
 }
 
 output "custom_gameusersettings_file_name" {
-  value       = module.asa.custom_gameusersettings_file_name
+  value       = module.ark-survival-ascended.custom_gameusersettings_file_name
   description = "The custom gameusersettings file name that was uploaded to s3 if use custom GUS ini with s3 was configured."
 }
 
 output "vpc_id" {
-  value       = module.asa.vpc_id
+  value       = module.ark-survival-ascended.vpc_id
   description = "The ID of the VPC created by Terraform."
 }
 
 output "subnet_id" {
-  value       = module.asa.subnet_id
+  value       = module.ark-survival-ascended.subnet_id
   description = "The subnet ID of the subnet created by Terraform."
 }
 
 output "security_group_id" {
-  value       = module.asa.security_group_id
+  value       = module.ark-survival-ascended.security_group_id
   description = "The security group ID of the security group created by Terraform."
 }
 
 output "ark_server_public_ip" {
-  value       = module.asa.ark_server_public_ip
+  value       = module.ark-survival-ascended.ark_server_public_ip
   description = "The public IP address of the Ark server to connect on."
 }

examples/enable_additional_platforms/main.tf

@@ -1,4 +1,4 @@
-module "asa" {
+module "ark-survival-ascended" {
   source = "../../"
 
   ge_proton_version          = "8-27"

examples/enable_additional_platforms/outputs.tf

@@ -1,89 +1,89 @@
 output "backup_s3_bucket_name" {
-  value       = module.asa.backup_s3_bucket_name
+  value       = module.ark-survival-ascended.backup_s3_bucket_name
   description = "The ID of the S3 bucket created for backups if enabled."
 }
 
 output "backup_s3_bucket_arn" {
-  value       = module.asa.backup_s3_bucket_arn
+  value       = module.ark-survival-ascended.backup_s3_bucket_arn
   description = "The ARN of the S3 bucket created for backups if enabled."
 }
 
 output "ssh_key_name" {
-  value       = module.asa.ssh_key_name
+  value       = module.ark-survival-ascended.ssh_key_name
   description = "The name of the SSH key generated by Terraform."
 }
 
 output "server_using_custom_gameusersettingsini" {
-  value       = module.asa.server_using_custom_gameusersettingsini
+  value       = module.ark-survival-ascended.server_using_custom_gameusersettingsini
   description = "Is the server using custom GameUserSettings.ini."
 }
 
 output "server_using_custom_gameini" {
-  value       = module.asa.server_using_custom_gameini
+  value       = module.ark-survival-ascended.server_using_custom_gameini
   description = "Is the server using custom Game.ini."
 }
 
 output "server_is_password_protected" {
-  value       = module.asa.server_is_password_protected
+  value       = module.ark-survival-ascended.server_is_password_protected
   description = "Is the server password protected."
 }
 
 output "join_password" {
-  value       = module.asa.join_password
+  value       = module.ark-survival-ascended.join_password
   description = "The server join password required to join."
 }
 
 output "max_players" {
-  value       = module.asa.max_players
+  value       = module.ark-survival-ascended.max_players
   description = "The configured max players."
 }
 
 output "steam_query_port" {
-  value       = module.asa.steam_query_port
+  value       = module.ark-survival-ascended.steam_query_port
   description = "The configured steam query port."
 }
 
 output "game_client_port" {
-  value       = module.asa.game_client_port
+  value       = module.ark-survival-ascended.game_client_port
   description = "The configured game client port."
 }
 
 output "admin_commands_password" {
-  value       = module.asa.admin_commands_password
+  value       = module.ark-survival-ascended.admin_commands_password
   description = "The configured admin command password."
 }
 
 output "session_name" {
-  value       = module.asa.session_name
+  value       = module.ark-survival-ascended.session_name
   description = "The configured session name."
 }
 
 output "custom_ini_s3_bucket_name" {
-  value       =  module.asa.custom_ini_s3_bucket_name
+  value       =  module.ark-survival-ascended.custom_ini_s3_bucket_name
   description = "The ID of the S3 bucket that was created if use custom ini with s3 was configured."
 }
 
 output "custom_gameusersettings_file_name" {
-  value       = module.asa.custom_gameusersettings_file_name
+  value       = module.ark-survival-ascended.custom_gameusersettings_file_name
   description = "The custom gameusersettings file name that was uploaded to s3 if use custom GUS ini with s3 was configured."
 }
 
 output "vpc_id" {
-  value       = module.asa.vpc_id
+  value       = module.ark-survival-ascended.vpc_id
   description = "The ID of the VPC created by Terraform."
 }
 
 output "subnet_id" {
-  value       = module.asa.subnet_id
+  value       = module.ark-survival-ascended.subnet_id
   description = "The subnet ID of the subnet created by Terraform."
 }
 
 output "security_group_id" {
-  value       = module.asa.security_group_id
+  value       = module.ark-survival-ascended.security_group_id
   description = "The security group ID of the security group created by Terraform."
 }
 
 output "ark_server_public_ip" {
-  value       = module.asa.ark_server_public_ip
+  value       = module.ark-survival-ascended.ark_server_public_ip
   description = "The public IP address of the Ark server to connect on."
 }

examples/restore_from_backup/README.md

@@ -10,7 +10,7 @@ These inputs are required when migrating from an existing server with existing d
 > [!WARNING]
 > When `backup_files_storage_type = "local"` using The objects/files in the directory you specify with `backup_files_local_path` must not be compressed. Terraform will iterate through each file in that directory and upload it to the root of an S3 bucket it creates.
 
-- `backup_files_storage_type = "local"` will instruct terraform to create an S3 bucket named `ark-bootstrap-local-saves-region-accID` and upload the save files from your local PC `backup_files_local_path` directory specified to that bucket. The user_data script on the EC2 instance will download the files from that S3 bucket when the server starts and place them in the `/ark-asa/ShooterGame/Saved/SaveGames` directory.
+- `backup_files_storage_type = "local"` will instruct terraform to create an S3 bucket named `ark-bootstrap-local-saves-region-accID` and upload the save files from your local PC `backup_files_local_path` directory specified to that bucket. The user_data script on the EC2 instance will download the files from that S3 bucket when the server starts and place them in the `/ark-ark-survival-ascended/ShooterGame/Saved/SaveGames` directory.
 
 - `backup_files_storage_type = "s3"` Is informing terraform that you have an existing S3 bucket somewhere that contains the save game data. The EC2 user_data script will attempt to sync the root of that S3 bucket with the SaveGames directory of ark. That is why it is important that the objects be uncompressed and in the root of the directory. 
 

examples/restore_from_backup/main.tf

@@ -1,4 +1,4 @@
-module "asa" {
+module "ark-survival-ascended" {
   source = "../.."
 
   # Infrastructure inputs