feat: Add privateEndpointHostames field to Data Federation resource by marcabreracast · Pull Request #4358 · mongodb/terraform-provider-mongodbatlas

marcabreracast · 2026-04-01T08:41:02Z

Description

This PR adds the computed attribute private_endpoint_hostnames to mongodbatlas_federated_database_instance resource, and corresponding data sources mongodbatlas_federated_database_instance and mongodbatlas_federated_database_instances.

Link to any related issue(s): CLOUDP-391245

Type of change:

Bug fix (non-breaking change which fixes an issue). Please, add the "bug" label to the PR.
New feature (non-breaking change which adds functionality). Please, add the "enhancement" label to the PR. A migration guide must be created or updated if the new feature will go in a major version.
Breaking change (fix or feature that would cause existing functionality to not work as expected). Please, add the "breaking change" label to the PR. A migration guide must be created or updated.
This change requires a documentation update
Documentation fix/enhancement

Required Checklist:

I have signed the MongoDB CLA
I have read the contributing guides
I have checked that this change does not generate any credentials and that they are NOT accidentally logged anywhere.
I have added tests that prove my fix is effective or that my feature works per HashiCorp requirements
I have added any necessary documentation (if appropriate)
I have run make fix and verified my code
If changes include deprecations or removals I have added appropriate changelog entries.
If changes include removal or addition of 3rd party GitHub actions, I updated our internal document. Reach out to the APIx Integration slack channel to get access to the internal document.

Further comments

Copilot

Pull request overview

Adds exposure of Data Federation private endpoint hostname information in the Terraform provider’s federated database instance resource.

Changes:

Adds a new computed private_endpoint_hostnames attribute to the federated database instance resource schema.
Populates the attribute during Read and Import using a new flattener for the Atlas SDK response type.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

internal/service/federateddatabaseinstance/resource_federated_database_instance.go

svc-apix-Bot · 2026-04-07T00:46:21Z

This PR has gone 7 days without any activity and meets the project’s definition of "stale". This will be auto-closed if there is no new activity over the next 7 days. If the issue is still relevant and active, you can simply comment with a "bump" to keep it open, or add the label "not_stale". Thanks for keeping our repository healthy!

github-actions · 2026-04-07T14:06:20Z

APIx bot: a message has been sent to Docs Slack channel

augmentcode · 2026-04-07T14:07:57Z

🤖 Augment PR Summary

Summary: Adds support for exposing private endpoint hostnames on Atlas Data Federation resources and data sources.

Changes:

Introduced computed private_endpoint_hostnames in mongodbatlas_federated_database_instance resource schema and read/import flows
Added the same computed attribute to the singular and plural federated database instance data sources
Implemented a shared flattener to map Atlas SDK PrivateEndpointHostname objects into Terraform state
Extended acceptance tests to assert the new attribute is present (currently empty in the test environment)
Updated docs and changelog entries to document the new attribute

_{🤖 Was this summary useful? React with 👍 or 👎}

augmentcode

Review completed. 1 suggestion posted.

Comment augment review to trigger a new review at any time.

docs/data-sources/federated_database_instance.md

corryroot

LGTM! I commented with some copy nits.

corryroot · 2026-04-07T14:40:01Z

docs/data-sources/federated_database_instance.md


 * `id` - The Terraform's unique identifier used internally for state management.
 * `hostnames` - The list of hostnames assigned to the Federated Database Instance. Each string in the array is a hostname assigned to the Federated Database Instance.
+* `private_endpoint_hostnames` - The list of private endpoint hostnames assigned to the Federated Database Instance.


Suggested change

* `private_endpoint_hostnames` - The list of private endpoint hostnames assigned to the Federated Database Instance.

* `private_endpoint_hostnames` - List of private endpoint hostnames assigned to the Federated Database Instance.

Addressed in 0c7f891

corryroot · 2026-04-07T14:40:23Z

docs/data-sources/federated_database_instance.md

 * `id` - The Terraform's unique identifier used internally for state management.
 * `hostnames` - The list of hostnames assigned to the Federated Database Instance. Each string in the array is a hostname assigned to the Federated Database Instance.
+* `private_endpoint_hostnames` - The list of private endpoint hostnames assigned to the Federated Database Instance.
+  * `private_endpoint_hostnames.#.hostname` - Human-readable label identifying the hostname.


Suggested change

* `private_endpoint_hostnames.#.hostname` - Human-readable label identifying the hostname.

* `private_endpoint_hostnames.#.hostname` - Human-readable label that identifies the host.

Addressed in 0c7f891

corryroot · 2026-04-07T14:40:37Z

docs/data-sources/federated_database_instance.md

 * `hostnames` - The list of hostnames assigned to the Federated Database Instance. Each string in the array is a hostname assigned to the Federated Database Instance.
+* `private_endpoint_hostnames` - The list of private endpoint hostnames assigned to the Federated Database Instance.
+  * `private_endpoint_hostnames.#.hostname` - Human-readable label identifying the hostname.
+  * `private_endpoint_hostnames.#.private_endpoint` - Human-readable label identifying the private endpoint.


Suggested change

* `private_endpoint_hostnames.#.private_endpoint` - Human-readable label identifying the private endpoint.

* `private_endpoint_hostnames.#.private_endpoint` - Human-readable label that identifies the private endpoint.

Addressed in 0c7f891

corryroot · 2026-04-07T14:40:50Z

docs/data-sources/federated_database_instances.md

+* `private_endpoint_hostnames` - The list of private endpoint hostnames assigned to the Federated Database Instance.
+  * `private_endpoint_hostnames.#.hostname` - Human-readable label identifying the hostname.
+  * `private_endpoint_hostnames.#.private_endpoint` - Human-readable label identifying the private endpoint.


Same as above

Addressed in 0c7f891

corryroot · 2026-04-07T14:41:02Z

docs/resources/federated_database_instance.md

+* `private_endpoint_hostnames` - The list of private endpoint hostnames assigned to the Federated Database Instance.
+  * `private_endpoint_hostnames.#.hostname` - Human-readable label identifying the hostname.
+  * `private_endpoint_hostnames.#.private_endpoint` - Human-readable label identifying the private endpoint.


Same as above.

Addressed in 0c7f891

EspenAlbert · 2026-04-07T15:02:28Z

internal/service/federateddatabaseinstance/resource_federated_database_instance_test.go

 		"storage_stores.0.read_preference.0.tag_sets.#":             "2",
 		"storage_stores.0.read_preference.0.tag_sets.0.tags.#":      "2",
 		"storage_databases.0.collections.0.data_sources.0.database": "sample_airbnb",
+		"private_endpoint_hostnames.#":                              "0",


Do we have any test where this is set?

Agree, first double check on which scenario it is populated and from there see feasibility of capturing within a test

Added a test in a435f94 to fully create a private endpoint from scratch. Note that because the creation takes some time, I had to take a similar approach to what we're doing in encryptionatrest resource test, where we wait for the value to be populated.

EspenAlbert · 2026-04-07T15:05:32Z

internal/service/federateddatabaseinstance/data_source_federated_database_instance.go

 		return diag.FromErr(fmt.Errorf(errorFederatedDatabaseInstanceSetting, "hostnames", name, err))
 	}

+	if err := d.Set("private_endpoint_hostnames", flattenPrivateEndpointHostnames(dataFederationInstance.GetPrivateEndpointHostnames())); err != nil {


not sure if the API always returns privateEndpointHostnames = [] or omits the field.
Using the GetXXX will not differentiate the two cases but I think this is ok here since it is a computed attribute it makes it simpler for the consumers, so they never have to worry about null value and can always assume a []

EspenAlbert

LGTM. But ideally we should have a test where it is not empty

AgustinBettati

LGTM

EspenAlbert · 2026-04-09T08:27:23Z

internal/service/federateddatabaseinstance/resource_federated_database_instance_test.go

 	`, federatedInstanceName, projectName, orgID)
 }

+func TestAccFederatedDatabaseInstance_withPrivateEndpoint(t *testing.T) {


[nit] Move test above all the internal functions

Addressed in 7bda453

EspenAlbert · 2026-04-09T08:28:25Z

internal/service/federateddatabaseinstance/resource_federated_database_instance_test.go

+  region = "us-east-1"
+}
+
+resource "aws_vpc" "test" {


q: Is this the only place were we create aws_vpc* resources? Seems like a good opportunity to refactor?

We also do it in resource_private_endpoint_regional_mode_test.go. However looking at the config used there, it differs meaningfully from what we're doing in this resource. I'd say that it's a refactor where the gain would be minimal as the boiler plate we could extract is very minor.

EspenAlbert · 2026-04-09T08:28:49Z

internal/service/federateddatabaseinstance/resource_federated_database_instance_test.go

+
+func configWithPrivateEndpoint(projectID, name string) string {
+	return fmt.Sprintf(`
+provider "aws" {


Why do we need this? Isn't it part of ExternalProviders?

Not needed, added it because I wanted to make the region specific but as it's our default anyway, removed it in 7f39bec

EspenAlbert · 2026-04-09T08:29:46Z

internal/service/federateddatabaseinstance/resource_federated_database_instance_test.go

+			},
+			{
+				PreConfig:    waitForStatusUpdate,
+				RefreshState: true,


Why is this needed? (Add comment)

Added comment in 46b452b

EspenAlbert · 2026-04-09T08:31:22Z

internal/service/federateddatabaseinstance/resource_federated_database_instance_test.go

+				Config: configWithPrivateEndpoint(projectID, name),
+			},
+			{
+				PreConfig:    waitForStatusUpdate,


Q: Is this something we should also document? That you need a sleep resource for the private_endpoint_hostnames to be populated?
Seems like a "gotcha" that users can run into.

Yeah makes sense, added a note to the docs in 2f36c2d

Looking into this further, a time_sleep resource would not help here since it cannot trigger a re-read of a resource that has already been applied to my understanding. A terraform apply -refresh-only after the initial apply will update state with the populated hostnames.

Rephrased the note in 76d38cc, let me know if it makes sense.

EspenAlbert · 2026-04-09T08:31:47Z

internal/service/federateddatabaseinstance/resource_federated_database_instance_test.go

 }

+func TestAccFederatedDatabaseInstance_withPrivateEndpoint(t *testing.T) {
+	var (


Great job on adding this!
Maybe it is worth also adding it to the examples/ directory?

We could add it yes, however where would we want it to go? We already have examples for Data Federation Private Link in examples/mongodbatlas_privatelink_endpoint/aws/data-federation-online-archive, and also for examples/mongodbatlas_federated_database_instance/aws

Added an example in ab1c745 ab1c745 ab1c745 under the data_federation examples. Let me know if it suits or we want a different place

marcabreracast added 2 commits April 1, 2026 10:36

Add field to resource

76a9fac

Add functionality to read and import

b3559ce

Copilot AI review requested due to automatic review settings April 1, 2026 08:41

github-actions bot added the enhancement label Apr 1, 2026

Add field to singular data source

fcbf3fa

Copilot AI reviewed Apr 1, 2026

View reviewed changes

marcabreracast added 4 commits April 1, 2026 10:51

Add field to plural data source

deee4f9

Add acceptance tests

c391d97

Update nil check

ebbb7e5

Add changelog

de1e4ed

svc-apix-Bot added the stale label Apr 7, 2026

marcabreracast added not_stale Not stale issue or PR and removed stale labels Apr 7, 2026

marcabreracast added 2 commits April 7, 2026 12:09

Add fields to resource and data sources docs

ce9eb6f

Add field for test

50e5ddc

marcabreracast marked this pull request as ready for review April 7, 2026 14:05

marcabreracast requested review from a team as code owners April 7, 2026 14:05

augmentcode bot reviewed Apr 7, 2026

View reviewed changes

docs/data-sources/federated_database_instance.md Outdated Show resolved Hide resolved

Fix typo in docs

d7635ec

corryroot approved these changes Apr 7, 2026

View reviewed changes

EspenAlbert reviewed Apr 7, 2026

View reviewed changes

EspenAlbert approved these changes Apr 7, 2026

View reviewed changes

AgustinBettati approved these changes Apr 8, 2026

View reviewed changes

marcabreracast added 2 commits April 8, 2026 15:43

Address doc comments

0c7f891

Add acceptance test for private endpoint field in Data Federation

a435f94

marcabreracast added 3 commits April 8, 2026 17:53

Update test so it creates VPC from scratch and avoids CI conflict

d0bc750

Remove additional fields to avoid permission issue

782f39e

Increase waiting time to avoid flakiness

3ca2e0c

EspenAlbert reviewed Apr 9, 2026

View reviewed changes

marcabreracast added 6 commits April 9, 2026 10:38

Move test above internal functions

7bda453

Remove specific aws provider declaration from test

7f39bec

Add comment clarifying waiting behaviour

46b452b

Add note to docs to clarify sleep behaviour

2f36c2d

Rephrase note

76d38cc

Add example

ab1c745

	* `private_endpoint_hostnames` - The list of private endpoint hostnames assigned to the Federated Database Instance.
	* `private_endpoint_hostnames` - List of private endpoint hostnames assigned to the Federated Database Instance.

	* `private_endpoint_hostnames.#.hostname` - Human-readable label identifying the hostname.
	* `private_endpoint_hostnames.#.hostname` - Human-readable label that identifies the host.

	* `private_endpoint_hostnames.#.private_endpoint` - Human-readable label identifying the private endpoint.
	* `private_endpoint_hostnames.#.private_endpoint` - Human-readable label that identifies the private endpoint.

Conversation

marcabreracast commented Apr 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Type of change:

Required Checklist:

Further comments

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

svc-apix-Bot commented Apr 7, 2026

Uh oh!

github-actions bot commented Apr 7, 2026

Uh oh!

augmentcode bot commented Apr 7, 2026

Uh oh!

augmentcode bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

corryroot left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

EspenAlbert Apr 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

EspenAlbert left a comment

Choose a reason for hiding this comment

Uh oh!

AgustinBettati left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

marcabreracast commented Apr 1, 2026 •

edited

Loading

EspenAlbert Apr 7, 2026 •

edited

Loading