feat: Add error_message, provider_account_id, and interface_endpoint_name to Stream PrivateLinkEndpoint models (#3161)

tcannon91 · web-flow · commit cc742e80a038 · 2025-03-19T11:12:49.000-04:00
diff --git a/.changelog/3161.txt b/.changelog/3161.txt
@@ -0,0 +1,3 @@
+```release-note:enhancement
+resource/mongodbatlas_stream_privatelink_endpoint: Adds `error_message`, `interface_endpoint_name`, and `provider_account_id` attributes
+```
diff --git a/docs/data-sources/stream_privatelink_endpoint.md b/docs/data-sources/stream_privatelink_endpoint.md
@@ -93,7 +93,10 @@ output "interface_endpoint_ids" {
 
 - `dns_domain` (String) Domain name of Privatelink connected cluster.
 - `dns_sub_domain` (List of String) Sub-Domain name of Confluent cluster. These are typically your availability zones.
+- `error_message` (String) Error message if the connection is in a failed state.
 - `interface_endpoint_id` (String) Interface endpoint ID that is created from the specified service endpoint ID.
+- `interface_endpoint_name` (String) Name of interface endpoint that is created from the specified service endpoint ID.
+- `provider_account_id` (String) Account ID from the cloud provider.
 - `provider_name` (String) Provider where the Kafka cluster is deployed.
 - `region` (String) Domain name of Confluent cluster.
 - `service_endpoint_id` (String) Service Endpoint ID.
diff --git a/docs/data-sources/stream_privatelink_endpoints.md b/docs/data-sources/stream_privatelink_endpoints.md
@@ -99,11 +99,14 @@ Read-Only:
 
 - `dns_domain` (String) Domain name of Privatelink connected cluster.
 - `dns_sub_domain` (List of String) Sub-Domain name of Confluent cluster. These are typically your availability zones.
+- `error_message` (String) Error message if the connection is in a failed state.
 - `id` (String) The ID of the Private Link connection.
 - `interface_endpoint_id` (String) Interface endpoint ID that is created from the specified service endpoint ID.
+- `interface_endpoint_name` (String) Name of interface endpoint that is created from the specified service endpoint ID.
 - `project_id` (String) Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.
 
 **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group or project id remains the same. The resource and corresponding endpoints use the term groups.
+- `provider_account_id` (String) Account ID from the cloud provider.
 - `provider_name` (String) Provider where the Kafka cluster is deployed.
 - `region` (String) Domain name of Confluent cluster.
 - `service_endpoint_id` (String) Service Endpoint ID.
diff --git a/docs/resources/stream_privatelink_endpoint.md b/docs/resources/stream_privatelink_endpoint.md
@@ -99,8 +99,11 @@ output "interface_endpoint_ids" {
 
 ### Read-Only
 
+- `error_message` (String) Error message if the connection is in a failed state.
 - `id` (String) The ID of the Private Link connection.
 - `interface_endpoint_id` (String) Interface endpoint ID that is created from the specified service endpoint ID.
+- `interface_endpoint_name` (String) Name of interface endpoint that is created from the specified service endpoint ID.
+- `provider_account_id` (String) Account ID from the cloud provider.
 - `state` (String) Status of the connection.
 
 For more information see: [MongoDB Atlas API - Streams Privatelink](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createPrivateLinkConnection) Documentation.
diff --git a/internal/service/streamprivatelinkendpoint/model.go b/internal/service/streamprivatelinkendpoint/model.go
@@ -16,23 +16,25 @@ const (
 
 func NewTFModel(ctx context.Context, projectID string, apiResp *admin.StreamsPrivateLinkConnection) (*TFModel, diag.Diagnostics) {
 	result := &TFModel{
-		Id:                  types.StringPointerValue(apiResp.Id),
-		DnsDomain:           types.StringPointerValue(apiResp.DnsDomain),
-		ProjectId:           types.StringPointerValue(&projectID),
-		InterfaceEndpointId: types.StringPointerValue(apiResp.InterfaceEndpointId),
-		Provider:            types.StringPointerValue(apiResp.Provider),
-		Region:              types.StringPointerValue(apiResp.Region),
-		ServiceEndpointId:   types.StringPointerValue(apiResp.ServiceEndpointId),
-		State:               types.StringPointerValue(apiResp.State),
-		Vendor:              types.StringPointerValue(apiResp.Vendor),
+		Id:                    types.StringPointerValue(apiResp.Id),
+		DnsDomain:             types.StringPointerValue(apiResp.DnsDomain),
+		ErrorMessage:          types.StringPointerValue(apiResp.ErrorMessage),
+		ProjectId:             types.StringPointerValue(&projectID),
+		InterfaceEndpointId:   types.StringPointerValue(apiResp.InterfaceEndpointId),
+		InterfaceEndpointName: types.StringPointerValue(apiResp.InterfaceEndpointName),
+		Provider:              types.StringPointerValue(apiResp.Provider),
+		ProviderAccountId:     types.StringPointerValue(apiResp.ProviderAccountId),
+		Region:                types.StringPointerValue(apiResp.Region),
+		ServiceEndpointId:     types.StringPointerValue(apiResp.ServiceEndpointId),
+		State:                 types.StringPointerValue(apiResp.State),
+		Vendor:                types.StringPointerValue(apiResp.Vendor),
 	}
-	if apiResp.DnsSubDomain != nil {
-		subdomain, diags := types.ListValueFrom(ctx, types.StringType, apiResp.GetDnsSubDomain())
-		if diags.HasError() {
-			return nil, diags
-		}
-		result.DnsSubDomain = subdomain
+
+	subdomain, diags := types.ListValueFrom(ctx, types.StringType, apiResp.GetDnsSubDomain())
+	if diags.HasError() {
+		return nil, diags
 	}
+	result.DnsSubDomain = subdomain
 
 	return result, nil
 }
diff --git a/internal/service/streamprivatelinkendpoint/model_test.go b/internal/service/streamprivatelinkendpoint/model_test.go
@@ -19,31 +19,35 @@ type sdkToTFModelTestCase struct {
 }
 
 var (
-	projectID           = "projectID"
-	id                  = "id"
-	dnsDomain           = "dnsDomain"
-	dnsSubDomain        = "dnsSubDomain"
-	interfaceEndpointID = "interfaceEndpointId"
-	provider            = "AWS"
-	region              = "us-east-1"
-	serviceEndpointID   = "serviceEndpointId"
-	state               = "DONE"
-	vendor              = "CONFLUENT"
+	projectID             = "projectID"
+	id                    = "id"
+	dnsDomain             = "dnsDomain"
+	dnsSubDomain          = "dnsSubDomain"
+	interfaceEndpointID   = "interfaceEndpointId"
+	interfaceEndpointName = "interfaceEndpointName"
+	provider              = "AWS"
+	providerAccountID     = "providerAccountId"
+	region                = "us-east-1"
+	serviceEndpointID     = "serviceEndpointId"
+	state                 = "DONE"
+	vendor                = "CONFLUENT"
 )
 
 func TestStreamPrivatelinkEndpointSDKToTFModel(t *testing.T) {
 	testCases := map[string]sdkToTFModelTestCase{
 		"Complete SDK response": {
 			SDKResp: &admin.StreamsPrivateLinkConnection{
-				Id:                  &id,
-				DnsDomain:           &dnsDomain,
-				DnsSubDomain:        conversion.Pointer([]string{dnsSubDomain, dnsSubDomain}),
-				InterfaceEndpointId: &interfaceEndpointID,
-				Provider:            &provider,
-				Region:              &region,
-				ServiceEndpointId:   &serviceEndpointID,
-				State:               &state,
-				Vendor:              &vendor,
+				Id:                    &id,
+				DnsDomain:             &dnsDomain,
+				DnsSubDomain:          conversion.Pointer([]string{dnsSubDomain, dnsSubDomain}),
+				InterfaceEndpointId:   &interfaceEndpointID,
+				InterfaceEndpointName: &interfaceEndpointName,
+				Provider:              &provider,
+				ProviderAccountId:     &providerAccountID,
+				Region:                &region,
+				ServiceEndpointId:     &serviceEndpointID,
+				State:                 &state,
+				Vendor:                &vendor,
 			},
 			projectID: projectID,
 			expectedTFModel: &streamprivatelinkendpoint.TFModel{
@@ -53,13 +57,15 @@ func TestStreamPrivatelinkEndpointSDKToTFModel(t *testing.T) {
 					types.StringValue(dnsSubDomain),
 					types.StringValue(dnsSubDomain),
 				}),
-				ProjectId:           types.StringValue(projectID),
-				InterfaceEndpointId: types.StringValue(interfaceEndpointID),
-				Provider:            types.StringValue(provider),
-				Region:              types.StringValue(region),
-				ServiceEndpointId:   types.StringValue(serviceEndpointID),
-				State:               types.StringValue(state),
-				Vendor:              types.StringValue(vendor),
+				ProjectId:             types.StringValue(projectID),
+				InterfaceEndpointId:   types.StringValue(interfaceEndpointID),
+				InterfaceEndpointName: types.StringValue(interfaceEndpointName),
+				Provider:              types.StringValue(provider),
+				ProviderAccountId:     types.StringValue(providerAccountID),
+				Region:                types.StringValue(region),
+				ServiceEndpointId:     types.StringValue(serviceEndpointID),
+				State:                 types.StringValue(state),
+				Vendor:                types.StringValue(vendor),
 			},
 		},
 		"SDK response without dns subdomains": {
@@ -77,6 +83,7 @@ func TestStreamPrivatelinkEndpointSDKToTFModel(t *testing.T) {
 			expectedTFModel: &streamprivatelinkendpoint.TFModel{
 				Id:                  types.StringValue(id),
 				DnsDomain:           types.StringValue(dnsDomain),
+				DnsSubDomain:        types.ListNull(types.StringType),
 				ProjectId:           types.StringValue(projectID),
 				InterfaceEndpointId: types.StringValue(interfaceEndpointID),
 				Provider:            types.StringValue(provider),
@@ -89,7 +96,8 @@ func TestStreamPrivatelinkEndpointSDKToTFModel(t *testing.T) {
 		"Empty SDK response": {
 			SDKResp: &admin.StreamsPrivateLinkConnection{},
 			expectedTFModel: &streamprivatelinkendpoint.TFModel{
-				ProjectId: types.StringValue(""),
+				ProjectId:    types.StringValue(""),
+				DnsSubDomain: types.ListNull(types.StringType),
 			},
 		},
 	}
@@ -120,13 +128,15 @@ func TestStreamPrivatelinkEndpointTFModelToSDK(t *testing.T) {
 					types.StringValue(dnsSubDomain),
 					types.StringValue(dnsSubDomain),
 				}),
-				ProjectId:           types.StringValue(projectID),
-				InterfaceEndpointId: types.StringValue(interfaceEndpointID),
-				Provider:            types.StringValue(provider),
-				Region:              types.StringValue(region),
-				ServiceEndpointId:   types.StringValue(serviceEndpointID),
-				State:               types.StringValue(state),
-				Vendor:              types.StringValue(vendor),
+				ProjectId:             types.StringValue(projectID),
+				InterfaceEndpointId:   types.StringValue(interfaceEndpointID),
+				InterfaceEndpointName: types.StringValue(interfaceEndpointName),
+				Provider:              types.StringValue(provider),
+				ProviderAccountId:     types.StringValue(providerAccountID),
+				Region:                types.StringValue(region),
+				ServiceEndpointId:     types.StringValue(serviceEndpointID),
+				State:                 types.StringValue(state),
+				Vendor:                types.StringValue(vendor),
 			},
 			expectedSDKReq: &admin.StreamsPrivateLinkConnection{
 				DnsDomain:         &dnsDomain,
diff --git a/internal/service/streamprivatelinkendpoint/resource_migration_test.go b/internal/service/streamprivatelinkendpoint/resource_migration_test.go
@@ -10,5 +10,5 @@ import (
 func TestMigStreamPrivatelinkEndpoint_basic(t *testing.T) {
 	acc.SkipTestForCI(t)                // needs confluent cloud resources
 	mig.SkipIfVersionBelow(t, "1.25.0") // when resource 1st released
-	mig.CreateTestAndRunUseExternalProviderNonParallel(t, basicTestCase(t), mig.ExternalProvidersWithConfluent(), nil)
+	mig.CreateTestAndRunUseExternalProviderNonParallel(t, basicTestCase(t, true), mig.ExternalProvidersWithConfluent(), nil)
 }
diff --git a/internal/service/streamprivatelinkendpoint/resource_schema.go b/internal/service/streamprivatelinkendpoint/resource_schema.go
@@ -23,6 +23,10 @@ func ResourceSchema(ctx context.Context) schema.Schema {
 				MarkdownDescription: "Sub-Domain name of Confluent cluster. These are typically your availability zones.",
 				ElementType:         types.StringType,
 			},
+			"error_message": schema.StringAttribute{
+				Computed:            true,
+				MarkdownDescription: "Error message if the connection is in a failed state.",
+			},
 			"project_id": schema.StringAttribute{
 				Required:            true,
 				MarkdownDescription: "Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.\n\n**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group or project id remains the same. The resource and corresponding endpoints use the term groups.",
@@ -31,6 +35,14 @@ func ResourceSchema(ctx context.Context) schema.Schema {
 				Computed:            true,
 				MarkdownDescription: "Interface endpoint ID that is created from the specified service endpoint ID.",
 			},
+			"interface_endpoint_name": schema.StringAttribute{
+				Computed:            true,
+				MarkdownDescription: "Name of interface endpoint that is created from the specified service endpoint ID.",
+			},
+			"provider_account_id": schema.StringAttribute{
+				Computed:            true,
+				MarkdownDescription: "Account ID from the cloud provider.",
+			},
 			"provider_name": schema.StringAttribute{
 				Required:            true,
 				MarkdownDescription: "Provider where the Kafka cluster is deployed.",
@@ -56,16 +68,19 @@ func ResourceSchema(ctx context.Context) schema.Schema {
 }
 
 type TFModel struct {
-	Id                  types.String `tfsdk:"id"`
-	DnsDomain           types.String `tfsdk:"dns_domain"`
-	DnsSubDomain        types.List   `tfsdk:"dns_sub_domain"`
-	ProjectId           types.String `tfsdk:"project_id"`
-	InterfaceEndpointId types.String `tfsdk:"interface_endpoint_id"`
-	Provider            types.String `tfsdk:"provider_name"`
-	Region              types.String `tfsdk:"region"`
-	ServiceEndpointId   types.String `tfsdk:"service_endpoint_id"`
-	State               types.String `tfsdk:"state"`
-	Vendor              types.String `tfsdk:"vendor"`
+	Id                    types.String `tfsdk:"id"`
+	DnsDomain             types.String `tfsdk:"dns_domain"`
+	DnsSubDomain          types.List   `tfsdk:"dns_sub_domain"`
+	ErrorMessage          types.String `tfsdk:"error_message"`
+	ProjectId             types.String `tfsdk:"project_id"`
+	InterfaceEndpointId   types.String `tfsdk:"interface_endpoint_id"`
+	InterfaceEndpointName types.String `tfsdk:"interface_endpoint_name"`
+	Provider              types.String `tfsdk:"provider_name"`
+	ProviderAccountId     types.String `tfsdk:"provider_account_id"`
+	Region                types.String `tfsdk:"region"`
+	ServiceEndpointId     types.String `tfsdk:"service_endpoint_id"`
+	State                 types.String `tfsdk:"state"`
+	Vendor                types.String `tfsdk:"vendor"`
 }
 
 type TFModelDSP struct {
diff --git a/internal/service/streamprivatelinkendpoint/resource_test.go b/internal/service/streamprivatelinkendpoint/resource_test.go
@@ -21,7 +21,14 @@ var (
 
 func TestAccStreamPrivatelinkEndpoint_basic(t *testing.T) {
 	acc.SkipTestForCI(t) // needs confluent cloud resources
-	tc := basicTestCase(t)
+	tc := basicTestCase(t, true)
+	// Tests include testing of plural data source and so cannot be run in parallel
+	resource.Test(t, *tc)
+}
+
+func TestAccStreamPrivatelinkEndpoint_noDNSsubdomains(t *testing.T) {
+	acc.SkipTestForCI(t) // needs confluent cloud resources
+	tc := basicTestCase(t, false)
 	// Tests include testing of plural data source and so cannot be run in parallel
 	resource.Test(t, *tc)
 }
@@ -40,7 +47,7 @@ func TestAccStreamPrivatelinkEndpoint_missingRequiredFields(t *testing.T) {
 	resource.Test(t, *tc)
 }
 
-func basicTestCase(t *testing.T) *resource.TestCase {
+func basicTestCase(t *testing.T, withDNSSubdomains bool) *resource.TestCase {
 	t.Helper()
 
 	var (
@@ -50,7 +57,7 @@ func basicTestCase(t *testing.T) *resource.TestCase {
 		awsAccountID        = os.Getenv("AWS_ACCOUNT_ID")
 		networkID           = os.Getenv("CONFLUENT_CLOUD_NETWORK_ID")
 		privatelinkAccessID = os.Getenv("CONFLUENT_CLOUD_PRIVATELINK_ACCESS_ID")
-		config              = acc.GetCompleteConfluentConfig(true, true, projectID, provider, region, vendor, awsAccountID, networkID, privatelinkAccessID)
+		config              = acc.GetCompleteConfluentConfig(true, withDNSSubdomains, projectID, provider, region, vendor, awsAccountID, networkID, privatelinkAccessID)
 	)
 
 	return &resource.TestCase{
@@ -154,8 +161,10 @@ func checksStreamPrivatelinkEndpoint(projectID, provider, region, vendor string,
 	attrSet := []string{
 		"id",
 		"interface_endpoint_id",
+		"interface_endpoint_name",
 		"state",
 		"dns_domain",
+		"provider_account_id",
 		"service_endpoint_id",
 	}
 	if dnsSubdomainsCheck {
diff --git a/internal/testutil/acc/pre_check.go b/internal/testutil/acc/pre_check.go
@@ -384,6 +384,6 @@ func PreCheckConfluentAWSPrivatelink(tb testing.TB) {
 		os.Getenv("CONFLUENT_CLOUD_API_SECRET") == "" ||
 		os.Getenv("CONFLUENT_CLOUD_NETWORK_ID") == "" ||
 		os.Getenv("CONFLUENT_CLOUD_PRIVATELINK_ACCESS_ID") == "" {
-		tb.Fatal("`CONFLUENT_CLOUD_API_KEY`, `CONFLUENT_CLOUD_API_SECRET`, `CONFLUENT_CLOUD_NETWORK_ID`, and `CONFLUENT_CLOUD_PRIVATELINK_ACCESS_ID` must be set for Cloud Backup Snapshot Export Bucket acceptance testing")
+		tb.Fatal("`CONFLUENT_CLOUD_API_KEY`, `CONFLUENT_CLOUD_API_SECRET`, `CONFLUENT_CLOUD_NETWORK_ID`, and `CONFLUENT_CLOUD_PRIVATELINK_ACCESS_ID` must be set for AWS PrivateLink acceptance testing")
 	}
 }

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	+```release-note:enhancement
	`2`	+resource/mongodbatlas_stream_privatelink_endpoint: Adds `error_message`, `interface_endpoint_name`, and `provider_account_id` attributes
	`3`	+```
Original file line number	Diff line number	Diff line change
`@@ -10,5 +10,5 @@ import (`
`10`	`10`	`func TestMigStreamPrivatelinkEndpoint_basic(t *testing.T) {`
`11`	`11`	`acc.SkipTestForCI(t) // needs confluent cloud resources`
`12`	`12`	`mig.SkipIfVersionBelow(t, "1.25.0") // when resource 1st released`
`13`		`- mig.CreateTestAndRunUseExternalProviderNonParallel(t, basicTestCase(t), mig.ExternalProvidersWithConfluent(), nil)`
	`13`	`+ mig.CreateTestAndRunUseExternalProviderNonParallel(t, basicTestCase(t, true), mig.ExternalProvidersWithConfluent(), nil)`
`14`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -384,6 +384,6 @@ func PreCheckConfluentAWSPrivatelink(tb testing.TB) {`
`384`	`384`	`os.Getenv("CONFLUENT_CLOUD_API_SECRET") == "" \|\|`
`385`	`385`	`os.Getenv("CONFLUENT_CLOUD_NETWORK_ID") == "" \|\|`
`386`	`386`	`os.Getenv("CONFLUENT_CLOUD_PRIVATELINK_ACCESS_ID") == "" {`
`387`		- tb.Fatal("`CONFLUENT_CLOUD_API_KEY`, `CONFLUENT_CLOUD_API_SECRET`, `CONFLUENT_CLOUD_NETWORK_ID`, and `CONFLUENT_CLOUD_PRIVATELINK_ACCESS_ID` must be set for Cloud Backup Snapshot Export Bucket acceptance testing")
	`387`	+ tb.Fatal("`CONFLUENT_CLOUD_API_KEY`, `CONFLUENT_CLOUD_API_SECRET`, `CONFLUENT_CLOUD_NETWORK_ID`, and `CONFLUENT_CLOUD_PRIVATELINK_ACCESS_ID` must be set for AWS PrivateLink acceptance testing")
`388`	`388`	`}`
`389`	`389`	`}`