update outputs and docs

[shubhamsinha-sf]

Description

Update the example and module outputs for custom subnets and nat gateway.

Related Issue

• issue 80: There is a lot of confusion around using this module for creating a custom scenario with a single nat gateway. The example should be updated with NAT gateway and EIP resources. Also, the module output currently, does not reflects the outputs from the custom subnets submodule, that needs to be updated as well.

Checklist

Please ensure that the following steps are completed before submitting the pull request:

• Code follows the Terraform best practices and style guidelines.
• Changes are appropriately documented, including any necessary updates to README or other documentation files.
• Unit tests have been added or updated to cover the changes introduced by this pull request.
• Changes have been tested locally and verified to work as expected.
• The code has been reviewed to ensure it aligns with the project's goals and standards.
• Dependencies and backward compatibility have been considered and addressed if applicable.

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Intermediate change (work in progress)
• Documentation (Informative changes)

Testing Instructions

Use the custom subnets example.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud