feat: Support pinned_fcv attribute in advanced_cluster resource and data sources

.changelog/2785.txt

@@ -0,0 +1,11 @@
+```release-note:enhancement
+resource/mongodbatlas_advanced_cluster: Adds `pinned_fcv` attribute
+```
+
+```release-note:enhancement
+data-source/mongodbatlas_advanced_cluster: Adds `pinned_fcv` attribute
+```
+
+```release-note:enhancement
+data-source/mongodbatlas_advanced_clusters: Adds `pinned_fcv` attribute
+```

docs/data-sources/advanced_cluster.md

@@ -96,6 +96,7 @@ In addition to all arguments above, the following attributes are exported:
 * `tags` - Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See [below](#tags).
 * `labels` - Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See [below](#labels). **(DEPRECATED.)** Use `tags` instead.
 * `mongo_db_major_version` - Version of the cluster to deploy.
+* `pinned_fcv` - The pinned Feature Compatibility Version (FCV) with its associated expiration date. See [below](#pinned_fcv).
 * `pit_enabled` - Flag that indicates if the cluster uses Continuous Cloud Backup.
 * `replication_specs` - List of settings that configure your cluster regions. If `use_replication_spec_per_shard = true`, this array has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations. See [below](#replication_specs).
 * `root_cert_type` - Certificate Authority that MongoDB Atlas clusters use. 
@@ -202,6 +203,11 @@ Key-value pairs that categorize the cluster. Each key and value has a maximum le
 * `transaction_lifetime_limit_seconds` - Lifetime, in seconds, of multi-document transactions. Defaults to 60 seconds.
 * `change_stream_options_pre_and_post_images_expire_after_seconds` - (Optional) The minimum pre- and post-image retention time in seconds This parameter is only supported for MongoDB version 6.0 and above. Defaults to `-1`(off).
 
+### pinned_fcv
+
+* `expiration_date` - Expiration date of the fixed FCV.
+* `version` - Feature compatibility version of the cluster.
+
 ## Attributes Reference
 
 In addition to all arguments above, the following attributes are exported:

docs/data-sources/advanced_clusters.md

@@ -98,6 +98,7 @@ In addition to all arguments above, the following attributes are exported:
 * `tags` - Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See [below](#tags).
 * `labels` - Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See [below](#labels).
 * `mongo_db_major_version` - Version of the cluster to deploy.
+* `pinned_fcv` - The pinned Feature Compatibility Version (FCV) with its associated expiration date. See [below](#pinned_fcv).
 * `pit_enabled` - Flag that indicates if the cluster uses Continuous Cloud Backup.
 * `replication_specs` - List of settings that configure your cluster regions. If `use_replication_spec_per_shard = true`, this array has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations. See [below](#replication_specs)
 * `root_cert_type` - Certificate Authority that MongoDB Atlas clusters use.
@@ -205,6 +206,11 @@ Key-value pairs that categorize the cluster. Each key and value has a maximum le
 * `transaction_lifetime_limit_seconds` - (Optional) Lifetime, in seconds, of multi-document transactions. Defaults to 60 seconds.
 * `change_stream_options_pre_and_post_images_expire_after_seconds` - (Optional) The minimum pre- and post-image retention time in seconds. This parameter is only supported for MongoDB version 6.0 and above. Defaults to `-1`(off).
 
+### pinned_fcv
+
+* `expiration_date` - Expiration date of the fixed FCV.
+* `version` - Feature compatibility version of the cluster.
+
 
 ## Attributes Reference
 

docs/resources/advanced_cluster.md

@@ -383,7 +383,8 @@ This parameter defaults to false.
 * `tags` - (Optional) Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See [below](#tags).
 * `labels` - (Optional) Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See [below](#labels). **DEPRECATED** Use `tags` instead.
 * `mongo_db_major_version` - (Optional) Version of the cluster to deploy. Atlas supports all the MongoDB versions that have **not** reached [End of Live](https://www.mongodb.com/legal/support-policy/lifecycles) for M10+ clusters. If omitted, Atlas deploys the cluster with the default version. For more details, see [documentation](https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-). Atlas always deploys the cluster with the latest stable release of the specified version.  If you set a value to this parameter and set `version_release_system` `CONTINUOUS`, the resource returns an error. Either clear this parameter or set `version_release_system`: `LTS`.
-* `pit_enabled` - (Optional) - Flag that indicates if the cluster uses Continuous Cloud Backup.
+* `pinned_fcv` - (Optional) Pins the Feature Compatibility Version (FCV) to the current MongoDB version with a provided expiration date. To unpin the FCV the `pinned_fcv` attribute must be removed. Once FCV has expired `pinned_fcv` attribute must be removed. See [below](#pinned_fcv).
+* `pit_enabled` - (Optional) Flag that indicates if the cluster uses Continuous Cloud Backup.
 * `replication_specs` - List of settings that configure your cluster regions. This attribute has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations. If for each replication_spec `num_shards` is configured with a value greater than 1 (using deprecated sharding configurations), then each object represents a zone with one or more shards. See [below](#replication_specs)
 * `root_cert_type` - (Optional) - Certificate Authority that MongoDB Atlas clusters use. You can specify ISRGROOTX1 (for ISRG Root X1).
 * `termination_protection_enabled` - Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.
@@ -650,6 +651,11 @@ After adding the `lifecycle` block to explicitly change `instance_size` comment
 * `compute_min_instance_size` - (Optional) Minimum instance size to which your cluster can automatically scale (such as M10). Atlas requires this parameter if `replication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_scale_down_enabled` is true.
 * `compute_max_instance_size` - (Optional) Maximum instance size to which your cluster can automatically scale (such as M40). Atlas requires this parameter if `replication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_enabled` is true.
 
+### pinned_fcv
+
+* `expiration_date` - (Required) Expiration date of the fixed FCV. Note that this field cannot exceed 4 weeks from the pinned date.
+* `version` - Feature compatibility version of the cluster.
+
 ## Attributes Reference
 
 In addition to all arguments above, the following attributes are exported:

internal/common/conversion/type_conversion.go

@@ -35,6 +35,14 @@ func StringToTime(str string) (time.Time, bool) {
 	return ret, err == nil
 }
 
+func StringPtrToTimePtr(str *string) (*time.Time, bool) {
+	if str == nil {
+		return nil, true
+	}
+	res, ok := StringToTime(*str)
+	return &res, ok
+}
+
 func Int64PtrToIntPtr(i64 *int64) *int {
 	if i64 == nil {
 		return nil

internal/service/advancedcluster/data_source_advanced_cluster.go

@@ -260,6 +260,22 @@ func DataSource() *schema.Resource {
 				Type:     schema.TypeString,
 				Computed: true,
 			},
+			"pinned_fcv": {
+				Type:     schema.TypeList,
+				Computed: true,
+				Elem: &schema.Resource{
+					Schema: map[string]*schema.Schema{
+						"version": {
+							Type:     schema.TypeString,
+							Computed: true,
+						},
+						"expiration_date": {
+							Type:     schema.TypeString,
+							Computed: true,
+						},
+					},
+				},
+			},
 		},
 	}
 }
@@ -301,12 +317,6 @@ func dataSourceRead(ctx context.Context, d *schema.ResourceData, meta any) diag.
 		if err != nil {
 			return diag.FromErr(fmt.Errorf(errorRead, clusterName, err))
 		}
-		if err := d.Set("replica_set_scaling_strategy", clusterDescNew.GetReplicaSetScalingStrategy()); err != nil {
-			return diag.FromErr(fmt.Errorf(ErrorClusterAdvancedSetting, "replica_set_scaling_strategy", clusterName, err))
-		}
-		if err := d.Set("redact_client_log_data", clusterDescNew.GetRedactClientLogData()); err != nil {
-			return diag.FromErr(fmt.Errorf(ErrorClusterAdvancedSetting, "redact_client_log_data", clusterName, err))
-		}
 
 		zoneNameToZoneIDs, err := getZoneIDsFromNewAPI(clusterDescNew)
 		if err != nil {
@@ -318,10 +328,7 @@ func dataSourceRead(ctx context.Context, d *schema.ResourceData, meta any) diag.
 			return diag.FromErr(fmt.Errorf(ErrorClusterAdvancedSetting, "replication_specs", clusterName, err))
 		}
 
-		clusterDesc := convertClusterDescToLatestExcludeRepSpecs(clusterDescOld)
-		clusterDesc.ConfigServerManagementMode = clusterDescNew.ConfigServerManagementMode
-		clusterDesc.ConfigServerType = clusterDescNew.ConfigServerType
-		diags := setRootFields(d, clusterDesc, false)
+		diags := setRootFields(d, clusterDescNew, false)
 		if diags.HasError() {
 			return diags
 		}
@@ -340,12 +347,6 @@ func dataSourceRead(ctx context.Context, d *schema.ResourceData, meta any) diag.
 		if err := d.Set("disk_size_gb", GetDiskSizeGBFromReplicationSpec(clusterDescLatest)); err != nil {
 			return diag.FromErr(fmt.Errorf(ErrorClusterAdvancedSetting, "disk_size_gb", clusterName, err))
 		}
-		if err := d.Set("replica_set_scaling_strategy", clusterDescLatest.GetReplicaSetScalingStrategy()); err != nil {
-			return diag.FromErr(fmt.Errorf(ErrorClusterAdvancedSetting, "replica_set_scaling_strategy", clusterName, err))
-		}
-		if err := d.Set("redact_client_log_data", clusterDescLatest.GetRedactClientLogData()); err != nil {
-			return diag.FromErr(fmt.Errorf(ErrorClusterAdvancedSetting, "redact_client_log_data", clusterName, err))
-		}
 
 		zoneNameToOldReplicationSpecIDs, err := getReplicationSpecIDsFromOldAPI(ctx, projectID, clusterName, connV220240530)
 		if err != nil {

internal/service/advancedcluster/data_source_advanced_clusters.go

@@ -273,6 +273,22 @@ func PluralDataSource() *schema.Resource {
 							Type:     schema.TypeString,
 							Computed: true,
 						},
+						"pinned_fcv": {
+							Type:     schema.TypeList,
+							Computed: true,
+							Elem: &schema.Resource{
+								Schema: map[string]*schema.Schema{
+									"version": {
+										Type:     schema.TypeString,
+										Computed: true,
+									},
+									"expiration_date": {
+										Type:     schema.TypeString,
+										Computed: true,
+									},
+								},
+							},
+						},
 					},
 				},
 			},
@@ -375,6 +391,7 @@ func flattenAdvancedClusters(ctx context.Context, connV220240530 *admin20240530.
 			"redact_client_log_data":               cluster.GetRedactClientLogData(),
 			"config_server_management_mode":        cluster.GetConfigServerManagementMode(),
 			"config_server_type":                   cluster.GetConfigServerType(),
+			"pinned_fcv":                           flattenPinnedFCV(cluster),
 		}
 		results = append(results, result)
 	}
@@ -434,6 +451,7 @@ func flattenAdvancedClustersOldSDK(ctx context.Context, connV20240530 *admin2024
 			"redact_client_log_data":               clusterDescNew.GetRedactClientLogData(),
 			"config_server_management_mode":        clusterDescNew.GetConfigServerManagementMode(),
 			"config_server_type":                   clusterDescNew.GetConfigServerType(),
+			"pinned_fcv":                           flattenPinnedFCV(clusterDescNew),
 		}
 		results = append(results, result)
 	}

internal/service/advancedcluster/model_advanced_cluster.go

@@ -426,6 +426,16 @@ func CheckRegionConfigsPriorityOrderOld(regionConfigs []admin20240530.Replicatio
 	return nil
 }
 
+func flattenPinnedFCV(cluster *admin.ClusterDescription20240805) []map[string]string {
+	if cluster.FeatureCompatibilityVersion == nil { // pinned_fcv is defined in state only if featureCompatibilityVersion is present in cluster response
+		return nil
+	}
+	nestedObj := map[string]string{}
+	nestedObj["version"] = cluster.GetFeatureCompatibilityVersion()
+	nestedObj["expiration_date"] = *conversion.TimePtrToStringPtr(cluster.FeatureCompatibilityVersionExpirationDate)
+	return []map[string]string{nestedObj}
+}
+
 func flattenConnectionStrings(str admin.ClusterConnectionStrings) []map[string]any {
 	return []map[string]any{
 		{

internal/service/advancedcluster/model_sdk_version_conversion.go

@@ -12,14 +12,6 @@ import (
 // - These functions must not contain any business logic.
 // - All will be removed once we rely on a single API version.
 
-func convertTagsPtrToLatest(tags *[]admin20240530.ResourceTag) *[]admin.ResourceTag {
-	if tags == nil {
-		return nil
-	}
-	result := convertTagsToLatest(*tags)
-	return &result
-}
-
 func convertTagsPtrToOldSDK(tags *[]admin20240805.ResourceTag) *[]admin20240530.ResourceTag {
 	if tags == nil {
 		return nil
@@ -298,30 +290,3 @@ func convertRegionConfigSliceToLatest(slice *[]admin20240530.CloudRegionConfig,
 	}
 	return &results
 }
-
-func convertClusterDescToLatestExcludeRepSpecs(oldClusterDesc *admin20240530.AdvancedClusterDescription) *admin.ClusterDescription20240805 {
-	return &admin.ClusterDescription20240805{
-		BackupEnabled: oldClusterDesc.BackupEnabled,
-		AcceptDataRisksAndForceReplicaSetReconfig: oldClusterDesc.AcceptDataRisksAndForceReplicaSetReconfig,
-		ClusterType:                      oldClusterDesc.ClusterType,
-		CreateDate:                       oldClusterDesc.CreateDate,
-		DiskWarmingMode:                  oldClusterDesc.DiskWarmingMode,
-		EncryptionAtRestProvider:         oldClusterDesc.EncryptionAtRestProvider,
-		GlobalClusterSelfManagedSharding: oldClusterDesc.GlobalClusterSelfManagedSharding,
-		GroupId:                          oldClusterDesc.GroupId,
-		Id:                               oldClusterDesc.Id,
-		MongoDBMajorVersion:              oldClusterDesc.MongoDBMajorVersion,
-		MongoDBVersion:                   oldClusterDesc.MongoDBVersion,
-		Name:                             oldClusterDesc.Name,
-		Paused:                           oldClusterDesc.Paused,
-		PitEnabled:                       oldClusterDesc.PitEnabled,
-		RootCertType:                     oldClusterDesc.RootCertType,
-		StateName:                        oldClusterDesc.StateName,
-		TerminationProtectionEnabled:     oldClusterDesc.TerminationProtectionEnabled,
-		VersionReleaseSystem:             oldClusterDesc.VersionReleaseSystem,
-		Tags:                             convertTagsPtrToLatest(oldClusterDesc.Tags),
-		BiConnector:                      convertBiConnectToLatest(oldClusterDesc.BiConnector),
-		ConnectionStrings:                convertConnectionStringToLatest(oldClusterDesc.ConnectionStrings),
-		Labels:                           convertLabelsToLatest(oldClusterDesc.Labels),
-	}
-}